Эта страница является
переводом страницы
ZWave. Перевод выполнен на 100%.
iRidium for Z-Wave
how iRidium server gets access to Z-Wave wireless network
The documentation was updated on 12.12.2022
The following server work with Z-Wave:
- iRidium server UMC C3 with a built-in Z-Wave* module or with the help of USB-stick - Z-Wave ZME-UZB1.
- iRidium server RPi and PCs on Windows OS, with the help of USB-stick - Z-Wave ZME-UZB1.
* - out of production.
- iRidium server RPi аnd PCs with Windows OS with iRidium Server software and Z-Wave ZME-UZB1 USB-stick.
Read more about USB-stick here.
It is planned to add support of PCs on Linux with installed iRidium server and Z-Wave/USB-sticks
iRidium server does not support all Z-Wave devices and functions. The section "Working with Commands and Feedbacks" contains information about supported Z-Wave classes.
Advantages
Wireless Z-Wave network is developed specially for home automation.
Z-Wave devices:
- Can exchange information at a distance of 30 meters (ideal conditions are direct visibility between devices).
- Consume very little energy and can work on regular batteries. Electric wiring is not required to make smart home.
- Can organize mesh networks: devices can exchange information not only directly but also via Z-Wave intermediary devices - retranslators that help to avoid obstacles and dead zones. Routes of data exchange can change in real time depending on the electromagnetic situation. It increases the reliability of the wireless communication.
There are a lot of devices with Z-Wave interface on the market. Developers now have a splendid opportunity to integrate all these devices with iRidium platform.
Adding Devices to the Network
Wireless network unlike wired one requires virtual connection of devices. It is with the help of NodeID in Z-Wave network. iRidium server stores the list of all wireless devices with its IDs.
1 Supply power to iRidium server UMC C3 with Z-Wave module or connect Z-Wave/USB-stick to your controller or PC with installed iRidium server. Install the driver for the stick according to its manual.
2 Enter the server web-interface.
3 Go to Z-Wave tab.
4 Press Change Port
In the window that appears enter the port name to which Z-Wave USB-stick is connected.
For Z-Wave on UMC C3 with a built-in Z-Wave module, the /hal/zwt_m3 port is used.
The port can be defined this way:
For Linux OS:
- Disconnect USB-stick from the server, if it is connected
- Launch Putty and write
ls /dev in the command line
A list of all ports where devices are connected appears
- Connect USB-stck to the server and enter the
ls /dev command one more time
New port name appears in the list
This is the required port name. In our exapmple it is /dev/ttyUSB0
For Windows OS
- Connect USB-stick
- Go to the device manager. Find your USB-stick. The name of the port to which it is connected is displayed after its name in the brackets. In our example it is COM7
5Click the Add button, enter the name of a device and then click Add again.
6 The server scans the network for about 20 seconds. During this time you are to do certain physical actions with a wireless device that has to be added. As a rule it is required to press a button on a device three times. (Read the manual to your device to learn what exactly has to be done.)
7 The device is added to the list and gets its NodeID. Add the required number of device to your network.
8 After it the network is created. Export data about the created network as a .xml file by clicking the Export button.
To delete devices from the net use the Delete button. After it press a button on the device that you want to delete (or any other action required by the device manual). After deleting it is recommended to cut off the power or take the battery from a device, as many Z-Wave devices try to connect to the wireless network again.
Working in iRidium studio
Adding Z-Wave Network Driver
1 Create server project in iRidium studio. Click a button to import the .xml file (Z-Wave XML Files).
2 The driver with all devices appears in the Project Device Panel.
3 You can change device names (Name). Names in iRidium studio can differ from name in the server web-interface. The other parameters can't be edited.
Working with Commands and Feedbacks
Set control of wireless devices with the help of commands and feedbacks.
More:
You will find below information about supported classes of Z-Wave devices, its commands and feedbacks.
Info About Supported Z-Wave Functions
Supported functions:
Not supported functions:
- associations (direct connection of Z-Wave devices),
- scenes.
Battery
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Get state (Battery) |
Command |
Any value |
Request the level of battery charge.
A command may be not executed at once.
|
| State (Battery) |
Feedback |
From 0 to 100
255 - warning about low level of battery charge |
Battery level
|
Binary sensor
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Get state (Binary sensor) |
Command |
Any value |
Request a sensor state
|
| State (Binary sensor) |
Feedback |
0 or 1 |
Sensor state
|
Binary switch
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Set state (Binary switch) |
Command |
OFF - 0,
ON - from 1 to 99 |
Set the switch state
|
| State (Binary switch) |
Feedback |
0 or 1 |
Switch state
|
Central scene
| Name of a command or a feedback channel |
Type |
Admissible values |
Description
|
| Count |
Feedback |
Value |
Displays the number of clicks on the scene buttons.
|
| Released |
Feedback |
Value |
The number of the released button.
|
| Held Down |
Feedback |
Value |
The number of the held down button.
|
| Pressed |
Feedback |
Value |
The number of the pressed button.
|
Color switch
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Set Warm White (Color switch) |
Command |
From 0 to 255 |
Set the level of the white color
|
| Get Warm White (Color switch) |
Command |
Any value |
Request the level of the white color
|
| Set Red (Color switch) |
Command |
From 0 to 255 |
Set the level of the red color
|
| Get Red (Color switch) |
Command |
Any value |
Request the level of the red color
|
| Set Green (Color switch) |
Command |
From 0 to 255 |
Set the level of the green color
|
| Get Green (Color switch) |
Command |
Any value |
Request the level of the green color
|
| Set Blue (Color switch) |
Command |
From 0 to 255 |
Set the level of the blue color
|
| Get Blue (Color switch) |
Command |
Any value |
Request the level of the blue color
|
| State Warm White (Color switch) |
Feedback |
From 0 to 255 |
Value of the white color
|
| State Red (Color switch) |
Feedback |
From 0 to 255 |
Value of the red color
|
| State Green (Color switch) |
Feedback |
From 0 to 255 |
Value of the green color
|
| State Blue (Color switch) |
Feedback |
From 0 to 255 |
Value of the blue color
|
Multilevel sensor
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Get state |
Command |
Any value |
Request a sensor state
|
| State |
Feedback |
Depends on the device |
Sensor state
|
Multilevel switch
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Set level |
Command |
From 0 to 99 |
Set a level
|
| Get level |
Command |
Any level |
Request a level
|
| Level |
Feedback |
From 0 to 99 |
Level
|
Meter
| Name of a command or feedback |
Type |
Admissible values |
Description
|
| Get |
Command |
Any level |
Request a level
|
| State |
Feedback |
Depends on a device |
Level
|
Thermostat
| Name of a command or a feedback channel |
Type |
Admissible values |
Description
|
| Set mode by name |
Command |
Heat
Cool
Fan
Dry
Auto Changeover |
Set a thermostat mode by name
|
| Set mode by ID |
Command |
Value |
Set thermostat mode by name
|
| Set State |
Command |
Value |
Set a mode temperature (Cooling, Dry Air, Heating, Auto Changeover).
|
| Get Mode |
Command |
Value |
Request a mode
|
| Get State |
Command |
Value |
Request a mode temperature (Cooling, Dry Air, Heating, Auto Changeover).
|
| Set on by ID |
Command |
Value |
Turn on a fan by ID
|
| Set on by name |
Command |
Auto Low
Low
Auto High
High
Auto Medium
Medium
Circulation
Left right
Quiet
Up down
Humidity circulation |
Turn on a fan mode by name
|
| Set off by ID |
Command |
Value |
Turn on a fan by ID
|
| Set off by name |
Command |
Auto Low
Low
Auto High
High
Auto Medium
Medium
Circulation
Left right
Quiet
Up down
Humidity circulation |
Turn in a fan mode by name
|
| Mode Text |
Feedback |
Value |
Mode name
|
| Mode Value |
Feedback |
Value |
Mode value
|
| State (Setpoint) |
Feedback |
Value |
Value of set temperature
|
| State Text |
Feedback |
Value |
Name of fan mode
|
| State Value |
Feedback |
Value |
Value of fan mode
|
Testing
At present the driver for Z-Wave is supported in UMC C3 with Z-Wave module, as well as in RPI and Windows PCs (with installed iRidium server) with the help of Z-Wave ZME-UZB1 USB-stick.
Using iRidium server as Z-Wave hub
To use iRidium server UMC, RPi, NUC as Z-Wave hub to communicate with equipment based on Z-Wave protocol, it is required to connect Z-Wave ZME_USB-stick to iRidium server.
To purchase Z-Wave ZME UZB1 USB-stick, follow this link. The UZB comes in three different versions depending on the transmitting frequency used:
- ZMEEUZB: Version for all frequencies around 868 MHz (EU, Russia, India, China — default is EU)
- ZMEAUZB: Version for all frequencies around 921 MHz (Australia, Brasil, Japan, Korea — default is Australia/Brasil)
- ZMEUUZB: Version for all frequencies around 908 MHz (USA, Israel — default is USA)
Depending on your location, choose a distributor in your region.
It is enough to purchase the USB-stick without Z-Wave license to work with iRidium server.
For more information about technical data and the different operating frequencies please refer to the UZB manual.
The recommended retail price of Z-Wave ZME_UZB1 USB-stick (without Z-Wave license) is 35 euro.
If you have any additional questions, feel free to contact our technical support -
support@iridiummobile.ru.
