HA Standard API

APIs for Zigbee Home Automation (HA) standard device pre-defined functions.

API Reference

Header File

components/esp-zigbee-lib/include/ha/esp_zigbee_ha_standard.h

Functions

esp_zb_cluster_list_t *esp_zb_on_off_light_clusters_create(esp_zb_on_off_light_cfg_t *light_cfg)

Create a standard HA on-off light cluster list.

Note

This contains basic, identify, groups, scenes, on-off cluster as server side.

Parameters: light_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_on_off_light_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_on_off_switch_clusters_create(esp_zb_on_off_switch_cfg_t *switch_cfg)

Create a standard HA on-off switch cluster list.

Note

This contains basic, identify, as server side. And identify, on-off cluster as client side.

Parameters: switch_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_on_off_switch_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_color_dimmable_light_clusters_create(esp_zb_color_dimmable_light_cfg_t *light_cfg)

Create a standard HA color dimmable light cluster list.

Note

This contains basic, identify, groups, scenes, on-off, level, color cluster as server side.

Parameters: light_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_color_dimmable_light_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_color_dimmable_switch_clusters_create(esp_zb_color_dimmable_switch_cfg_t *switch_cfg)

Create a standard HA color dimmable switch cluster list.

Note

This contains basic, identify, as server side. And identify, on-off, level, color cluster as client side.

Parameters: switch_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_color_dimmable_switch_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_mains_power_outlet_clusters_create(esp_zb_mains_power_outlet_cfg_t *outlet_cfg)

Create a standard HA mains power outlet cluster list.

Note

This contains basic, identify, groups, scenes, on-off, level control and shade config cluster as server side.

Parameters: outlet_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_mains_power_outlet_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_shade_clusters_create(esp_zb_shade_cfg_t *shade_cfg)

Create a standard HA shade cluster list.

Note

This contains basic, identify, groups, scenes, on-off cluster as server side.

Parameters: shade_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_shade_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_shade_controller_clusters_create(esp_zb_shade_controller_cfg_t *shade_controller_cfg)

Create a standard HA shade controller cluster list.

Note

This contains basic, identify cluster as server side. Identify, on-off and level control cluster as client side.

Parameters: shade_controller_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_shade_controller_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_door_lock_clusters_create(esp_zb_door_lock_cfg_t *door_lock)

Create a standard HA door lock cluster list.

Note

This contains basic, identify, groups, scenes, door lock cluster as server side.

Parameters: door_lock – [in] Configuration parameters for this cluster lists defined by esp_zb_door_lock_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_door_lock_controller_clusters_create(esp_zb_door_lock_controller_cfg_t *door_lock_controller)

Create a standard HA door lock controller cluster list.

Note

This contains basic, identify cluster as server side. Identify, scenes, groups and door lock cluster as client side.

Parameters: door_lock_controller – [in] Configuration parameters for this cluster lists defined by esp_zb_door_lock_controller_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_temperature_sensor_clusters_create(esp_zb_temperature_sensor_cfg_t *temperature_sensor)

Create a standard HA temperature sensor cluster list.

Note

This contains basic, identify cluster and temperature measurement as server side. Identify cluster as client side.

Parameters: temperature_sensor – [in] Configuration parameters for this cluster lists defined by esp_zb_temperature_sensor_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_configuration_tool_clusters_create(esp_zb_configuration_tool_cfg_t *configuration_tool)

Create a standard HA configuration tool cluster list.

Note

This contains basic, identify cluster as server side. Identify, scenes, groups and door lock cluster as client side.

Parameters: configuration_tool – [in] Configuration parameters for this cluster lists defined by esp_zb_configuration_tool_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_cluster_list_t *esp_zb_thermostat_clusters_create(esp_zb_thermostat_cfg_t *thermostat)

Create a standard HA thermostat cluster list.

Note

This contains basic, identify and thermostat cluster as server side. Identify cluster as client side.

Parameters: thermostat – [in] Configuration parameters for this cluster lists defined by esp_zb_thermostat_cfg_s
Returns: Pointer to cluster list esp_zb_cluster_list_s

esp_zb_ep_list_t *esp_zb_on_off_light_ep_create(uint8_t endpoint_id, esp_zb_on_off_light_cfg_t *light_cfg)

Create a standard single HA on off light endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
light_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_on_off_light_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_on_off_switch_ep_create(uint8_t endpoint_id, esp_zb_on_off_switch_cfg_t *switch_cfg)

