Child Supervision
API > Add-Ons

This module includes functions for child supervision feature.

Functions

uint16_t otChildSupervisionGetInterval (otInstance *aInstance)
 Get the child supervision interval (in seconds).
 
void otChildSupervisionSetInterval (otInstance *aInstance, uint16_t aInterval)
 Set the child supervision interval (in seconds).
 
uint16_t otChildSupervisionGetCheckTimeout (otInstance *aInstance)
 Get the supervision check timeout interval (in seconds).
 
void otChildSupervisionSetCheckTimeout (otInstance *aInstance, uint16_t aTimeout)
 Set the supervision check timeout interval (in seconds).

Detailed Description

This module includes functions for child supervision feature.

The functions in this module are available when child supervision feature (OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE) is enabled.

Function Documentation

◆ otChildSupervisionGetCheckTimeout()

uint16_t otChildSupervisionGetCheckTimeout ( otInstance *  aInstance)

Get the supervision check timeout interval (in seconds).

If the device is a sleepy child and it does not hear from its parent within the specified check timeout, it initiates the re-attach process (MLE Child Update Request/Response exchange with its parent).

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The supervision check timeout. Zero indicates that supervision check on the child is disabled.

◆ otChildSupervisionGetInterval()

uint16_t otChildSupervisionGetInterval ( otInstance *  aInstance)

Get the child supervision interval (in seconds).

Child supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child within the supervision interval. If there is no transmission to the child within the supervision interval, OpenThread enqueues and sends a supervision message (a data message with empty payload) to the child.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The child supervision interval. Zero indicates that child supervision is disabled.

◆ otChildSupervisionSetCheckTimeout()

void otChildSupervisionSetCheckTimeout ( otInstance *  aInstance,
uint16_t  aTimeout 
)

Set the supervision check timeout interval (in seconds).

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aTimeoutThe check timeout (in seconds). Zero to disable supervision check on the child.

◆ otChildSupervisionSetInterval()

void otChildSupervisionSetInterval ( otInstance *  aInstance,
uint16_t  aInterval 
)

Set the child supervision interval (in seconds).

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aIntervalThe supervision interval (in seconds). Zero to disable supervision on parent.