Functions

EmberStatus emberFormNetwork (EmberNetworkParameters *parameters)
 Form a new network by becoming the coordinator. This API requires the parent-support library to be present. More...
 
EmberStatus emberGetChildFlags (EmberMacAddress *address, EmberChildFlags *flags)
 Return an EmberChildFlags bitmask indicating the child flags of the child corresponding to the passed MAC address. More...
 
EmberStatus emberRemoveChild (EmberMacAddress *address)
 Remove the node corresponding to the passed MAC address from the child table. More...
 
EmberStatus emberPurgeIndirectMessages (void)
 Purge all indirect transmissions from the indirect message queue. More...
 
EmberStatus emberSetIndirectQueueTimeout (uint32_t timeoutMs)
 Set indirect queue timeout value. The indirect queue timeout is set by default to EMBER_INDIRECT_TRANSMISSION_TIMEOUT_MS. More...
 

Handlers

void emberChildJoinHandler (EmberNodeType nodeType, EmberNodeId nodeId)
 This handler is invoked at coordinator, range extender, or mac mode nodes when a new child has joined the device. More...
 

Function Documentation

◆ emberChildJoinHandler()

void emberChildJoinHandler ( EmberNodeType  nodeType,
EmberNodeId  nodeId 
)

This handler is invoked at coordinator, range extender, or mac mode nodes when a new child has joined the device.

Parameters
[in]nodeTypeThe role of the joining device (EMBER_STAR_RANGE_EXTENDER, EMBER_STAR_END_DEVICE, EMBER_STAR_SLEEPY_END_DEVICE, EMBER_MAC_MODE_DEVICE or EMBER_MAC_MODE_SLEEPY_DEVICE).
[in]nodeIdThe node ID of the joining device.

◆ emberFormNetwork()

EmberStatus emberFormNetwork ( EmberNetworkParameters parameters)

Form a new network by becoming the coordinator. This API requires the parent-support library to be present.

Parameters
[in]parametersAn EmberNetworkParameters value that specifies the network parameters of the network to be formed.
Returns
An EmberStatus value that indicates either the successful formation of the new network or the reason that the network formation failed.

◆ emberGetChildFlags()

EmberStatus emberGetChildFlags ( EmberMacAddress address,
EmberChildFlags flags 
)

Return an EmberChildFlags bitmask indicating the child flags of the child corresponding to the passed MAC address.

Parameters
[in]addressA pointer to an EmberMacAddress that specifies the MAC address of the child.
[out]flagsA pointer to an EmberChildFlags containing the child flags of the child corresponding to the passed MAC address.
Returns
An EmberStatus value of EMBER_SUCCESS if the child was found in the child table, or another EmberStatus value indicating the reason of failure.

◆ emberPurgeIndirectMessages()

EmberStatus emberPurgeIndirectMessages ( void  )

Purge all indirect transmissions from the indirect message queue.

Returns
an EmberStatus value of EMBER_SUCCESS if all indirect messages were purged, or another EmberStatus value indicating the reason of failure.

◆ emberRemoveChild()

EmberStatus emberRemoveChild ( EmberMacAddress address)

Remove the node corresponding to the passed MAC address from the child table.

Parameters
[in]addressA pointer to an EmberMacAddress that specifies the MAC address of the child to be removed.
Returns
An EmberStatus value of EMBER_SUCCESS if the node was successfully removed from the child table, or another EmberStatus value indicating the reason of failure.

◆ emberSetIndirectQueueTimeout()

EmberStatus emberSetIndirectQueueTimeout ( uint32_t  timeoutMs)

Set indirect queue timeout value. The indirect queue timeout is set by default to EMBER_INDIRECT_TRANSMISSION_TIMEOUT_MS.

Parameters
timeoutMsThe timeout in milliseconds to be set.
Returns
an EmberStatus value of EMBER_SUCCESS if the passed timeout was successfully set, or a value of EMBER_INVALID_CALL if the passed value is invalid.