Child Supervision

This module includes functions for Child Supervision feature.

Summary

Functions
`otChildSupervisionGetCheckFailureCounter(otInstance *aInstance)`	`uint16_t` Get the value of supervision check timeout failure counter.
`otChildSupervisionGetCheckTimeout(otInstance *aInstance)`	`uint16_t` Gets the supervision check timeout interval (in seconds) on the child.
`otChildSupervisionGetInterval(otInstance *aInstance)`	`uint16_t` Gets the Child Supervision interval (in seconds) on a child.
`otChildSupervisionResetCheckFailureCounter(otInstance *aInstance)`	`void` Reset the supervision check timeout failure counter to zero.
`otChildSupervisionSetCheckTimeout(otInstance *aInstance, uint16_t aTimeout)`	`void` Sets the supervision check timeout interval (in seconds) on the child.
`otChildSupervisionSetInterval(otInstance *aInstance, uint16_t aInterval)`	`void` Sets the child supervision interval (in seconds) on the child.

Functions

otChildSupervisionGetCheckFailureCounter

uint16_t otChildSupervisionGetCheckFailureCounter(
  otInstance *aInstance
)

Get the value of supervision check timeout failure counter.

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.

otChildSupervisionGetCheckTimeout

uint16_t otChildSupervisionGetCheckTimeout(
  otInstance *aInstance
)

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

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
)

Gets the Child Supervision interval (in seconds) on a child.

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 Child Supervision Message to the child.

Details

Parameters

[in] aInstance

A pointer to an OpenThread instance.

Returns

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

otChildSupervisionResetCheckFailureCounter

void otChildSupervisionResetCheckFailureCounter(
  otInstance *aInstance
)

Reset the supervision check timeout failure counter to zero.

otChildSupervisionSetCheckTimeout

void otChildSupervisionSetCheckTimeout(
  otInstance *aInstance,
  uint16_t aTimeout
)

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

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
)

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

Details

Parameters

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

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.