 | ZWManager Methods |
The ZWManager type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ActivateScene | Activate given scene to perform all its actions. |
| AddAssociation | Adds a node to an association group. |
| AddDriver(String) | Creates a new driver for a Z-Wave controller. |
| AddDriver(String, ZWControllerInterface) | Creates a new driver for a Z-Wave controller. |
| AddNode | Start the Inclusion Process to add a Node to the Network. |
| AddSceneValue(Byte, ZWValueId, Boolean) | Add a bool Value ID to an existing scene. |
| AddSceneValue(Byte, ZWValueId, Byte) | Add a byte Value ID to an existing scene. |
| AddSceneValue(Byte, ZWValueId, Int16) | Add a 16-bit signed integer Value ID to an existing scene. |
| AddSceneValue(Byte, ZWValueId, Int32) | Add a 32-bit signed integer Value ID to an existing scene. |
| AddSceneValue(Byte, ZWValueId, Single) | Add a decimal Value ID to an existing scene. |
| AddSceneValue(Byte, ZWValueId, String) | Add a string Value ID to an existing scene. |
| AddSceneValueListSelection(Byte, ZWValueId, Int32) | Add the selected item list Value ID to an existing scene (as a integer). |
| AddSceneValueListSelection(Byte, ZWValueId, String) | Add the selected item list Value ID to an existing scene (as a string). |
| AssignReturnRoute | Ask a Node to update its update its Return Route to the Controller |
| CancelControllerCommand | Cancels any in-progress command running on a controller. |
| ClearSwitchPoints | Clears all switch points from the schedule. |
| CreateButton | Create a handheld button id. |
| CreateNewPrimary | Create a new primary controller when old primary fails. Requires SUC. |
| CreateScene | Create a new Scene passing in Scene ID |
| DeleteAllReturnRoutes | Ask a Node to delete all Return Route. |
| DeleteButton | Delete a handheld button id. |
| Destroy | Deletes the Manager and cleans up any associated objects. |
| DisablePoll | Disable the polling of a device's state. |
| EnablePoll(ZWValueId) | Enable the polling of a device's state. |
| EnablePoll(ZWValueId, Byte) | Enable the polling of a device's state. |
| GetAllScenes | |
| GetAssociations | |
| GetControllerInterfaceType | Obtain controller interface type |
| GetControllerNodeId | Get the node ID of the Z-Wave controller. |
| GetControllerPath | Obtain controller interface path |
| GetLibraryTypeName | Get a string containing the Z-Wave API library type used by a controller. |
| GetLibraryVersion | Get the version of the Z-Wave API library used by a controller. |
| GetLoggingState | Gets the current library logging state. |
| GetMaxAssociations | Gets the maximum number of associations for a group. |
| GetNodeBasic | Get a node's "basic" type. |
| GetNodeClassInformation | |
| GetNodeGeneric | Get a node's "generic" type. |
| GetNodeLocation | Get the location of a node. |
| GetNodeManufacturerId | Get the manufacturer ID of a device. |
| GetNodeManufacturerName | Get the manufacturer name of a device. |
| GetNodeMaxBaudRate | Get the maximum baud rate of a node's communications |
| GetNodeName | Get the name of a node. |
| GetNodeNeighbors | |
| GetNodeProductId | Get the product ID of a device. |
| GetNodeProductName | Get the product name of a device. |
| GetNodeProductType | Get the product type of a device. |
| GetNodeQueryStage | Get whether the node's query stage as a string |
| GetNodeSecurity | Get the security byte for a node. Bit meanings are still to be determined. |
| GetNodeSpecific | Get a node's "specific" type. |
| GetNodeType | Get a human-readable label describing the node. |
| GetNodeVersion | Get the version number of a node |
| GetNumGroups | Gets the number of association groups reported by this node. |
| GetNumScenes | Gets the number of scenes that have been defined. |
| GetNumSwitchPoints | Get the number of switch points defined in a schedule. |
| GetPollIntensity | Get the polling intensity of a device's state. |
| GetPollInterval | Get the time period between polls of a node's state. |
| GetSceneLabel | Returns a label for the particular scene. |
| GetSendQueueCount | Get count of messages in the outgoing send queue. |
| GetSucNodeId | Get the node ID of the Static Update Controller. |
| GetSwitchPoint | |
| GetValueAsBool | |
| GetValueAsByte | |
| GetValueAsInt | |
| GetValueAsShort | |
| GetValueAsString | |
| GetValueHelp | Gets a help string describing the value's purpose and usage. |
| GetValueLabel | Gets the user-friendly label for the value. |
| GetValueListItems | |
| GetValueListSelection(ZWValueId, Int32) | |
| GetValueListSelection(ZWValueId, String) | |
| GetValueListValues | |
| GetValueUnits | Gets the units that the value is measured in. |
| GetVersionAsString | Get the Version Number of OZW as a string |
| HasNodeFailed | Check if the Controller Believes a Node has Failed. |
| HealNetwork | Heal network by requesting node's rediscover their neighbors. |
| HealNetworkNode | Heal network node by requesting the node rediscover their neighbors. |
| Initialize | Creates the Manager singleton object. |
| IsBridgeController | Query if the controller is using the bridge controller library. |
| IsNodeAwake | Get whether the node is awake or asleep |
| IsNodeBeamingDevice | Get whether the node is a beam capable device. |
| IsNodeFailed | Get whether the node is working or has failed |
| IsNodeFrequentListeningDevice | Get whether the node is a frequent listening device that goes to sleep but
can be woken up by a beam. Useful to determine node and controller consistency. |
| IsNodeInfoReceived | Get whether the node information has been received |
| IsNodeListeningDevice | Get whether the node is a listening device that does not go to sleep. |
| IsNodeRoutingDevice | Get whether the node is a routing device that passes messages to other nodes. |
| IsNodeSecurityDevice | Get the security attribute for a node. True if node supports security features. |
| IsNodeZWavePlus | Is this a ZWave+ Supported Node? |
| IsPolled | Determine the polling of a device's state. |
| IsPrimaryController | Query if the controller is a primary controller. |
| IsStaticUpdateController | Query if the controller is a static update controller. |
| IsValuePolled | Test whether the value is currently being polled. |
| IsValueReadOnly | Test whether the value is read-only. |
| IsValueSet | Test whether the value has been set. |
| LogDriverStatistics | Sends current driver statistics to the log file |
| PressButton | Starts an activity in a device. |
| ReceiveConfiguration | Receive network configuration information from primary controller. Requires secondary. |
| RefreshNodeInfo | Trigger the fetching of fixed data about a node. |
| RefreshValue | Refreshes the specified value from the Z-Wave network. |
| ReleaseButton | Stops an activity in a device. |
| RemoveAssociation | Removes a node from an association group. |
| RemoveDriver | Removes the driver for a Z-Wave controller, and closes the serial port. |
| RemoveFailedNode | Remove a Failed Device from the Z-Wave Network |
| RemoveNode | Remove a Device from the Z-Wave Network |
| RemoveScene | Remove an existing Scene. |
| RemoveSceneValue | Remove the Value ID from an existing scene. |
| RemoveSwitchPoint | Remove a switch point from the schedule. |
| ReplaceFailedNode | Replace a failed device with another. |
| ReplicationSend | Send information from primary to secondary |
| RequestAllConfigParams | Request the values of all known configurable parameters from a device. |
| RequestConfigParam | Request the value of a configurable parameter from a device. |
| RequestNetworkUpdate | Update the controller with network information from the SUC/SIS. |
| RequestNodeDynamic | Trigger the fetching of just the dynamic value data for a node. |
| RequestNodeNeighborUpdate | Ask a Node to update its Neighbor Tables |
| RequestNodeState | Trigger the fetching of session and dynamic value data for a node. |
| ResetController | Hard Reset a PC Z-Wave Controller. |
| SceneExists | Check if a Scene ID is defined. |
| SceneGetValueAsBool | |
| SceneGetValueAsByte | |
| SceneGetValueAsInt | |
| SceneGetValueAsShort | |
| SceneGetValueAsString | |
| SceneGetValueListSelection(Byte, ZWValueId, Int32) | |
| SceneGetValueListSelection(Byte, ZWValueId, String) | |
| SceneGetValues | |
| SendNodeInformation | Send a NIF frame from the Controller to a Node. |
| SetChangeVerified | Sets a flag indicating whether value changes noted upon a refresh should be verified. If so, the
library will immediately refresh the value a second time whenever a change is observed. This helps to filter
out spurious data reported occasionally by some devices. |
| SetConfigParam | Set the value of a configurable parameter in a device. |
| SetLogFileName | Sets the current library log file name to a new name |
| SetLoggingState | Sets the library logging state. |
| SetNodeLocation | Set the location of a node. |
| SetNodeManufacturerName | Set the manufacturer name of a device. |
| SetNodeName | Set the name of a node. |
| SetNodeProductName | Set the product name of a device. |
| SetPollIntensity | Set the frequency of polling (0=none, 1=every time through the list, 2-every other time, etc) |
| SetPollInterval | Set the time period between polls of a node's state. |
| SetSceneLabel | Sets a label for the particular scene. |
| SetSceneValue(Byte, ZWValueId, Boolean) | Set a bool Value ID to an existing scene's ValueID |
| SetSceneValue(Byte, ZWValueId, Byte) | Set a byte Value ID to an existing scene's ValueID |
| SetSceneValue(Byte, ZWValueId, Int16) | Set a 16-bit integer Value ID to an existing scene's ValueID |
| SetSceneValue(Byte, ZWValueId, Int32) | Set a 32-bit signed integer Value ID to an existing scene's ValueID |
| SetSceneValue(Byte, ZWValueId, Single) | Set a decimal Value ID to an existing scene's ValueID |
| SetSceneValue(Byte, ZWValueId, String) | Set a string Value ID to an existing scene's ValueID |
| SetSceneValueListSelection(Byte, ZWValueId, Int32) | Set the list selected item Value ID to an existing scene's ValueID (as a integer). |
| SetSceneValueListSelection(Byte, ZWValueId, String) | Set the list selected item Value ID to an existing scene's ValueID (as a string). |
| SetSwitchPoint | Set a switch point in the schedule. |
| SetValue(ZWValueId, Boolean) | Sets the state of a bool. |
| SetValue(ZWValueId, Byte) | Sets the value of a byte. |
| SetValue(ZWValueId, Int16) | Sets the value of a 16-bit signed integer. |
| SetValue(ZWValueId, Int32) | Sets the value of a 32-bit signed integer. |
| SetValue(ZWValueId, Single) | Sets the value of a decimal. |
| SetValue(ZWValueId, String) | Sets the value from a string, regardless of type. |
| SetValueLabel | Sets the user-friendly label for the value. |
| SetValueListSelection | Sets the selected item in a list. |
| SoftReset | Soft Reset a PC Z-Wave Controller. |
| SwitchAllOff | Switch all devices off. |
| SwitchAllOn | Switch all devices on. |
| TestNetwork | Test network. |
| TestNetworkNode | Test network node. |
| TransferPrimaryRole | Add a new controller to the network and make it the primary. |
| WriteConfig | Saves the configuration of a PC Controller's Z-Wave network to the application's user data folder. |
See Also