From 4b3b3c8c5a6c677443344c5b6fdce2e162a05568 Mon Sep 17 00:00:00 2001 From: Daniel Perna Date: Tue, 25 Oct 2016 06:59:22 +0200 Subject: [PATCH] Documentation for the Notifications for Android TV platform. (#1296) * Documentation for the Notifications for Android TV platform. * Changes as requested by reviewer @Landrash * Bump to 0.32 since PR has not been merged yet * Changed option 'ip' to 'host' like most other platforms do --- .../_components/notify.nfandroidtv.markdown | 55 ++++++++++++++++++ .../images/supported_brands/nfandroidtv.png | Bin 0 -> 7978 bytes 2 files changed, 55 insertions(+) create mode 100644 source/_components/notify.nfandroidtv.markdown create mode 100644 source/images/supported_brands/nfandroidtv.png diff --git a/source/_components/notify.nfandroidtv.markdown b/source/_components/notify.nfandroidtv.markdown new file mode 100644 index 00000000000..4832dc8554b --- /dev/null +++ b/source/_components/notify.nfandroidtv.markdown @@ -0,0 +1,55 @@ +--- +layout: page +title: "Notifications for Android TV / FireTV" +description: "Notifications for Android TV / FireTV" +date: 2016-10-21 13:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: nfandroidtv.png +ha_category: Notifications +ha_release: 0.32 +--- + + +Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google&hl=de) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). +The notifications are in the global scope of your Android TV device. They will be displayed regardless of which application is running. +The In-App purchases only apply to the client for Android smartphones, so there isn't any limit when pushing notifications from HASS. + +To enable the notification platform, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: +- platform: nfandroidtv + name: Kitchen + host: 192.168.1.12 +``` + +Configuration variables: + +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **host** (*Required*): IP address of the Android TV / FireTV device. +- **duration** (*Optional*): The duration in seconds for which the notification will be displayed. Default is 5 seconds. +- **position** (*Optional*): Has to be one of: bottom-right (default), bottom-left, top-right, top-left, center +- **color** (*Optional*): Has to be one of: grey (default), black, indigo, green, red, cyan, teal, amber, pink +- **transparency** (*Optional*): Has to be one of: 0%, 25% (default), 50%, 75%, 100% +- **interrupt** (*Optional*): If set to true, 1, on etc., the notification is interactive and can be dismissed or selected to display more details. + +The configuration will be used to configure the default values for the notification for the host specified by the IP. However, you can override most of the settings by passing them with the data-attribute when calling the service. +This is a fully customized JSON you can use to test how the final notification will look like: + +```json +{ +"message": "Messagetext", +"title": "My Notification", +"data":{ + "position":"center", + "duration":2, + "transparency":"0%", + "color": "red", + "interrupt": 1 + } +} +``` diff --git a/source/images/supported_brands/nfandroidtv.png b/source/images/supported_brands/nfandroidtv.png new file mode 100644 index 0000000000000000000000000000000000000000..043aa2d5e56b68640e48e352862a50220a85c441 GIT binary patch literal 7978 zcmd6MXH-+ow|5dqi1Z*Of&$VdfT4yGN+hUMK_EnG08x}Ch=3p^h;&3AL69cGBfW$U z(gFx5y-1N>#L%ns_U8ZI_shH1z2EPgb=I8O?aVo|XZBwE7hz~{hl!q>9smF^Y2U@( z2LON)|GA+MD&?jB+ZWW1_Ay2u0|1o9GMw6isbhZoyZ7}00ACRRASeU?IHr<bk zNC04k001Z_0RUXjQokCZsSJpn?j0=P;y+hLL(Y2ufES~U#hCbvuTS|!KQv3@+uGbr zJ;}Y(GrTqHPDKaa z$^Gw=5&Haa!Kce&`aT~Y-^IwcZ{JD)j(cZ4rUk=+hvQBq%N=U_(qM8756V?{;>UZ@ zy(pX0%-+7fdp+IVr>XgN2#b5B;t4a!$;pGLrlTIT;$)4xh4;yCQT4o`p`p?2oSe;N zT|!S!kE+Mf&f-el%$X}MtLtQqOO5{=gH8YP^76&6L~{P{(~F~zkJIOfv+Xex*>zzz z8xJ!JMprj~ITQAr*-ux73z|-k`T}{e*cA8ec`fwGS~*+C_RQGYb6+-mrTMy>!M%H2 zjYmChJ7TN@+5XGAHo@WbFUw;$wF!AEzYu1{cusYgOWR^sqEViSf$RRZ>Lm%-c1n+k z?x*moe}|u5f4iWs-e^Yr@=+2d&?ymD)MG{Y`COor3Bn0mgwRBVd%PxUVQc61cH7jC z2V&>*a?)?HYoXb&N?f$S-swO-w(93I&3p1BgPE6XHzlvOjoQ@E&(Md9~ZXDskctNZoVO`VqBWkDw|p#uvq{lU+at^6Z@hGAyUe_jmc@E!zJ z#aw621=;dDYDIee>(3xnMGAN10MA-rN-yI8{D8(p01(r=0Cx|ndWT0lXzZ=piVZV#j7Qsh5F!^1cKIkZlPJcHUE4w z`YJi7x(d8YQE`1>%`@UZ7-O?qW@NG0SzdRW1A69JY-)`pIqE)qpr|D1cnoo|>ED;+ zZp@hDsVKrsT>gferG1vB!3K^NN9SzWYrPYTjMJ3%fC|#7dx%wBD>T*^y!Q$+)@ul8 z6cu|@r=GatMYX1x`6NqBLE|@%1iNIuR#aPX*mpoFOcCa(!ZC$Q1R&GinM)}IE3(T0 zObDM@;imYUt!swSY|%e2M~~PambT~)Qe^9WJ5U-*k8QzJd)K-&b9mw1Zx3@hCI4tL zJf_X`&8h^GUFW)O24cR&T)5xvm(yrHKpO8{H;kWP7VM#YUkTNWdARI`tgpHg7ixN= zo3bTO6NOvynn-TMIE;1t43BN=zhz>p+*GaNlck5Lp7_{!dkTeTWR!}5h}~wUqX_DC z-w{JyR)j%DIXzqREx&JiyD&=Vyv}@&iRmXiMU$O>X*v&1pk5XSo`t#wT`|Stw#I#e zy6l1NE7HtnzML6E?oujWnlNxMx9vlAcuGFokl2dNibHdPiEH4%BKUrAPV;Cu| z1T*6BK*mDVJM4}}5H4m;L&kDP7Sftf*az7(y6{J{yRuYNL0tZ?Fq5KD#xl?8lFy|fOAH2G^!Fj5m7YLgk~1Qd61LxG2}^`{WmuT5rq9w>pqp!3g}dMS z&`hYV6@Pt~!|<{C1^Ph|-Cwe@R?)-lR(s)!)6)QkF@~v#FY0QREql^@?Myh^-0TD9 ztA9x#IG)A=gJ@L?@T{N(?@wmzCOZUIL>=y&gNoM>j3yu1gBxJfg>%{x&jt;bh3(Qs z=@v-zmtD3dMqLILzojd{#eL7Rqx8ztkPs;<0q8e$1u|0XlD&N5EtgtXaEpJbmL7%f zUNiq<$m-*_Dke*UV2@ogX6f$eG8X7>rOi)%20aSfMP&;wO@9Bm(U8?m<_2VH{Jzx7 zcLM{*rKlfq)R3Bj-q-~+s>=P-TUrLG#lLQ#ob(MTT(Fa!P8je|3A(Xr4FJ{ch77or zS37)O;@3?X3scJtq~)*7?p=4&EeN=u0}|`s0&_8Q$nxydldFU0GMlY!!h?wk_L&+* zzvn8qSwB3eJk!Y_@7eMVWd(?6BL31YzPsihL`-lp2x6e4zgn@PrS&Y*OjJ{j=6zoO zIO6gxlz%Fo_Na(pCJK@Wxmvvf2KHA4N1ZU}9+<6F-{%)Y7UI$mB!aKvihExb=q}jW zj9T#3bY_q(f6N~{_E)nIH)f9woB6l)dqev5`2;yJYF6ot2j4ty)akSPxX7$^wFE|b z4m5mLMZ4GvTCyO*IP!7(NVC5RjTsMU?IeP(>h<0Sn|zj9b~^$&9zsfD!HVcn^RG^O zZ#UHdGoVGFrDsVZ9Iqsp@8e*TG*W0m`vD*IuUhPzPw3coC(64D&bVJc*)Yg5mc=1A z>~e9rA*H{s@!gBat_7e7Mes0ULq|7fiQ(2K{Xa2Ck_VPOm+=S>U6<@A{synewr*aW zxlqOK%CatCgeDSf2ZWQ(%H0TSYl343V>V%z==~XrJOR_Qj1-X6cgFs@ zMmpAUf3MNoUW?deZ`)Uw{f0lSHhtULS45h$V;B)Pt<#8`oD?#OG5`MD#gH=S#&B{C zpXRYS{FGT>nHvXYE_UOgL2${#@nXJ?zGbN5mLL5Fk=X|x^*ybL1`wu$Kis&6Z{*Ha z%>A}uqfc}NELh^lvasI@!6KyKxPORqKEvyyU{1__rE04aJV8>2hgB{kvPRKc2j*60=M4$iV%vT@eKuB7E<5 zx7&y3r|~3*`aP_7Pb__t;NA-`^`bk`kxP3&JpRr6!58E@NT$#WLW5Xf6U?Ox<;dt8 z$Mx@zmPmCahI~$IC3hl?2+|dXy~wqTQUKD1^e&~5vg!p4+du5N?!`cNN5)ESu09M{hBeS2^%EuXS zD6mykCzk};bLeQ1)sU7WwbYu{MGzAfk;vexo(+I&!4zbk*3EBLf>-%D7uxA_gCmoO zw9WzFoo6*r#nF_57514TtdFf)OE}E=MV=?{T{wSPa2ZEPnmU;@ZpB#0sOxNwDZ?Yo z_aNsxf^Kb1hu__1-)4pRU4W#PAK)dWgSm=P+p#uz>*3&iR4_DYzzeZI900I6C9F2sdCB9_P5Sj$pYi_0RewGXrdeu zW8YQ~5M1ab(iiz8M@lRmLNBoNwA>QIZiy3d;t1vAKa&jP#DucEH68=z@s+)f05l{SjMPJU91kml+?_6`2f0p^Za)`y!*St%%v5$3-Nc{V;jIXEvBP_%Jc zP_LJZMa0l*;nd>S*WGMaLDX2yve)naNXvYHB{d@H>&b^VguxKvtnnH~N!ssvo^xU~e>*qfNQ+>J)}6o#-aL zoLfb5|6PCdZzBxtT|{I-t23Bt@q)^!kmFgz_XCj#TN~!R#v~zJP?!T=9d5V0QlD`?gKve0!;4(E+z3IQv z-p2*lEp1gl3gA!+vK54a#o)~i#Afxcq##O3H9_SJ1z9M#+-#JN|| zR-w};f`EqXgEQ}jJrKJ_y`2LXGqwEn*MLXEMQ<|@9&`$ z%CC?6!DBkLJDU({W>r(T@(wGhhdzWe*YBDEo0GdP7l^Ng2X{IV~HUhlfe} zo$6&C&JM6mm)*3auNk{>zH&|T@W__sd4#|+x^a%3wYj9pmK`jp%D@FS)MI~>WYrR2 z&wyBn1_|niz3Jb$YvpdlF!$T&>Tv>#;A9}0DWBJ5Z|p|E5%!8^V{=a6{Z_q+>qs)) zz4)y;zuQJ-W%Cy3oJf{b-rLQxhX-7o$jeIcg|pQL@!Q0@P*zE&btNz}hw7_8pS54@ zTQUWDHY8NFguXi6SItsX;VtwzUB3@l#2VdIq$`-ArYO{G+uh;k<~pBgSZ-}l1l=_8 z>>e7t5T;3 z`VBly52U;z7aUkFc0OxMe2W~r(GGfz9T*~k28)ldh)|>Auwggq(QXX9%{kOLDBBBc zpC7Bc;0@jML;Msrtd=bZ^J=vp(=`)xp0YC!0y%o~s;@BoykTBF9@9I+@U?u|+p&}Q zdRAjsp>FZ#WyV7ERiPYsK}V9LpDI*}&Vsx72TQ=!H-g@O3mIzSiW*yRknR^@GY9zi z4EXaFN0Aj!6#q#obYBvibYtdxZcwOs>sK{K`9hy3LG>9af&6@p`4O;5xSLpEk(9x{ z=h#20l)F$ylOiq-eJg>bGHGcLqNiiFucYU5PNh5mA`_Q7sZ?qJ7d4?haWZnFo2hn+ z4auf|_EdU4Mnfiqn2^s(yNxm$|(oG2JYV#gC`R zUk1J%wb!e%6LPk4V533gm;{|AK!-Hd^0g+aj~?I#F>4$gGr-vMPfuR$^j<%0Z?G4` zKPa`!<#(B5eC)`m2aLCGn;KTA3%=5hIY_Nr-GkIeGcj8L1A0-1C@!w;-=C~o+ukgF zIN<6AiIV+?IYHCj$RX-Z%LawGgc-{gb(_jye5+G0%%Zj$sToX)84u~U%*&QGP^xt} z@|T{Xw%h_$ni5U0sf@`QhPp#2S{yMM+&9k0cV!Q|SrCRlMohx7K|iWmm!GECCeSbz z0y6{@6{f!ZzNK*U?LO_88~C0Lo_x}{r!0l~$BM_fi9?k9Y;B9|{NAaOLQCVM5e~{J zQ7{abdtY7-CMR*6K9Fp=Lk+mK-#>q1x&@w9Y5SDocgpZP}7XGjL4da96vUTgG!pfpZFxqvrSt^SECTe4TpA!keoz+u}*h=}>s zhkZPdk)Y+!k%q+bslgT9U!Desbd=<=QN4F0XOA$Vd^ksWxfhkY3bk`UfS%xQ1fhBr z+)2$JOs%C!kjh|sLuaMQgK>e-Wae$&^oBI(Y~H-fD9>0&Ev~km%uNsv;zMjSm4z?t zK})}232Cpa_T^gduaQ}6fy!Ry=@4koi6+He%d6i!{QQet$9anDJz#QZ-3t8YmGQBV641A{pa!9*Nudf ztlB@0w39nug4c_uuN*JWzvNNNF%I0!t9V9&EqsXsloN>qr`BnM>*opfZ6A+3n`qZS z%mNUc0U{Sbt@15>!Bh_4{)ZkpptIHQNn_Tj*2_c}&gj8mIh7$ppPC-~%uf1N(!WEB zK6yO^JL=&gPH^EiLB-y4341S>`t~MPu^v9R^DZ{AOO1Pkod3v+U_J0Le>O;E1-6kC zYk2o+D%8T1<}ES7J@T)bZ~B9&^;J_ui}rER+>ayZ9WFu38%H(wcaRhw=paKu`Lj)2 z!r%RE&C+?iV9P)o9P>}3lGKxW6p|#<4P`w9&15^>UH3%gOf)E$vd%qIZFxo5e)^+B z&k?504X>MWSo7LM>o*}4tz)G}bPSig&XSD%=xGp|CPTHxjU2SRv%e-b_gzpzg`fp$ zAuR^3-$#(DsKJqH%(wa#KtsziUYoIFQIktmne0KD$J}(umzXQq^c3vl?di0XwTPp@ z4SmK!wN>T}i}#`NZVqilCC5rWg=xjOS@tk$X>8a&HG%VKBSyF)mzFaMXIKr<7escs zz7_78uAi*G*<~K}1kQjqjc02!Ttl)cMOU)vRlNVAVd8ZHWh`uz0UcWBbS2K^QKmlJ z8@>A*Iqs!MgvP;yAdWoEnUDLo2DhGCV4Mdr&qiOS^RM4OHkebG)`gSBp8{SpCsa< z{lbDZb>MD=3uB=*SFU!B0KQzs7#6;7a%Kl}p4oWM z@5`Rxi+mW3BON=CB!&L7NB3x<%GVuwI&1G^D^%ckr~Y2`XziPF`_U3ispVj;pX!W- zZ#R769}j`IPJ7EF5!w96!tmp#eUOozV(V&fGE??-B4s_;5{&a+q?t%_*tn!D%i@X-rLYWa!1%rDxXeE?7bY093zq#yX3|t@YQ7A^Jloj8!#quOAC0F*J~}JFe{eN_eSIbnG-*;)=k&M;wJ#E! zZe5-0y143TGdksoO09@~5#wRu$Nk-Rad|}Y&tGLx?-WYivO;rWLnL8Qn)SgiaTF@y z$wAFh8D&LzvFWczwZw19GsWr^Nv+>r2MRhLFG=(fo>=XQ;jr5=Gs0?qdue1Xeo*`EB^!Rii#H&S-AIPH29E9` zW3J!iEBABJ3Ewz<@AqfsO!mRa5$dcPUZ|7d8kC>S6eeUOJxMOy9;0uQhK93?AzZ{+waectt1Gx;VPBSx`S zMZI2m<#fj;tAx0>ob#zY=TkuPo#b!@;nwO+Ap!G<|KKtI6DksuPWvI>BUu^d^3iqM zH=Q~Puh99z_8+iE2nvFiAHi2l8CLzmn6E`XIK@_QQEqLwj|LP0CJ%02kV8l_*Kte)7!xUAyr%XbkPzNcAQdU$jWBxK4`5%0(bjtr= z>Nug~l@^6UvB@(L_g3I$auz1}$^_=)3W`p%1Y%Vv=gVtrYd2r*71*>L?NX%W*~+!2~S->+V1rsFFNwLO#vY|;hY&kGUKHk3+4?NxipVZ;+U{Z#w>9yeGA zuFlWTV_@!QH`N5jCG*AG;V5Ng-)ZxcFeCOe>7a|Yf36Gs?`WC8g9~7bPF(?OrS1_G zUKaM$!h1fn^>k3S_i&(g02!pTf}}K3Qbxu^T3%UNL0Lu)fs|23B3(1m^8Y^t7q^E` d9=-f;6lDKPVceXD3S