Trident IoT Z-Wave SDK
 
Loading...
Searching...
No Matches
SReceiveNodeUpdate Struct Reference

#include <ZW_application_transport_interface.h>

Data Fields

uint8_t Status
 
node_id_t NodeId
 
uint8_t iLength
 
uint8_t aPayload [MAX_NODE_INFO_LENGTH]
 

Detailed Description

The Z Wave protocol MAY notify an application by sending SReceiveNodeUpdate when a Node Information Frame has been received. The Z Wave protocol MAY refrain from sending the information if the protocol is currently expecting node information.

A controller application MAY use the information provided by SReceiveNodeUpdate to update local data structures.

The Z Wave protocol MUST notify a controller application by calling SReceiveNodeUpdate when a new node has been added or deleted from the controller through the network management features.

The Z Wave protocol MUST pass SReceiveNodeUpdate to application in response to SNodeInfoRequest being passed to protocol by the controller application. The Z Wave protocol MAY notify a controller application by sending SReceiveNodeUpdate when a Node Information Frame has been received. The Z Wave protocol MAY refrain from sending the information if the protocol is currently expecting a Node Information frame.

SReceiveNodeUpdate MUST be sent in a controller node operating as SIS each time a node is added or deleted by the primary controller. SReceiveNodeUpdate MUST be sent in a controller node operating as SIS each time a node is added/deleted by an inclusion controller.

A controller application MAY send a ZW_RequestNetWorkUpdate command to a SIS or SIS node. In response, the SIS MUST return update information for each node change since the last update handled by the requesting controller node. The application of the requesting controller node MAY receive multiple instances of SReceiveNodeUpdate in response to application passing SNetworkUpdateRequest to protocol.

The Z Wave protocol MUST NOT send SReceiveNodeUpdate in a controller node acting as primary controller or inclusion controller when a node is added or deleted.

Any controller application MUST implement this function.

Parameters
[in]bNodeID
[in]pCmdPointer of the updated node's node info.
[in]bLenThe length of the pCmd parameter.

serialapi{ZW->HOST: REQ | 0x49 | bStatus | bNodeID | bLen | basic | generic | specific | commandclasses[ ]}

SReceiveNodeUpdate via the Serial API also have the possibility for receiving the status UPDATE_STATE_NODE_INFO_REQ_FAILED, which means that a node did not acknowledge a SNodeInfoRequest .

Field Documentation

◆ aPayload

uint8_t SReceiveNodeUpdate::aPayload[MAX_NODE_INFO_LENGTH]

◆ iLength

uint8_t SReceiveNodeUpdate::iLength

◆ NodeId

node_id_t SReceiveNodeUpdate::NodeId

◆ Status

uint8_t SReceiveNodeUpdate::Status

The documentation for this struct was generated from the following file: