From 5f411b67cc79506153ae65217095c05cbb4b0367 Mon Sep 17 00:00:00 2001 From: Johann Kellerman Date: Wed, 4 May 2016 22:24:59 +0200 Subject: [PATCH] qwikswitch-docs --- source/_components/light.qwikswitch.markdown | 22 ++++++++ source/_components/qwikswitch.markdown | 49 ++++++++++++++++++ source/_components/switch.qwikswitch.markdown | 23 ++++++++ source/images/supported_brands/qwikswitch.png | Bin 0 -> 4665 bytes 4 files changed, 94 insertions(+) create mode 100644 source/_components/light.qwikswitch.markdown create mode 100644 source/_components/qwikswitch.markdown create mode 100644 source/_components/switch.qwikswitch.markdown create mode 100644 source/images/supported_brands/qwikswitch.png diff --git a/source/_components/light.qwikswitch.markdown b/source/_components/light.qwikswitch.markdown new file mode 100644 index 00000000000..639f681a7ee --- /dev/null +++ b/source/_components/light.qwikswitch.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: "QwikSwitch Lights" +description: "Instructions how to integrate Qwikswitch Dimemrs and Relays as lights into Home Assistant." +date: 2016-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qwikswitch.png +ha_category: Light +ha_iot_class: "Local Push" +ha_release: 0.19 +--- + + +The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) Relays and Dimmers as lights from within Home Assistant. + +They will be automatically discovered if the discovery component is enabled. + +For more configuration information see the [QwikSwitch component](/components/qwikswitch/) documentation. + diff --git a/source/_components/qwikswitch.markdown b/source/_components/qwikswitch.markdown new file mode 100644 index 00000000000..d1456dd9bcf --- /dev/null +++ b/source/_components/qwikswitch.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "QwikSwitch QSUSB Hub" +description: "Instructions how to integrate the QwikSwitch QSUSB Hub into Home Assistant." +date: 2016-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qwikswitch.png +ha_category: Hub +featured: true +--- + + +The `qwikswitch` component is the main component to integrate various [QwikSwitch](http://www.qwikswitch.co.za/) devices with Home Assistant. + +Loading the `qwikswitch` component will automatically add all devices from the QS Mobile application. QS Mobile controls the QSUSB Modem device. + +Currently QwikSwitch Relays and LED Dimmers are supported (tested). QwikSwitch Relay devices can be Switches or [Lights](/components/qwikswitch/lights/) in Home-Assistant. If the device name in the QSUSB app ends with ` Switch` it will be created as a Switch, otherwise a Light. + +Example configuration: + +```yaml +# Example configuration.yaml entry +qwikswitch: + url: 'http://127.0.0.1:2020' +``` + +{% linkable_title QwikSwitch Buttons %} + +QwikSwitch devices (i.e. Tranmitter Buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any `automation` action, as follows: + +```yaml +automation: + - alias: Action - Respond to button press + trigger: + platform: event + event_type: qwikswitch.button.@12df34 +``` + +`event_type` names should be in the format **qwikswitch.button.@__ID__**. where **@__ID__** will be captured in the Home Assistant log when pressing the button. Alternatively, you can also access the listen API call by going to 'http://127.0.0.1:2020/&listen' and then pressing the button. + +Currently Event will be created for the following commands (cmd) value in the Listen packet: +- `TOGGLE` - Normal QwikSwitch Transmitter button +- `SCENE EXE` - QwikSwitch Scene Transmitter buttons +- `LEVEL` - QwikSwitch OFF Tranmitter buttons + +Technically this could work for Keyfobs, Door Sensors and PIR Tranmitters as well. diff --git a/source/_components/switch.qwikswitch.markdown b/source/_components/switch.qwikswitch.markdown new file mode 100644 index 00000000000..bdacbc2e827 --- /dev/null +++ b/source/_components/switch.qwikswitch.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "QwikSwitch Switch" +description: "Instructions how to integrate QwikSwitch Relays into Home Assistant." +date: 2016-05-04 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: qwikswitch.png +ha_category: Switch +ha_iot_class: "Local Push" +ha_release: 0.19 +--- + + +The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) Relays as Switches from within Home Assistant. + +QwikSwitch Relay devices can be Switches or [Lights](/components/qwikswitch/lights/) in Home-Assistant. If the device name in the QSUSB app ends with ` Switch` it will be created as a Switch, otherwise a Light. + +They will be automatically discovered from the QSUSB API if the discovery component is enabled. + +For more configuration information see the [QwikSwitch component](/components/qwikswitch/) documentation. diff --git a/source/images/supported_brands/qwikswitch.png b/source/images/supported_brands/qwikswitch.png new file mode 100644 index 0000000000000000000000000000000000000000..f9f7a4ecd287ba63c5eee2ef79c83e56680fc227 GIT binary patch literal 4665 zcmaJ_c|4SD+omjI&62TBrV&yG!x;N+>?4MvArfP4%wS~f5sI=Dku8mVDGFsPTh_7; zlkA2N6=f&%>3N@?_xs~}zWaCI_qF_v<2cXrI*-4uSPOGQ4pt#nIyyQIV z69+II{pHL&wvGltBGQ&Bg$l(H)0)Slbe9 zQD&;nc$|#WZ;T8HM>t~B(Wz^Z2u{vkSR(iu*3H9P1G3uC1Oa=vXh3WfQF17P9@gE% zD99IU6=ZJh9OUJ!;sVjq1gn!&j|6a7q7#^eyYB6$O45M*rK@^0|Gg~>0sjRddTBuZ zlawvW0<4Gk#ex-O6rj#>Fc=ttkb%J!5eS$xSY8e$FDrNSBA_t1sv<&FUJ3m7138N3 z>*A`4);IV&*3n7>;!Y$IRAprY0s>?L6lCzeZn7{H6_wu_^77Cl1k^9ko9IM>di#m} zQP9WwIs1ALh#q)v@NY$@Yj}U62IMHy|CE3u{3Gk__xCX!9hfZ1i69G;k^5cJA0P_# z|3h)Of6#tJH1@yw{-45r)`0}9EE?;F_xE)^YMiUs?@$C)JzuO75$|h_$6x<*iWcs8 zBHqs(PXOy#A;4#CJiJ}-0e(_{;ZZ16V{bpAleaV0SYHEjq#)zr;i9SxlT(2y%IPWV zDaylONJV7>n1YUyB0@(Vp=Y3?WAKNok9YRRVZDiexGw+Y>i;YEw-s=NqsaPLUymDD z7Xx2B4*XZisviHIi_X95{mpgx_gr-Ul`DIcjO_2m{;x*=**bF1@996bJzD%@e6078 z+kKC0O;wycq@&|}W~{GcO&a@Z&qBP^&KDLA5V%vU-OOkKFyb06Msh)pMYCe;b?H?K zZq|YtM1I(AWB3#Ny$X=#NJcM93yaZ{CtZ>Y&Yi_b#hqnheTN3>q#6N?oBDqR`zkbs zbFk1K2KQ;;r(UNAuDh;G{G3!<|3#)y(6UIW(qlwc7a#HRcCv*#tXwuyG9sXkQBR7D zvg9N0CAFv5zB(qF_xd8&Ot4R=lz6pNXkMFX5bq+Gk*qsHht|s9x=Ka!a{)O zT8y+ebdV3EuCo4I8g6C{$fkF=y>ZrFxL$W0`D9z9=Ay@^yDc?0M{*;^388fln18Sm zfO7$)U$^AX8$v*f6FFRD5k8YwPy32y@MQx^`Q55txjS>;I4B#u$Jh0L(sH2$>|&@z zj(P%*t%DS!W(7T{9ET=!In0f~`L$+Viv{-dxp%ouv)TTH&;3Tj?Z-CCp1PeH61i&e@qVxa7{}EmL%B z^$HSy@veVGi|6J%du49{y*b)T1>EkLIajB>edDX_TB}`Z0Z-5FxlE`?Cw!YW(zS0_ zf8RW|4qt|lAKvn%`bp_cYXd$S`L$;k$u_S>G{t>}M(akK_$CD3?5EiN__-LNbqB^A zI`0B3n_A0%dfdj#*w|Pq{YmCWMRV^vs^ix9JKZ_YUN?vhzi(Z?C{EM0g1k)Z9HRD# zq7KEDzkIs6#&+?r9)LSU^`}J&r|%E#YZ}rj1jMX&JHIImgwn5Od>Nijd|j0#uhJze zk4+Vmz0$uzoPxCud!2CL%4>S+=cnCN-dgn#w#=b8zn3clkfzULx@;O6d5k(*j* z?OMiVw{z?WD_F<6OPIZ1a>X`u;Zzlb=X|z&U?j7bOXUOcjK&wF3y$fzIT1?fi?6kY z0GzbuZw@43*xl3c;csFQq12h)W9bBQYvExvj_zN}fy}(KyFwukzyf+U7cy8@XdC`P z_M#_Q;}-<-4#7|ft?;KEFJi#W*Q~xlbhJ&+GkyUKVmxU)F{t>pJ&7QGr)KF;Lq{pH zsI=1K#SVJd`)H3ur3{4S9(n}R>Tq&wTQHQXuz^c`Dn$#KeDTSXO@^@Q+46G4R(|*P znO)r1{&mmr*j8-jvF9(v4NN35gFDzoE$Sfid=Nb6g;Rpha@?X`m2sbWY*BB_HWLDE z%WiGsSDxDm%bMOyDc5?bYs##`s<|Iu{bssiyFmI?=IeS^GGB)++?h}}Hj&t>RQV>T z@MGP~g>&+$u5&K2XbX_}^7y44_8GQT(Fy}^k!nI;P zTkgecND*hX9+2K~-cZ%ipFa|?(Eyw)&!!kP{q*UsB#_=39c>(D1o~Xz6!os|u^A zcJ;|JWzVa?Cz7aNmJe`)86l^V9A_>B z<8hDoSBf<;hVhvFY?G{Y5IqKQzh1}oCHlnkd?&*6koIG-o`-Pi;i7`WRHDubmWpeh+|X)|YDz`_l(>viL)u0^`tpEb8IiWY z&U*YZ`AaU#`|THnc`p`(lGDlVOg1Z7`K^pjEx`=?bd-%9K_wCX8Dd=YETH(xvo+B z@uViE(-M9wrMM#U`HQ*I~`}&^#D1Anf-J2OGb^h3X z(ank?Aab;X9vi#+Dp#Y!pSh&>GBbD6rp?cN%ZZ%q#R>XPxy}N&n+%tWjhLeMg$zwY zmSb)uxq;4V$@K0c`+|WPpCdV9p#!?+23~c8Nm||H`Iz2Ghta%yb0TGfrgNJ5)5eT# za#IbrP1q!bio~IB!2?SI=ac(?+T=q=f@s-7K~KKl9Mf;|iSQ$nNvH^NQe4w>2`U?65W#)d zlb-aUsKEEC{Od}|-S@{ilviwobb4O;k>l^d>Os*zLmIBS2u9xcV8Y2yJ_zIb?$nl? zxR#bU@iuMC$0G;c4e}wqAy#`QFYQrg)YFP1n1g8?5s|)8E|5W&ja``))(At$8y#i! zvj`zpTkD#@7ByrJO|W17BOtn|1uc=0 zcC5;-4_!wq`>xqpP$L~wJv6sbQb{a@E|_ETbH+cp^T`W@J?Iev6`0`;t_Uv1JuUcn z9oN3?Y8bn{^+6F+#}*ae1Q_Vh;Cq#~WhZz#Y}~YO0K?*Bw2(wD21d%C4jmWzetV{7 z{)a)XI&bE)LZfE=)lMzgQX$uj=0oRVAKxg#;HYOn&fdCD6r&@mk#4b&JT~@ZO+idM z5jYj`&1+gke0V27JDZnpQ;OPvKt6xEcs>Yy25I!D`vhjg}z~C@+?c(kJOP%NuL6*D2~uEh+O=JCW?OrsrvQPTD+E`|=^07DPMU z8e@}7dTIz!ywAigAN__$#FWzRFgn?4G~5`eu}3OS=MQIZDiK|H%5Eln;)fgfCAj+S z68tpEYTvKI^8g`bscL0$C!=LL+Y`!un4Q%Ji7wg~^;;v3)yby~*ryT8sq0B6LeK6Y&p_iMU4v8J6VLVMxa2r-s0oRdXpD}{85e# z=OA#*^bEdWd#DvuRQHU`XmHxGh)a;4W-27f`n}4t;X>t$kvJgcg6PUQs{dv`5)ZS? z>nOF$eU->Y!aw956N^5}E~(6Gmm6!Qlz{A-898tmt;%amJ9rJFYC^4CW^Dr}LDUW) z%jFE4tr}uG>-JzAhs~KYR{n9~6CnsQTBSebomYN$jS0EOrglw$`PA?Y;8oE2EmEP8qB>B-dx1go3Orp+X+3j~O1Yu%**hz)lF z&b&C*sV$;)`3uz{++$V5X$)TR^#p3W_}4i0B8%XSM~8h@;h_My-m3J|E@RV!G#e5P zG19h?;`c(&HeR