Zpal-power-manager#

zpal_pm_type_t#

zpal_pm_type_t

Power manager type in which a lock can request an opearation to prevent the system from entering a sleep mode.

zpal_pm_powerlevel_t#

zpal_pm_powerlevel_t

Power manager power levels, each level corresponds to physical power mode implementation.

zpal_pm_state_t#

zpal_pm_state_t

For each lock, three states are defined:

• ZPAL_PM_STATE_ACTIVE_PERMANENT: The lock is active and will remain active until it is cancelled.

• ZPAL_PM_STATE_ACTIVE_TIMER: The lock is active and will remain active until the timer expires.

• ZPAL_PM_STATE_INACTIVE: The lock is inactive.

zpal_pm_domain_t#

zpal_pm_domain_t

A domain is a group of locks.

They are stored in the same domain structure.

zpal_pm_lock#

zpal_status_t zpal_pm_lock (zpal_pm_type_t type, zpal_pm_domain_t domain, uint32_t timeout_ms, uint8_t idx)

Locks the power mode for a given time period.

Returns

• true when the lock is successfully acquired

• ZPAL_STATUS_BUSY if the lock is already in active state.

• ZPAL_STATUS_INVALID_ARGUMENT when the type or idx are invalid or timeout is greater than the maximum timeout.

• ZPAL_STATUS_OK if the lock is successfully acquired.

Note

• to acquire by force, use zpal_pm_relock

zpal_pm_relock#

zpal_status_t zpal_pm_relock (zpal_pm_type_t type, zpal_pm_domain_t domain, uint32_t timeout_ms, uint8_t idx)

Locks the power mode for a given time period.

If the lock is already active this function overwrites the previous lock. Use with caution. You can get the lock active state for the given id by calling zpal_pm_lock_is_activeReturns

• true when the lock is successfully acquired, false otherwise (bad parameters).

• ZPAL_STATUS_INVALID_ARGUMENT when the type or idx are invalid or timeout is greater than the maximum timeout.

• ZPAL_STATUS_OK if the lock is successfully acquired.

zpal_get_max_timeout#

uint32_t zpal_get_max_timeout (void )

Gets the maximum timeout value that can be set for a lock.

Returns

• The maximum timeout value in ms.

zpal_pm_lock_is_active#

bool zpal_pm_lock_is_active (zpal_pm_type_t type, zpal_pm_domain_t domain, uint8_t idx, zpal_pm_state_t * state)

Return the state of a given lock.

Returns

• true is in active state, false if inactive.

Note

• Similar to zpal_pm_lock_type_is_active but for an individual lock.

zpal_pm_lock_type_is_active#

bool zpal_pm_lock_type_is_active (zpal_pm_type_t pm_type, zpal_pm_state_t * state)

Return the state of the given type of lock.

Resulted from all zwave locks operations on that type. Returns

• true if the lock is active, false if inactive.

Note

• : Similar to zpal_pm_lock_is_active but done at the type level which contains any locks operating on that type.

zpal_pm_register_domain#

zpal_status_t zpal_pm_register_domain (zpal_pm_domain_t domain, pm_domain_status_t * radio_domain_status, pm_domain_status_t * deep_sleep_domain_status)

Registers a domain for power locks.

Returns

• ZPAL_STATUS_OK if one or two of the domains status are successfully registered, ZPAL_STATUS_FAIL otherwise.

zpal_pm_lock_cancel#

zpal_status_t zpal_pm_lock_cancel (zpal_pm_type_t type, zpal_pm_domain_t domain, uint8_t idx)

This function cancels an active power lock despite of the ongoing mode (permanent or timer).

Note

• If the specified type is not supported, this function will not perform any action.

Returns

• ZPAL_STATUS_OK if the lock is successfully cancelled, ZPAL_STATUS_FAIL otherwise.

zpal_pm_lock_cancel_all#

void zpal_pm_lock_cancel_all (void )

Cancels all active power locks on both radio and deep sleep power locks.

Note

• It cancels all power locks created during runtime, hence it can be used ONLY as a part of power down routine.

zpal_zw_pm_event_handler#

void zpal_zw_pm_event_handler (zpal_pm_powerlevel_t from, zpal_pm_powerlevel_t to)

Function to update stack logic (radio operations and configuration) before power mode transitions defined in zpal_pm_powerlevel_t.

Note

• This function is called through app_pm_transition_event and is mapped onto power manager platform specific events.

zpal_pm_halt#

void zpal_pm_halt (void )