diff --git a/source/_integrations/binary_sensor.knx.markdown b/source/_integrations/binary_sensor.knx.markdown deleted file mode 100644 index 054e64f5071..00000000000 --- a/source/_integrations/binary_sensor.knx.markdown +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "KNX Binary Sensor" -description: "Instructions on how to setup the KNX binary sensors within Home Assistant." -ha_category: - - Binary Sensor -ha_release: 0.24 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors. - -Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). - -## Configuration - -To use your binary sensors please add the relevant configuration to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -knx: - binary_sensor: - - name: sensor1 - state_address: '6/0/2' -``` - -{% configuration %} -state_address: - description: KNX group address of the binary sensor. *DPT 1* - required: true - type: string -name: - description: A name for this device used within Home Assistant. - required: false - type: string -sync_state: - description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire ` to read the state from the KNX bus when no telegram was received for \ or `every ` to update it regularly every \. Maximum value for \ is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60". - required: false - type: [boolean, string, integer] - default: True -device_class: - description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend. - required: false - type: string -reset_after: - description: Reset back to OFF state after specified milliseconds. - required: false - type: integer -{% endconfiguration %} - -### Automation actions - -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. - -```yaml -# Example configuration.yaml entry -knx: - binary_sensor: - - name: Livingroom.3Switch3 - state_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 %} -name: - description: A name for this device used within Home Assistant. - required: false - type: string -counter: - description: 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. - required: false - type: integer - default: 1 -hook: - description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off". - required: false - type: string - default: "on" -action: - description: Specify a list of actions analog to the [automation rules](/docs/automation/action/). - required: false - type: list -{% endconfiguration %} diff --git a/source/_integrations/climate.knx.markdown b/source/_integrations/climate.knx.markdown deleted file mode 100644 index e38c6e19903..00000000000 --- a/source/_integrations/climate.knx.markdown +++ /dev/null @@ -1,231 +0,0 @@ ---- -title: "KNX Climate" -description: "Instructions on how to integrate KNX thermostats with Home Assistant." -ha_category: - - Climate -ha_release: 0.25 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` climate platform is used as an interface to KNX thermostats and room controllers. - -To use your KNX thermostats in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - climate: - - name: HASS-Kitchen.Temperature - temperature_address: '5/1/1' - setpoint_shift_address: '5/1/2' - setpoint_shift_state_address: '5/1/3' - target_temperature_state_address: '5/1/4' - operation_mode_address: '5/1/5' - operation_mode_state_address: '5/1/6' -``` - -Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode: - -```yaml -# Example configuration.yaml entry -knx: - climate: - - name: HASS-Kitchen.Temperature - temperature_address: '5/1/1' - setpoint_shift_address: '5/1/2' - setpoint_shift_state_address: '5/1/3' - target_temperature_state_address: '5/1/4' - operation_mode_frost_protection_address: '5/1/5' - operation_mode_night_address: '5/1/6' - operation_mode_comfort_address: '5/1/7' - operation_mode_state_address: '5/1/8' -``` - -If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` -attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address` -to the configuration in this case.: - -```yaml -# Example configuration.yaml entry -knx: - climate: - - name: HASS-Kitchen.Temperature - temperature_address: '5/1/2' - target_temperature_address: '5/1/4' - target_temperature_state_address: '5/1/1' - operation_mode_frost_protection_address: '5/1/5' - operation_mode_night_address: '5/1/6' - operation_mode_comfort_address: '5/1/7' - operation_mode_state_address: '5/1/8' - operation_mode_standby_address: '5/1/9' - min_temp: 7.0 - max_temp: 32.0 -``` - -`setpoint_shift_mode` allows the two following DPTs to be used: - -- DPT6.002 (for 1 byte signed integer) -- DPT9.002 (for 2 byte float) - -Example: - -```yaml -# Example configuration.yaml entry -knx: - climate: - - name: HASS-Kitchen.Temperature - temperature_address: '5/1/1' - setpoint_shift_address: '5/1/2' - setpoint_shift_state_address: '5/1/3' - setpoint_shift_mode: 'DPT9002' - target_temperature_state_address: '5/1/4' - operation_mode_address: '5/1/5' - operation_mode_state_address: '5/1/6' -``` - -`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified. -If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant. - -The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`: - -- 0 (cooling) -- 1 (heating) - -The following values are valid for the `hvac_mode` attribute: - -- Off (maps internally to HVAC_MODE_OFF within Home Assistant) -- Auto (maps internally to HVAC_MODE_AUTO within Home Assistant) -- Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant) -- Cool (maps internally to HVAC_MDOE_COOL within Home Assistant) -- Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant) -- Dry (maps internally to HVAC_MODE_DRY within Home Assistant) - -The following presets are valid for the `preset_mode` attribute: - -- Comfort (maps internally to PRESET_COMFORT within Home Assistant) -- Standby (maps internally to PRESET_AWAY within Home Assistant) -- Night (maps internally to PRESET_SLEEP within Home Assistant) -- Frost Protection (maps internally to PRESET_ECO within Home Assistant) - -{% configuration %} -name: - description: A name for this device used within Home Assistant. - required: false - default: KNX Climate - type: string -temperature_address: - description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001* - required: true - type: string -temperature_step: - description: Defines the step size in Kelvin for each step of setpoint_shift. - required: false - type: float - default: 0.1 -target_temperature_address: - description: KNX group address for setting target temperature. *DPT 9.001* - required: false - type: string -target_temperature_state_address: - description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001* - required: true - type: string -setpoint_shift_address: - description: KNX address for setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode* - required: false - type: string -setpoint_shift_state_address: - description: KNX address for reading setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode* - required: false - type: string -setpoint_shift_mode: - description: Defines the internal device DPT used. - required: false - default: 0.5 - type: string - default: DPT6010 -setpoint_shift_min: - description: Minimum value of setpoint shift. - required: false - default: -6 - type: float -setpoint_shift_max: - description: Maximum value of setpoint shift. - required: false - default: 6 - type: float -operation_mode_address: - description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102* - required: false - type: string -operation_mode_state_address: - description: KNX address for reading operation mode. *DPT 20.102* - required: false - type: string -controller_status_address: - description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3). - required: false - type: string -controller_status_state_address: - description: KNX address for reading HVAC controller status. - required: false - type: string -controller_mode_address: - description: KNX address for setting HVAC controller modes. *DPT 20.105* - required: false - type: string -controller_mode_state_address: - description: KNX address for reading HVAC Control Mode. *DPT 20.105* - required: false - type: string -heat_cool_address: - description: KNX address for switching between heat/cool mode. *DPT 1.100* - required: false - type: string -heat_cool_state_address: - description: KNX address for reading heat/cool mode. *DPT 1.100* - required: false - type: string -operation_mode_frost_protection_address: - description: KNX address for switching on/off frost/heat protection mode. *DPT 1* - required: false - type: string -operation_mode_night_address: - description: KNX address for switching on/off night mode. *DPT 1* - required: false - type: string -operation_mode_comfort_address: - description: KNX address for switching on/off comfort mode. *DPT 1* - required: false - type: string -operation_mode_standby_address: - description: KNX address for switching on/off standby mode. *DPT 1* - required: false - type: string -operation_modes: - description: Overrides the supported operation modes. Provide the supported `hvac_mode` and `preset_mode` values for your device. - required: false - type: list -on_off_address: - description: KNX address for switching the climate device on/off. *DPT 1* - required: false - type: string -on_off_invert: - description: Value for switching the climate device on/off is inverted. - required: false - default: false - type: boolean -on_off_state_address: - description: KNX address for gathering the current state (on/off) of the climate device. *DPT 1* - required: false - type: string -min_temp: - description: Override the minimum temperature. - required: false - type: float -max_temp: - description: Override the maximum temperature. - required: false - type: float -{% endconfiguration %} diff --git a/source/_integrations/cover.knx.markdown b/source/_integrations/cover.knx.markdown deleted file mode 100644 index c44d06f8374..00000000000 --- a/source/_integrations/cover.knx.markdown +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "KNX Cover" -description: "Instructions on how to integrate KNX covers with Home Assistant." -ha_category: - - Cover -ha_release: 0.48 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` cover platform is used as an interface to KNX covers. - -To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - cover: - - name: "Kitchen.Shutter" - move_long_address: '3/0/0' - move_short_address: '3/0/1' - stop_address: '3/0/4' - position_address: '3/0/3' - position_state_address: '3/0/2' - travelling_time_down: 51 - travelling_time_up: 61 -``` - -{% configuration %} -name: - description: A name for this device used within Home Assistant. - required: false - default: KNX Cover - type: string -move_long_address: - description: KNX group address for moving the cover full up or down. *DPT 1* - required: false - type: string -move_short_address: - description: KNX group address for moving the cover short time up or down. *DPT 1* - required: false - type: string -stop_address: - description: KNX group address for stopping the current movement from the cover. *DPT 1* - required: false - type: string -position_address: - description: KNX group address for moving the cover to the dedicated position. *DPT 5.001* - required: false - type: string -position_state_address: - description: Separate KNX group address for requesting the current position of the cover. *DPT 5.001* - required: false - type: string -angle_address: - description: KNX group address for moving the cover to the dedicated angle. *DPT 5.001* - required: false - type: string -angle_state_address: - description: Separate KNX group address for requesting the current angle of cover. *DPT 5.001* - required: false - type: string -travelling_time_down: - description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. - required: false - default: 25 - type: integer -travelling_time_up: - description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. - required: false - default: 25 - type: integer -invert_position: - description: Set this to true if your actuator report fully closed as 0% in KNX. - required: false - default: false - type: boolean -invert_angle: - description: Set this to true if your actuator reports tilt fully closed as 0% in KNX. - required: false - default: false - type: boolean -{% endconfiguration %} diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown index a13d3f3c764..3a0318c1250 100644 --- a/source/_integrations/knx.markdown +++ b/source/_integrations/knx.markdown @@ -3,6 +3,15 @@ title: KNX description: Instructions on how to integrate KNX components with Home Assistant. ha_category: - Hub + - Binary Sensor + - Climate + - Cover + - Light + - Notify + - Scene + - Sensor + - Switch + - Weather ha_release: 0.24 ha_iot_class: Local Push ha_codeowners: @@ -24,16 +33,15 @@ Please note, the `knx` platform does not support KNX Secure. There is currently support for the following device types within Home Assistant: -- [Binary Sensor](/integrations/binary_sensor.knx) -- [Climate](/integrations/climate.knx) -- [Cover](/integrations/cover.knx) -- [Light](/integrations/light.knx) -- [Notify](/integrations/notify.knx) -- [Scene](/integrations/scene.knx) -- [Sensor](/integrations/sensor.knx) -- [Switch](/integrations/switch.knx) -- [Weather](/integrations/weather.knx) - +- [Binary Sensor](#binary-sensor) +- [Climate](#climate) +- [Cover](#cover) +- [Light](#light) +- [Notify](#notify) +- [Scene](#scene) +- [Sensor](#sensor) +- [Switch](#switch) +- [Weather](#weather) ## Basic Configuration @@ -223,3 +231,902 @@ address: type: string required: true {% endconfiguration %} + + +The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) binary sensors. + +Binary sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). + +## Binary Sensor + +To use your binary sensors please add the relevant configuration to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +knx: + binary_sensor: + - name: sensor1 + state_address: '6/0/2' +``` + +{% configuration %} +state_address: + description: KNX group address of the binary sensor. *DPT 1* + required: true + type: string +name: + description: A name for this device used within Home Assistant. + required: false + type: string +sync_state: + description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire ` to read the state from the KNX bus when no telegram was received for \ or `every ` to update it regularly every \. Maximum value for \ is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60". + required: false + type: [boolean, string, integer] + default: True +device_class: + description: Sets the [class of the device](/integrations/binary_sensor/), changing the device state and icon that is displayed on the frontend. + required: false + type: string +reset_after: + description: Reset back to OFF state after specified milliseconds. + required: false + type: integer +{% endconfiguration %} + +### Automation actions + +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. + +```yaml +# Example configuration.yaml entry +knx: + binary_sensor: + - name: Livingroom.3Switch3 + state_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 %} +name: + description: A name for this device used within Home Assistant. + required: false + type: string +counter: + description: 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. + required: false + type: integer + default: 1 +hook: + description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off". + required: false + type: string + default: "on" +action: + description: Specify a list of actions analog to the [automation rules](/docs/automation/action/). + required: false + type: list +{% endconfiguration %} + +## Climate + +The `knx` climate platform is used as an interface to KNX thermostats and room controllers. + +To use your KNX thermostats in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + climate: + - name: HASS-Kitchen.Temperature + temperature_address: '5/1/1' + setpoint_shift_address: '5/1/2' + setpoint_shift_state_address: '5/1/3' + target_temperature_state_address: '5/1/4' + operation_mode_address: '5/1/5' + operation_mode_state_address: '5/1/6' +``` + +Alternatively, if your device has dedicated binary group addresses for frost/night/comfort mode: + +```yaml +# Example configuration.yaml entry +knx: + climate: + - name: HASS-Kitchen.Temperature + temperature_address: '5/1/1' + setpoint_shift_address: '5/1/2' + setpoint_shift_state_address: '5/1/3' + target_temperature_state_address: '5/1/4' + operation_mode_frost_protection_address: '5/1/5' + operation_mode_night_address: '5/1/6' + operation_mode_comfort_address: '5/1/7' + operation_mode_state_address: '5/1/8' +``` + +If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` +attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address` +to the configuration in this case.: + +```yaml +# Example configuration.yaml entry +knx: + climate: + - name: HASS-Kitchen.Temperature + temperature_address: '5/1/2' + target_temperature_address: '5/1/4' + target_temperature_state_address: '5/1/1' + operation_mode_frost_protection_address: '5/1/5' + operation_mode_night_address: '5/1/6' + operation_mode_comfort_address: '5/1/7' + operation_mode_state_address: '5/1/8' + operation_mode_standby_address: '5/1/9' + min_temp: 7.0 + max_temp: 32.0 +``` + +`setpoint_shift_mode` allows the two following DPTs to be used: + +- DPT6.002 (for 1 byte signed integer) +- DPT9.002 (for 2 byte float) + +Example: + +```yaml +# Example configuration.yaml entry +knx: + climate: + - name: HASS-Kitchen.Temperature + temperature_address: '5/1/1' + setpoint_shift_address: '5/1/2' + setpoint_shift_state_address: '5/1/3' + setpoint_shift_mode: 'DPT9002' + target_temperature_state_address: '5/1/4' + operation_mode_address: '5/1/5' + operation_mode_state_address: '5/1/6' +``` + +`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified. +If the actor doesn't support explicit state communication objects the *_state_address can be configured with the same group address as the writeable *_address. The Read-Flag for the *_state_address communication object has to be set in ETS to support initial reading e.g., when starting Home Assistant. + +The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`: + +- 0 (cooling) +- 1 (heating) + +The following values are valid for the `hvac_mode` attribute: + +- Off (maps internally to HVAC_MODE_OFF within Home Assistant) +- Auto (maps internally to HVAC_MODE_AUTO within Home Assistant) +- Heat (maps internally to HVAC_MDOE_HEAT within Home Assistant) +- Cool (maps internally to HVAC_MDOE_COOL within Home Assistant) +- Fan only (maps internally to HVAC_MODE_FAN_ONLY within Home Assistant) +- Dry (maps internally to HVAC_MODE_DRY within Home Assistant) + +The following presets are valid for the `preset_mode` attribute: + +- Comfort (maps internally to PRESET_COMFORT within Home Assistant) +- Standby (maps internally to PRESET_AWAY within Home Assistant) +- Night (maps internally to PRESET_SLEEP within Home Assistant) +- Frost Protection (maps internally to PRESET_ECO within Home Assistant) + +{% configuration %} +name: + description: A name for this device used within Home Assistant. + required: false + default: KNX Climate + type: string +temperature_address: + description: KNX group address for reading current room temperature from KNX bus. *DPT 9.001* + required: true + type: string +temperature_step: + description: Defines the step size in Kelvin for each step of setpoint_shift. + required: false + type: float + default: 0.1 +target_temperature_address: + description: KNX group address for setting target temperature. *DPT 9.001* + required: false + type: string +target_temperature_state_address: + description: KNX group address for reading current target temperature from KNX bus. *DPT 9.001* + required: true + type: string +setpoint_shift_address: + description: KNX address for setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode* + required: false + type: string +setpoint_shift_state_address: + description: KNX address for reading setpoint_shift. *DPT 6.010 or 9.001 based on setpoint_shift_mode* + required: false + type: string +setpoint_shift_mode: + description: Defines the internal device DPT used. + required: false + default: 0.5 + type: string + default: DPT6010 +setpoint_shift_min: + description: Minimum value of setpoint shift. + required: false + default: -6 + type: float +setpoint_shift_max: + description: Maximum value of setpoint shift. + required: false + default: 6 + type: float +operation_mode_address: + description: KNX address for setting operation mode (Frost protection/night/comfort). *DPT 20.102* + required: false + type: string +operation_mode_state_address: + description: KNX address for reading operation mode. *DPT 20.102* + required: false + type: string +controller_status_address: + description: KNX address for HVAC controller status (in accordance with KNX AN 097/07 rev 3). + required: false + type: string +controller_status_state_address: + description: KNX address for reading HVAC controller status. + required: false + type: string +controller_mode_address: + description: KNX address for setting HVAC controller modes. *DPT 20.105* + required: false + type: string +controller_mode_state_address: + description: KNX address for reading HVAC Control Mode. *DPT 20.105* + required: false + type: string +heat_cool_address: + description: KNX address for switching between heat/cool mode. *DPT 1.100* + required: false + type: string +heat_cool_state_address: + description: KNX address for reading heat/cool mode. *DPT 1.100* + required: false + type: string +operation_mode_frost_protection_address: + description: KNX address for switching on/off frost/heat protection mode. *DPT 1* + required: false + type: string +operation_mode_night_address: + description: KNX address for switching on/off night mode. *DPT 1* + required: false + type: string +operation_mode_comfort_address: + description: KNX address for switching on/off comfort mode. *DPT 1* + required: false + type: string +operation_mode_standby_address: + description: KNX address for switching on/off standby mode. *DPT 1* + required: false + type: string +operation_modes: + description: Overrides the supported operation modes. Provide the supported `hvac_mode` and `preset_mode` values for your device. + required: false + type: list +on_off_address: + description: KNX address for switching the climate device on/off. *DPT 1* + required: false + type: string +on_off_invert: + description: Value for switching the climate device on/off is inverted. + required: false + default: false + type: boolean +on_off_state_address: + description: KNX address for gathering the current state (on/off) of the climate device. *DPT 1* + required: false + type: string +min_temp: + description: Override the minimum temperature. + required: false + type: float +max_temp: + description: Override the maximum temperature. + required: false + type: float +{% endconfiguration %} + +## Cover + +The `knx` cover platform is used as an interface to KNX covers. + +To use your KNX covers in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + cover: + - name: "Kitchen.Shutter" + move_long_address: '3/0/0' + move_short_address: '3/0/1' + stop_address: '3/0/4' + position_address: '3/0/3' + position_state_address: '3/0/2' + travelling_time_down: 51 + travelling_time_up: 61 +``` + +{% configuration %} +name: + description: A name for this device used within Home Assistant. + required: false + default: KNX Cover + type: string +move_long_address: + description: KNX group address for moving the cover full up or down. *DPT 1* + required: false + type: string +move_short_address: + description: KNX group address for moving the cover short time up or down. *DPT 1* + required: false + type: string +stop_address: + description: KNX group address for stopping the current movement from the cover. *DPT 1* + required: false + type: string +position_address: + description: KNX group address for moving the cover to the dedicated position. *DPT 5.001* + required: false + type: string +position_state_address: + description: Separate KNX group address for requesting the current position of the cover. *DPT 5.001* + required: false + type: string +angle_address: + description: KNX group address for moving the cover to the dedicated angle. *DPT 5.001* + required: false + type: string +angle_state_address: + description: Separate KNX group address for requesting the current angle of cover. *DPT 5.001* + required: false + type: string +travelling_time_down: + description: Time cover needs to travel down in seconds. Needed to calculate the intermediate positions of cover while traveling. + required: false + default: 25 + type: integer +travelling_time_up: + description: Time cover needs to travel up in seconds. Needed to calculate the intermediate positions of cover while traveling. + required: false + default: 25 + type: integer +invert_position: + description: Set this to true if your actuator report fully closed as 0% in KNX. + required: false + default: false + type: boolean +invert_angle: + description: Set this to true if your actuator reports tilt fully closed as 0% in KNX. + required: false + default: false + type: boolean +{% endconfiguration %} + +## Light + +The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as: + +- switching actuators +- dimming actuators +- LED controllers +- DALI gateways + +### Configuration + +To use your KNX light in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + light: + - name: 'kitchen' + address: '1/0/9' +``` + +{% configuration %} +address: + description: KNX group address for switching the light on and off. *DPT 1.001* + required: true + type: string +state_address: + description: KNX group address for retrieving the switch state of the light. *DPT 1.001* + required: false + type: string +name: + description: A name for this device used within Home Assistant. + required: false + type: string +brightness_address: + description: KNX group address for setting the brightness of the light in percent (absolute dimming). *DPT 5.001* + required: false + type: string +brightness_state_address: + description: KNX group address for retrieving the brightness of the light in percent. *DPT 5.001* + required: false + type: string +color_address: + description: KNX group address for setting the RGB color of the light. *DPT 232.600* + required: false + type: string +color_state_address: + description: KNX group address for retrieving the RGB color of the light. *DPT 232.600* + required: false + type: string +rgbw_address: + description: KNX group address for setting the RGBW color of the light. *DPT 251.600* + required: false + type: string +rgbw_state_address: + description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600* + required: false + type: string +color_temperature_address: + description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode* + required: false + type: string +color_temperature_state_address: + description: KNX group address for retrieving the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode* + required: false + type: string +color_temperature_mode: + description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001* + required: false + type: string + default: absolute +min_kelvin: + description: Warmest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*) + required: false + type: integer + default: 2700 +max_kelvin: + description: Coldest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*) + required: false + type: integer + default: 6000 +{% endconfiguration %} + +Many KNX devices can change their state internally without a message to the switch address on the KNX bus, e.g., if you configure a scene or a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given `state_address` (in most cases from the light actuator), it will overwrite the state of the switch object. + +For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set `state_address` to the same value as `address`. + +*Note on tunable white:* Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior. + +## Extended configuration example + +```yaml +knx: + light: + # dimmable light + - name: Bedroom-Light-1 + address: '1/0/9' + state_address: '1/1/9' + brightness_address: '1/2/9' + brightness_state_address: '1/3/9' + # + # RGB light + - name: Bathroom-Light-1 + address: '1/0/9' + state_address: '1/1/9' + brightness_address: '1/2/9' + brightness_state_address: '1/3/9' + color_address: '1/4/9' + color_state_address: '1/5/9' + # + # tunable white light + - name: Office-Light-1 + address: '1/0/21' + state_address: '1/1/21' + brightness_address: '1/2/21' + brightness_state_address: '1/3/21' + color_temperature_address: '1/4/21' + color_temperature_state_address: '1/5/21' + color_temperature_mode: absolute + min_kelvin: 2550 + max_kelvin: 6200 + # + # actuator without dedicated state communication object + - name: Cellar-Light-1 + address: '1/0/5' + state_address: '1/0/5' +``` + +## Notify + +The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices. + +### Configuration + +To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +knx: + notify: + - name: Alarm + address: '5/1/10' +``` + +{% configuration %} +address: + description: KNX group address of the notification. *DPT 16.000* + required: true + type: string +name: + description: A name for this device used within Home Assistant. + required: false + type: string +{% endconfiguration %} +The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes. + +## Scene + +### Configuration + +To use your KNX scene in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + scene: + - name: Romantic + address: 8/8/8 + scene_number: 23 +``` + +{% configuration %} +address: + description: KNX group address for the scene. *DPT 17.001* + required: true + type: string +scene_number: + description: KNX scene number to be activated. ( 1 ... 64 ) + required: true + type: integer +name: + description: A name for this device used within Home Assistant. + required: false + type: string +{% endconfiguration %} + +## Sensor + +The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors. + +Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). + + +### Configuration + +To use your KNX sensor in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + sensor: + - name: Heating.Valve1 + state_address: '2/0/0' +``` + +In order to actively read the sensor data from the bus all 30 seconds you can add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + sensor: + - name: Heating.Valve1 + state_address: '2/0/0' + sync_state: expire 30 +``` + +{% configuration %} +state_address: + description: KNX group address of the sensor. + required: true + type: string +name: + description: A name for this device used within Home Assistant. + required: false + type: string +sync_state: + description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire ` to read the state from the KNX bus when no telegram was received for \ or `every ` to update it regularly every \. Maximum value for \ is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60". + required: false + type: [boolean, string, integer] + default: True +type: + description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. + required: true + type: string +{% endconfiguration %} + +| KNX DPT | type | size in byte | range | unit | +|--------:|-------------------------------|-------------:|:--------------------------:|----------------| +| 5.001 | percent | 1 | 0 ... 100 | % | +| 5.003 | angle | 1 | 0 ... 360 | ° | +| 5.004 | percentU8 | 1 | 0 ... 255 | % | +| 5.010 | pulse | 1 | 0 ... 255 | | +| 5.010 | 1byte_unsigned | 1 | 0 ... 255 | | +| 6.001 | percentV8 | 1 | -128 ... 127 | % | +| 6.010 | counter_pulses | 1 | -128 ... 127 | counter pulses | +| 7.001 | 2byte_unsigned | 2 | 0 ... 65535 | pulses | +| 7.002 | time_period_msec | 2 | 0 ... 65535 | ms | +| 7.003 | time_period_10msec | 2 | 0 ... 65535 | ms | +| 7.004 | time_period_100msec | 2 | 0 ... 65535 | ms | +| 7.005 | time_period_sec | 2 | 0 ... 65535 | s | +| 7.006 | time_period_min | 2 | 0 ... 65535 | min | +| 7.007 | time_period_hrs | 2 | 0 ... 65535 | h | +| 7.011 | length_mm | 2 | 0 ... 65535 | mm | +| 7.012 | current | 2 | 0 ... 65535 | mA | +| 7.013 | brightness | 2 | 0 ... 65535 | lx | +| 7.600 | color_temperature | 2 | 0 ... 65535 | K | +| 8.001 | 2byte_signed | 2 | -32768 ... 32767 | pulses | +| 8.002 | delta_time_ms | 2 | -32768 ... 32767 | ms | +| 8.005 | delta_time_sec | 2 | -32768 ... 32767 | s | +| 8.006 | delta_time_min | 2 | -32768 ... 32767 | min | +| 8.007 | delta_time_hrs | 2 | -32768 ... 32767 | h | +| 8.010 | percentV16 | 2 | -32768 ... 32767 | % | +| 8.011 | rotation_angle | 2 | -32768 ... 32767 | ° | +| 9.* | enthalpy | 2 | -671088.64 ... 670760.96 | H | +| 9.001 | temperature | 2 | -273 ... 670760 | °C | +| 9.002 | temperature_difference_2byte | 2 | -670760 ... 670760 | K | +| 9.003 | temperature_a | 2 | -670760 ... 670760 | K/h | +| 9.004 | illuminance | 2 | 0 ... 670760 | lx | +| 9.005 | wind_speed_ms | 2 | 0 ... 670760 | m/s | +| 9.006 | pressure_2byte | 2 | 0 ... 670760 | Pa | +| 9.007 | humidity | 2 | 0 ... 670760 | % | +| 9.008 | ppm | 2 | -671088.64 ... 670760.96 | ppm | +| 9.010 | time_1 | 2 | -670760 ... 670760 | s | +| 9.011 | time_2 | 2 | -670760 ... 670760 | ms | +| 9.020 | voltage | 2 | -671088.64 ... 670760.96 | mV | +| 9.022 | power_density | 2 | -671088.64 ... 670760.96 | W/m² | +| 9.023 | kelvin_per_percent | 2 | -671088.64 ... 670760.96 | K/% | +| 9.024 | power_2byte | 2 | -671088.64 ... 670760.96 | kW | +| 9.025 | volume_flow | 2 | -671088.64 ... 670760.96 | l/h | +| 9.026 | rain_amount | 2 | -671088.64 ... 670760.96 | l/m² | +| 9.027 | temperature_f | 2 | -459.6 ... 670760 | °F | +| 9.028 | wind_speed_kmh | 2 | 0 ... 670760 | km/h | +| 12.*** | 4byte_unsigned | 4 | 0 ... 4294967295 | | +| 13.*** | 4byte_signed | 4 | -2147483648 ... 2147483647 | | +| 13.002 | flow_rate_m3h | 4 | -2147483648 ... 2147483647 | m³/h | +| 13.010 | active_energy | 4 | -2147483648 ... 2147483647 | Wh | +| 13.011 | apparant_energy | 4 | -2147483648 ... 2147483647 | VAh | +| 13.012 | reactive_energy | 4 | -2147483648 ... 2147483647 | VARh | +| 13.013 | active_energy_kwh | 4 | -2147483648 ... 2147483647 | kWh | +| 13.014 | apparant_energy_kvah | 4 | -2147483648 ... 2147483647 | kVAh | +| 13.015 | reactive_energy_kvarh | 4 | -2147483648 ... 2147483647 | kVARh | +| 13.100 | long_delta_timesec | 4 | -2147483648 ... 2147483647 | s | +| 14.000 | acceleration | 4 | | m/s² | +| 14.*** | 4byte_float | 4 | | | +| 14.001 | acceleration_angular | 4 | | rad/s² | +| 14.002 | activation_energy | 4 | | J/mol | +| 14.003 | activity | 4 | | s⁻¹ | +| 14.004 | mol | 4 | | mol | +| 14.005 | amplitude | 4 | | | +| 14.006 | angle_rad | 4 | | rad | +| 14.007 | angle_deg | 4 | | ° | +| 14.008 | angular_momentum | 4 | | J s | +| 14.009 | angular_velocity | 4 | | rad/s | +| 14.010 | area | 4 | | m² | +| 14.011 | capacitance | 4 | | F | +| 14.012 | charge_density_surface | 4 | | C/m² | +| 14.013 | charge_density_volume | 4 | | C/m³ | +| 14.014 | compressibility | 4 | | m²/N | +| 14.015 | conductance | 4 | | S | +| 14.016 | electrical_conductivity | 4 | | S/m | +| 14.017 | density | 4 | | kg/m³ | +| 14.018 | electric_charge | 4 | | C | +| 14.019 | electric_current | 4 | | A | +| 14.020 | electric_current_density | 4 | | A/m² | +| 14.021 | electric_dipole_moment | 4 | | C m | +| 14.022 | electric_displacement | 4 | | C/m² | +| 14.023 | electric_field_strength | 4 | | V/m | +| 14.024 | electric_flux | 4 | | c | +| 14.025 | electric_flux_density | 4 | | C/m² | +| 14.026 | electric_polarization | 4 | | C/m² | +| 14.027 | electric_potential | 4 | | V | +| 14.028 | electric_potential_difference | 4 | | V | +| 14.029 | electromagnetic_moment | 4 | | A m² | +| 14.030 | electromotive_force | 4 | | V | +| 14.031 | energy | 4 | | J | +| 14.032 | force | 4 | | N | +| 14.033 | frequency | 4 | | Hz | +| 14.034 | angular_frequency | 4 | | rad/s | +| 14.035 | heatcapacity | 4 | | J/K | +| 14.036 | heatflowrate | 4 | | W | +| 14.037 | heat_quantity | 4 | | J | +| 14.038 | impedance | 4 | | Ω | +| 14.039 | length | 4 | | m | +| 14.040 | light_quantity | 4 | | lm s | +| 14.041 | luminance | 4 | | cd/m² | +| 14.042 | luminous_flux | 4 | | lm | +| 14.043 | luminous_intensity | 4 | | cd | +| 14.044 | magnetic_field_strength | 4 | | A/m | +| 14.045 | magnetic_flux | 4 | | Wb | +| 14.046 | magnetic_flux_density | 4 | | T | +| 14.047 | magnetic_moment | 4 | | A m² | +| 14.048 | magnetic_polarization | 4 | | T | +| 14.049 | magnetization | 4 | | A/m | +| 14.050 | magnetomotive_force | 4 | | A | +| 14.051 | mass | 4 | | kg | +| 14.052 | mass_flux | 4 | | kg/s | +| 14.053 | momentum | 4 | | N/s | +| 14.054 | phaseanglerad | 4 | | rad | +| 14.055 | phaseangledeg | 4 | | ° | +| 14.056 | power | 4 | | W | +| 14.057 | powerfactor | 4 | | cosΦ | +| 14.058 | pressure | 4 | | Pa | +| 14.059 | reactance | 4 | | Ω | +| 14.060 | resistance | 4 | | Ω | +| 14.061 | resistivity | 4 | | Ω m | +| 14.062 | self_inductance | 4 | | H | +| 14.063 | solid_angle | 4 | | sr | +| 14.064 | sound_intensity | 4 | | W/m² | +| 14.065 | speed | 4 | | m/s | +| 14.066 | stress | 4 | | Pa | +| 14.067 | surface_tension | 4 | | N/m | +| 14.068 | common_temperature | 4 | | °C | +| 14.069 | absolute_temperature | 4 | | K | +| 14.070 | temperature_difference | 4 | | K | +| 14.071 | thermal_capacity | 4 | | J/K | +| 14.072 | thermal_conductivity | 4 | | W/mK | +| 14.073 | thermoelectric_power | 4 | | V/K | +| 14.074 | time_seconds | 4 | | s | +| 14.075 | torque | 4 | | N m | +| 14.076 | volume | 4 | | m³ | +| 14.077 | volume_flux | 4 | | m³/s | +| 14.078 | weight | 4 | | N | +| 14.079 | work | 4 | | J | +| 16.000 | string | 14 | | | +| 17.001 | scene_number | 1 | 1 ... 64 | | + +### Full example + +```yaml +# Example configuration.yaml entry +knx: + sensor: + - name: Heating.Valve1 + state_address: '2/0/0' + sync_state: init + type: 'percent' + - name: Kitchen.Temperature + state_address: '6/2/1' + sync_state: every 60 + type: 'temperature' +``` + +## Switch + +The `knx` switch platform is used as an interface to switching actuators. + +### Configuration + +To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +knx: + switch: + - name: Kitchen.Coffee + address: '1/1/6' +``` + +{% configuration %} +address: + description: KNX group address for switching the switch on/off. *DPT 1* + required: true + type: string +name: + description: A name for this device used within Home Assistant. + required: false + default: KNX Switch + type: string +state_address: + description: Separate KNX group address for retrieving the switch state. *DPT 1* + required: false + type: string +{% endconfiguration %} + +Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. +For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. + +## Weather + +The `knx` weather platform is used as an interface to KNX weather stations. + +To use your KNX weather station in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +knx: + weather: + - name: "home" + address_temperature: "7/0/0" + address_brightness_south: "7/0/1" + address_brightness_west: "7/0/2" + address_brightness_east: "7/0/3" + address_wind_speed: "7/0/4" + address_rain_alarm: "7/0/5" + address_frost_alarm: "7/0/6" + address_wind_alarm: "7/0/7" + address_day_night: "7/0/8" + address_air_pressure: "7/0/9" + address_humidity: "7/0/10" + expose_sensors: False + sync_state: True +``` + +{% configuration %} +name: + description: A name for this device used within Home Assistant. + required: false + default: KNX Weather + type: string +address_temperature: + description: KNX group address for reading current outside temperature from KNX bus. *DPT 9.001* + required: true + type: string +address_brightness_south: + description: KNX group address for reading current brightness to south coordinate from KNX bus. *DPT 9.004* + required: false + type: string +address_brightness_west: + description: KNX group address for reading current brightness to west coordinate from KNX bus. *DPT 9.004* + required: false + type: string +address_brightness_east: + description: KNX group address for reading current brightness to east coordinate from KNX bus. *DPT 9.004* + required: false + type: string +address_wind_speed: + description: KNX group address for reading current wind speed from KNX bus. *DPT 9.005* + required: false + type: string +address_rain_alarm: + description: KNX group address for reading if rain alarm is on/off. + required: false + type: string +address_frost_alarm: + description: KNX group address for reading if frost alarm is on/off. + required: false + type: string +address_wind_alarm: + description: KNX group address for reading if wind alarm is on/off. + required: false + type: string +address_day_night: + description: KNX group address for reading if it's day/night. + required: false + type: string +address_air_pressure: + description: KNX address reading current air pressure. *DPT 9.006* + required: false + type: string +address_humidity: + description: KNX address for reading current humidity. *DPT 9.007* + required: false + type: string +expose_sensors: + description: If true, exposes all sensor values as dedicated sensors to HA. + required: false + type: boolean + default: False +sync_state: + description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. + required: false + type: boolean + default: True +{% endconfiguration %} diff --git a/source/_integrations/light.knx.markdown b/source/_integrations/light.knx.markdown deleted file mode 100644 index 22cf1510fc7..00000000000 --- a/source/_integrations/light.knx.markdown +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "KNX Light" -description: "Instructions on how to integrate KNX lights with Home Assistant." -ha_category: - - Light -ha_release: 0.44 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx light` integration is used as an interface to control KNX actuators for lighting applications such as: - -- switching actuators -- dimming actuators -- LED controllers -- DALI gateways - -## Configuration - -To use your KNX light in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - light: - - name: 'kitchen' - address: '1/0/9' -``` - -{% configuration %} -address: - description: KNX group address for switching the light on and off. *DPT 1.001* - required: true - type: string -state_address: - description: KNX group address for retrieving the switch state of the light. *DPT 1.001* - required: false - type: string -name: - description: A name for this device used within Home Assistant. - required: false - type: string -brightness_address: - description: KNX group address for setting the brightness of the light in percent (absolute dimming). *DPT 5.001* - required: false - type: string -brightness_state_address: - description: KNX group address for retrieving the brightness of the light in percent. *DPT 5.001* - required: false - type: string -color_address: - description: KNX group address for setting the RGB color of the light. *DPT 232.600* - required: false - type: string -color_state_address: - description: KNX group address for retrieving the RGB color of the light. *DPT 232.600* - required: false - type: string -rgbw_address: - description: KNX group address for setting the RGBW color of the light. *DPT 251.600* - required: false - type: string -rgbw_state_address: - description: KNX group address for retrieving the RGBW color of the light. *DPT 251.600* - required: false - type: string -color_temperature_address: - description: KNX group address for setting the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode* - required: false - type: string -color_temperature_state_address: - description: KNX group address for retrieving the color temperature of the light. *DPT 5.001 or 7.600 based on color_temperature_mode* - required: false - type: string -color_temperature_mode: - description: Color temperature group address data type. `absolute` color temperature in Kelvin. *color_temperature_address -> DPT 7.600*. `relative` color temperature in percent cold white (0% warmest; 100% coldest). *color_temperature_address -> DPT 5.001* - required: false - type: string - default: absolute -min_kelvin: - description: Warmest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*) - required: false - type: integer - default: 2700 -max_kelvin: - description: Coldest possible color temperature in Kelvin. (Used in combination with *color_temperature_address*) - required: false - type: integer - default: 6000 -{% endconfiguration %} - -Many KNX devices can change their state internally without a message to the switch address on the KNX bus, e.g., if you configure a scene or a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given `state_address` (in most cases from the light actuator), it will overwrite the state of the switch object. - -For switching/light actuators that are only controlled by a single group address and don't have dedicated state communication objects you can set `state_address` to the same value as `address`. - -*Note on tunable white:* Home Assistant uses Mireds as the unit for color temperature, whereas KNX typically uses Kelvin. The Kelvin/Mireds relationship is reciprocal, not linear, therefore the color temperature pickers (sliders) in Home Assistant may not align with ones of KNX visualizations. This is the expected behavior. - -## Extended configuration example - -```yaml -knx: - light: - # dimmable light - - name: Bedroom-Light-1 - address: '1/0/9' - state_address: '1/1/9' - brightness_address: '1/2/9' - brightness_state_address: '1/3/9' - # - # RGB light - - name: Bathroom-Light-1 - address: '1/0/9' - state_address: '1/1/9' - brightness_address: '1/2/9' - brightness_state_address: '1/3/9' - color_address: '1/4/9' - color_state_address: '1/5/9' - # - # tunable white light - - name: Office-Light-1 - address: '1/0/21' - state_address: '1/1/21' - brightness_address: '1/2/21' - brightness_state_address: '1/3/21' - color_temperature_address: '1/4/21' - color_temperature_state_address: '1/5/21' - color_temperature_mode: absolute - min_kelvin: 2550 - max_kelvin: 6200 - # - # actuator without dedicated state communication object - - name: Cellar-Light-1 - address: '1/0/5' - state_address: '1/0/5' -``` diff --git a/source/_integrations/notify.knx.markdown b/source/_integrations/notify.knx.markdown deleted file mode 100644 index 2b8f344ba40..00000000000 --- a/source/_integrations/notify.knx.markdown +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "KNX Notify" -description: "Instructions on how to use the KNX notify with Home Assistant." -ha_category: - - Notifications -ha_release: 0.53 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` notify platform allows you to send notifications to [KNX](https://www.knx.org/) devices. - -## Configuration - -To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -knx: - notify: - - name: Alarm - address: '5/1/10' -``` - -{% configuration %} -address: - description: KNX group address of the notification. *DPT 16.000* - required: true - type: string -name: - description: A name for this device used within Home Assistant. - required: false - type: string -{% endconfiguration %} diff --git a/source/_integrations/scene.knx.markdown b/source/_integrations/scene.knx.markdown deleted file mode 100644 index 4a99b63ba86..00000000000 --- a/source/_integrations/scene.knx.markdown +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "KNX Scene" -description: "Instructions on how to integrate KNX Scenes into Home Assistant." -ha_category: - - Scene -ha_release: 0.63 -ha_domain: knx ---- - -The `knx` scenes platform allows you to trigger [KNX](https://www.knx.org/) scenes. - -## Configuration - -To use your KNX scence in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - scene: - - name: Romantic - address: 8/8/8 - scene_number: 23 -``` - -{% configuration %} -address: - description: KNX group address for the scene. *DPT 17.001* - required: true - type: string -scene_number: - description: KNX scene number to be activated. ( 1 ... 64 ) - required: true - type: integer -name: - description: A name for this device used within Home Assistant. - required: false - type: string -{% endconfiguration %} diff --git a/source/_integrations/sensor.knx.markdown b/source/_integrations/sensor.knx.markdown deleted file mode 100644 index 935204d6b85..00000000000 --- a/source/_integrations/sensor.knx.markdown +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: "KNX Sensor" -description: "Instructions on how to use a KNX Sensor with Home Assistant." -ha_category: - - Sensor -ha_release: 0.29 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors. - -Sensors are read-only. To write to the knx-bus configure an exposure [KNX Integration - Expose](/integrations/knx/#exposing-sensor-values-or-time-to-knx-bus). - - -## Configuration - -To use your KNX sensor in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - sensor: - - name: Heating.Valve1 - state_address: '2/0/0' -``` - -In order to actively read the sensor data from the bus all 30 seconds you can add the following lines to your `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - sensor: - - name: Heating.Valve1 - state_address: '2/0/0' - sync_state: expire 30 -``` - -{% configuration %} -state_address: - description: KNX group address of the sensor. - required: true - type: string -name: - description: A name for this device used within Home Assistant. - required: false - type: string -sync_state: - description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. `sync_state` can be set to `init` to just initialize state on startup, `expire ` to read the state from the KNX bus when no telegram was received for \ or `every ` to update it regularly every \. Maximum value for \ is 1440. If just a number is configured "expire"-behaviour is used. Defaults to `True` which is interpreted as "expire 60". - required: false - type: [boolean, string, integer] - default: True -type: - description: A type from the following table must be defined. The DPT of the group address should match the expected KNX DPT to be parsed correctly. - required: true - type: string -{% endconfiguration %} - -| KNX DPT | type | size in byte | range | unit | -|--------:|-------------------------------|-------------:|:--------------------------:|----------------| -| 5.001 | percent | 1 | 0 ... 100 | % | -| 5.003 | angle | 1 | 0 ... 360 | ° | -| 5.004 | percentU8 | 1 | 0 ... 255 | % | -| 5.010 | pulse | 1 | 0 ... 255 | | -| 5.010 | 1byte_unsigned | 1 | 0 ... 255 | | -| 6.001 | percentV8 | 1 | -128 ... 127 | % | -| 6.010 | counter_pulses | 1 | -128 ... 127 | counter pulses | -| 7.001 | 2byte_unsigned | 2 | 0 ... 65535 | pulses | -| 7.002 | time_period_msec | 2 | 0 ... 65535 | ms | -| 7.003 | time_period_10msec | 2 | 0 ... 65535 | ms | -| 7.004 | time_period_100msec | 2 | 0 ... 65535 | ms | -| 7.005 | time_period_sec | 2 | 0 ... 65535 | s | -| 7.006 | time_period_min | 2 | 0 ... 65535 | min | -| 7.007 | time_period_hrs | 2 | 0 ... 65535 | h | -| 7.011 | length_mm | 2 | 0 ... 65535 | mm | -| 7.012 | current | 2 | 0 ... 65535 | mA | -| 7.013 | brightness | 2 | 0 ... 65535 | lx | -| 7.600 | color_temperature | 2 | 0 ... 65535 | K | -| 8.001 | 2byte_signed | 2 | -32768 ... 32767 | pulses | -| 8.002 | delta_time_ms | 2 | -32768 ... 32767 | ms | -| 8.005 | delta_time_sec | 2 | -32768 ... 32767 | s | -| 8.006 | delta_time_min | 2 | -32768 ... 32767 | min | -| 8.007 | delta_time_hrs | 2 | -32768 ... 32767 | h | -| 8.010 | percentV16 | 2 | -32768 ... 32767 | % | -| 8.011 | rotation_angle | 2 | -32768 ... 32767 | ° | -| 9.* | enthalpy | 2 | -671088.64 ... 670760.96 | H | -| 9.001 | temperature | 2 | -273 ... 670760 | °C | -| 9.002 | temperature_difference_2byte | 2 | -670760 ... 670760 | K | -| 9.003 | temperature_a | 2 | -670760 ... 670760 | K/h | -| 9.004 | illuminance | 2 | 0 ... 670760 | lx | -| 9.005 | wind_speed_ms | 2 | 0 ... 670760 | m/s | -| 9.006 | pressure_2byte | 2 | 0 ... 670760 | Pa | -| 9.007 | humidity | 2 | 0 ... 670760 | % | -| 9.008 | ppm | 2 | -671088.64 ... 670760.96 | ppm | -| 9.010 | time_1 | 2 | -670760 ... 670760 | s | -| 9.011 | time_2 | 2 | -670760 ... 670760 | ms | -| 9.020 | voltage | 2 | -671088.64 ... 670760.96 | mV | -| 9.022 | power_density | 2 | -671088.64 ... 670760.96 | W/m² | -| 9.023 | kelvin_per_percent | 2 | -671088.64 ... 670760.96 | K/% | -| 9.024 | power_2byte | 2 | -671088.64 ... 670760.96 | kW | -| 9.025 | volume_flow | 2 | -671088.64 ... 670760.96 | l/h | -| 9.026 | rain_amount | 2 | -671088.64 ... 670760.96 | l/m² | -| 9.027 | temperature_f | 2 | -459.6 ... 670760 | °F | -| 9.028 | wind_speed_kmh | 2 | 0 ... 670760 | km/h | -| 12.*** | 4byte_unsigned | 4 | 0 ... 4294967295 | | -| 13.*** | 4byte_signed | 4 | -2147483648 ... 2147483647 | | -| 13.002 | flow_rate_m3h | 4 | -2147483648 ... 2147483647 | m³/h | -| 13.010 | active_energy | 4 | -2147483648 ... 2147483647 | Wh | -| 13.011 | apparant_energy | 4 | -2147483648 ... 2147483647 | VAh | -| 13.012 | reactive_energy | 4 | -2147483648 ... 2147483647 | VARh | -| 13.013 | active_energy_kwh | 4 | -2147483648 ... 2147483647 | kWh | -| 13.014 | apparant_energy_kvah | 4 | -2147483648 ... 2147483647 | kVAh | -| 13.015 | reactive_energy_kvarh | 4 | -2147483648 ... 2147483647 | kVARh | -| 13.100 | long_delta_timesec | 4 | -2147483648 ... 2147483647 | s | -| 14.000 | acceleration | 4 | | m/s² | -| 14.*** | 4byte_float | 4 | | | -| 14.001 | acceleration_angular | 4 | | rad/s² | -| 14.002 | activation_energy | 4 | | J/mol | -| 14.003 | activity | 4 | | s⁻¹ | -| 14.004 | mol | 4 | | mol | -| 14.005 | amplitude | 4 | | | -| 14.006 | angle_rad | 4 | | rad | -| 14.007 | angle_deg | 4 | | ° | -| 14.008 | angular_momentum | 4 | | J s | -| 14.009 | angular_velocity | 4 | | rad/s | -| 14.010 | area | 4 | | m² | -| 14.011 | capacitance | 4 | | F | -| 14.012 | charge_density_surface | 4 | | C/m² | -| 14.013 | charge_density_volume | 4 | | C/m³ | -| 14.014 | compressibility | 4 | | m²/N | -| 14.015 | conductance | 4 | | S | -| 14.016 | electrical_conductivity | 4 | | S/m | -| 14.017 | density | 4 | | kg/m³ | -| 14.018 | electric_charge | 4 | | C | -| 14.019 | electric_current | 4 | | A | -| 14.020 | electric_current_density | 4 | | A/m² | -| 14.021 | electric_dipole_moment | 4 | | C m | -| 14.022 | electric_displacement | 4 | | C/m² | -| 14.023 | electric_field_strength | 4 | | V/m | -| 14.024 | electric_flux | 4 | | c | -| 14.025 | electric_flux_density | 4 | | C/m² | -| 14.026 | electric_polarization | 4 | | C/m² | -| 14.027 | electric_potential | 4 | | V | -| 14.028 | electric_potential_difference | 4 | | V | -| 14.029 | electromagnetic_moment | 4 | | A m² | -| 14.030 | electromotive_force | 4 | | V | -| 14.031 | energy | 4 | | J | -| 14.032 | force | 4 | | N | -| 14.033 | frequency | 4 | | Hz | -| 14.034 | angular_frequency | 4 | | rad/s | -| 14.035 | heatcapacity | 4 | | J/K | -| 14.036 | heatflowrate | 4 | | W | -| 14.037 | heat_quantity | 4 | | J | -| 14.038 | impedance | 4 | | Ω | -| 14.039 | length | 4 | | m | -| 14.040 | light_quantity | 4 | | lm s | -| 14.041 | luminance | 4 | | cd/m² | -| 14.042 | luminous_flux | 4 | | lm | -| 14.043 | luminous_intensity | 4 | | cd | -| 14.044 | magnetic_field_strength | 4 | | A/m | -| 14.045 | magnetic_flux | 4 | | Wb | -| 14.046 | magnetic_flux_density | 4 | | T | -| 14.047 | magnetic_moment | 4 | | A m² | -| 14.048 | magnetic_polarization | 4 | | T | -| 14.049 | magnetization | 4 | | A/m | -| 14.050 | magnetomotive_force | 4 | | A | -| 14.051 | mass | 4 | | kg | -| 14.052 | mass_flux | 4 | | kg/s | -| 14.053 | momentum | 4 | | N/s | -| 14.054 | phaseanglerad | 4 | | rad | -| 14.055 | phaseangledeg | 4 | | ° | -| 14.056 | power | 4 | | W | -| 14.057 | powerfactor | 4 | | cosΦ | -| 14.058 | pressure | 4 | | Pa | -| 14.059 | reactance | 4 | | Ω | -| 14.060 | resistance | 4 | | Ω | -| 14.061 | resistivity | 4 | | Ω m | -| 14.062 | self_inductance | 4 | | H | -| 14.063 | solid_angle | 4 | | sr | -| 14.064 | sound_intensity | 4 | | W/m² | -| 14.065 | speed | 4 | | m/s | -| 14.066 | stress | 4 | | Pa | -| 14.067 | surface_tension | 4 | | N/m | -| 14.068 | common_temperature | 4 | | °C | -| 14.069 | absolute_temperature | 4 | | K | -| 14.070 | temperature_difference | 4 | | K | -| 14.071 | thermal_capacity | 4 | | J/K | -| 14.072 | thermal_conductivity | 4 | | W/mK | -| 14.073 | thermoelectric_power | 4 | | V/K | -| 14.074 | time_seconds | 4 | | s | -| 14.075 | torque | 4 | | N m | -| 14.076 | volume | 4 | | m³ | -| 14.077 | volume_flux | 4 | | m³/s | -| 14.078 | weight | 4 | | N | -| 14.079 | work | 4 | | J | -| 16.000 | string | 14 | | | -| 17.001 | scene_number | 1 | 1 ... 64 | | - -## Full example - -```yaml -# Example configuration.yaml entry -knx: - sensor: - - name: Heating.Valve1 - state_address: '2/0/0' - sync_state: init - type: 'percent' - - name: Kitchen.Temperature - state_address: '6/2/1' - sync_state: every 60 - type: 'temperature' -``` diff --git a/source/_integrations/switch.knx.markdown b/source/_integrations/switch.knx.markdown deleted file mode 100644 index 2ba783165c6..00000000000 --- a/source/_integrations/switch.knx.markdown +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "KNX Switch" -description: "Instructions on how to integrate KNX switches with Home Assistant." -ha_category: - - Switch -ha_release: 0.24 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` switch platform is used as an interface to switching actuators. - -## Configuration - -To use your KNX switch in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -knx: - switch: - - name: Kitchen.Coffee - address: '1/1/6' -``` - -{% configuration %} -address: - description: KNX group address for switching the switch on/off. *DPT 1* - required: true - type: string -name: - description: A name for this device used within Home Assistant. - required: false - default: KNX Switch - type: string -state_address: - description: Separate KNX group address for retrieving the switch state. *DPT 1* - required: false - type: string -{% endconfiguration %} - -Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. -For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. diff --git a/source/_integrations/weather.knx.markdown b/source/_integrations/weather.knx.markdown deleted file mode 100644 index a0ee0c13288..00000000000 --- a/source/_integrations/weather.knx.markdown +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "KNX Weather" -description: "Instructions on how to integrate KNX weather stations with Home Assistant." -ha_category: - - Weather -ha_release: 0.115 -ha_iot_class: Local Push -ha_domain: knx ---- - -The `knx` weather platform is used as an interface to KNX weather stations. - -To use your KNX weather station in your installation, add the following lines to your top level [KNX Integration](/integrations/knx) configuration key in `configuration.yaml`: - -```yaml -# Example configuration.yaml entry -knx: - weather: - - name: "home" - address_temperature: "7/0/0" - address_brightness_south: "7/0/1" - address_brightness_west: "7/0/2" - address_brightness_east: "7/0/3" - address_wind_speed: "7/0/4" - address_rain_alarm: "7/0/5" - address_frost_alarm: "7/0/6" - address_wind_alarm: "7/0/7" - address_day_night: "7/0/8" - address_air_pressure: "7/0/9" - address_humidity: "7/0/10" - expose_sensors: False - sync_state: True -``` - -{% configuration %} -name: - description: A name for this device used within Home Assistant. - required: false - default: KNX Weather - type: string -address_temperature: - description: KNX group address for reading current outside temperature from KNX bus. *DPT 9.001* - required: true - type: string -address_brightness_south: - description: KNX group address for reading current brightness to south coordinate from KNX bus. *DPT 9.004* - required: false - type: string -address_brightness_west: - description: KNX group address for reading current brightness to west coordinate from KNX bus. *DPT 9.004* - required: false - type: string -address_brightness_east: - description: KNX group address for reading current brightness to east coordinate from KNX bus. *DPT 9.004* - required: false - type: string -address_wind_speed: - description: KNX group address for reading current wind speed from KNX bus. *DPT 9.005* - required: false - type: string -address_rain_alarm: - description: KNX group address for reading if rain alarm is on/off. - required: false - type: string -address_frost_alarm: - description: KNX group address for reading if frost alarm is on/off. - required: false - type: string -address_wind_alarm: - description: KNX group address for reading if wind alarm is on/off. - required: false - type: string -address_day_night: - description: KNX group address for reading if it's day/night. - required: false - type: string -address_air_pressure: - description: KNX address reading current air pressure. *DPT 9.006* - required: false - type: string -address_humidity: - description: KNX address for reading current humidity. *DPT 9.007* - required: false - type: string -expose_sensors: - description: If true, exposes all sensor values as dedicated sensors to HA. - required: false - type: boolean - default: False -sync_state: - description: Actively read the value from the bus. If `False` no GroupValueRead telegrams will be sent to the bus. - required: false - type: boolean - default: True -{% endconfiguration %} diff --git a/source/_redirects b/source/_redirects index 3b6702c79c9..8a08df1d0dd 100644 --- a/source/_redirects +++ b/source/_redirects @@ -2056,6 +2056,15 @@ /ecosystem/notebooks/installation https://data.home-assistant.io /ecosystem/notebooks/stats https://data.home-assistant.io /ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started +/integrations/binary_sensor.knx /integrations/knx#binary-sensor +/integrations/climate.knx /integrations/knx#climate +/integrations/cover.knx /integrations/knx#cover +/integrations/light.knx /integrations/knx#light +/integrations/notify.knx /integrations/knx#notify +/integrations/scene.knx /integrations/knx#scene +/integrations/sensor.knx /integrations/knx#sensor +/integrations/switch.knx /integrations/knx#switch +/integrations/weather.knx /integrations/knx#weather # Migrated Community Guides /cookbook/apache_configuration https://community.home-assistant.io/t/reverse-proxy-with-apache/196942