Wake-up

This module includes configuration variables for the Wake-up Coordinator and Wake-up End Device roles.

Summary

Macros

OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE 0
Define to 1 to enable the Wake-up Coordinator role that is capable of establishing a link with one or more Wake-up End Devices by sending a sequence of wake-up frames.
OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE 0
Define to 1 to enable the Wake-up End Device role that periodically listens for wake-up frames to establish a link with a Wake-up Coordinator device.
OPENTHREAD_CONFIG_WED_LISTEN_DURATION 8000
The default wake-up listen duration in microseconds.
OPENTHREAD_CONFIG_WED_LISTEN_INTERVAL 1000000
The default wake-up listen interval in microseconds.
OPENTHREAD_CONFIG_WED_RECEIVE_TIME_AFTER 500
Margin to be applied after the end of a wake-up listen duration to schedule the next listen interval, in units of microseconds.

Macros

OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE

 OPENTHREAD_CONFIG_WAKEUP_COORDINATOR_ENABLE 0

Define to 1 to enable the Wake-up Coordinator role that is capable of establishing a link with one or more Wake-up End Devices by sending a sequence of wake-up frames.

OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE

 OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE 0

Define to 1 to enable the Wake-up End Device role that periodically listens for wake-up frames to establish a link with a Wake-up Coordinator device.

OPENTHREAD_CONFIG_WED_LISTEN_DURATION

 OPENTHREAD_CONFIG_WED_LISTEN_DURATION 8000

The default wake-up listen duration in microseconds.

OPENTHREAD_CONFIG_WED_LISTEN_INTERVAL

 OPENTHREAD_CONFIG_WED_LISTEN_INTERVAL 1000000

The default wake-up listen interval in microseconds.

OPENTHREAD_CONFIG_WED_RECEIVE_TIME_AFTER

 OPENTHREAD_CONFIG_WED_RECEIVE_TIME_AFTER 500

Margin to be applied after the end of a wake-up listen duration to schedule the next listen interval, in units of microseconds.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.