AN241
5.4. NLME-START-ROUTER
5.4.1. Description
5.4.2. Request
Description:
This function allows the next higher layer of a ZigBee router to initialize or change its
superframe configuration. It also allows the next higher layer of a ZigBee coordinator to
change its superframe configuration.
Function Prototype:
Parameters:
NWK_ENUM nlmeStartRouterRequest(BYTE beaconOrder, BYTE
superframeOrder, BOOL BatteryLifeExtension)
BYTE beaconOrder
In star mode or tree mode this specifies the beacon order of the network that the higher
layers wish to form. (0x00–0x0F)
In MESH_MODE there are no beacons and this parameter will be set equal to 0x0F.
BYTE superframeOrder
In star mode or tree mode this specifies the superframe order of the network that the
higher layers wish to form. (0x00–0x0F)
In MESH_MODE there are no beacons and this parameter may be omitted. If the
parameter is supplied, it will be ignored.
BOOL BatteryLifeExtension
If this value is TRUE, the NLME will request that the ZigBee coordinator is started
supporting battery life extension mode.
If this value is FALSE, the NLME will request that the ZigBee coordinator is started without
supporting battery life extension mode.
5.4.3. Confirm
Description:
Confirmation by return value of nlmeStartRouterRequest, type NWK_ENUM (See
Section “6.1.1. NWK_ENUM” on page 28).
Returned Values:
INVALID_REQUEST or any status value (SUCCESS, NO_SHORT_ADDRESS,
UNAVAILABLE_KEY,FRAME_TOO_LONG, FAILED_SECURITY_CHECK or
INVALID_PARAMETER) returned from the mlmeStartRequest function.
Rev. 0.1
17