Source Routing APIs#
This file provides routines pertaining to source routing. Source routing is only available for routers and coordinators that have the source routing library included.
See source-route.h for more information.
Variables#
To configure non trust center node to assume a concentrator type of the trust center it join to, until it receive many-to-one route request from the trust center. For the trust center node, concentrator type is configured from the concentrator plugin. The stack by default assumes trust center be a low RAM concentrator that make other devices send route record to the trust center even without receiving a many-to-one route request. The assumed concentrator type can be changed by setting appropriate config value to emberAssumedTrustCenterConcentratorType.
Functions#
initializing the node to act as a concentrator with:
Return the number of used entries in the source route table.
Return the size of the source route table.
Returns the number of bytes needed in a packet for source routing. Since each hop consumes 2 bytes in the packet, this routine calculates the total number of bytes needed based on number of hops to reach the destination.
Set source route discovery mode(MTORR scheduling mode) to on/off/reschedule.
Legacy API Starts periodic many-to-one route discovery. Periodic discovery is started by default on bootup, but this function may be used if discovery has been stopped by a call to emberConcentratorStopDiscovery().
Legacy API. Stops periodic many-to-one route discovery.
Legacy API. Notes when a packet fails to deliver.
Legacy API. Notes when a route error has occurred.
Variable Documentation#
emberAssumedTrustCenterConcentratorType#
EmberAssumeTrustCenterConcentratorType emberAssumedTrustCenterConcentratorType
To configure non trust center node to assume a concentrator type of the trust center it join to, until it receive many-to-one route request from the trust center. For the trust center node, concentrator type is configured from the concentrator plugin. The stack by default assumes trust center be a low RAM concentrator that make other devices send route record to the trust center even without receiving a many-to-one route request. The assumed concentrator type can be changed by setting appropriate config value to emberAssumedTrustCenterConcentratorType.
Function Documentation#
emberSetConcentrator#
EmberStatus emberSetConcentrator (bool on, uint16_t concentratorTypeParam, uint16_t minTime, uint16_t maxTime, uint8_t routeErrorThresholdParam, uint8_t deliveryFailureThresholdParam, uint8_t maxHopsParam)
initializing the node to act as a concentrator with:
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | N/A | on | |
| uint16_t | N/A | concentratorTypeParam | |
| uint16_t | N/A | minTime | |
| uint16_t | N/A | maxTime | |
| uint8_t | N/A | routeErrorThresholdParam | |
| uint8_t | N/A | deliveryFailureThresholdParam | |
| uint8_t | N/A | maxHopsParam |
@params discovery mode on/off concentratorTypeParam min time between MTORRs max time between MTORRs threshodl to react to route error message threshodl to react to delivery failures max number of hops for MTORR
emberGetSourceRouteTableFilledSize#
uint8_t emberGetSourceRouteTableFilledSize (void )
Return the number of used entries in the source route table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberGetSourceRouteTableTotalSize#
uint8_t emberGetSourceRouteTableTotalSize (void )
Return the size of the source route table.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberGetSourceRouteOverhead#
uint8_t emberGetSourceRouteOverhead (EmberNodeId destination)
Returns the number of bytes needed in a packet for source routing. Since each hop consumes 2 bytes in the packet, this routine calculates the total number of bytes needed based on number of hops to reach the destination.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberNodeId | N/A | destination | The destination's short address. |
Returns
uint8_t The number of bytes needed for source routing in a packet.
emberSetSourceRouteDiscoveryMode#
uint32_t emberSetSourceRouteDiscoveryMode (EmberSourceRouteDiscoveryMode mode)
Set source route discovery mode(MTORR scheduling mode) to on/off/reschedule.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberSourceRouteDiscoveryMode | N/A | mode |
@params: mode: EMBER_SOURCE_ROUTE_DISCOVERY_OFF = 0x00, EMBER_SOURCE_ROUTE_DISCOVERY_ON = 0x01, EMBER_SOURCE_ROUTE_DISCOVERY_RESCHEDULE = 0x02,
emberConcentratorStartDiscovery#
void emberConcentratorStartDiscovery (void )
Legacy API Starts periodic many-to-one route discovery. Periodic discovery is started by default on bootup, but this function may be used if discovery has been stopped by a call to emberConcentratorStopDiscovery().
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberConcentratorStopDiscovery#
void emberConcentratorStopDiscovery (void )
Legacy API. Stops periodic many-to-one route discovery.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
emberConcentratorNoteDeliveryFailure#
void emberConcentratorNoteDeliveryFailure (EmberOutgoingMessageType type, EmberStatus status)
Legacy API. Notes when a packet fails to deliver.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberOutgoingMessageType | N/A | type | |
| EmberStatus | N/A | status |
emberConcentratorNoteRouteError#
void emberConcentratorNoteRouteError (EmberStatus status, EmberNodeId nodeId)
Legacy API. Notes when a route error has occurred.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberStatus | N/A | status | |
| EmberNodeId | N/A | nodeId |