Эта страница является
переводом страницы
ZWaveMe. Перевод выполнен на 100%.
iRidium for Z-Wave.me
A set of tools to create control interfaces for equipment by Z-Wave.me.
The documentation was updated on 02.9.2022
Use the following example of a project to learn about driver capabilities.
iRidium for Z-Wave.me is a driver to control devices working with Z-way server via Z-Wave.me API.
Tested equipmetn:
- Raspberry PI 3B+ (OS:razberry-3.2.2_bullseye/ SDK version 6.51.09),
- USB Z-Wave Transceiver (ZMEEUZB/ 869 MHz/GKRCH/EN300220),
- Z.Wave.Me (ZMR_TH) thermostat (SDK version 4.55.00 //Application version 2.1),
- Philio PAN04-1B - Relay Insert 2x1.5kW with Power Meter 500 series (SDK version 6.51.02 // Application version 1.4),
- Philio Slim Multisensor PST02-A (SDK version 6.51.01 // Application version 1.0),
- Zipato RGBW BULB 2 (SDK version 6.51.01 // Application version 1.7).
Connection
Z-Wave.me driver is connected to Z-Wave.me gateway via WebSocket (TCP).
To connect to Z-Wave.me equipmrent, do the following:
1 Connect equipment and set it (you'll find a detailed manual here);
2 Add Z-Wave.me driver ti created panel and server projects and set it;
3 Assign commands and feedback channels to graphic items of the interface and set required logic.
How to Get Remote / Local Token for Connection
1 Open Smarthome web-interface, go to Menu > My settings;
2 You'll see the Generate authorization tokens section in the lower part of the screen.
You can generate a token for remote and local access there.
Work in iRidium
Create a new project and add Z-Wave.me driver to it with the help of a scanner or manually.
Network scanning
Scanning works locally or remotely depending on the chosen type Local / Remote - it allows to add all available Z-Wave.me devices to iRidium project fast. Steps to use scanning:
- Create a new project and click Scan > Z-Wave.me Scanner in the Devices tab;
- Choose a type of connection Local or Remote;
- Enter a token for Local Connection or a remote token for Remote;
- Enter IP-address and a port to connect to equipem for the local type of connection (set on Z-Wave.me server);
- Choose devices to add to your project.
If the scanner can't find equipment, you can enter the driver settings manually:
Driver Setting
1 Add Z-Wave.me driver in the DEVICES tab to a created project.
2 Enter the driver connection settings:
Local:
- Host - IP-address of equipment;
- Port - post (8083);
- SSL - type of encrypting (Disable);
- Token - a local token, it is set on Z-Wave.me server.
Remote:
- Host - find.z-wave.me;
- Port - port (443);
- SSL - type of encrypting (SSL v2.3);
- Token - a remote token, it is set on Z-Wave.me server.
3 Click the right mouse button on the added Z-Wave.me driver and add a required number of devices (Add subdevice). Each subdevice has the following settings Device type (z-wave devices, other) and Node ID (a unique ID of a device). You can get information about a device on Z-Wave.me server.
4 All commands and feedback channels of subdevices have Channel ID parameter (it is set on Z-Wave.me server), and they are devided into types. Types of all commands and feedback channels are described below.
Setting Commands and Feedback Channels
To control equipment it is required to set commands (Commands) and feedback channels (Feedbacks). To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback drag'n'drop a feedback channel on a graphic item and choose how to output or display a value.
Read more about work with graphic items in the
"Types of graphic items" article.
Commands
A command is assigned to a graphic item with a value that must be sent to the bus when a graphic item is pressed. Limits of values can be different for different devices depending on the equipment.
| Channel Type |
Channel Subtype |
Description
|
| Switch Multilevel |
MultiLevel |
Change the value of a level (dimmer)
|
| Switch Color Soft White |
Change the value of soft white color
|
| Switch Color Cold White |
Change the value of cold white color
|
| Switch Color Red / Green / Blue |
Change the value of levels in RGB channels
|
| Motor |
Control closing of blinds
|
| Volume |
Control sound volume
|
| Other |
Add other commands
|
| Switch Binary |
Thermostat Mode |
Thermostat mode heating / colling (not for 869.0 МHz)
|
| Power Switch Binary |
Binary switch
|
| Scene Switch Binary |
Binary scene switch
|
| Power Strip |
Turn on/ off a power strip
|
| Valve |
Open / close a valve
|
| Switch |
Turn on / off a switch
|
| Siren |
Activate / deactivate a siren
|
| Other |
Add other commands
|
| Switch RGB |
Switch Color RGBA |
Switch the color of an RGBA lamp
|
| Switch Color RGB |
Switch the color of an RGB lamp voice assistants only work with RGB.
|
| Thermostat |
Thermostat SetPoint |
Set temperature for heating / cooling
|
| Other |
Add other commands
|
| Toggle Button |
|
Toggle
|
| Doorlock |
|
Open / close a lock
|
Feedbacks
A feedback channel is assigned to a graphic item to dipsplay the state or equipment in the bus. Limit values of one type of feedback channels can be different for different devices, depending on equipment.
| Feedback Type |
Feedback Subtype |
Description
|
| Switch Multilevel |
MultiLevel |
Values of a level (dimmer)
|
| Switch Color Soft White |
Value of sofl white color
|
| Switch Color Cold White |
Value of cold white color
|
| Switch Color Red / Green / Blue |
Values in RGB channels
|
| Motor |
Level of blind closing
|
| Volume |
Volume level
|
| Other |
Other values
|
| Switch Binary |
Thermostat Mode |
Thermostat mode heating / cooling
|
| Power Switch Binary |
Value of a binary switch
|
| Scene Switch Binary |
Value of binary scene switch
|
| Power Strip |
Power strip (on / off)
|
| Valve |
Valve state
|
| Switch |
Switch state
|
| Siren |
Siren state
|
| Other |
Other values
|
| Switch RGB |
Switch Color RGBA |
Color value of an RGBA lamp
|
| Switch Color RGB |
Color value of an RGB lamp
|
| Thermostat |
Thermostat SetPoint |
Value of set temperature
|
| Other |
Other values
|
| Sensor Binary |
General Purpose |
Value of general sensor
|
| Smoke |
Value of smoker sensor
|
| Flood |
Value of leakage sensor
|
| Cooling |
Cooling mode
|
| Tamper |
Value of tamper sensor
|
| Door-Window |
Value of magnet sensor (open / closed)
|
| Motion |
Value of motion sensor
|
| Door |
Value of door sensor
|
| Alarm sensor general purpose |
Alarm value of general purpose sensor
|
| Alarm Sensor Smoke |
Alarm value of smoke sensor
|
| Alarm Sensor Co |
Alarm value of CO2 sensor
|
| Alarm Sensor Coo |
Alarm value of COO sensor
|
| Alarm Sensor Heat |
Alarm value of temperature sensor
|
| Alarm Sensor Flood |
Alarm value of leakage sensor
|
| Alarm Sensor Door |
Alarm value of door sensor
|
| Alarm Sensor Burglar |
Alarm value of burglar sensor
|
| Alarm Sensor Power |
Alarm value of power sensor
|
| Alarm Sensor System |
Alarm value of system sensors
|
| Alarm Sensor Emergency |
Alarm value of emergency sensor
|
| Alarm Sensor Clock |
Activation by set time
|
| Alarm Door |
Alarm value of door sensor
|
| Window Tilt |
Window in airing mode (open / closed)
|
| Alarm Power |
Alarm value of power sensor
|
| Alarm Smoke |
Alarm value of smoke sensor
|
| Alarm Co |
Alarm value of CO2 sensor
|
| Alarm Coo |
Alarm value of COO sensor
|
| Alarm Heat |
Alarm value of temperature sensor
|
| Alarm Flood |
Alarm value of leakage sensor
|
| Alarm Burglar |
Alarm value of burglar sensor
|
| Alarm System |
Alarm value of system sensors
|
| Alarm Emergency |
Alarm value of emergency sensor
|
| Alarm Clock |
Activation by set time
|
| Gas |
Value of gas leakage sensor
|
| CO |
Value of CO2 sensor
|
| Siren |
Siren activity
|
| Other |
Other values
|
| Sensor Multilevel |
Temperature |
Temperature value
|
| Luminosity |
Brightness level
|
| Energy |
Consumed power
|
| Humidity |
Humidity value
|
| Barometer |
Value of atmospheric pressure
|
| Ultraviolet |
Value of UV radiation?
|
| Meter Electric Kilowatt Per Hour |
Current electricity cosumption in kW/h
|
| Meter Electric Watt |
Current electricity consumption in Watts
|
| Meter Electric Pulse Count |
Meter of electric impulses
|
| Meter Electric Voltage |
Current electricity consumption in Volt.
|
| Meter Electric Ampere |
Current electricity consumption in Amperes
|
| Meter Electric Power Factor |
Value of electrci power
|
| Rain |
Value of rain sensor
|
| Seismic |
Value of seismic sensor
|
| Acceleration X / Y / Z |
Value of accelerometer along X / Y / Z axes
|
| Meter Electric Kilovolt Ampere Hour |
Electricity meter in Kilovolt Ampere Hour
|
| Meter Gas Cubic Meters |
Gas meter in cubic meters
|
| Meter Gas Cubic Feet |
Gas meter in cubic feet
|
| Meter Gas Pulse Count |
Impulse sensor of gas meter
|
| Meter Water Cubic Meters |
Water meter in cubic meters
|
| Meter Water Cubic Feet |
Water meter in cubic feet
|
| Meter Water Us Gallons |
Water meter in in US gallon
|
| Meter Water Pulse Count |
Impusle sensor of water meter
|
| CO |
CO2 value
|
| Other |
Other values
|
| Battery |
|
Battery level
|
| Doorlock |
|
Lock state (open / closed)
|
Work with Voice Assistants
The following articles describe how to work with voice assistants:
Below you can see how to set control of equipment via Yandex Alice.
1 Create a server project.
For correct display of devices, download the latest verson of iRidium studio from our website.
2 Add Z-wave.me driver to your project.
3 Add Yandex Alice Platform driver to the project.
4 Click right mouse button on Yandex Alice Platform and add the same smart devices that the Z-wave.me driver controls.
If Z-wave.me device does not agree with a template device of Yandex Alice, you can use a device that is more suitable functionally (for example, to turn on/off devices a "Switch" can be used).
5 To create connection between the voice assistant and Z-wave.me device use Forward value to… function.
There two types of tags for RGB lamps in Z-wave.me driver:
- Switch Color RGBA,
- Switch Color RGB.
Voice assistants work only with RGB. iR.Studio works with RGBA.
6 Upload your project to the cloud following the general manual on setting voice assistants.