Lock

class st.zigbee.defaults.lock
zigbee_handlers: table
attribute_configurations: table
capability_handlers: table
static lock_operation_event_handler(driver, device, zb_rx)

Default handler for lock OperatingEventNotification cluster command

This will look at the event_source, event_value, and user_id to generate a lock.lock event with the appropriate value and data.

Parameters
  • driver (ZigbeeDriver) – The current driver running containing necessary context for execution

  • device (st.zigbee.Device) – The device this message was received from containing identifying information

  • zb_rx (st.zigbee.ZigbeeMessageRx) – the full message this report came in

static lock_state_handler(driver, device, value, zb_rx)

Default handler for lock state attribute on the door lock cluster

This converts the lock state value to the appropriate value

Parameters
  • driver (Driver) – The current driver running containing necessary context for execution

  • device (st.zigbee.Device) – The device this message was received from containing identifying information

  • value (LockState) – the value of the door lock cluster lock state attribute

  • zb_rx (st.zigbee.ZigbeeMessageRx) – the full message this report came in

static lock(driver, device, command)

Default handler for the Lock.lock command

This will send the lock command to the door lock cluster

Parameters
  • driver (Driver) – The current driver running containing necessary context for execution

  • device (st.Device) – The device this message was received from containing identifying information

  • command (table) – The capability command table

static unlock(driver, device, command)

Default handler for the Lock.unlock command

This will send the unlock command to the door lock cluster

Parameters
  • driver (Driver) – The current driver running containing necessary context for execution

  • device (st.Device) – The device this message was received from containing identifying information

  • command (table) – The capability command table