NodeDiscovery
NodeDiscovery

Represents 1 node discovery, which is created when a Wireless Node Discovery packet is sent from a Node.  Note: There are multiple versions of Node Discovery packets which have been developed over time.  Each version has added more useful information. If an earlier version of the Node Discovery packet is heard, this NodeDiscovery object will have some information be invalid (set to default values).

Functions
NodeDiscovery
explicit NodeDiscovery(
const WirelessPacket &packet
)

Creates a NodeDiscovery object from a WirelessPacket

Parameters
packet

The WirelessPacket to create the NodeDiscovery object from

Variables
m_nodeAddress
uint16 m_nodeAddress

The node address of the node that sent the Node Discovery packet.

m_radioChannel
WirelessTypes::Frequency m_radioChannel

The radio channel (WirelessTypes::Frequency) that the node was on that sent the Node Discovery packet.

m_panId
uint16 m_panId

The PAN id of the Node that send the Node Discovery packet.

m_model
WirelessModels::NodeModel m_model

The model of the node that sent the Node Discovery packet.

m_serialNumber
uint32 m_serialNumber

The serial number of the node that sent the Node Discovery packet.

m_firmwareVersion
Version m_firmwareVersion

The firmware version of the node that sent the Node Discovery packet.

m_defaultMode
WirelessTypes::DefaultMode m_defaultMode

The WirelessTypes::DefaultMode of the node that sent the Node Discovery packet.

m_bitResult
uint32 m_bitResult

The Built In Test result that was sent in the packet.

m_baseRssi
int16 m_baseRssi

The Base Station RSSI that identifies the received signal strength at the Base Station.

m_timestamp
Timestamp m_timestamp

The Timestamp of when the NodeDiscovery packet was received by MSCL.

Functions
initFromPacket_v1
void initFromPacket_v1(
const WirelessPacket &packet
)

Initializes the NodeDiscovery object from a version 1 Node Discovery packet.

Parameters
packet

The WirelessPacket which is a version 1 Node Discovery packet.

initFromPacket_v2
void initFromPacket_v2(
const WirelessPacket &packet
)

Initializes the NodeDiscovery object from a version 2 Node Discovery packet.

Parameters
packet

The WirelessPacket which is a version 2 Node Discovery packet.

initFromPacket_v3
void initFromPacket_v3(
const WirelessPacket &packet
)

Initializes the NodeDiscovery object from a version 3 Node Discovery packet.

Parameters
packet

The WirelessPacket which is a version 3 Node Discovery packet.

initFromPacket_v4
void initFromPacket_v4(
const WirelessPacket &packet
)

Initializes the NodeDiscovery object from a version 4 Node Discovery packet.

Parameters
packet

The WirelessPacket which is a version 4 Node Discovery packet.

nodeAddress
uint16 nodeAddress() const

Gets the node address of the discovered Node.

Returns

The node address of the discovered Node.

frequency
WirelessTypes::Frequency frequency() const

Gets the WirelessTypes::Frequency of the discovered Node.

Returns

The WirelessTypes::Frequency of the discovered Node.

panId
uint16 panId() const

Gets the PAN Id of the discovered Node.  Note: Returns 0 if not present in the packet.

Returns

The PAN Id of the discovered Node.

model
WirelessModels::NodeModel model() const

Gets the model of the discovered Node.

Returns

The WirelessModels::NodeModel of the discovered Node.

serialNumber
uint32 serialNumber() const

Gets the serial number of the discovered Node.  Note: Returns 0 if not present in the packet.

Returns

The serial number of the discovered Node.

firmwareVersion
Version firmwareVersion() const

Gets the firmware version of the discovered Node.  Note: Returns 0.0.0 if not present in the packet.

Returns

The firmware version of the discovered Node.

defaultMode
WirelessTypes::DefaultMode defaultMode()

Gets the WirelessTypes::DefaultMode of the discovered Node.  Note: Returns 999 if not present in the packet.

Returns

The WirelessTypes::DefaultMode of the discovered Node.

builtInTestResult
uint32 builtInTestResult()

Gets the result bitmask of the built in test.

Returns

A uint32 bitmask representing the result of the built in test.

baseRssi
int16 baseRssi() const

Gets the base station rssi of the discovered Node.

Returns

The base station rssi of the discovered Node.

timestamp
Timestamp timestamp() const

Gets the Timestamp of when the NodeDiscovery packet was received by MSCL.

Returns

The Timestamp of when the NodeDiscovery packet was received by MSCL.

Types
NodeDiscoveries

typedef for a vector of NodeDiscovery objects