PreviousNext
getNetworkParams
Help > OS functions > Networking > getNetworkParams

Function

 

Get network parameters

Purpose

 

Get some information about the current system, RF, and network parameters

Syntax

 

uns8 getNetworkParams()

Parameters

 

 –

Return value

 

userInterface register. See IQRF OS User’s guide, chapter User interface.

Output values

 

     param2: Address of  the device in the network

         0 - Illegal value (resulting probably due to forbidden getNetworkParams usage at an unbonded device)

         1 – 239 Bonded Node (logical address)

         254 (0xFE)       Prebonded Node, not yet authorized

     bit _NTWF

         1 – IQMESH packet

          0 – Peer-to-peer packet

     param3: Network identification. MSB = NID1, LSB = NID0.

   If the device is bonded NID0 and NID1 refer to the Coordinator otherwise to the device itself. These features are not guaranteed for future OS versions.

     Network parameters (registers with names beginning with the ntw prefix) are updated. See IQRF OS User’s guide, Appendix 2, table OS, RF, and network parameters.

     param4: MSB = ntwDID, LSB = ntwVRN.

Preconditions

 

     For IQMESH only.

     For bonded devices only, see Example.

Remarks

 

Side effects

 

 –

See also

 

amIBonded, removeBondAddress

Example

 

if (amIBonded())           // Is the Node bonded?

{                          // Yes:

  getNetworkParams();     //   Get Node number

  myAddr = param2;

}