jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 16:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

New parameters (#498)

Browse Source
This commit is contained in:
Johann Kellerman 2016-05-22 15:27:06 +03:00 committed by Fabian Affolter
parent 1f29e6b9e0
commit 4d68b72472
3 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
source/_components/light.qwikswitch.markdown
View File

@ -16,7 +16,4 @@ ha_release: "0.20"
The `qwikswitch` light 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.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).

12
source/_components/qwikswitch.markdown
View File

@ -16,7 +16,7 @@ ha_release: "0.20"
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 adds all devices from the QS Mobile application. QS Mobile controls the QSUSB Modem device.
Loading the `qwikswitch` component automatically adds 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](/components/switch.qwikswitch/) or [lights](/components/light.qwikswitch/) in Home-Assistant. If the device name in the QSUSB app ends with ` Switch` it will be created as a switch, otherwise as a light.
@ -31,6 +31,8 @@ qwikswitch:
Configuration variables:
- **url** (*Required*): The URL including the port of your QwikSwitch hub.
- **dimmer_adjust** (*Optional*): A decimal value to adjust the brightness of the dimmer exponentially. Increasing this value allows dimmers that reaches full brightness with low values in QS Mobile to appear more linear in Home Assistant. Recommended values between 1 and 2 and the default is 1.
- **button_events** (*Optional*): A comma separated list of button types that will generate events. Details below.
### {% linkable_title QwikSwitch Buttons %}
@ -44,11 +46,13 @@ automation:
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.
`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 get the device ID from the QS Mobile application or using the listen API call by browsing 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:
By default events will be fired if the value in the command (cmd) field of the listen packet equals:
- `TOGGLE` - Normal QwikSwitch Transmitter button
- `SCENE EXE` - QwikSwitch Scene Transmitter buttons
- `LEVEL` - QwikSwitch OFF Transmitter buttons
Technically this could work for Keyfobs, door sensors, and PIR transmitters as well.
The list of recognized commands can be extended for Keyfobs, door sensors, and PIR transmitters with the **button_events** configuration option. **button_events** contain a comma separated list of commands that will fire Home Assistant events. By default it is: TOGGLE,SCENE EXE,LEVEL.
On some QS Mobile servers button events are only generated for switches added to the QS Mobile application, so it might be best to test button presses through the `/&listen` API

6
source/_components/switch.qwikswitch.markdown
View File

@ -16,8 +16,6 @@ ha_release: "0.20"
The `qwikswitch` platform allows you to control your [QwikSwitch](http://www.qwikswitch.co.za/) relays as switches from within Home Assistant.
If the device name in the QSUSB app ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).
If the device name in the QS Mobile application ends with `Switch` it will be created as a switch, otherwise as a [light](/components/light.qwikswitch/).
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.
The platform is configured through the [QwikSwitch component](/components/qwikswitch/).