From d3ba5fdfccd819e3bfa6950bca1a73dbabf67be8 Mon Sep 17 00:00:00 2001 From: Rob Connolly Date: Tue, 10 Oct 2017 11:54:24 +1300 Subject: [PATCH] Add documentation for Rocket.Chat notifications. (#3424) * Add documentation for Rocket.Chat notifications. * Update 'ha_release' --- source/_components/notify.rocketchat.markdown | 56 ++++++++++++++++++ source/images/supported_brands/rocketchat.png | Bin 0 -> 3006 bytes 2 files changed, 56 insertions(+) create mode 100644 source/_components/notify.rocketchat.markdown create mode 100644 source/images/supported_brands/rocketchat.png diff --git a/source/_components/notify.rocketchat.markdown b/source/_components/notify.rocketchat.markdown new file mode 100644 index 00000000000..2c014c30546 --- /dev/null +++ b/source/_components/notify.rocketchat.markdown @@ -0,0 +1,56 @@ +--- +layout: page +title: "Rocket.Chat" +description: "Instructions on how to add Rocket.Chat notifications to Home Assistant." +date: 2017-09-23 20:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: rocketchat.png +ha_category: Notifications +ha_release: 0.56 +--- + + +The `rocketchat` platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. + +To add Rocket.Chat to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + - platform: rocketchat + name: NOTIFIER_NAME + url: https://rocketchat.example.com + username: USERNAME + password: PASSWORD + room: my-awesome-room +``` + +- **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **url** (*Required*): The URL of your Rocket.Chat instance. +- **username** (*Required*): The Rocket.Chat username. +- **password** (*Required*): The Rocker.Chat password. +- **room** (*Required*): The chat room name to send messages to. + +### {% linkable_title script.yaml example %} + +```yaml +rocketchat_notification: + sequence: + - service: notify.NOTIFIER_NAME + data: + message: "Message to Rocket.Chat from Home Assistant!" + data: + emoji: ":smirk:" +``` + +#### {% linkable_title Message variables %} + +- **message** (*Required*): Message to be displayed. +- **data** (*Optional*): Dictionary containing any of the variables defined in the + [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) + +To use notifications, please see the [getting started with automation page](/getting-started/automation/). + diff --git a/source/images/supported_brands/rocketchat.png b/source/images/supported_brands/rocketchat.png new file mode 100644 index 0000000000000000000000000000000000000000..912112d2c9794607a75a6b0a76187da730810f8e GIT binary patch literal 3006 zcmb7``8U*$8^zzoHg;o|WkzI_eVJ^TW~`BAtSOOH)*@N*vCW9Fha^hb_iTlxk!6Mm zAzMhuknA!-Of&e_pYT2Bp7Xl*oadM4ocqH~!dRQ}aGu}<0D#B*g0UR{F#WYm0GRnN z{A!#X{$d(q>0t7g9dPCUOCzoxU&10OkFytxN~nGP^k2V@kB_?%dNc7!8?9~oi$D4d z%~tAO?M#08>=!VIabPeQTU%S-Tid4^ne}f=5B0k zdqu6(M_|j>pP8u_j0B_dRK>Sjx&bmJ-CD zWLg}j`38s)?%P!dN<_CU0w&*6(u3p zZ3w;=%CW}3n%Y(5FUrCfF>O#D6KOneik5@=$QIjNOpC2nuBM22+joLnE%RN03fVi> zpMTEyP)kJ~X|&1S%e^CJP;e-@!QEzLSrL{m$2qeVO2@IV$7uSy(_gUsva1ZsEXw20 zTnN*>Xy41zB+CZB1T=Pj8?AdKjX`}Ac!>`+tI}Y_9qL=P80*J?$X1mpP4*t$!eleN z)}~lnCX|>vgFVyaXJIHrPWWMZQNJe*rx?Fn%I1r^-hhT702PcN3tWPN^;SBJF{Hvy zv1Zm2)dUL@R4krS6cC5W$ueyix2j=6{L*)WDFjawT zzxav%tpIR~5*{e(UbrNFz)wlXrK#Yo4-2aCB%w3GOj&q0%J6RvGDUQ%L$nJ-2moKp z&O%vP4Z~B`*Kj>p$h+3sqp*=E`_df#@Wa zWUU>`-MBf>6%yp!U>5FzsENaIEQtgDPE8;Jj;ssh0k_+eF!b9+tgcXR$l3k9x2(vT zKpC9|gxUqRoV@%TvTuSaKespgZ__Y%2)gV+35$Hpjf##w`8_2+{7?KTn7&#P9yOZ+ zn7%@tBuAtIswl{9C)|EBi7{)3s}x&c1J!IY3lN}g>H};jQwp;aK;~qw$i4AGlX6EY z)ZdyaGbxaHHD2R*8}^-Io5ZBbfb46)bgwC|jV0%n7P^g%+98kP){~LumZ9nL-U(lG zOS8h_>0?90c4Flz5h?G_ToM2ZOuUdndvPaeHaWLgTp1&c_+3H-wMKUw1yf8WM7BmC z>%6;r1dD_N5+hkkpc#Tp-DMm- z5N321)+B_}c=$a^gED6vjOTBsM|&DBC}1VE+UPseLrrniWzbvd9i{ZOA=Y?UJ8i!4 zS%J-LjRp)ds0v&E_*}%;koL2ups%I=yknpOFQq6xZ8~Cv{pJe~eK4`+)(QIYv5EfX zw}CVdFkALwG&G8Cd$M40G47ooIjh;&lT9%)(lwEKQzbLEeAnZ$*@8wh#27(2zLzM8r7*yh~}w3@gw#dTrlN`$GUZvT%S06Wj@Irsrhx~K-A?1GMOyPFel zc{&3O*ZcGumHF~2ko)D9XBS{|gl1M$=655D!`d+{XFl{S_jHBu#h0~>@0S_c2Vi_v z%y0lG9sBCmx~zb+9XGQaHd8Yc11|F^RQm+L2A@TEA7nNS6XW5l@og!|^5KHQ8Vod{ zqo;C3&gH>bz3-s>+7k!|F3b6PvPtMkk~oahk?LgEc=|Lc^@{>5d ztbTioVilgQ7h8SKQRz0xu4M{0)-pVEwY$m*5q>y!2Xs|#dYnaYv;8n`r1E-qV(XFmhyNs92j{tWsuez|bM>10{rz=&Tj*$#;h9L}oXYO@NB0zEV3VxbhocH@>x2Ge4_G)p`cSd$C?57xkcR&QXP@(=a15$kUO9&JJTsRXbAE!WPPxuxcJ?I<1sm8W0=W z;2s%ysD}TZ$>Cq%qo1fBeyi(zz)tpkjPlyTgkoigG%}dap^xqD$K9(uAu?SF@~8P{ z=c4#q=kddIPJ_~S|Zy%_RfaQk= zgS-?GaymWVNf%_E!Xznd+?UX!V9BAIZpDut3QV+sm&oH8H6X`*?ypzhFhJuYAww{? vird0+B