-
Notifications
You must be signed in to change notification settings - Fork 0
/
nodes_tools.txt
382 lines (279 loc) · 25.4 KB
/
nodes_tools.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
=====================
Devices (Nodes) tools
=====================
.. |menu2| image:: ozwave_menu-nodes.png
:width: 400px
|menu2|
Get Zwave devices (Nodes) informations
======================================
.. note ::
On a zwave system, devices are called **Nodes**.
- **Devices initialisation** field give state of global initialize process.
The process can take a long time (up to 5 min). Be patient.....
All nodes discovered and / or stored are scanned one by one to be initialized.
.. |check-dev1| image:: ozwave_check-dev1.png
:width: 700px
|check-dev1|
- **Detail status information**.
.. |progess-state1| image:: ozwave_progess-state1.png
:width: 150px
.. |progess-state2| image:: ozwave_progess-state2.png
.. |battery-level| image:: ozwave_battery-level.png
.. |awake1| image:: ozwave_awake1.png
.. |awake2| image:: ozwave_update-sleep.png
:width: 150px
.. |det-type| image:: ozwave_detail-type.png
:width: 150px
.. |cmd_node| image:: ozwave_cmd_node.png
.. |refr-node-inf| image:: ozwave_refresh-node-info.png
:width: 200px
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
| Representation | Message | Description |
+==================+====================================+====================================================================================================+
| | **Pointing the mouse over icon in column "NodeId" give status of initializing.** |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| |progess-state1| | Uninitialized | No starting init operation. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Initialized - not known | Node has completed init, but openzwave don't know is model (shows xml openzwave files). |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Completed | Node has full completed init. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | In progress - Can receive messages | | Node can now receive messages, but his initialization not finish. Probably node is sleeping |
| | (Not linked) | | Controller have finish init, when node awake it state should be Completed. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| |progess-state2| | In progress - Linked to controller | Node is recognize by controller, initialization is in progress. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | In progress - Can receive messages | Node can now receive messages, but initialization not finish. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Out of operation | Node is mark as failed, controller don't find him. |
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
| | **Pointing the mouse over battery icon in column "NodeId" give status of battery level.** |
| |battery-level| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Value in % | Fill icon picture level of battery. |
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
| | **Pointing the mouse over icon in column "Awake" give status of listening mode.** |
| |awake1| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Awake | Node is awake, message can send immediately. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| |awake2| | Sleeping | Node probably sleeping, message are put on send queue. |
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
| | **Pointing the mouse over icon in column "Type" give capacities of node.** |
| |det-type| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Primary Controller | | Node is primary controller, is the main device used to configure and control a Z-Wave network. |
| | | | The only difference between a primary and secondary controller is that the primary is the |
| | | | only one that can be used to add or remove other devices. |
| | | | For this reason, it is usually better for the primary controller to be portable, since most |
| | | | devices must be added when installed in their final location. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Secondary Controller | There can only be one primary controller - all other controllers are secondary controllers. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Static Update Controller | | A Static Update Controller (SUC) is a controller that must never be moved in normal operation |
| | | | and which can be used by other nodes to receive information about network changes. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Bridge Controller | | A bridge controller is able to create virtual nodes that can be associated with other |
| | | | controllers to enable events to be passed on. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Routing | Node is a routing device that passes messages to other nodes. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Listening | Node is a setening device that does not go to sleep. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Beaming | Node is a beam capable device.. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Security | Node supports security features. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | FLiRS | | Node is a frequent setening device that goes to sleep but can be woken up by a beam. |
| | | | Useful to determine node and controller consistency.. |
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
| | **Buttons on column "Action" get access of others commands on nodes.** |
| |cmd_node| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Detail Node | Show/hide command class capacities table. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Update Node | | Send to node **Name** and **Location** field to update it. |
| | | | Saving modification in config file with "Save config" button |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Edit association | Manage groups association. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Force Refresh Node | | Causes the nodes data to be obtained from the Z-Wave network in the same way as if it had just |
| | | | been added. This method would normally be called automatically by OpenZWave, but if you know |
| | |refr-node-inf| | | that a node has been changed, calling this method will force a refresh of the data held by |
| | | | the library. |
| | | | This can be especially useful for devices that were asleep when the application was first run. |
| | | |
| | | Four options possible : |
| | | - Node informations : Fetch the data for a node from the Z-Wave network |
| | | - State Node : Fetch the command class data for a node from the Z-Wave network |
| | | - Dynamics data : Fetch only the dynamic command class data for a node from the Z-Wave network. |
| | | - Heal node with reroute : Try to heal node and reroute it after. |
| +------------------------------------+----------------------------------------------------------------------------------------------------+
| | Monitor Node and log it | | This commmand store all event send an receive by a node. To stop monitoring click again button. |
| | | | Log file saved in user path defined in config section. |
| | | | (defaut: /var/lib/domogik/domogik_packages/plugin_ozwave/data/lognodeXXX.log) |
| | | | Log contains also openzwave log if unable. |
+------------------+------------------------------------+----------------------------------------------------------------------------------------------------+
Manage association devices (groups)
===================================
.. |grp-dialog-bt| image:: ozwave_grp-dialog-bt.png
- Some devices have the ability to be combined with other devices and can send their information.
- These associations are using groups, access to the dialog management groups is done with the button |grp-dialog-bt|
.. |grp-dialog| image:: ozwave_grp-dialog.png
:width: 500px
|grp-dialog|
how to use management associations
----------------------------------
.. note ::
- Due to the possibility of sleeping devices, the system considers the command to have been transmitted.
- In the case of a device sleeping command will be transmitted when the device wakes up.
- So the association will be effective as this momment there.
.. warning ::
Careful if the plugin is stopped between time command is lost.
- An icon indicates the status of the device in the group, it may be :
- unknown
- confirmed
- to confirm
- to update
- The operations are performed by simply drag and drop.
- After making the changes click on **OK** to send at the device.
- To quit dialog box click **Cancel**.
- Actually button **Reset** is not handled.
.. |grp-dialog1| image:: ozwave_grp-dialog1.png
.. |grp-dialog2| image:: ozwave_grp-dialog2.png
.. |grp-dialog3| image:: ozwave_grp-dialog3.png
.. |grp-dialog4| image:: ozwave_grp-dialog4.png
============== ================================================================================
Example Description
============== ================================================================================
|grp-dialog1| If you drop at bad placement a icon forbidden is show.
|grp-dialog2| When you drop in a group who device ins'it to add it, a icon plus is show.
|grp-dialog3| After adding device in group, a icon to update is show.
|grp-dialog4| If you drop at bad placement a icon forbidden is show.
============== ================================================================================
Manage devices Commands Class
=============================
Display commands class list
---------------------------
- All command class are listed in a table.
.. |tab-cmdclass1| image:: ozwave_tab-cmdclass1.png
:width: 750px
|tab-cmdclass1|
Change values of command class
------------------------------
- You can edit the values that are in writing, if the value is changed one "Edit" button appears, you must click it to send change at device
- If exist, pointing the mouse over icon "i" give information about command-class.
.. |tab-cmdclass2| image:: ozwave_tab-cmdclass2.png
:width: 650px
|tab-cmdclass2|
- When a value of command class is updated, she his tagged during 5 secondes. Pointing the mouse over value give date of update.
.. |update-cmdclass| image:: ozwave_update-cmdclass.png
:width: 750px
|update-cmdclass|
Poll service
------------
- Modern devices will not require polling. Some old devices need to be polled as the only way to detect status changes.
- Due to patent concerns, some devices do not report state changes automatically to the controller.
These devices need to have their state polled at regular intervals. The length of the interval is the same for all devices.
To even out the Z-Wave network traffic generated by polling, OpenZWave divides the polling interval by the number of devices that have polling enabled, and polls each in turn. It is recommended that if possible, the interval should not be set shorter than the number of polled devices in seconds (so that the network does not have to cope with more than one poll per second).
Set time interval
^^^^^^^^^^^^^^^^^
- Set in seconds global interval, click send button to confirm.
.. |manage-plugin| image:: ozwave_menu-manage-plugin.png
|manage-plugin|
Polling a command class
^^^^^^^^^^^^^^^^^^^^^^^
.. |tab-cmdclass3| image:: ozwave_tab-cmdclass3.png
:width: 750px
.. |polling-dialog| image:: ozwave_polling-dialog.png
- In first column a check box give access to poll value.
|tab-cmdclass3|
- A dialog box appeared to confirme action. Here check if polled and set intensity, the number (frequency) of poll during global interval.
|polling-dialog|
.. warning ::
- Polling sleeping devices put openzwave library in waiting confirmation. This could raise a network error.
- Using an intensity value more 2 could raise a network error.
.. todo::
Screen shoot and explanations of other functions......
Drivers and controller commands
===============================
.. |ctrl-cmd-bts| image:: ozwave_ctrl-cmd-bts.png
In this section, orders can be sent directly to the driver
|ctrl-cmd-bts|
Stop and Start driver (controller)
----------------------------------
.. |ctrl-start-bt| image:: ozwave_ctrl-start-bt.png
.. |ctrl-stop-bt| image:: ozwave_ctrl-stop-bt.png
.. |ctrl-stop-dlg| image:: ozwave_ctrl-stop-dialog.png
Driver automatically starts and start/stop button automatically changes depending on the state of the driver.
- You can stop it when it's possible : |ctrl-stop-bt|
confimation dialog aks you to continue.
|ctrl-stop-dlg|
- You can Start it when it's possible : |ctrl-start-bt|
Initialization process running, you must be patient ....
Controller commands and actions
-------------------------------
.. |ctrl-action-bt| image:: ozwave_ctrl-action-bt.png
.. |ctrl-action-dialog| image:: ozwave_ctrl-action-dialog.png
:width: 250px
- You access to dialog box by button |ctrl-action-bt|
|ctrl-action-dialog|
Actions process
^^^^^^^^^^^^^^^
- This modal dialog contains informations to guide the user.
- Just actions "CreateButton" and "DeleteButton" are not implemented yet.
+---------------------------+------------------------------------------------------------------------------------------------------------+
| Action / command | Description |
+===========================+============================================================================================================+
| AddDevice | Add a new device (but not a controller) to the Z-Wave network. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| CreateNewPrimary | Add a new controller to the Z-Wave network. The new controller will be the primary, and the current |
| | primary will become a secondary controller. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| ReceiveConfiguration | Receive Z-Wave network configuration information from another controller. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| RemoveDevice | Remove a new device (but not a controller) from the Z-Wave network. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| RemoveFailedNode | Move a node to the controller's failed nodes list. This command will only work if the node cannot respond. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| HasNodeFailed | Check whether a node is in the controller's failed nodes list. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| ReplaceFailedNode | Replace a non-responding node with another. The node must be in the controller's list of failed nodes for |
| | this command to succeed. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| TransferPrimaryRole | Make a different controller the primary. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| RequestNetworkUpdate | Request network information from the SUC/SIS. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| RequestNodeNeighborUpdate | Get a node to rebuild its neighbour list. This method also does ControllerCommand_RequestNodeNeighbors. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| AssignReturnRoute | Assign a network return routes to a device. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| DeleteAllReturnRoutes | Delete all return routes from a device. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| SendNodeInformation | Send a node information frame. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| ReplicationSend | Send information from primary to secondary. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| CreateButton | Create an id that tracks handheld button presses. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| DeleteButton | Delete id that tracks handheld button presses. |
+---------------------------+------------------------------------------------------------------------------------------------------------+
Schematic processing
^^^^^^^^^^^^^^^^^^^^
- Each action have differents step, some will attempt user action on device, some will take a long time, some must be stop manually.
- You can stop action, but stop result have some time a fail report.
.. |ctrl-action-process| image:: ozwave_ctrl-action-process.png
:width: 650px
|ctrl-action-process|
Reset controller
----------------
.. |ctrl-reset-bt| image:: ozwave_ctrl-reset-bt.png
- Two mode possible with acces by buttons : |ctrl-reset-bt|
Soft reset
^^^^^^^^^^
.. |ctrl-reset-dialog1| image:: ozwave_ctrl-reset-dialog1.png
- Soft Reset a PC Z-Wave Controller who resets a controller without erasing its network configuration settings
|ctrl-reset-dialog1|
Hard reset
^^^^^^^^^^
.. |ctrl-reset-dialog2| image:: ozwave_ctrl-reset-dialog2.png
.. warning ::
Be careful this action is irreverssible
|ctrl-reset-dialog2|