From 9847b4e79e0201680c63f05e572fad366fb61353 Mon Sep 17 00:00:00 2001 From: Zack Arnett Date: Mon, 15 Oct 2018 14:08:52 -0400 Subject: [PATCH] Button Card documentation (#6823) * Adding Gauge Card * Updating Docs * Resolving Reviews * Adding button card Documentation * Add period * Updating image type --- source/_lovelace/entity-button.markdown | 78 ++++++++++++++++++ .../lovelace/lovelace_entity_button_card.png | Bin 0 -> 5289 bytes .../lovelace_entity_button_complex_card.png | Bin 0 -> 3196 bytes 3 files changed, 78 insertions(+) create mode 100644 source/_lovelace/entity-button.markdown create mode 100644 source/images/lovelace/lovelace_entity_button_card.png create mode 100644 source/images/lovelace/lovelace_entity_button_complex_card.png diff --git a/source/_lovelace/entity-button.markdown b/source/_lovelace/entity-button.markdown new file mode 100644 index 00000000000..1571da98a78 --- /dev/null +++ b/source/_lovelace/entity-button.markdown @@ -0,0 +1,78 @@ +--- +layout: page +title: "Entity Button Card" +sidebar_label: Entity Button +description: "The Entity Button card allows you to add buttons to perform tasks" +date: 2018-10-11 10:28 +00:00 +sidebar: true +comments: false +sharing: true +footer: true +--- + +The Entity Button card allows you to add buttons to perform tasks. + +

+Screenshot of the entity button card +Screenshot of the Entity Button card. +

+ +```yaml +- type: entity-button + entity: light.living_room +- type: entity-button + entity: light.office +- type: entity-button + entity: light.bedroom +``` + +{% configuration %} +type: + required: true + description: entity-button + type: string +entity: + required: true + description: Home Assistant entity ID. + type: string +name: + required: false + description: Overwrites friendly name. + type: string + default: Name of Entity +icon: + required: false + description: Overwrites icon or entity picture. + type: string + default: Entity Domain Icon +tap_action: + required: false + description: "Set to `toggle` or `call-service` for direct actions." + type: string + default: more-info +service: + required: false + description: "For `call-service`, e.g., `media_player.media_play_pause`" + type: string +service_data: + required: false + description: The service data to use. + type: object + default: "entity_id: entity_id" +{% endconfiguration %} + +## {% linkable_title Examples %} + +Title and Script Service Example: + +```yaml +- type: entity-button + title: Turn Off Lights + entity: script.turn_off_lights + service: script.turn_on +``` + +

+Screenshot of the entity button card +Screenshot of the Entity Button card with Title and Script Service. +

diff --git a/source/images/lovelace/lovelace_entity_button_card.png b/source/images/lovelace/lovelace_entity_button_card.png new file mode 100644 index 0000000000000000000000000000000000000000..1cc3871664453b839ba7445c69a5b0f2e015626d GIT binary patch literal 5289 zcmcIoc{tSj_a`@sF(Z{F8o5LlS(>p$BubV^NF{q1V;jrZvX=Eyj3vtqkx00VjIzvF zLWo%`$v)PMBwJ*O_Y1^zv9AIDQHMBz-`Qc|2;gzp`>G{|jSbw&`m%R;6+5x99kVjf)4363yZB@W zbIh64vF*OAbE{gj<3}6OkRo&T!ZhK!jBPUJEywHI&lY$U7Gh*5X5POHrAp`rKn|P` z6!<7*_>{jc;lL5TLxM50seD%tiEmOqeuXw7npS70<~xn0->)IR@00|?jqS$i>n@EZ zfhOHf#!_iY=x^)mFK@?Z_$ijYa<(kHl+Jv5bA%{&Q`~6H`z3A^M_pN zvT@)#I?3m`-k_L}kYcpt!O*Bce2!n*F`i(9(9;?B=gPo_I7WTOQ~FY&AK6l@z1gghkA^rW&3DKYBpY;p346I{!?<%l91h~ zxRu`Donry#6f{_6ZDeG`TY%+xIp$B$6f`HTzOHV#zrR1aiZ4}j1p@8rDa*TKN!z~Zk<_}R5MOasb(k72s0fe8{_ot@ z9C}6vz2sl}Wtq=qQ&Y^pHFrxwL9`U7H|ra(@brPIqUTfhUCDm^>zm)A-(S`0p`^s% z)O}gu*9wdBhvh1EJE>Vs<6~>n`!=^A_0|2F8eUHX9a1MUSE8w31+OaL zY35A5iKTtlKjj-(q+ort*B;f*;W8;5o)hu>!G3n%o2n0pqR-g|%)Ywi7Ud(n!NOul zq(cgth=b@@xnOZN)fVaUdH5~5ATxUz8{>YOKNh){Q*Mi_&iHZ7wSW6KKG=OG-@E*6 zj4cxag9#UAdoV4FOT1Ll#%=Nw1Zu{=?;xQ*GKz4_i;9|7(Xp>NBUv*yXNi?XOq8YC zfyy4ru02vJ4ycr7Bu7&}ZlbCBM!I{gvOhhuXv#N4jh`Jv8++%cid!Dsv-Nx@VfsPC z7RJHxV+s{*%LKz{)y$tU6H&Jv&0*S>?*u|HW)<97yh)Y9MTwk+p|T&Qokug zRy3uDG6n?00>P|%hMy>zkJ~-(g7+!A`&?F&aX^7-Q=S#Yv>LuPqorHBU_km>= zA2?nrwYv>_-#$dA`Bmxla~f3Yv^bz&Nb?{lDMWc#!q{qyvv6+M!p{rAkHucdctr&qwE%ynjC&^t@!;&n68~ zx-x#xt4MhazpkTD;D8hmoR`YJ_b$%P!#u{IRDiH8K9=g&($n8;GkYfuL8RyH%KSIe zi0(bJ<5DGftw6*d;25Vl5w|D=F=;7S`k%IkmXiCU4N9TGvW&b1XVm8}6PgyDFAWAB zB+O3@6hi*WxT0rpqM|F+Zz?wR6%hQFcKtr5A1~3NwaW8Rwx0pYSk>F*7R=VTVVWxM zp?}8#0Na{7$qM_D*EQyEHd|?7_%jBA)e_~3aQ{ZDu!<4;v@)CDmU(KV!g`EOB9W^s zncF$o+rQcEkj*P4N?Hhsji%fb!k-Um3O8n@H(ntI`G<9!CM>XA#@H-o^*u<}oGUQZ zomZvvJjwm$@A+K;BqI+(`lTC1+~Vn_5A>)PEh+DLbzvHw zhzUSGeY5EqNH6lFml2t}`c*k=?Q!uw*H&g&6cdPMQ&T!JNu zHGCEk!RBgiq`!4p%mx7pn~kz4HI}e=&n#0pX@m3DYw4jTeqO97p#@6H((+_8|7u{( z$nQleYeQub#b&%Uw!0|ZQ`+0dW07bOXq_vf&Dgy~!W5WsVo7>z4OF1iL{>LcdDoRw z>bGlXrPe;~0mIdk3g8rX2NaWjF(OYr%sXW}VA$(JtmuozA72E_BZ4vi98X;E=4pXm zz#O8*K~QF@`J*U2Q+MKd8Xm=Eg!w%D#EO8qcvKF3(cErot%YH)m?N+31&?jfjS6?1l>FKj(I0xPy z09J&r#nI|ldMH7tVZoYTlUTEo>&j>B%7iw?p!UkoKuX=L$(5*nZE9`dV=w>#yafIL zP>>&bnvmf&B_W^}mygp{)^EBlg2{0!V;mu**8+%&FdkMzX>zSNAF2|#m6f?aw{ZL0 z=axj|y;+l@8f;$rqe#GS>j2KKbnk9ymvjdqYJ#pP=q{9H`j`9v@FlAWY1Hr=k&~Us z40KRW1y~CujkwV|fAHKro^iUjhceYnl@n#Plja+-_CYNzr5me|&k#U(T8O#8-^5fY z&tJ;L$J&A+NaPf2_|CDn$%%q!TLAaqV09J=x-1sCB6i%cGUL}Rs_#YAa`GPp{7=&M z%|yQS_@~XgRqza6f`6J_u}2DkSpyK7Lms-z8r>F+#ld?Ob~r-rxHqpPcPw*7?YfeU z>p-tX-MT81>JVb?abhauz=a912Dc9~YkfuvxTGZT+G>Yb z_MlzFg{|k-ii^W8dCGa=-(6Q=%nsi-gox(IgGCh;3PIGbfHSA_{PMEu?CdOZcWady zD}q+6VFYAve=5KlTUlADb-W((ceJ&-9nc!fJNPJOE~59@<>v2--7{Eibim?>Gbbl! zi#ow~YsCTP+;t2ylcBd=LY5nvm8Q5edIyBR zk>pMr4ja*)b3udNlv!3G6$^;lKdF9P4_T_~kh3I81|`Y)=4N{}4pXy~T1C};C39wE zyunM&I<;F=Shuw*B$QF<*kKQz@aZ_2GLxR39)q=}Y%GpOeIr*y_5SKtC5cxrEF}=Y zdU{XmL^T4ak3>}Ex0-mRhN%ZGI_NB!v~z8ZBTRlkB!mh zqraq#=5{(!b1#HY8#c$?RnTKXnz6GlcVD@_k6dg&2ZUoTk(X7hYS6q)_MOdTNK5c+ zS9(!prP9!?+e_PXd8*~*<;|J_^;YP*(?eI{j}K|tHJWzi<7BtL%oPv*1nuynN~i2` zP_arrPZQ=*TU9RIDliv12+aN3xliwxkP_!(;a9EIfz$a*ad(|AQF*F^MsOQ2@OidaR|&T^CXy8s^I8iBmT?aRNQi~d<#duuXk z0en%)Bv-U-@Zehg{@zaWdhgOJzbYqu-35+JjYIk_0Z?J%fFD?`@2FF$mSMip(H#)Req$Q@%*&g`O+^^JE*#8yf+zu^kDa>wdZD7Y_>kWB zk7*{Hx-?H_@=t5xAAL`|jb_T*oImqobjaqVg7^K^wQg-LZO02E>>L>#mdC1vXAn=$ ze<-tS8rNKXdvwr4mSFf)yv&BYfuHM;F3fs<3}2Vr9X?P`L^Zpn?CB>S7K5BTf6O@Z zk0X(yYxp;p7$Q#HooUih9e})_6-mr_RJ*PXd9>@u5czPwI!nH@^?=a(3w(#YO&#nK?p_7|7h z2b5^E<%>$}EPN-Nw5~mxB|v^;{h|Vz2!H5y^RB*KSaa!Mv#?q_+mK7`-TR{L^&>$Ahv$(7%9xO7q*v%0 z;lz+mOT!t0*w<<5nC<5j-&+2u3H*?J0AndM$P4N?y6Ds4?NcLbHA!k}B7@}5Uf3MN zG&|p@=Q{7&S9sCh7?Y=vcV@PS8l$#j$$=#k00~tkx~BX|G7MwQt7kj(2ft+cU8pLT z=?Xnp%^5@WhmTgH?uD&Rx1HMe)P6IA`Z^St75E=g!7Jh1<6LiddV=<7v z5?LRj9+fmyc{o7zsX8$()_x5W!+tL7)wda!F`f8!_iXin2mT{QgBc#9(l5kM`4ps( z8~6}pb}*NuTJgI84p9PhQsz>BqG^!BB)uooF8rQ1`Slz{&`=$Y5nl?=_)lg{4ea#X zy4yhPZCJ%;0i9d8{DJp7682+FM7F(Ybgk*$%0LN z(CXyrO*5Z6BuihK=mF{z4b|GmQJe7$`^OrlR@y(c&(SOEJ(+BIKN^=CcOtQR_7{@h zhCc$S@)*4GpCLlz9V~?_IbLClrV0c%V%VN(5u;I4{Lvf=wL?zL_$&adwcExw;I#E-bGtgJEh)JM2=Qe9>0x zu|_XpqRYb-g*t>Mj8c8BPlnfVHg2(LyW6cCcs9T*T#1GU+@Fh(Y=XBZ#XWflyRdm* z>ht#32WDVe=(|8|Bd6p#lsKnqX=!O>mB6FJkh$)>y!V;yk2VykF=iWmq>oGHq4P%a zb|)N9roAs{gkL!yKX-&zh%j7v<*Sk7*s8ZmQubnx;QfvBLWx&ZftSAIg~z_A)Lx$d zw++a@y@34d>kbI7zK2$6lWhA5*cS=ofj!evV9#`!q&`G-cXvm4d3mXch z4cK#$GZRaH`;E55Ak*kiG%U*^1vI0)zWSz!09mH{^%`YVqyw4UqywKxdhPe`!I-77 zx=A?Hf8&d#fV&=rbg&!PtVKnj?MI$vmlY=15<|>kIegk`( zGam8&D-#phzSkd6qNJ*Zy9{^L*|_W~bBW8X%FqI*o&S;ZTDh}S`S&*lQIuBq!-lbg zmrb;-3pMsqYgKi!4w-77ktg0cee^Z|F!Uc-Bj?$cH4D#mPb%X2yG-)Acl7~={7Y@m z+S(S+qP)D$w}h&}kdGZ%t5Y2zAt6HpPH~BrOvXOQ_c2u{shB78HQEv?Z%?M6Agj0c zC={|u!dl4bYY#`q$4lRy=Z}JZD6?%OOwd*vr+v6$ArEhnxRLX2H)vDuzS;^l ztuGzLV@(hmcignh4kg9Gkh~P(xN}k3Y>kVN6Ip2slI@J-N06g{%W^ox^2Vk z%*s`bbYr7*i4yX{t}sa$UlHouTTV}b98V0LV<8g`b!q}_GSJR4Z5A)ag$;ZKM*j>J zf6a8E_4veAD2gf^d&@Dv`-`nNf>eLAtXm>3c0o36yUQQVDAYMKhUd^5gC#{BH|1d- zzb>~tA6Q*aIMW;W63C$58s_C@!uIFqS=)LqZ<6eP26t#NU0hY#NQnDI9WUfy9tF0w z?4AtR{&ZQ$hfR`qCnW6*0Ie5^rdxGFHl1a5IGX+@1I8_u#k}7nnE-wVng0qpz~>WH zSCvLm-9BKHipVP6ectrpyG7RIE%<7-nKBTgDeLwHiS3aI~qH6R*GtKm@hSTfl>>7vOWR?tg`aQ1{91#SL z(UBoklGrg%ZDG+iRJXl0R<5m z4MNw%&+?eqjEbu)wr3*v$fMNeETa+)7kZ9Fo zW&#N-KoS&lIN9LyR}T0*C7dRj>#nwg$g26lxY&w24f*WB8fXsoXn!hDcXn9y6XeZ_ zKa4$05?dq#W%q-&tg30?G)yJ>JC&C2{DllgkbnYn-^V8 z?bHVkIhfudqkwo$byuSy0;;C}!9yOV_ed%!!}aK&7^=|pp$gaG(x(aXf8z^MAS&MN znM+L(m}BICwYiVQ@NnH>F=Npt}M=yC`K7UQQQ#)0%51f*9r{Usm%m^d+E;_ zn5KlaS>(oOXrFHhIc&HVDO_p6*O4VRxZd!rwaAxKX|vo5qJ)ppczqvF|M;m?#7M=Y2U3)(( zODyM(mK}8rLH4VCIi2-!I@{2sGB+r3sivjyRU*%%GIgP^RHY2_<{Ny0mw!SvZs4U`s4WWVKeB^FQ2P zOO8#gFkH*7yt@p2#K7tTINKfgQ*NH~?&FgqDrczv6f7ChgEvIn zQV+xpFhp1Pr6Rv)HX3{xl4{i0f4x+X$>A`KGH@N$b?~Jk!_dkXal(OX60rp07j>k8|P@?%u?b;NL|+n?9AJ!@Yd^3egfli*G2b;*?AO6iyp z+WeO^lv{g{WHhuaV$$vff=;46ePJvIbG)Z~R{<`1;hVV9w1ya0&4%g|*WQ`+B=6jl zbf}hJYeX7*kVA{nV3@7Pw_HcPjlYo~YR#W!2XBP5#D~VWyNevjqxz8n?fc-^uE$++ z3FbwaOF4Kw?Jlzs2A9v<<&c@zQQ+;G2`$fpR%Ah=vnpd4#HkGX6yqewamVx%oktoX zTW1Oda-qpNaTo36bjs2mm@HBHv@z{rTh)>f52)I6*UNu&oOBwlKGIpnIL78pCf2n& z=H}s`{7$s=!)=B87zNHvZES~_N2f26emDHotGr?+|4uzWSVwV!KcmBOaG8EOk(X+2 zlcF`NxbB^tb1;Og8=^-dBG&c=0s@ItdCci`K3}wuM_EbaO~e%si~3-5B}i85oCyXi zRGv#!)l}g8HUm^JdC(9VtgJc_g+061cP^=OpFQnDf?@>odj zJdI`xx@no^Y1cSsoiyKH4lE>ImcVNCWR)WoeF56kQB|wKhS(7aQ=wg%d%zIg02Ie| zv^6?(^w+EI2>@Se+x4aUHGagQ-rnAK{jV*sCUykEAZ__doN>FnfH|;a7Q3ulY>F^I tv~$vc