nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Channel Manager

This module includes functions for Channel Manager. More...

Functions

otError otChannelManagerRequestChannelChange (otInstance *aInstance, uint8_t aChannel)
 
uint8_t otChannelManagerGetRequestedChannel (otInstance *aInstance)
 
uint16_t otChannelManagerGetDelay (otInstance *aInstance)
 
otError otChannelManagerSetDelay (otInstance *aInstance, uint16_t aDelay)
 
uint32_t otChannelManagerGetSupportedChannels (otInstance *aInstance)
 
void otChannelManagerSetSupportedChannels (otInstance *aInstance, uint32_t aChannelMask)
 

Detailed Description

This module includes functions for Channel Manager.

The functions in this module are available when Channel Manager feature (OPENTHREAD_ENABLE_CHANNEL_MANAGER) is enabled. Channel Manager is available only on an FTD build.

Function Documentation

uint16_t otChannelManagerGetDelay ( otInstance aInstance)

This function gets the delay (in seconds) used by Channel Manager for a channel change.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The delay (in seconds) for channel change.
uint8_t otChannelManagerGetRequestedChannel ( otInstance aInstance)

This function gets the channel from the last successful call to otChannelManagerRequestChannelChange()

Returns
The last requested channel or zero if there has been no channel change request yet.
uint32_t otChannelManagerGetSupportedChannels ( otInstance aInstance)

This function gets the supported channel mask.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Returns
The supported channels as bit-mask.
otError otChannelManagerRequestChannelChange ( otInstance aInstance,
uint8_t  aChannel 
)

This function requests a Thread network channel change.

The network switches to the given channel after a specified delay (

See also
otChannelManagerSetDelay). The channel change is performed by updating the Pending Operational Dataset.

A subsequent call to this function will cancel an ongoing previously requested channel change.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aChannelThe new channel for the Thread network.
Return values
OT_ERROR_NONEChannel change request successfully processed.
OT_ERROR_INVALID_ARGSThe channel is not a supported channel (
See also
otChannelManagerGetSupportedChannels).
otError otChannelManagerSetDelay ( otInstance aInstance,
uint16_t  aDelay 
)

This function sets the delay (in seconds) used for a channel change.

The delay should preferably be longer than maximum data poll interval used by all sleepy-end-devices within the Thread network.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aDelayDelay in seconds.
Return values
OT_ERROR_NONEDelay was updated successfully.
OT_ERROR_INVALID_ARGSThe given delay aDelay is too short.
void otChannelManagerSetSupportedChannels ( otInstance aInstance,
uint32_t  aChannelMask 
)

This function sets the supported channel mask.

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aChannelMaskA channel mask.