Skip to content

Commit 58c4d9b

Browse files
committed
docs: Updated events
1 parent 1e4a78a commit 58c4d9b

File tree

1 file changed

+4
-21
lines changed

1 file changed

+4
-21
lines changed

README-events.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,52 +4,40 @@ This is a list of all the events emitted by the library. This list is not exhaus
44
## Driver events
55
Events emitted by the OpenZWave Driver class:
66

7-
87
* `zwave.on('driver ready', function(homeid){...})`
98

109
the OpenZWave driver has initialised and scanning has started. Returns a unique `homeid` which identifies this particular ZWave network.
1110

12-
13-
14-
1511
* `zwave.on('driver failed', function(){...})`
1612

1713
The OpenZWave driver failed to initialise.
1814

15+
* `zwave.on('connected', function(version){...})`
1916

20-
17+
the OpenZWave driver is connected. Returns `version` which identifies the Openzwave Library version.
2118

2219
* `zwave.on('scan complete', function(){...})`
2320

2421
The initial network scan has finished.
2522

26-
27-
28-
29-
## Node events:
23+
## Node events
3024

3125
* `zwave.on('node added', function(nodeid){...})`
3226

3327
A new node has been found on the network. At this point you can allocate resources to hold information about this node.
3428

35-
3629
* `zwave.on('node removed', function(nodeid){...})`
3730

3831
A node with the provided id has been just been removed from the network. You need to deallocate all resources for this nodeid.
3932

40-
4133
* `zwave.on('node naming', function(nodeid, nodeinfo){...})`
4234

4335
Useful information about the node is returned as a plain JS object. It includes elements like 'manufacturer', 'product', 'type' and 'name' amongst others.
4436

45-
46-
4737
* `zwave.on('node available', function(nodeid, nodeinfo){...})`
4838

4939
This corresponds to OpenZWave's `EssentialNodeQueriesComplete` notification, which means that the node is now available for operation, but don't expect all of its info structures (nodeinfo, see below) to be filled in.
5040

51-
52-
5341
* `zwave.on('node ready', function(nodeid, nodeinfo){...})`
5442

5543
This corresponds to OpenZWave's `NodeQueriesComplete` notification. The node is now ready for operation, and information about the node is available in the `nodeinfo` object:
@@ -65,14 +53,12 @@ This corresponds to OpenZWave's `NodeQueriesComplete` notification. The node is
6553

6654

6755

68-
6956
* `zwave.on('polling enabled/disabled', function(nodeid){...})`
7057

7158
Polling for a node has been enabled or disabled.
7259

7360

7461

75-
7662
* `zwave.on('scene event', function(nodeid, sceneid){...});`
7763

7864
This is fired when a scene event is received by the controller.
@@ -102,10 +88,7 @@ It would send:
10288
As an example, an Aeon Labs Water sensor will fire this event and `data` would
10389
be 255 when water is detected and 0 when it isn't.
10490

105-
106-
107-
108-
## Value events:
91+
## Value events
10992

11093
* `zwave.on('value added', function(nodeid, commandclass, valueId){...})`
11194

0 commit comments

Comments
 (0)