BDB_eNfStartNwkFormation

BDB_teStatus BDB_eNfStartNwkFormation(void);

Description

This function starts the Network Formation process and, if necessary, must be called after BDB_vStart(). If it is potentially required on a node, Network Formation must be enabled via the attribute u8bdbCommissioningMode.

The function can be called only on a Coordinator or Router:

• If called on a Coordinator, a centralized security network is formed.

• If called on a Router, a distributed security network is formed.

The above network types are described in Network security.

Once Network Formation starts, the function returns and the eventual outcome of the Network Formation process is indicated by an asynchronous event - one of the following:

• BDB_EVENT_NWK_FORMATION_SUCCESS if a centralized or distributed network has been successfully formed.

• BDB_EVENT_NWK_FORMATION_FAILURE if a network has not been successfully formed.

Network Formation is described in more detail in Network Formation.

Parameters

• None

Returns

• BDB_E_SUCCESS

  (Network Formation has been successfully started)*.

• BDB_E_ERROR_INVALID_PARAMETER

  (End Device has attempted Network Formation).

• BDB_E_ERROR_NODE_IS_ON_A_NWK

  (node is already in a network).

The eventual outcome is indicated by a BDB_EVENT_NWK_FORMATION_SUCCESS or BDB_EVENT_NWK_FORMATION_FAILURE event, as described above.

Parent topic:Functions