From cbca44a566157ff9c5fc4465ea4d26627108cedf Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 14 May 2018 09:14:17 +0200 Subject: [PATCH] Add SpaceAPI documentation (#5336) * Add SpaceAPI documentation * Update description --- source/_components/spaceapi.markdown | 149 ++++++++++++++++++++ source/images/supported_brands/spaceapi.png | Bin 0 -> 9022 bytes 2 files changed, 149 insertions(+) create mode 100644 source/_components/spaceapi.markdown create mode 100644 source/images/supported_brands/spaceapi.png diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown new file mode 100644 index 00000000000..c5d8c452bc2 --- /dev/null +++ b/source/_components/spaceapi.markdown @@ -0,0 +1,149 @@ +--- +layout: page +title: "SpaceAPI" +description: "Instructions on how to configure the SpaceAPI for Home Assistant." +date: 2018-05-08 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: spaceapi.png +ha_category: Other +ha_release: "0.70" +--- + +The `spaceapi` component allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). + +## {% linkable_title Configuration %} + +To setup the `spaceapi` component in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +spaceapi: + space: HACKERSPACE_NAME + logo: URL_FOR_LOGO + url: URL + location: + address: ADDRESS + contact: + email: EMAIL_ADDRESS + issue_report_channels: + - email + state: + entity_id: binary_sensor.front_door +``` + +{% configuration %} +space: + description: Name of the Hackerspace. + required: true + type: string +logo: + description: URL which is publicly accessible of the logo. + required: true + type: URL +logo: + description: URL of the hackerspace's web site. + required: true + type: URL +location: + description: Location of the Hackerspace. + required: true + type: map + keys: + address: + description: The physical address of the Hackerspace. + required: true + type: String +contact: + description: Contact information of the Hackerspace. + required: true + type: map + keys: + email: + description: The email address of the Hackerspace. + required: true + type: String + irc: + description: The IRC channel of the Hackerspace + required: false + type: String + mailing_list: + description: The mailing list of the Hackerspace. + required: false + type: String + twitter: + description: The Twitter account of the Hackerspace. + required: false + type: String +issue_report_channels: + description: "The reporting channel for issues. Pick an entity from `contact:`." + required: true + type: List +state: + description: The current state of the Hackerspace. + required: true + type: list + keys: + entity_id: + description: "The `entity_id` of a binary sensor that represents the current state." + required: true + type: entity_id + icon_open: + description: The URL which is publicly accessible of the icon for the open Hackerspace. + required: false + type: URL + icon_closed: + description: The URL which is publicly accessible of the icon for the closed Hackerspace. + required: false + type: URL +sensors: + description: List of sensors to expose. + required: false + type: list + keys: + temperature: + description: List of temperature sensors. + required: true + type: entity_id + humidity: + description: The Twitter account of the Hackerspace. + required: true + type: entity_id +{% endconfiguration %} + +## {% linkable_title Examples %} + +In this section you find some real life examples of how to use this component. + +### {% linkable_title Eastermundigen %} + +A possible configuration entry for [Eastermundigen](http://www.eastermundigen.ch/), a Hackerspace in Switzerland, could look like this. + +```yaml +# Example configuration.yaml entry +spaceapi: + space: Eastermundigen + logo: https://eastermundigen.ch/logo.png + url: https://eastermundigen.ch + location: + address: "Steinbruchweg 16, 3072 Ostermundigen, Schweiz" + contact: + phone: "+41311111111" + twitter: "@eastermundigen" + email: "info@eastermundigen.ch" + issue_report_channels: + - email + state: + entity_id: binary_sensor.front_door" + icon_open: https://eastermundigen.ch/open.png + icon_closed: https://eastermundigen.ch/close.png + sensors: + temperature: + - "sensor.temperature_in" + - "sensor.temperature_out" + humidity: + - "sensor.humidity_in" + - "sensor.humidity_out" +``` diff --git a/source/images/supported_brands/spaceapi.png b/source/images/supported_brands/spaceapi.png new file mode 100644 index 0000000000000000000000000000000000000000..364516a240cea08ddec1ce052e78d935f2cd3d13 GIT binary patch literal 9022 zcmZ{KbyQo=6K@jSy~VvaMGD2;-Q9{?A-GGRKtqeWTLmaqN^uA&1TO@4*A%B{(Z~1q z{(bMH`44l&3Ki8}q3j)ap!ndSTjW zs3-y+|9eV0%hR7II9{q|z5oEe=6?+ch}Ze{M8xt_(^A6Pz`((IE|Ow1)C&MG0@M`c z41*R93xjj4lrrIw%Z2A@G1YA7ATuV)Zo(g!4tO7bU}EFr4zNSt-Np&>S8WI$;c}Ir ziI;rZ01R<3k~-l107n7T7;|D$Y8qt4{~V4ml&_pOluLx~FSRX(?p}o-vz!O+uY9xc z-#082*PxS{LbHd&!%N}1B{8;?)4%oCfF%@j1%Df8AoK88_ye5d4gVOh8fyhT3vdN` zOijNsBKi#=#BBQLUHo!(RO@J&56c+skfMv1>L*x2e9 z4nel|WgIxm+)hu`(X^oDWc_vUS3}%1wheL<6{L9CRHGFEB7l~J1t3lBN{@0-a?q5& z2t;`;|B_@L86o@_N|=+o;c%yq2=PEq`W+AW=QtETf!Tq3M=#3#D?rO9THLL(3D7=+ zCIKpLD(tYGk_-jxiVG`EbfD$XpDvWb<-~$jHuWQ{8y2GqueRqOJ4Q@g2szc|1*91N<{rGjCqhKt;SKqJ#nxqBrdjzP&2DI~h zCF_b)f9=U2Y1d;0o}=NA7!}X5V4>n{DH+=ig{t|I&pRU6$}R;%T!6IzPa>~6%tOMh zt{MjX9xopBCbqi-d-8N6wC~0KI>iO}ck%d!VHZ$okIaiGTS|B`aaB31n4Z~D=Zw_7 zkB}G3SVj}TjHrO9!!i5~rSOP9T#Hk3mzaz({zQ6>xtp$Y!>Z&M z!KZ*Z^f3As=~!ni1)g}JpMYC{&U4gqK)X%kl+m3?%)j$1$RaWF(hyxWw?E1Z%6Q#@QNT zNU+pjX+jitHCg5B_rq|x*U1KL?E8(79! z{yi%sJ@I|>rR?BAHBI(EE_oiCNGSm#ourn^MgfG*s`IhWuN4Dl91KG6C&>HyAoh`Yw`$V1-}NkM-*nT|=Jrz@I0>|Mr`w;85%>Y=j=Ge}mWq7xxfUnPPJWpsqbi3F ztEwn}ZodvN9DF~w)fe&3-KIPr-sWq*Dn}7+uzT~#pp{xHzar_a1xiek4~PeKa%_CH zkqb*(ke%G^Nu$kS$~kDNOkV;ErOkU)&|GgPH~Mrh<98(H9P+A=R`39_|% z<(!^)q7(j#_DcEURu)Zw8aTCL@+~uI$Q$2LOq+M^v#f7GX(qP#q^%9T_d|!=y88oC|FsP@fG2_nSxJgId~`56B$ zJzrFv^Dc|AX+;fn64z=qIlFws^ry*k*SO~$=|Qoc=XMCjiHmx;;X@~YR^x};xQ77s zb%}vv%-dONMdS))3yeV3a2~vwtu8clTn7&&t!Ut5xU4wK4L`6f%et>2V|882pSVoF zc4Vbh4XQRtcrU@cWRW@X+O5|awCc0>K_9bAC7xcxnUM{U4T>Bpp|gSqTGGjXlT7j@ z8`q$^(AhqA);>(z>D~dovF$#*Az8QMOT?)4VX#f}hmqvulmc33Kh>s(W-j+vYJSSF z+L}tAekq%`(3(S!Rm>A<5d}t!?GpHJ+YHNDWPy$eg(@B-6n?F&f|mADE z8>vNP^s#nwXjm;K`T)P0KbBh;gJGDva=!o+%a>Gr%mB5j9kSlc3}Qw<}dIS+Gevc3YuNUy_2ZMIVBXR~}( zvc^3f_av@W$Ymi3@|p$;N|G+JQ{S*0r-}l~LRC$C@NnYNPu2`R`_c;%oC z-i5!O9x-%meW7MlarJ%~N=v>Yg-~U2a*^{XXGq)_(U2TjY2P{RUD;LQ0ECFzTdb`h|oF-W> zz%QS86H-B|p5yzC0y-N!c(}KrXd(ruHw_W`CB6C%6+wlZjD!}5EMGnIPZG`D+p!w* zse1B;VBlZAsH672nu=q^bFjyq$3a!d)d3qK&xw?@X^jJOrqEMKa(Z%uYRw68Q$|rQ zjrtZ8$vY5rDh3^F$YO%Ws&edeRMpPnGRqE0yl)|!xj@J$1fkc*N6z7_{m69{Bb?({ zBi;gB&q)u}onKR80UxOwV6)6HT5yYip3mxURYl=zs@@|{{0)(FQ~Awu44L!=XYOZN z;od~!XJ!da>gPUFeHgL z?`wMa{te4IRWF~%#LsWAb%jPTv}K-}dCtBj1_|!uh|bqM zG$JD@Blj!Co4E^AlFzb|D^UlO{t@`6`V7!N(An1G`(vV??nhu!n>KjxCstJ-v;BF%pV+`Q~Za2;o%qqTx)lf{}_wvF!f%){{MxV4ostZ!0YQYGsZ*r$Tj$_yLMX zRHwhAwOt!uNl>KlIdc~I2grL|{aeW*8xff7w>=l@Wp2O*ZK-W{OMe5Z@BjsSD~pB5 zdPX?IGcJabTJ*<@h>aC?`-lgmt9qmg;p)TvYqE~{mxj{EG()@huNAB=WVkSj0bplu8yNsq^;{3cfMDBme+q@Mgr&nyUeq_qUxBSe}Of@*3 zjw);Ck^M>Zhik5u(c?%V+s*fzPjBk8y6+y7!@3|v-?&rslXm>oM5lf~GI63S^(-#q z{8Hr5PLQPqa|r2=*Ryqcxk@c#w`NC@vcG4AeSevM`6~NDwu!@tktKs0VO~mBh*U@W z6I(v>9rF?YBP?W%Q`LvZrk1V!?z{(@71x+1Lj19{rCO2aBy81NHR-Qq*h8-Zk)im@Gn9PxUSm;^ZBP2wM0)3;&!WJ`6!GEZ z&l%IT*VyceVW!a)-{rCWSFJP$5Kg!2fk`*c$?g&;iLKkFAaK-fq7$o8k8`GdF!zRW zs^|p;Ls0-;xOAT^8Nyhp>mb$lSI#+WIQavRtytm5q+>4-7f7nUe3@lOA}al6k?5C> zhhP5gy^Z{+h zE9ZeE8?ptsnOxBl_Dj2-X?TgcelwwjcSCA^iixm>Lh`CjLU!37cB~IsTJDf+v>DsN z-3zU#B8g`*lk>vYyA`JK=$Ys1IkXAe;FdyLn=T)ore3(P_C7Itxthoc2BKQRALxS@ z(s`-KDiT243-%u!|&H*F$Vdc>0 zzT5~xgvhNUif-~5a$kW;{vg`MJWhtQcr%~$x`q12$y()3N#AJwvdO2FXXoCD#h9N( zU??L4^f`AyD7CiSBm)Uu%J=RRZk=FIeN+99*zLz@VMQZT-|<;T1bL&kbUUHgyAX+w z$&G1WprbDdZ<(Cp-`lzv;W=K&`x3yaFz<}y7+a-(DB24@7oV=EySkW>MM|w~E@a0) zx9%w~exC}C{6@?JB4qyrWelI6k0guC-(S&GJa1?4d$dvUIBT-=7lrQO^sh;qog$iEn0#TJZjoz3v)#I7hOpU-<&l|LsYaJ3c_SeN z8mxN==UIw3hD>b)>!XdQab7ru_g!2r3-fB15cZI73cf54wtm#t{IyN<>MhYXoiEn! zW4h)gO1;T7AP^L_%!kO94=~nkl~gZ!iK*{^Kf2f{A$L;s;m2Kcc85P%NT0h#Tj(Xp zF%*g+`q$mNZ`}xQ=1d?Rsj_roJ%KS^uk-i451-xHnP2qEBU}Z!UY&|~4!pukv3$9^ zT`IU}zP^G&A0R-T*=HD;uro$=O2?r1_ubx_OjL#imKsIgGFG|;2Flwf6hSqC5f+m z^8J)rA28$`tuL@}$nNT7guV`Q3m&c7eh}m)t9W-zHPDuWl*H}wZPP*o7VxwNZ;>Yp zHk^t8N6|by2_I7Jb~EvSppC`xxGlEiDvh_w-DEl-n4&0mN{4}dRy>QW`I5?|{Wkh+ zXaTe3k7+Lo^;AqC}#|K35=XIl*!n=S6B3)nl=aPG+&Q&k8K!-OspB}uZ)8O z@Jce_?yL;k;$%ROonQdz3By3HvgHHec)yJiy%=5KClmE+ndbW%IP!ZSAcg0&6Gkl%au-E|71 zs{E;fhzsF(vxB9xO;tUqmr|d9QWY%k59h%# zw&i0#got>VamzG8@$;vw;nX#&(h0T*8nqtN#9)3Qr!kmB3Lmj@V~#Mjdsj6Ev~Fxz z!68l*_KNqq{HT-D>;Cxf!PPI-0U{PGiIgF^dSZb?d=ly#d_++M;rxE1!bDk)kT{h7 zz>_*Hg$+3s9EO7VIW09YVbG>)*d;mJ00oo3VMLi&UjXscIBOt8y5(>PD}0%(RwlcxOPGa3i+$49RHFNSB=Bk>b1moh zg3lMI9N%*UhXn8u?R=f8xtS2}Bv0dMiz&P*?Mf+_bMMWxgA6rb{)yHy-vCs21y$81 zSR2bBX#6sExt+x2h>uc%g?dCJ!fw;mL>x4@qHM(<^e(5OBi>82_Kvx~zIeZg8D~e4 zHt>)q%Wx4q(5fn2VpiHjHd3;NeOFd$yz;2O)M|~WVG3AEUJ2Yek46SJK-?<}`PE~| z85!AH>zIRQ`ukguhKjraPI9aDubYE2=mz44#I16Eg`zH9nw3?ZrOe9jI~tFgM|o#f zKC`p-xv>kqX6_^2Uv6YdAQk&X|c4jFi;hzjIMIgLligbzkJPIqF*d z{w`9VR<52Z*);Jbe4rEXD;!;gWo73*q6H~}$0ZwA`caSk#nKgzQn=@fh%$Zxy=h4> z=c;$sbsP!>ss$Bs&Y7+h+ud}WJ0;D2_E!1tP)Af-oMcFpU%5Wl2Uy)i{b%6xBz+nH8cp?a4Co3W59Cmp}tG-bYt zCTp{IF)_1oU>S06%#bgP$IXQCWqTSTX#HFZa!+}xQX&?56NsWwzH6F-Bb|&^da^^% zubmI|*X7vPEE^RIId3}E;XwF{qV7X-MDZX;3IK?c>0Pt$HKJH=5rwWQwb5Ghj{|dP zT~b*fK6^xbv+Oh!+J-hBb4Oq7E#n@u(h@yFv6*tmA|00PrS=&!&tMeJ*D>^mO}1Op z%XKm~=i04dfX=Gq$^xrHL$8*%`?HWGlk97%TfJA*t(*aJE>u zz=i?6tL5(2>i!m=b94xYTpnHlNg-H}>`X@@p0QgGz3K%<^8#iqNMDoep_^esVMUZc z`>723@D0A==9YNl8{b&4bfPnM_MRD#waD|IuL zCo9;qF4ea3!J0(+ni0|xDUKh+>C(MzZg*zqiZ?!s(IrR1M{o6OHyJ4GgSw(|yvZ0T zI>NRiVp`GfE8oVR7FW>Sm?EB`5Jx^`wLMjwq z0@!RJe7rU>!%10`tYe7l0)I?p0hTq!9uNErrHhqDEgiF1H|y1-QOQ#Z8yj@nJ7>z% zjbj%S*cS8k$Y7jlJ46P&BJN+?<(nap)Oqb1_gKMkMo)&;OU|e;rlfbs0S}cL)gsJ` zKWl`}*7iQqI*2|*(KQe=a#L{6g|He18q=@T473*UWp9V^FdPSm(~yFB@m4U4UIF!K zKwGSitsSAIB51oM!}8an&-mreGiewKzfzOV1^!>b6?-#~g+Clx^m5cM?3}PM0q|+fHcW6c{g{K8gF)o91Tw;rga+E+HD!W1c#4To* zBeXmIzIz5WSLU2*j;mwTE52IB|4a~Z7o9O}IG>yyN@%HmY#%QUyeAbH$L}R(4ROz? zue1t}M31*zq^%fLNcC-rRGf03Wjt-(D|`dBvy&!!MAvsk*I9bTeJX;sn!Tr*k;&P! ztX{t*eN97R^m`71cB8*lQuX;xDmHR!nmZF|zSF94qnZ$qnei?ARVK3SrISsB$vD_t z&RV_l@y3qFF6q9ceK!NW-{Rku(21O1{SUTQx*g}JcFdsB7~s(~=uTPhQIh8a__W&h zIccE??iu;2KS{^3Ox$&`lE>^bR`|}Ncd*R!PS72-cgRG{h^J4wyO|8_?&eMH#y@Xq z6oD$&vPaE~vY726{iay{cqJK)z2upO0H%4>ZUeop^#13ZO-Hm7y1ULq=N5`v?sL(% zSr8q?rJ4-82XPYj4y@&zF7zNiJI4TQA5;XXm%s_wvn+C=68u^*tWUNN^Ha)}z4S$d zD0}+4j6^AMS3xq48(F<+_m$&vl1u@O*Sx@nItRvd{wt{NRJGx3K{W@VE7d74(i+t z_QVQh6Q-%Od521S-2*%l_9`wrA)C^bs|CP?@9#H?Otu^ZC0BTd!uB4B$MNwr zA%@r~Ki-WAl`&)`dM|Em>U*vgIylomr5xN?ZENa5E#k`ms_f5u1yoqXM9UJHSt2#jlG$W<8Y4Qjw~h{O*|e>!abkeb?8(iYz#F|h3~%?Mhu zcp^mSW*?_E(gp$5G=m((ME=MTGFvykn;z)e0PmO&z8j$GfeEnpS&_cAFW`YT1Bx*N ze#_Z3GCI|8W43rw*cn~?qfKs)qE$zpbgYJ8YWEa8tI;mpJ=4ko=;_)B6pppBnjU9A&pM$V#Ts-w!AK)0lk&=mmhYl` zK>ZXhudM8EN)ZRkVoyXtP+QrVLjAM)HPz^VtvAAzR?~FQF7431dsCnG(p9GSqi1N# zS0bM56S;Ev+Op3boA3lOuJs9T95L*oBOYJZ&NDo!Vgyq#QrBIJQM$3Q)PJ35Qako* zFX_@L(Sk)V&bDSA;YBUBK+j3B3zc;EyM-dHpq}?`-EpLUMlhg*-qap>M6|ROE4$)G zIt%wdumyONHj+>D*dpRCU_?AjPoPON%V%D;@Ir|i>>MPF5&^)e%ntyFq^Y)eZ z2tgbUsbJM!1tChkZE^2?*f(mV=RZYsU553&LNObD{$*OOcjAg%CGbM_OC9+$w514{ zotPyDcqrX9G_^8whW;5tX?dm%cmHl0tz_9@zPXh`TL}f8STqAnQ8)aD3R5AouveB0 zy(3liGZ(WL19HBh(f1ROoFVJAfCMJCb&=Eo^k$aS!qr++Bjqm`r+E3$93Jp)42m+O z`{z$F|2Z<%%U>PTU?D&|i}eMWl|>%+PN!#cny3H0)N18s(*=x;snSd1{d=zgM)l4FOAh>Gny6blj|q<~?aH&S zcXm&|tT5wFcE-z%cIJmy1fCm~$5YnHETs}zyIv_%ENaUgiVsY>}G=S8*>GhfD&m#niFiU?qRZjmnUi`i!P5|eq#KG`{MWfhphfTWbprklK;Oll#j`Bm$=b_AW;laLNzy`IqP^^N+Vgiw4Vnu zQMai)No=wpAC40=R;@}~O65iY3^j&(Rxgs1jLPrbopUsrK~LZ|+5y%Qp{4+k)X7~0 zYcSjMiG-&KkbVndl_r3hiADP$1+DOM|`D8n3qz^U+)am*swpS-gG3%8n6XFwnt wSd>W*v=Fro4_k9uBZDi_us^L2+F6(NDd-p7B}4R6r3*k!Nn5d2{!R4%0kQ^BdjJ3c literal 0 HcmV?d00001