Create a standard single HA on off switch endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
switch_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_on_off_switch_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_color_dimmable_light_ep_create(uint8_t endpoint_id, esp_zb_color_dimmable_light_cfg_t *light_cfg)

Create a standard single HA color dimmable light endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
light_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_color_dimmable_light_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_color_dimmable_switch_ep_create(uint8_t endpoint_id, esp_zb_color_dimmable_switch_cfg_t *switch_cfg)

Create a standard single HA color dimmable switch endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
switch_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_color_dimmable_switch_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_mains_power_outlet_ep_create(uint8_t endpoint_id, esp_zb_mains_power_outlet_cfg_t *outlet_cfg)

Create a standard single HA mains power outlet endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
outlet_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_mains_power_outlet_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_shade_ep_create(uint8_t endpoint_id, esp_zb_shade_cfg_t *shade_cfg)

Create a standard single HA shade endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
shade_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_shade_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_shade_controller_ep_create(uint8_t endpoint_id, esp_zb_shade_controller_cfg_t *shade_controller_cfg)

Create a standard single HA shade controller endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
shade_controller_cfg – [in] Configuration parameters for this cluster lists defined by esp_zb_shade_controller_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_door_lock_ep_create(uint8_t endpoint_id, esp_zb_door_lock_cfg_t *door_lock)

Create a standard single HA door lock endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
door_lock – [in] Configuration parameters for this cluster lists defined by esp_zb_door_lock_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_door_lock_controller_ep_create(uint8_t endpoint_id, esp_zb_door_lock_controller_cfg_t *door_lock_controller)

Create a standard single HA door lock controller endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
door_lock_controller – [in] Configuration parameters for this cluster lists defined by esp_zb_door_lock_controller_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_temperature_sensor_ep_create(uint8_t endpoint_id, esp_zb_temperature_sensor_cfg_t *temperature_sensor)

Create a standard single HA temperature sensor endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
temperature_sensor – [in] Configuration parameters for this cluster lists defined by esp_zb_temperature_sensor_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_configuration_tool_ep_create(uint8_t endpoint_id, esp_zb_configuration_tool_cfg_t *configuration_tool)

Create a standard single HA configuration tool endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
configuration_tool – [in] Configuration parameters for this cluster lists defined by esp_zb_configuration_tool_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

esp_zb_ep_list_t *esp_zb_thermostat_ep_create(uint8_t endpoint_id, esp_zb_thermostat_cfg_t *thermostat)

Create a standard single HA thermostat endpoint.

Note

This function adds a single endpoint to a cluster list.

Parameters

endpoint_id – [in] The specific endpoint
thermostat – [in] Configuration parameters for this cluster lists defined by esp_zb_thermostat_cfg_s

Returns

Pointer to esp_zb_ep_list_t esp_zb_ep_list_s

Macros

ESP_ZB_DEFAULT_ON_OFF_LIGHT_CONFIG(): Zigbee HA standard on-off light device default config value.

ESP_ZB_DEFAULT_ON_OFF_SWITCH_CONFIG(): Zigbee HA standard on-off switch device default config value.

ESP_ZB_DEFAULT_COLOR_DIMMABLE_LIGHT_CONFIG(): Zigbee HA standard color dimmable light device default config value.

ESP_ZB_DEFAULT_COLOR_DIMMABLE_SWITCH_CONFIG(): Zigbee HA standard color dimmable switch device default config value.

ESP_ZB_DEFAULT_MAINS_POWER_OUTLET_CONFIG(): Zigbee HA standard mains power outlet device default config value.

ESP_ZB_DEFAULT_SHADE_CONFIG(): Zigbee HA standard shade device default config value.

ESP_ZB_DEFAULT_SHADE_CONTROLLER_CONFIG(): Zigbee HA standard shade controller device default config value.

ESP_ZB_DEFAULT_DOOR_LOCK_CONFIG(): Zigbee HA standard door lock device default config value.

ESP_ZB_DEFAULT_DOOR_LOCK_CONTROLLER_CONFIG(): Zigbee HA standard door lock controller device default config value.

ESP_ZB_DEFAULT_TEMPERATURE_SENSOR_CONFIG(): Zigbee HA standard temperature sensor device default config value.

ESP_ZB_DEFAULT_CONFIGURATION_TOOL_CONFIG(): Zigbee HA standard configuration tool device default config value.

ESP_ZB_DEFAULT_THERMOSTAT_CONFIG(): Zigbee HA standard thermostat device default config value.