Link Search Menu Expand Document

Sensor - Monitor values of KNX

Overview

Sensors are monitoring temperature, air humidity, pressure etc. from KNX bus.

Interface

  • xknx is the XKNX object.
  • name is the name of the object.
  • group_address_state is the KNX group address of the sensor device.
  • sync_state defines if the value should be actively read from the bus. If False no GroupValueRead telegrams will be sent to its group address. Defaults to True
  • always_callback defines if a callback/update should always be triggered no matter if the previous and the new state are identical.
  • value_type controls how the value should be rendered in a human readable representation. The attribut may have may have the values percent, temperature, illuminance, speed_ms or current.
  • device_updated_cb awaitable callback for each update.

Example

sensor = Sensor(
    xknx=xknx,
    name='DiningRoom.Temperature.Sensor',
    always_callback=False,
    group_address_state='6/2/1',
    sync_state=True,
    value_type='temperature'
)

# Requesting current state via KNX GroupValueRead from the bus
await sensor.sync(wait_for_result=True)

# Returns the value of in a human readable way
sensor.resolve_state()

# Returns the unit of the value as string
sensor.unit_of_measurement()

# Returns the last received telegram or None
sensor.last_telegram