UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. Back to index page.
SparkFun sensor images provided under CC BY-NC-SA-3.0.

zwNode Class

Module: ozw

This class is used by ozw to manage valueids for a node (device). No user-serviceable parts inside. It is not exposed to the end user.

Methods

zwNode

(
  • homeId
  • nodeId
)
Number

zwNode constructor.

Parameters:

  • homeId Number

    the homeId os the network controller

  • nodeId Number

    the node index

Returns:

Number:

nodeId

() Number

get the nodeId

Returns:

Number:

The nodeId for this node

homeId

() Number

get the homeId

Returns:

Number:

The homeId for this node

addValueID

(
  • vid
)

Add an OpenZWave ValueID and index to the value map, incrementing m_vindex.

Parameters:

  • vid OpenZWave::ValueID

    The OpenZWave ValueID

removeValueID

(
  • vid
)

Remove an OpenZWave ValueID from the value map.

Parameters:

  • vid OpenZWave::ValueID

    The OpenZWave ValueID

indexToValueID

(
  • index
  • vid
)
Boolean

Lookup and return a ValueID corresponding to an index.

Parameters:

  • index Number

    the index to look up

  • vid OpenZWave::ValueID *

    The pointer to the returned ValueID, if it exists

Returns:

Boolean:

true if the index was found, false otherwise

dumpNode

(
  • all
)

Dump various information about the ValueIDs stored in this node.

Parameters:

  • all Boolean

    true to dump all values, false to limit dumping only 'user' values.

updateVIDMap

()

Clear the VID map, sort the list containing registered VID's, and re-create the VID map. The goal is to ensure that the Map is always sorted in acsending order by VID.

setAutoUpdate

(
  • enable
)

When enabled, updateVIDMap() will be called every time a new VID is inserted or removed. This is disabled by default for performance reasons during init() time. Once the driver is initialized, then this option is, by default enabled so that the VID map is always kept in a sorted order.

Parameters:

  • enable Boolean

    true to enable, false to disable.