BDB_u8OutOfBandCommissionStartDevice

uint8 BDB_u8OutOfBandCommissionStartDevice(
BDB_tsOobWriteDataToCommission *psStartupData);

Description

This function initiates out-of-band commissioning which allows the local device to form a network as a Coordinator or to join an existing network as a Router or End Device. The function should be called after ZPS_eAplAfInit(). It is called when commissioning data is received from another device via out-of-band means. This commissioning data must be supplied to the function in a BDB_tsOobWriteDataToCommission structure, described in Section 2.7.5.

Not all the data values are mandatory.

The out-of-band commissioning interface makes sensible assumptions about data values and does not allow certain values already in the node to be over-ridden by the commissioning data. For example:

  • It does not allow the network address of a Coordinator to set to a non-zero value (since the network address of the Coordinator must be zero)

  • It does not allow the rejoin flag to set on a Coordinator (since the Coordinator cannot leave and then rejoin the network)

  • In a centralized network, it does not allow the IEEE/MAC address of Trust Centre to set to any value other than the IEEE/MAC address of Coordinator (since the Coordinator is always the Trust Centre)

For an overview of out-of-band commissioning, refer to Out-Of-Band Commissioning.

Parameters

Returns

  • BDB_E_SUCCESS

    (The device has successfully formed or joined a network).

  • BDB_E_FAILURE

    (The request to form or join a network has not been accepted).

  • ZPS_NWK_ENUM_INVALID_REQUEST

    (The request contained invalid data).

  • ZPS_APL_APS_E_ILLEGAL_REQUEST

    (The stack is not in the correct state to accept the request).

Parent topic:Functions