The knx sensor platform allows you to monitor KNX binary sensors.
The knx component must be configured correctly, see KNX Component.
binary_sensor:
- - platform: knx
- name: "Entrance.Motion.Sensor"
- address: '6/0/2'
- device_class: 'motion'
- #significant_bit: 2
+# Example configuration.yaml entry
+binary_sensor:
+ - platform: knx
+ name: "Entrance.Motion.Sensor"
+ address: '6/0/2'
+ device_class: 'motion'
+ #significant_bit: 2
+Configuration variables:
- name (Optional): A name for this device used within Home Assistant.
- - address: KNX group address of the binary sensor
- - device_class: (Optional) HASS device class e.g. “motion”
- - significant_bit: (Optional) Specify which significant bit of the KNX value should be used. Default is 1.
+ - address: KNX group address of the binary sensor.
+ - device_class (Optional): HASS device class e.g. “motion”.
+ - significant_bit (Optional): Specify which significant bit of the KNX value should be used. Default is 1.
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
-binary_sensor:
- - platform: knx
- name: Livingroom.3Switch3
- address: '5/0/26'
- automation:
- - counter: 1
- hook: 'on'
- action:
- - entity_id: light.hue_color_lamp_1
- service: homeassistant.turn_on
- - counter: 2
- hook: 'on'
- action:
- - entity_id: light.hue_bloom_1
- service: homeassistant.turn_on
- - entity_id: light.hue_bloom_2
- service: homeassistant.turn_on
+# Example configuration.yaml entry
+binary_sensor:
+ - platform: knx
+ name: Livingroom.3Switch3
+ address: '5/0/26'
+ automation:
+ - counter: 1
+ hook: 'on'
+ action:
+ - entity_id: light.hue_color_lamp_1
+ service: homeassistant.turn_on
+ - counter: 2
+ hook: 'on'
+ action:
+ - entity_id: light.hue_bloom_1
+ service: homeassistant.turn_on
+ - entity_id: light.hue_bloom_2
+ service: homeassistant.turn_on
+Configuration variables:
- name (Optional): A name for this device used within Home Assistant.
- - counter: (Optional) Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
- - hook: (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: “on” or “off”. Defaults to “on”.
- - action: Specify a list of actions analog to the HASS automation rules.
+ - counter (Optional): Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed. Defaults to 1.
+ - hook (Optional): Indicates if the automation should be executed on what state of the binary sensor. Values: “on” or “off”. Defaults to “on”.
+ - action: Specify a list of actions analog to the automation rules.
diff --git a/components/climate.knx/index.html b/components/climate.knx/index.html
index 199d0997d2..1e34766796 100644
--- a/components/climate.knx/index.html
+++ b/components/climate.knx/index.html
@@ -77,7 +77,8 @@
The knx climate platform is used as in interface with KNX thermostats.
The knx component must be configured correctly, see KNX Component.
To use your KNX thermostats in your installation, add the following lines to your configuration.yaml file:
-climate:
+# Example configuration.yaml entry
+climate:
- platform: knx
name: HASS-Kitchen.Temperature
temperature_address: '6/2/1'
@@ -87,17 +88,19 @@
Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode:
-climate:
- - platform: knx
- name: HASS-Kitchen.Temperature
- temperature_address: '6/2/1'
- setpoint_address: '5/1/2'
- target_temperature_address: '5/1/1'
- operation_mode_frost_protection_address: '5/1/3'
- operation_mode_night_address: '5/1/4'
- operation_mode_comfort_address: '5/1/5'
+# Example configuration.yaml entry
+climate:
+ - platform: knx
+ name: HASS-Kitchen.Temperature
+ temperature_address: '6/2/1'
+ setpoint_address: '5/1/2'
+ target_temperature_address: '5/1/1'
+ operation_mode_frost_protection_address: '5/1/3'
+ operation_mode_night_address: '5/1/4'
+ operation_mode_comfort_address: '5/1/5'
+Configuration variables:
- name (Optional): A name for this device used within Home Assistant.
- temperature_address: KNX group address for reading current room temperature from KNX bus.
@@ -105,15 +108,15 @@
-
setpoint_address: KNX group address for basis setpoint
- - operation_mode_address (Optional) KNX address for operation mode (Frost protection/night/comfort).
- - operation_mode_state_address (Optional) Explicit KNX address for reading operation mode
- - controller_status_address (Optional) KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
+ - operation_mode_address (Optional): KNX address for operation mode (Frost protection/night/comfort).
+ - operation_mode_state_address (Optional): Explicit KNX address for reading operation mode
+ - controller_status_address (Optional): KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3)
-
-
controller_status_state_address (Optional) Explicit KNX address for reading HVAC controller status
+ controller_status_state_address (Optional): Explicit KNX address for reading HVAC controller status
- - operation_mode_frost_protection_address (Optional) KNX address for switching on/off frost/heat protection mode.
- - operation_mode_night_address (Optional) KNX address for switching on/off night mode.
- - operation_mode_comfort_address (Optional) KNX address for switching on/off comfort mode.
+ - operation_mode_frost_protection_address (Optional): KNX address for switching on/off frost/heat protection mode.
+ - operation_mode_night_address (Optional): KNX address for switching on/off night mode.
+ - operation_mode_comfort_address (Optional): KNX address for switching on/off comfort mode.
operation_mode_frost_protection_address / operation_mode_night_address / operation_mode_comfort_address are not necessary if operation_mode_address was specified.
diff --git a/components/climate.mqtt/index.html b/components/climate.mqtt/index.html
index d6e4fe0e9f..85f2a6a4fc 100644
--- a/components/climate.mqtt/index.html
+++ b/components/climate.mqtt/index.html
@@ -122,7 +122,6 @@
climate:
- platform: mqtt
name: Study
- target_sensor: sensor.study_temperature
modes:
- off
- cool
diff --git a/components/counter/index.html b/components/counter/index.html
index ad289af569..5834c0ec5b 100644
--- a/components/counter/index.html
+++ b/components/counter/index.html
@@ -94,9 +94,8 @@
-Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with mdi:. For example mdi:car, mdi:ambulance, or mdi:motorbike.
+Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with mdi:. For example mdi:car, mdi:ambulance or mdi:motorbike.
Services
- Media control services
Available services: increment, decrement, and reset.
Service counter.increment
Increments the counter with 1 or the given value for the steps.
diff --git a/components/cover.knx/index.html b/components/cover.knx/index.html
index 97494348e0..2b5adc406f 100644
--- a/components/cover.knx/index.html
+++ b/components/cover.knx/index.html
@@ -79,28 +79,29 @@
To use your KNX covers in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
cover:
- - platform: knx
- name: "Kitchen.Shutter"
- move_long_address: '3/0/0'
- move_short_address: '3/0/1'
- position_address: '3/0/3'
- position_state_address: '3/0/2'
- travelling_time_down: 51
- travelling_time_up: 61
+ - platform: knx
+ name: "Kitchen.Shutter"
+ move_long_address: '3/0/0'
+ move_short_address: '3/0/1'
+ position_address: '3/0/3'
+ position_state_address: '3/0/2'
+ travelling_time_down: 51
+ travelling_time_up: 61
+Configuration variables:
- name (Optional): A name for this device used within Home Assistant.
- move_long_address: KNX group address for moving the cover full up or down.
- - move_short_address: (Optional) KNX group address for moving the cover short time up or down.
- - position_address: (Optional) KNX group address for moving the cover to the dedicated position.
- - position_state_address: (Optional) Separate KNX group address for requesting the current position of the cover.
- - angle_address: (Optional) KNX group address for moving the cover to the dedicated angle.
- - angle_state_address: (Optional) Separate KNX group address for requesting the current angle of cover.
- - travelling_time_down: (Optional) Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
- - travelling_time_up: (Optional) Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
- - invert_position: (Optional) Set this to true if your actuator report fully closed as 100%
- - invert_angle: (Optional) Set this to true if your actuator reports tilt fully closed as 100%
+ - move_short_address (Optional): KNX group address for moving the cover short time up or down.
+ - position_address (Optional): KNX group address for moving the cover to the dedicated position.
+ - position_state_address (Optional): Separate KNX group address for requesting the current position of the cover.
+ - angle_address (Optional): KNX group address for moving the cover to the dedicated angle.
+ - angle_state_address (Optional): Separate KNX group address for requesting the current angle of cover.
+ - travelling_time_down (Optional): Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
+ - travelling_time_up (Optional): Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. Defaults to 25.
+ - invert_position (Optional): Set this to true if your actuator report fully closed as 100%.
+ - invert_angle (Optional): Set this to true if your actuator reports tilt fully closed as 100%.
diff --git a/components/knx/index.html b/components/knx/index.html
index 11d6a6152b..3aeac85029 100644
--- a/components/knx/index.html
+++ b/components/knx/index.html
@@ -74,8 +74,7 @@
- Overview
-The KNX integration for Home Assistant allows you to connect to a KNX/IP devices.
+ The KNX integration for Home Assistant allows you to connect to a KNX/IP devices.
The component requires a local KNX/IP interface like the Weinzierl 730. Through this, it will send and receive commands to and from other devices to the KNX bus.
There is currently support for the following device types within Home Assistant:
@@ -87,18 +86,18 @@
- Thermostat
- Notify
-Configuration
+ Configuration
To use your KNX in your installation, add the following lines to your configuration.yaml file:
knx:
-Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside HASS:
+Optional, recommended for large KNX installations (>100 devices) and/or if you want to use the XKNX abstraction also for other scripted tools outside of Home Assistant:
knx:
config_file: '/path/to/xknx.yaml'
- - config_file: (Optional) path for xknx configuration file.
+ - config_file (Optional): The path for XKNX configuration file.
If the auto detection of the KNX/IP device does not work you can specify ip/port of the tunneling device:
knx:
@@ -109,9 +108,9 @@
- - host: Host of the KNX/IP tunneling device
- - port: Port of the KNX/IP tunneling device
- - local_ip: IP of the local interface
+ - host: Host of the KNX/IP tunneling device.
+ - port: Port of the KNX/IP tunneling device.
+ - local_ip: IP of the local interface.
Explicit connection to a KNX/IP routing device:
knx:
@@ -121,7 +120,7 @@
- - local_ip: local ip of interface (which should be used for multicasting)
+ - local_ip: The local IP address of interface (which should be used for multicasting).
knx:
fire_event: True
@@ -130,12 +129,10 @@
- fire_event (Optional): If set to True, platform will write all received KNX messages to event bus
- -
-
fire_event_filter (Optional): If fire_event is set fire_event_filter has to be specified. fire_event_filter defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HASS event bus.
-
+ - fire_event_filter (Optional): If
fire_event is set fire_event_filter has to be specified. fire_event_filter defines a list of patterns for filtering KNX addresses. Only telegrams which match this pattern are sent to the HOme Assistant event bus.
- state_updater (Optional): The component will collect the current state of each configured device from the KNX bus to display it correctly within Home-Assistant. Set this option to False to prevent this behaviour.
-Service
+ Services
In order to directly interact with the KNX bus, you can now use the following service:
Domain: knx
Service: send
@@ -146,9 +143,8 @@ Service Data: {"address": "1/0/15", "payload": 0}
address: KNX group address
payload: Payload, either an integer or an array of integers
-Known issues:
-Due to lame multicast support the routing abstraction and the gateway scanner
-only work with python >=3.5.
+ Known issues
+Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5.
diff --git a/sitemap.xml b/sitemap.xml
index fc3c74b62b..7da4fa71a0 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -3542,7 +3542,7 @@
https://home-assistant.io/components/switch.hook/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/cookbook/automation_for_rainy_days/
@@ -4210,99 +4210,99 @@
https://home-assistant.io/docs/autostart/init.d/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/api/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/configuration/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/example_apps/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/installation/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/operation/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/reboot/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/running/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/tutorial/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/updating/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/appdaemon/windows/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/certificates/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/hadashboard/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/hass-configurator/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/ios/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/nginx/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/notebooks/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/scenegen/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/ecosystem/synology/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/tools/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/tools/dev-tools/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/tools/hass/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/docs/tools/scripts/
-2017-10-29T20:22:20+00:00
+2017-10-30T07:17:46+00:00
https://home-assistant.io/faq/after-upgrading/
@@ -5384,62 +5384,62 @@
https://home-assistant.io/demo/frontend.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/index.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2017-10-29T20:21:36+00:00
+2017-10-30T07:16:50+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2017-10-29T20:21:37+00:00
+2017-10-30T07:16:51+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2017-10-29T20:21:37+00:00
+2017-10-30T07:16:51+00:00
https://home-assistant.io/static/mdi-demo.html
-2017-10-29T20:21:37+00:00
+2017-10-30T07:16:51+00:00