From 25407f8bc192af550067ed13deb0a6e6e4c12a7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20W=C4=99grzynek?= Date: Wed, 24 Apr 2019 20:38:57 +0200 Subject: [PATCH] Supla component docs (#8971) * Supla component docs * Update supla.markdown --- source/_components/supla.markdown | 53 +++++++++++++++++++++++ source/images/supported_brands/supla.png | Bin 0 -> 5876 bytes 2 files changed, 53 insertions(+) create mode 100644 source/_components/supla.markdown create mode 100644 source/images/supported_brands/supla.png diff --git a/source/_components/supla.markdown b/source/_components/supla.markdown new file mode 100644 index 00000000000..d96d02298c9 --- /dev/null +++ b/source/_components/supla.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "Supla" +description: "Instructions for integration with Supla Cloud's Web API" +date: 2019-03-14 20:05 +sidebar: true +comments: true +sharing: true +footer: true +logo: supla.png +ha_release: 0.92 +ha_category: + - Hub + - Cover +ha_iot_class: Cloud Polling +redirect_from: + - /components/cover.supla/ +--- + +The [Supla](http://supla.org) is an Open Source home automation system for ESP8266 based devices. It has its own set of protocols, it's own firmware and commercially available devices (produced for example by [Zamel](https://supla.zamel.pl/)) + +Currently only covers (shutters in Supla's lingo) are supported, but, thanks to comprehensive and universal REST API, it's pretty easy to add more. + +Right now it's impossible to add single devices -- all of them are discovered from +Supla Cloud's servers. + +## {% linkable_title Configuration %} + +To use Supla devices in your installation, add the following to your `configuration.yaml`: + +```yaml +supla: + servers: + - server: svr1.supla.org + access_token: your_really_long_access_token +``` + +{% configuration %} +servers: + description: List of server configurations. + requires: true + type: list +server: + description: Address of your Supla Cloud server (either IP or DNS name) + required: true + type: string +access_token: + description: + An access token for REST API configuration. Can be acquired from + http[s]://your.server.org/integrations/tokens (please add at least Channel's Read and Action Execution permissions). + required: true + type: string +{% endconfiguration %} diff --git a/source/images/supported_brands/supla.png b/source/images/supported_brands/supla.png new file mode 100644 index 0000000000000000000000000000000000000000..ee690c28729386a8d399174a44a5bc9a1bf75bd3 GIT binary patch literal 5876 zcmVBfY(HuuxqdhUSP?=AZ%EKFh~MfAi#h`5J*CxfD&RfntA(2&ES!k z_quQQ?R#%`*LO}G>74iG^{;PNb+~=2szTTd1hxdW1-9<^|43jxVDK8>T?~BO<=IwHGWSCsk;2QC8U<3AW0Su1c4uzMz> zpeSpw9`GyVe&4tAo7x26VEaR&D9{Ty16YE8M^9_d0=wBA9;M8T0ba+yW81Vg;J<-k z7RN~`8H0e^@$bx8+FamBTLY$)hn;|#_;+Ae_Iseem61~lO$9g`Xu-eJy0+=)I~1h> zy?|Tr@2Ea)32UzT^nnD)slabNYEUd- z8X!%;!^l!}7pw%HLYAk$2)qEyj`_Duz^1@Yvq>ngja9XJel(9!l3&s2cB z$o}@E6?yRg7IHPP$pGL8;8rBDD(ih&iUg=q0?s2_XIcSV3vB3UfBFL_k^Mx&EMRR% z`=oecAF@kkS_xbMtm|xVKF>kGb7ZrBHRQH5wCqjA66*qU$i{J|BF_aOPyxmvXZ$So z^#|^DMR7$HcpCf8@+smlJ>2a|Y=!{0VSk@nkjVn2K%9zwN101L@+yu4KEdw3Pa@2d zf|7uBk@7h<9b_`FzRR6R$&Sdhvdu9#%jq5{nQ;ep9ph1;uhTuS!zRGn*c*psK(o_5 zP^@zRc7tO)`3#Ount^w*Hy*dRm9N-l684;70`h_`?`(-IZ?Q2ZZNLt0>x_QuYEZwK~wE8Q7YWC5j( zaeBb5bR{kKV&}kL?OM2FHbG{iY@A3mpFJlG!%oqKw}F0+wfo>g?3_$4b1hs+#&@xE zz{j~3?ukCwc|S4_DSV*>j*T@}6DilK)#I^qQW@h~xMD^#azC8*K!44(aL@F_PNBTt zxE8LMVdG3VopN10I{6;y$8I*|9J}0bBk2$F>CRP$L4WKl>fGG5a3wxztFW&`N&%IX zD@h+9T68W@Mv(sb<00p&!(tcG2gvW7t5zbZA~_Ff?|&b&pe4^t0^U#g8{60rqS&Ph zY;56o9=Grtd8UTsyQEB)t_Mu4PsiXzdL^6#~%TwvG;kX1H>6ofJ) zij|5gQeHC+18oQ?2x)JT+O4QitWibUn5AK`4Iu?#NXoxoVnu~wjVe+MEe$^VdW6Ja z(s#sKXhVo%4;xpIO>77$05;aNEwb<%ibZS$$YwT#6aX9LduCbq4aFi=;GLAeu@gEy z39!3`-ct3rJO$G-KCBxlb^`W25ET49b~P{qLk7yXT#&R*dKitRVe?KFYOl&-BGk7u<^+ z>sAu*80io6%arRXau(^wtOk75wQ$9p#~cwL^*-w%R~1AbriP5cw~%4UVq%C(;-8Q!H~3_73oLij{F_tB<3J zEeFma{ZbaiB2%z;fFB2%+{({{L&@g3Bd)!OJo_jCVDl|6+`?CIblNK5 zSICT`;+cD~dvG5kpA}FJL&}Q!4vwz&4sdXW`>e!Z6mtJ-^T19+I_low-UWCS z`}@2S*sWt58z2GLX7Tr*LObPpp&5CnVcTJ9$i4I-&i14+Lx9W4Zl>z|Znn7{(z?yo zHdX*XA$>Vn#gIct-wC&oO+en_`=AeSCUX0e)&4y}<5kZ4VRveMI(Dk8CTa4UBna~?J1Ng|2hS|Uoh8mQF^g`Z@y9km_TM9e~{1}=2Y9?M% zRukf!MzRv`#XLLc=trcevYBu?(9xrEw}Q^#a_T%{5z{_yBGiO8u|n0 zB3H3A`?3HDI3*+22mXqGr*&Z~k@poLF#@=j^jGso(Ny2es3K>frTBN^tn39~M_U7y z0i%$Yx@l&-K0zuzx>(gvN;bkywZ@Qa5pvbYOGmApfWMG#pZ^Bz>{@tPs34UV-^IUk zr?FMY89A>Vea9jT7}MVEIvzu5e5*S6uv*-bQn{>zEZQLijt%HpJ z4oDxG9f0jAXeMPJ;QL4(h;Qd_WGj&hhnr?H3V!K}%y=y#`S{#UHvLRSA=!~P0aJ;7 zj$MJY5c~sj>sy#!nN?&V-yPU#yI|XP&2HC&VK{Qzlr;T!K5zo*Q+?M$>VCbDP{*1! z6Zj>?xatG41pPE*YSDI)h@@7gWTR2Y893=m=kdVC3AVc-Ql&DhiZSiT1Vy15%r*i0 z0zX5VS}wy+fRwSF-1bPR(c093&NFx_B&d-+U92*YGql zD>DbF>e1EaBeP~{UY0%RV&?*7f0EzsM6D7Yi)2{(IO(kdevS5F`HZbdoM1r<=Z45#M3oHlZCD${?S>YMV@N)Dn|RQhC-wv;lD!izL7r(|24-Qu6~$6Y{NO&2J zlaVsFNzw_v0{k!OYM=c&!FCJ5Q6xXBDDkKOuaRt=7a>!^Hd;9BnL+`AqL1n7RnLy~BhxQ?VICl#B6I7?>THDBIR4C!%+J^iGrd=rF>7ujvew6hCbYU> zcWh(${l8?QB0g^-?H=Ot#WDs+JF+&*6klzsL&mfY)#OZ6m|+qi88_h6(%jZ7iFfxj5!A19Z=Q)sR93E_&0+v z?|EKyOai1WGZki-l>ModH9){TKtP{E)}&_e-JzMOFk^_pcU#IFAk#2^TdL0?tMi`0 zcZU&1#-2&h?GMWwAYgtK(JRR6ykqd)3SsnS-_78=vo%1>7y*1S3n4k>ZNu;TKEZ4X zG#h;Xm9huO-;ow$Cg^R}KX@4_LLHZJSqX{B*9^ZuEfWH%3oC=dG@p7sKQe=43(Ur@ z9VyY{l7YyH%|vHuO8|ApnV1dUKl_mxEKg!Kelu{JrI{p?R2QdqVI*b+$FBAxGguD6 z+yNgXUPr35oR~n{6bHI;$5X@~K+~D8qEkhdlAAi>tw65~bsbN#CQ7ADl#1dM;tyaO zW=j^z!10(nVhwl<>2zz83UC(5%8BNe zJdsdG4XK}|)ZsDW52Ww((Gc05RO>1td##Ob5W%;@n+AtIW+dQF;tlX(bj}>)jrf!J zclfy0PDzVX+u}|WJya=y6=|4tv*KEgaNL|FrqmThNv(ijRS;@|1x+I{FsY-{|1 zc!PeoFM$EDGcwI>;-vQ=3l-CJqcydckOh^BMdG$>`+#yj=&g&?I5u(AuCsod12-Ur z!LtgCDZpWr^Y~;=Z(srO4n)}sIrPSS-PJGa{MHEI0;JWQji6YF1oXVNKt|)Zb2Sa%fNSl z>kYntJJP1DJ;AotLMq4)LoyHtBhM}iI&3adnWiTiDrzBz z3UC|ogX1O48tW(p;0mH0qo{=(E+Bqzyh%4nM@sS8nP}%IVj+hy#807}g(NX4B_&Q- zn<5o*7>)E4j1wI5&^orI=MthFr6`3Qh7rHc)gt^Aq*elATcVw%2!$Ma0FMwaIFrlE$SX8>~eBF~qC15ru+IjL? z$YFQlEhA|IzTruuk^`pF*n#p`$f22dYtGt%lRarva>BVZcA_QZtB^x~;^$(V?Mb7O zBQ_wqWm{efIaH9copFNWVow^C95Ru{&Xkuz4nHMca1?c&nUWFzMq`J{Lm`JFiPyaJ z7NkLrqQqt$8ut?Ukg&5gzeK$1k@w)HO`1|bqWXh}TF7Btq*{7Za6FFX{BEUOMD-F0 zv5-R_;qx_SXmb)%`PEe3Y5sWMV8INFgu=8EE+d+6RNT@`W|2E0*6L#JuNlj4nIsPCBnl<~HEBGuFz z1;>vw)}Sa28AScHSy?;hb#=DeX_sZZ{lXG*&O#n}fbPrTOhfAX_6K%AQgSy$iX{x= zAIr)YAusM`0RzE0VT9Q-WhK@G#j2N0dE_ zwm(w>V^`p9{0GP1&}={@FpkBnHFB1=OUC=EC`O!torm&|vGeS5RkpjUDDgQ3^WgXp zxCy!HY>mu%bxyZV25`U9r}GYqy> z1CC3)XNr=NW?&)l9CbeO@-Xd+g(~npqI1hT?Gs@8l-pDkV=BOt#B&?O^*c@esn0Ye?@QcA`FM4zcI^`xyc z*Q1f0=1H4U5~A++7vgUXR4=06lRW83n^FQQz+4(T;N{-b2`AH7Un{!8SILOYh`xo{ z%9}c2DA5Zh_w}YO$7nicG&@Cn{tobp109W6gv@9)Vp|tNiiQSAG*P_H{Y#qL~}jdbaMe}jQ=j%985lz(6`uR>&6bucJXl6%zKH7Is+^hfBltF*H5wP>)h#1|g+Gqa5-o z+_bhkHHMZpq}`jMIN|$5J7o>HnQX5lClRmM^=%nyP?XQn8+eI$L2@_ttBLdgE+Jmg zY#+}=io#Y%LAE$SG8Z_)(ss85{x9ZsYrtWawyP+{e3$r+S_7U&0;NZSZEXhJfLWK^ zE0gV(qS)gXm<34<$zQ()7)Sk8z)eV}s2?Edyrw-!wDq$R1Qq1WZW<(AZ8`FOWlD#= zN#nlfQFb40rDMD|g&hK8xTk(xMtg~!T6VgUuPKUh!Jcm5jEO9MX5&j<+%G`s;LuZ%(0000< KMNUMnLSTY&kounh literal 0 HcmV?d00001