Child Supervision#

This module includes functions for child supervision feature.

Functions#

uint16_t
otChildSupervisionGetInterval(otInstance *aInstance)

Gets the child supervision interval (in seconds) on a child.

void
otChildSupervisionSetInterval(otInstance *aInstance, uint16_t aInterval)

Sets the child supervision interval (in seconds) on the child.

uint16_t
otChildSupervisionGetCheckTimeout(otInstance *aInstance)

Gets the supervision check timeout interval (in seconds) on the child.

void
otChildSupervisionSetCheckTimeout(otInstance *aInstance, uint16_t aTimeout)

Sets the supervision check timeout interval (in seconds).

uint16_t

Get the value of supervision check timeout failure counter.

void

Reset the supervision check timeout failure counter to zero.

Function Documentation#

otChildSupervisionGetInterval#

uint16_t otChildSupervisionGetInterval (otInstance * aInstance)

Gets the child supervision interval (in seconds) on a child.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

Child supervision feature provides a mechanism for a sleepy child to ask its parent to ensure to send a message to it within the supervision interval. If there is no transmission to the child within the supervision interval, parent sends a supervision message (a data message with empty payload) to the child.

Returns

  • The child supervision interval. Zero indicates that supervision is disabled.


Definition at line 66 of file include/openthread/child_supervision.h

otChildSupervisionSetInterval#

void otChildSupervisionSetInterval (otInstance * aInstance, uint16_t aInterval)

Sets the child supervision interval (in seconds) on the child.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aInterval

The supervision interval (in seconds). Zero to disable supervision.


Definition at line 75 of file include/openthread/child_supervision.h

otChildSupervisionGetCheckTimeout#

uint16_t otChildSupervisionGetCheckTimeout (otInstance * aInstance)

Gets the supervision check timeout interval (in seconds) on the child.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

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

Returns

  • The supervision check timeout. Zero indicates that supervision check on the child is disabled.


Definition at line 88 of file include/openthread/child_supervision.h

otChildSupervisionSetCheckTimeout#

void otChildSupervisionSetCheckTimeout (otInstance * aInstance, uint16_t aTimeout)

Sets the supervision check timeout interval (in seconds).

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aTimeout

The check timeout (in seconds). Zero to disable supervision check on the child.


Definition at line 97 of file include/openthread/child_supervision.h

otChildSupervisionGetCheckFailureCounter#

uint16_t otChildSupervisionGetCheckFailureCounter (otInstance * aInstance)

Get the value of supervision check timeout failure counter.

Parameters
N/AaInstance

The counter tracks the number of supervision check failures on the child. It is incremented when the child does not hear from its parent within the specified check timeout interval.


Definition at line 106 of file include/openthread/child_supervision.h

otChildSupervisionResetCheckFailureCounter#

void otChildSupervisionResetCheckFailureCounter (otInstance * aInstance)

Reset the supervision check timeout failure counter to zero.

Parameters
N/AaInstance

Definition at line 112 of file include/openthread/child_supervision.h