Power Configuration Server APIs

Collaboration diagram for Power Configuration Server APIs:

Functions
zb_zcl_status_t	tr_power_configuration_server_set_mains_voltage (zb_uint8_t endpoint, zb_uint16_t voltage_100mv)
	API for setting the mains voltage.
zb_zcl_status_t	tr_power_configuration_server_set_mains_frequency (zb_uint8_t endpoint, zb_uint8_t frequency_hz)
	API for setting the mains frequency.
zb_zcl_status_t	tr_power_configuration_server_set_battery_voltage (zb_uint8_t endpoint, tr_power_configuration_server_battery_source_t battery_source, zb_uint8_t voltage_100mv)
	API for setting the battery voltage.
zb_zcl_status_t	tr_power_configuration_server_set_battery_percentage_remaining (zb_uint8_t endpoint, tr_power_configuration_server_battery_source_t battery_source, zb_uint8_t percentage_remaining)
	API for setting the battery percentage remaining.
void	tr_power_configuration_server_set_clear_mains_power_lost (zb_uint8_t endpoint, zb_bool_t mains_power_lost)
	API to indicate that mains power has been lost.
void	tr_power_configuration_server_unlatch_battery (zb_uint8_t endpoint, tr_power_configuration_server_battery_source_t battery_source)
	API to unlatch a low battery condition.

Detailed Description

---

---

Function Documentation

tr_power_configuration_server_set_battery_percentage_remaining()

zb_zcl_status_t tr_power_configuration_server_set_battery_percentage_remaining	(	zb_uint8_t	endpoint,
		tr_power_configuration_server_battery_source_t	battery_source,
		zb_uint8_t	percentage_remaining )

API for setting the battery percentage remaining.

Parameters

endpoint	device endpoint
battery_source	battery set (TR_POWER_CONFIGURATION_BATTERY_SOURCE_1, TR_POWER_CONFIGURATION_BATTERY_SOURCE_2, TR_POWER_CONFIGURATION_BATTERY_SOURCE_3)
percentage_remaining	remaining battery life in units of 0.5 percent (151 = 75.5%)

Returns

ZB_ZCL_STATUS_SUCCESS or error

tr_power_configuration_server_set_battery_voltage()

zb_zcl_status_t tr_power_configuration_server_set_battery_voltage	(	zb_uint8_t	endpoint,
		tr_power_configuration_server_battery_source_t	battery_source,
		zb_uint8_t	voltage_100mv )

API for setting the battery voltage.

Parameters

endpoint	device endpoint
battery_source	battery set (TR_POWER_CONFIGURATION_BATTERY_SOURCE_1, TR_POWER_CONFIGURATION_BATTERY_SOURCE_2, TR_POWER_CONFIGURATION_BATTERY_SOURCE_3)
voltage_100mv	voltage in units of 100mV (33 = 3.3VDC)

Returns

ZB_ZCL_STATUS_SUCCESS or error

tr_power_configuration_server_set_clear_mains_power_lost()

void tr_power_configuration_server_set_clear_mains_power_lost	(	zb_uint8_t	endpoint,
		zb_bool_t	mains_power_lost )

API to indicate that mains power has been lost.

Parameters

endpoint	device endpoint
mains_power_lost	ZB_TRUE if power is lost, ZB_FALSE if power is not lost

tr_power_configuration_server_set_mains_frequency()

zb_zcl_status_t tr_power_configuration_server_set_mains_frequency	(	zb_uint8_t	endpoint,
		zb_uint8_t	frequency_hz )

API for setting the mains frequency.

Parameters

endpoint	device endpoint
frequency_hz	mains frequency in units of 2 Hz (32 = 64Hz)

Returns

ZB_ZCL_STATUS_SUCCESS or error

tr_power_configuration_server_set_mains_voltage()

zb_zcl_status_t tr_power_configuration_server_set_mains_voltage	(	zb_uint8_t	endpoint,
		zb_uint16_t	voltage_100mv )

API for setting the mains voltage.

Parameters

endpoint	device endpoint
voltage_100mv	RMS voltage in units of 100mV (1173 = 117.3VAC)

Returns

ZB_ZCL_STATUS_SUCCESS or error

tr_power_configuration_server_unlatch_battery()

void tr_power_configuration_server_unlatch_battery	(	zb_uint8_t	endpoint,
		tr_power_configuration_server_battery_source_t	battery_source )

API to unlatch a low battery condition.

Parameters

endpoint	device endpoint
battery_source	battery set (TR_POWER_CONFIGURATION_BATTERY_SOURCE_1, TR_POWER_CONFIGURATION_BATTERY_SOURCE_2, TR_POWER_CONFIGURATION_BATTERY_SOURCE_3)