Child Supervision

This module includes functions for child supervision feature.

Summary

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

Functions

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

Functions

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).

Details
Parameters
[in] aInstance
A 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.

Details
Parameters
[in] aInstance
A 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).

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The 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).

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aInterval
The supervision interval (in seconds). Zero to disable supervision on parent.