f824c1cbd7
* Update qwikswitch.markdown New style configuration variables #6385 * Update qwikswitch.markdown
4.7 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | featured | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | QwikSwitch QSUSB Hub | Instructions on how to integrate the QwikSwitch QSUSB Hub into Home Assistant. | 2016-05-04 00:00 | true | false | true | true | qwikswitch.png | Hub | false | 0.20 |
The qwikswitch component is the main component to integrate various QwikSwitch devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application.
The qwikswitch component discovers all devices from QS Mobile. Currently, Relays and LED dimmers are discovered in Home Assistant. Relay devices are lights by default, and can be configured as switches.
{% linkable_title Configuration %}
# Example configuration.yaml entry
qwikswitch:
url: http://127.0.0.1:2020
{% configuration %}
url:
description: The URL including the port of your QwikSwitch hub.
required: true
type: string
dimmer_adjust:
description: A decimal value to adjust the brightness of the dimmer exponentially. Increasing this value allows dimmers that reach 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.
required: false
type: float
default: 1
button_events:
description: A comma-separated list of button types that will generate events. See [QwikSwitch Events] for detail.
required: false
default: TOGGLE,SCENE EXE,LEVEL
type: string
switches:
description: A list of device QS_id's that should be switches, and not lights (i.e. ['@0dev01', '@0dev02'])
required: false
type: list
sensors:
description: A dictionary of sensors.
required: false
type: list
keys:
name:
description: The sensor name from which the entity_id will be derived.
required: true
id:
description: A QS_Id
required: true
type: string
type:
description: |
The Qwikswitch sensor type. These could include:
- imod (binary_sensor, up to 6 channels)
- door (binary_sensor, single channel)
- qwikcord (Channel 1 = CTavg, Channel 2 = CTsum)
required: true
type: string
channel:
description: The channel of interest. Refer to type above.
required: false
default: 1
type: int
invert:
description: Invert the open/close state. Only applicable to binary_sensors
required: false
default: false
type: string
class:
description: The class or binary_sensor. Only applicable to binary_sensors.
required: false
default: door
type: string
{% endconfiguration %}
{% linkable_title QwikSwitch Events %}
QwikSwitch devices (i.e., transmitter buttons) will fire events on the Home Assistant bus. These events can then be used as triggers for any automation action, as follows:
automation:
- alias: Action - Respond to A button press
trigger:
platform: event
event_type: qwikswitch.button.@12df34
event_type names should be in the format qwikswitch.button.@QS_id. where @QS_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 by using the listen API call by browsing to http://127.0.0.1:2020/&listen and then pressing the button.
The full packet from the QSUSB API will be passed as data
By default events will be fired if the value in the command (cmd) field of the listen packet equals:
TOGGLE- Normal QwikSwitch Transmitter buttonSCENE EXE- QwikSwitch Scene Transmitter buttonsLEVEL- QwikSwitch OFF Transmitter buttons
The list of recognized commands can be extended for Keyfobs, door sensors, and PIR transmitters with the button_events configuration option. button_events can be a list or comma separated list of additional 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
{% linkable_title Qwikswitch Sensors %}
The sensor configuration is a list of sensors. Depending on the type of sensor, it will be a sensor or binary_sensor.
Example sensor configuration:
qwikswitch:
...
sensors:
- name: door sensor
id: "@id03"
type: door
- name: Imod 1 sensor
id: "@id02"
channel: 1
type: imod
- name: Imod 2 sensor
id: "@id02"
channel: 2
type: imod