Routing functions

The ZDO Routing functions can be used to make route discovery requests. The functions are listed below.

Function page

ZPS_eAplZdoRouteRequest

ZPS_teStatus ZPS_eAplZdoRouteRequest(
                                uint16 u16DstAddr,
                                uint8 u8Radius);

Description

This function requests the discovery of a route to the specified remote node (and that this route is added to the Routing tables in the relevant Router nodes).

Parent topic:ZPS_eAplZdoRouteRequest

Parameters

u16DstAddr 16-bit network address of destination node
u8Radius Maximum number of hops permitted to destination node (zero value specifies that default maximum is to be used)

Parent topic:ZPS_eAplZdoRouteRequest

Returns

ZPS_E_SUCCESS (route discovery request successfully initiated)
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplZdoRouteRequest

Parent topic:Routing functions

ZPS_eAplZdoManyToOneRouteRequest

ZPS_teStatus ZPS_eAplZdoManyToOneRouteRequest(
                                bool bCacheRoute,
                                uint8 u8Radius);

Description

This function requests a ‘many-to-one’ route discovery and should be called on a node that will act as a ‘concentrator’ in the network (that is, a node with which many other nodes will need to communicate).

As a result of this function call, a route discovery message is broadcast across the network and Routing table entries (for routes back to the concentrator) are stored in the Router nodes.

The maximum number of hops to be taken by a route discovery message in this broadcast must be specified. There is also an option to store the discovered routes in a Route Record Table on the concentrator (for return communications).

Parent topic:ZPS_eAplZdoManyToOneRouteRequest

Parameters

bCacheRoute: Indicates whether to store routes in Route Record Table:
- TRUE - store routes
- FALSE - do not store routes
u8Radius: Maximum number of hops of route discovery message (zero value specifies that default maximum is to be used)

Parent topic:ZPS_eAplZdoManyToOneRouteRequest

Returns

ZPS_E_SUCCESS (many-to-one route discovery successfully initiated)
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplZdoManyToOneRouteRequest

Parent topic:Routing functions

Parent topic:ZDO API functions