From 7243917103c4c9d3fed7c794b66aa7a47414204f Mon Sep 17 00:00:00 2001 From: Philip Abbey Date: Fri, 19 Jan 2024 21:14:33 +0000 Subject: [PATCH] Documentation --- README.md | 18 ++++++++++-------- images/Venu_Widget_sim.png | Bin 5351 -> 2725 bytes 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 00bed6d..361fc72 100644 --- a/README.md +++ b/README.md @@ -127,17 +127,17 @@ The example above illustrates how to configure: The example JSON shows an example usage of each of these Home Assistance entity types. Presently, an automation is the only one that can be either a 'tap' or a 'toggle'. -| HA Type | Tap | Toggle | -|------------|:---:|:------:| -| Switch | ❌ | ✅ | -| Light | ❌ | ✅ | -| Automation | ✅ | ✅ | -| Script | ✅ | ❌ | -| Scene | ✅ | ❌ | +| HA Type | Tap | Toggle | Template (custom status text) | +|------------|:---:|:------:|:----------------------------------------------------:| +| Switch | ❌ | ✅ | ✅
Separate on and off, or anything in between | +| Light | ❌ | ✅ | ✅
Separate on and off, or anything in between | +| Automation | ✅ | ✅ | ✅ | +| Script | ✅ | ❌ | ✅ | +| Scene | ✅ | ❌ | ✅ | NB. All 'tap' items must specify a 'service' tag. -Possible future extensions might include specifying the alternative texts to use instead of "On" and "Off", e.g. "Locked" and "Unlocked" (but wouldn't having locks operated from your watch be a security concern ;-)) +You can now specify alternative texts to use instead of "On" and "Off", e.g. "Locked" and "Unlocked" or "Open" and "Closed" through the use of a template menu item (but wouldn't having locks operated from your watch be a security concern ;-) ?) The [schema](https://raw.githubusercontent.com/house-of-abbey/GarminHomeAssistant/main/config.schema.json) is checked by using a URL directly back to this GitHub source repository, so you do not need to install that file. You can just copy & paste your entity names from the YAML configuration files used to configure Home Assistant. With a submenu, there's a difference between "title" and "name". The "name" goes on the menu item, and the "title" at the head of the submenu. If your dashboard definition fails to meet the schema, the application will simply drop items with the wrong field names without warning. @@ -297,4 +297,6 @@ The application and widget both now include a background service to report your 3. Templates can require significant definition for highly customised text. Just remember, you have the ability to crash the application by creating an excessively long menu definition. Older devices running as a widget can be limited in memory such that the JSON definition causes an "Out of Memory" error. Don't be silly. **Please don't give the application a poor review for an excessive menu definition!** + + 4. Parameters to tap menu items cannot have their parameter usage verified. If you get this wrong and crash the application, that's your fault not the application's. In this case, start by removing the parameters for the menu item causing the crash, and add them back one at a time until you find your fault. **Please don't give the application a poor review for your bad parameter definition!** diff --git a/images/Venu_Widget_sim.png b/images/Venu_Widget_sim.png index 363adbdf22212f6ce7982b64081b9d8c3a177f1c..64462284ab9c39033a14975ec0525e7672ba9df0 100644 GIT binary patch delta 2630 zcmV-M3c2;?DWw%-iBL{Q4GJ0x0000DNk~Le0002+0002+2m$~A0I@fI#Q*>R19L)2 zR0s$N+u={(000VINkl-q&^q{ zeVE(@6p@sJSd)k(k$e6)m4McyBDo<#H}Pl$^f7dr*EklDl-97#|4JfBmp?>A(-P}T zRjtJIVF>60JnH5pMwhC0{lBi2vo7rqRTa@Zo+qM7k_heTLlDqMNFr;1CM^TcYa?SB zi!LdXicEhhlZdM3@oC#40lrM}YcKDibO)Dqvx?l)G7z1XfxC50D(ZhD5YR_h#x6ufQYsA)QC;pyTKj!+ zPm*%aalL6Ne;4Qw9)*BD!aACf6meM^fF+HuL9O+Rno2K2rK(wWu zQ}2HGYw-1N9RdB4=0)c4Qc_Cy`~7~u-*&!A`NM&AhN}kw{gQGDOU3!7lbTZ6TQ|RN zV@^`sSv=QVL9&r^;?^(E4v~ylblj33`WRd@akZ z9`C6=q;+x4l)d6EtL*A{K=%%o%cLZ;$K7f!cPA!Tx3{(Vqq3sgugwfM6EqJ?yjF0; z>Jt&{X?#eVTi7e^vfL4|ng_xitnrk=X&A{NS64P=FH-Yz7vJ^%y4@_fZ6;_2bi7ux z@_%-hHM_y?fCSZiGv!Eemo<+m>6;RyCu%+3K)6)ohM$CWr&Nx0dXW zusVIO5!lRmZ*dn9?6$2nH`CXNdq=++(0|RG=Pk|BYrStyb6<8P7+)(s)Y9q{*6DvP zpwBgI_r%E5x5Venews&--LBd83_w!0y@?^^zZl@u~l-jMt^;XZKSvh3c3!xE=VwLzu9?`J)J@cdwW{_06DUQn_Iq_U~`mXBy~8Kf(ES|#P9;0P5YWxC?7H<5$3=WItN1H4RX>c^`?a}NFIn#+ z`}KP+pyT3`Q3oP_{DeH~xSOGU@Qo93;$2yN#SgqR=mUZ`2h>y2+n18K3G|OG`f1mH z3q&6QEmFN-D^6VA1?b*|^W3X(b`?G7zB(i~{GOnqE!D96`|g$eX{leIj>XsO_`xD* za{Lt~7IT#rgr0m&DC-Ew>H5PT|P9PA{wAU19hddq(T})dloslOwmV2U{R<(ai`hp9WQO z{Lhhf=jwHaLE_$b`z!u>lfxbT@>bURtk|;^^#5{iY@~y@S+spcY+ddv!y}vPmc~`k z#IhHY@$c||yZykck>9HKVqjJ61!aEQ`v;27ZyIg}bP2>=Z&My$ch`u`NkTazpxY;- zUVgjXK3sH(D*N7So1k0@#w+Q;b%XD7ZSacp8GpLTVbAVuRchboDxSgX?_kk3f_p*p zN(H(3rK-POMYA<>s@nR`aXp^Gc71wjq#7=8ud084y=YfN^Znay0Ir#d{paAi&d4Z7 zaG>xZ?)13j^S`g2uUBvW^xezziK2T;q>9V@&%sfSk#+4@bv^LX90eNOaR2}S00000 z00000fWL-$IewnKMaF$}^803(m*ZF$zrp|fr`Fv}e8`>h`M&D&+;sm*7pbAG-@4!Y z9b0REr(5`I{%An=W|PQG7dLZ7JmrO3!n_LDYf;=IWdp5e`X*5 zw9T64N&&6^zUtjRqkCB9o92RmwRjd_f_3im#(ONnR9C@BZ`*Y0v% z(boA}!IsoD^k1l+&&5@N_F8PuP)=;mvAagQpmgC<5;q^{sGsk5p=^t&TMM#2+BDcm zZMLS$!sgytK|s4Uv^}aWf4obx+2>9}9hBu%)d8KetplQ&m3=I<&aF8FVYl#qiJEV) zKj%Je=1`W{l&%qF!#c?G*PXNtEnBl6l{BT+boRCswJWqbV-`z%@YT|)ooiU(y&8=}WUO7p->Z;z18GDN>6BM}#3{pzX|uE;sKNu#e9%BRz8+Rmo4 zHFriiTvO7udgC^FX1@ zH=yO;@M;EV^TaoQ@@Pg?llJFn4g$1Z*c>Wx>6@F)5FY+PSe(#F+tB9`_jGp|Dc?vYfWMA%>V!Z07*qoM6N<$g5rBj00000 literal 5351 zcmd5AXNcriGYB#5JQtd0HsM2303$2F*FTD!2kgP zB?yM1NGCKYp@mK$bY8yq{@#0k-5>9abH>?Yoi)~8XU;w6J}1G_+=zo!h?S0xjss+@ zZ%s#cF7BU;nVuHeoc&ZoyPXfv1wCM9W*(oh_(Ml`sSu>E^WfRvYm+)pgzXVuw=7Js zava1G?C3YmEe}l%RV^2p(H_p)TLOkmc<(n??cARC`^EUdA99#77koS?`zU8}pk_W} zY@8tt%J2fZ%nM-*b_sF8zlzr5-E_&)igA&NkK&NbX}e_0DV<#iZbqDZXl!h1JUT;j zS?^+~;GhuX?v$O)qy(+C|8#f^?d8p_pDS&fXt*8a1=|S)94?(cJbF$rGH$yI&1E!V zkh!F(z0UcFRdDXopBGlVtTmk?ka@ihlOL&8yopPBJ)EFtXl_H$55FTbmPr$JTU~H6 z>UEwQfcO7Wz^Wzj$EoYB%sO>jR&uj>g)S8gA;~CMPfpd|cO}t;zfbmV+gqsFzPPQ+ z>*W3&y=ke8q%MSMpDbcq_pf5Otyo?~_)m!3wQ&M?K3qx&-^Tg2UaQV4;NwY{?^@U+ zrZjC|2SmCUNFgX2t!bWd(auua`2pL6Mbe(oK-}vXx2)G0e5q}E2eliKFjB{4Np^T7 zfr{L4jBISAq||b4OlxGx$``5V^1c$(v(EVBq%W1x-Mco_+iLHyeVPBV&kmLtZnl7~ zt#+b>pJ_)Nu=#&;61QTx93v&%%?>myssOhl-O14AbrnPsVOC2%KZ1nf|Mlk{&g31h zA~Q%UOHwMf1~K<@WtfW$(dJ2Y#UA7?suVPDt{uMF;fh42md7~J(iVhJ6823&i}0Ob zq*v%~j9}8BKENXD7i1H-F))2<0&u&bFD<}L15R2hHXeRJ>>auiLT+hoc=XEX6EVDZ zXP)BYf1sj-JXC4DD*uf~oTc+HzSvk9G7fHfS`UUeIQ1?1c+uvTg&$%~)i;2RX9_$! zndi8eL6)?ttKSxf%P(~i!?f+2Pa~RJGJcA=zYo3fE4`L~>O zg_iDnWR_47nLDk!yX8#YI*%v5Xt%>CvJSk&GJ)FOL0b$Rvm zp)JnTg4l)EFgb~(Ca+^k&~r_zXW1x`X|6mRshlOmz#5Ms(7Bw!%wIdz%OT?^y9vu&J@G*%dhV+ zgKB?@rrP>X;NWxqWEGA}sjfGw7kaz575w*irpl-sc8vP^(%h)ce2pSCx|n#lJ9&@B z4AP=yuYbhE3$ri;NE_gv+UD;WQQ*nEYn(M3RHH-WgFNCEpcBC!u+>Eq@B>_V?i41cByv zj*g7DQ(cozT`7uy$Qk%a&w1G%9cZJp zV|=9N9da1_$Q>l~5bO{k3~ZsSn)^6B6~qal1@O-CecayQEGFQ3!%+D-cVK*b7-n zY%$JRQ7XM6?zIpes14XUGN#F>2?yT=^4M49br@Og|FIM;U}p=musvQio^cPa0c@Fd zXOp`j$J6{z#Xgr8pC$@>oTDLw3_Lrit~2009hu#zWXY1g*aWikF_1n-Rcqh_9(Z>(#Q5JNs zNKjbXEAOIqM}N9C*v7Bj4$7r4btvVU!Qc!V`nbbHb`y}hp(*s#6LHi`5GfVs*X0c) zRw!v^;T$)jjIReUgCuz?m{ykX&qi++ELxW(f@E|ty{ICX*GPZ7en73)ujnTnW8-i| zU+t}tdepNZph}%+F~($MVN|U9N*X5U>(C#Zl$&=)$zxmd&V~sA6X9{2_c$)<4%7j3 z)J=LgditU90m{Y@)4R<$76y%!6n2dFh?o$`fqz5vO_Du;h8u6%p82@eNRrP0y;)V8y~%qikI3j%7O%NP`)Xcc9#kA=gK4lv zdmd_0qBE%NB43tH7IAG*Y4h1aWp1r{Vd_Qv=NFSsyUrJc0ADqAsmFa&ZS@m;! z=@oYvO5TYrCMDD^Tm^;t(GQKS36Ke>p(-Q;KNqlHkko={_t_NzljH%#CY05E9TjJr z;U>v3f9`;K9d4AN(PT5*Mhwbit5}eFJv&$_LCURnc_>}Yzz1`qUX@=vxk$rq#@gZD zeYMCjAtjtUB8)UG)6^} zvT0mzh|V!!G#QGV_&FWo4F{T&IgJn+uNB^I8c? z!0p`!aj9PAplb7t4#I1lakrG)Fdxj&=o10FKH^E%|5p9&QA1h+-Q*~Z(H~n*H5tgR(yuyqM&=DB z(}yN-axQIOTnpOXRAyU&df=z$=Gy$~(ddZQPRo$EsR)b8*5-j>^ThfP;)-7hvAnEy z9OT(KIQAOBR@De-F*hpkd^_NxY&WA=^58|6gcOIB52j>YYO)zBjQk8NqpUV)E+pn9 zIkHr>{3!Us4C1^=^11zGi=5sVHmPM;ym4UMZPU6P$C)>$Zue6;Y9>TbyM_&s ze&=21QE>|7z#vy+?JvLUokQ=KnEWCt#$H^p?4Gg=KQevZmIYn>&~81$94DU~w@vHV z**5THb)&F%lRXH6U8Yp@ema%PvKR99z5e;SEln5OwyvOvvg*JTl?#^H>{{j5vJi## z$C|@S<%O#}Vu1A0_(^D0oXK)#nDibBf7;TS)_mb#nbm(O7Ugw=W_5Jvixo^;V$IRu zPkcvJjtwmBUufn_f{l3&s;|d(6R{K273)VIc~Bld!P&$u%DjaUei z<%__(1S}$;c5ITI#fL~{Tow0V6892fush$~`YJcCcg7&m8nIMW9|>?)?@5{TWL56zf2GUyB)rpNZm!=-@%gj3)@TM{KmeS_@|gPKK=L>-F9p z`)lvxhN6t}+x27bsPuPM4G(FvjOTFRKOW%im#tBP;=KK`KgP#t zNluMEX(&sX49gL{`yQ|0m+s)W4V@`mt!(`86XE&y+F~y*= zh_~1$t_Kw%)JD)PJe=-kqQ)$KsYo-bKhADTY%BEhei|4PMb9VWI5YZriw`E|@l)t$ zgPCejnc1CLnmN>PX%&Q++A5x8gyMh?FlKS0CCTb0)qVYaoAQO6F~uw%J*RtnkiQ4H zsv6ff@h^=+!=AhucyHlelE|jetjo4NhNQiJPNSrIzNR{3?oX&uejxh>{hKeq2TYdB z`l#YIqvOG==SnE7YFBmpi{XFM3wRnfpM)R0b!DZf3f|5C(JJ@*zO$%j)wxlec?LiLpG_QrfQ%`G76ZiRkHxd8P7e%%SzAw*4_%z_7=Wu1+N5v$#c!OTD)LQ-l6Vj_WTGUP)Cn;qn zHAe`_+{*fNj?`FG4CBJi#O+lF2VqSuR<~`-Cj%v*5W*nQTM$3|x~iE@)tg9~L|1== zF_~=q^tz(b3N?h*Zm7*oo(1Pw`;aY$*IIW^P{C@ zE1Gj=kXo~J0rN$>-A=wJ(ofr3#=t*rluQfd3TguO9 zS2pifxmLJZ^+VVA!)wYb@8tXG#z~cUPHgkZ9KhVOUeDaKh8rcXKkZ-kM6T%juuD8~ zO2;4S0)@I%VTXjg_2lwtcJwEfhWUnaajcS`{@Z-nu3LVOouE#mQ(m3Fi$DE_i6I5t zd_Ia&)}rU&YWY)LVG9`lSo>JER!;V5OC<-y?fhFxws%h^Ft`9y&B=$6h@vbXF_12r@ITdSlPF2;?O^ioK}3)GjTpqja$I3K8DZK5zh&-PqR{TOTNG`UORLv4B~-{bO)0kjkhanFtiO1cR-C@t`HP0ffEr;%ZElxg*)=qvho)*w z*KE76XKS`p!EV`Muj?%RN@-B=ZSR|jq_RYta=(`5Wmo^pG}?J=Zu`po@@9HC*SOUd zsMe{LHYay2i|WuBXqSTLR&zc|S6<$?ZctIIZ_^X4<^G9>;3ZD@G*@q9{;=1-U2YA=zZ)>3X6qES4+6StcE&~5*PZ)jQgb1m= zQf59lX`OVTW3{Hyl11K+QwKN{j?BE!z7c#@m2bzp!F>Fx90PZ42}oc zonvBa;kMusyC+tpo0wb7pdk{xK^gWfBvVlD<5QPqw>R{B3(bkHT~ig}F0;1c>+zO; z%IU`<6-*bZ0<3(J;x+Bh|2-dG*UfA^>2~D`$C`_x%=^B+o7Nc-O#aiXJEi5_$l6j- zbTRAixbs=eB_1#H@_H%y=*{1ws7M>n>$GnT_%I-eL}|6Hxa&XE`>Sa^icbh4(ap%Y z(VJ_MjQU^zd`G-PVru5~RK^>_1T4-l{dyX1o}VMJ$Mtn#`~qs3)!d&PH+u&NPV4!M#B^uy79Km#vQPgL5|~{TRyvpUCXmLAnSckKdY;A2=xpO4pq3< zs;&$nJebY9a4)K+r4R9}V#(yX7|G)9}Q!#c3l>OTst-XJm1R0p? JSLr@_@jnT}&i()Z