Эта страница является переводом страницы ZigBee. Перевод выполнен на 94%.

---

iRidium for ZigBee

how iRidium server gets access to ZigBee wireless network

The documentation was updated on 17.1.2022

ZigBee networks can work with:

• Any hardware server (RPi, Windows, Linux, UMC) with a connected ZigBee stick.
• iRidium server UMC C3 with a built-in ZigBee module* (for Russian market only).
  

* - out of production.

iRidium server does not support all ZigBee devices and functions. "Working with Commands and Feedbacks" section contains information about supported ZigBee classes.

Tested hardware

Legrand Netatmo

• AG07556 - one-key (two-button), built-in light switch (dimmer);
• AG0777 - one-key (two-button), built-in curtains controller;
• AG08761 - wireless one-button switch;
• AG08763 - wireless curtains controller;
• AG08761 - wireless two-key switch.

Danfoss Icon

• 088U1122 - Room Thermostat;
• 088U1105 - Radio Module;
• 088U1141 - Master Controller OTA;
• 088H3110 - TWA-A NC;
• 088U1130 - Zigbee Module.

Aqara

• MCCGQ11LM - Aqara Door and Window Sensor;
• RTCGQ11LM - Aqara Motion Sensor;
• WSDCGQ11LM - Aqara Temperature and Humidity Sensor;
• QBKG03LM - Aqara 2х1 switch;
• WXKG02LM - Wireless Remote Switch (Double Rocker).

Special features os Aqare devices:

• As Xiaomi Aqara does not fully support zigbee specification, we do not recommend using a lot of wireless devices by Xiaomi in your projects, as stable works is not guaranteed.
• Check that the channel of your zigbee devices does not conflict with the wifi network. Sometimes zigbee can conflict with Wifi as they are located in one radio channel (read more here).
• To increase the stability of sensor work it is recommended to check that the server is always on and it functions all right (zigbee devices often lose their netwwork if they can't see the coordinator in it).
• If you do not get data from devices, check that a device is out of the network. If climate parameters remain within a definite range, it means that the device does not send any data to the network. You can "wake up" a device by pressing a button on it.
• If one and the same sebsor always loses network, try changing it. It can be a manuracting defect.

Advantages

One of the main spheres of ZigBee use is home automation
ZigBee devices

• can organize mesh-networks that provide self-repair and guaranteed data delivery in cases of connection loss, appearance of obstacles or malfunction of a network item
• are characterized by low power consumptiona and can work on regular batteries, thus, no cable is required.
• can exchange data at a distance of several dozen meters from each other (if located in the line of sight)

There are a lot of devices with ZigBee interface on the market. Developers now have a splendid opportunity to integrate all these devices with iRidium platform.

Adding Devices to the Network

1Supply power to the server.
2Go to the web-interfaсe of the server.
3Go to ZigBee (beta) tab.

4Press Settings button to configure Zigbee network.

5Configure USB-stick or built-in ZigBee module (only for UMC) in accordance with its technical characteristics.

Setting up USB sticks

ZigBee module configuration

A built-in module for ZigBee is always located in slot 4, it is displayed as /hal/zwt_m4.

• Elelabs Zigbee USB Adapter ELU013
  • Baud Rate: 115200,
  • Data Bits: 8,
  • Parity: None,
  • Stop Bits: 1.

• DEFARO SPRUTSTICK PRO
  • Baud Rate: 115200,
  • Data Bits: 8,
  • Parity: None,
  • Stop Bits: 1.

• Nortek HUSBZB
  • Baud Rate: 57600,
  • Data Bits: 8,
  • Parity: None,
  • Stop Bits: 1.

• 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.

If your device is displayed as an unknown device, update the drivers for the stick.

• For Linux OS
  • Connect USB-stick;
  • It is not required to install additional drivers. To select USB-stick port, clear Serial Port and select your stick in the list.

• For UMC_C3
  • Connect USB-stick;
  • It is not required to install additional drivers. To select USB-stick port, clear Serial Port and select your stick in the list.

A stick for UMC is always in the USB port, and it is displayed in its name ttyUSB.

It is relevant only for new servers with an installed patch for sticks. If the patch is not installed, and you can't see sticks in the web-interface, contact our technical support (support@iridi.com).

6Click Create Network to create new network.

7Click Open Network button. The server scans the network for about 180 seconds. During this time you are to do certain physical actions to a wireless device that has to be added. As a rule it is required to press a button on a device several times. (Read the manual to your device to learn what exactly has to be done.)

An example of adding a Legrand device:

1 Delete the safety tag;

2 Hold the button until the diode is lit;

3 Press the button one more time for the diode to blink (a blinking diode shows that the device is available to connect to ZigBee);

4 Wait till the device is shown in the web-interface;

An example of adding Aqara device:

1 Hold the button on the device until the diode blinks several times.

2 Press the button on a device from time to time to "wake it up".

3 We recommend controlling the server logs at the moment. See the level of logging into INFO and wait for Device inited. It means that the device is initiated and it is ready for further setting.

4 Wait till the device is shown in the web-interface.

5The device is added to the list and it gets an ID. Add all required devices to your net.

Device name can be enteres in User description field.
7After it the network is created. Export data about the created network as a .xml file by clicking the Export button.

To delete a device from the network, use Delete button. After it press the physical button three times on the device that you want to delete (or do another action described in the manual). The whole network can be deletd by clicking Delete Network button.

Working in iRidium studio

Adding ZigBee driver

1Create server project in iRidium studio. Click a button to import the .xml file (ZigBee XML Files).

2Select the required devices to add in your project.

3The driver with all devices appears in the Project Device Panel.

4You 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.

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 value drag'n'drop a feedback channel on a graphic item and choose how to output a value.

Read more about work with graphic items in the "Types of graphic items" article.

You will find below information about supported classes of ZigBee, its commands and feedbacks.

Information about supported ZigBee functions

On/Off

Command for switching devices between on and off states.

Name of a command or feedback	Type	Admissible values	Description
Set state	Command	OFF - 0, ON - 1	Set the switch state.
Off	Command	Any value	Set the switch state to off.
On	Command	Any value	Set the switch state to on.
Toggle	Command	Any value	Switch to the opposite switch state.
State	Feedbacks	0 / 1	Current switch state.
Off Event*	Feedbacks	0	Get event when the switch is turned off.
On Event*	Feedbacks	0	Get event when the switch is turned on.
Toggle Event*	Feedbacks	0	Get event when the state is switched.

Event * - an event which feedback receives from equipment when its state changes. The event cannot be displayed on a graphical interface item, its value will always be displayed as 0.

With the help of the Forward value to setting you can send an event to a command channel and unite several devices. For example, when you turn on the switch (On Event), we send an event to the command (On) of the relay to turn on the light.

When events are activated, listeners will be activated EVENT TAG CHANGE and EVENT GLOBAL TAG CHANGE.

Level

This cluster provides an interface to control the device characteristics, which can be installed on the level, for example: the brightness of the light, the degree of door closing or the power of the heater. In most cases it is used with OnOff commands.

Name of a command or feedback	Type	Admissible values	Description
Set Value	Command	0 - 255	Set level value.
Read Value	Command	0 - 255	Request the level value.
Move Up	Command	0 - 255	Increase the level value. The sent value will be used as “rate of increase” and will be indicated in units per second.
Move Down	Command	0 - 255	Decrease the level value. The sent value will be used as “rate of increase” and will be indicated in units per second.
Step Up	Command	0 - 255	Increase the level value to the certain step. The sent value will be used as the value of the step.
Step Down	Command	0 - 255	Decrease the level value to the certain step. The sent value will be used as the value of the step.
Stop	Command	Any value	Stop changes of the level value.
Value	Feedbacks	0 - 255	Current level value.
Move Event	Feedbacks	0 / 1	Event of gradual change of the level value: 0 - up, 1 - down.
Move Rate	Feedbacks	0 - 255	The rate of change of the level value at the Move event.
Step Event	Feedbacks	0 / 1	Event of level change by step: 0 - up, 1 - down.
Step Size	Feedbacks	0 - 255	Step size with Step event.
Stop Event	Feedbacks	0	Stop changing the level value.

Power

Commands to determine the detailed information about voltage and battery level.

Name of a command or feedback	Type	Admissible values	Description
Read Power	Command	Any value	Request values.
Battery Voltage	Feedback	0 - 255	Current battery voltage in units of 100mV.
Battery Percentage	Feedback	0 - 200	Current battery percentage: 0 - 0%, 100 - 50%, 200 - 100%, 255 - false value.

Binary Input

Binary input cluster provides an interface to read the value of a binary dimension and to access the various characteristics of that dimension. This cluster is usually used to implement a sensor, which measures a two-state physical quantity.

Name of a command or feedback	Type	Admissible values	Description
Read state	Command	Any value	Request the current value .
State	Feedback	0 / 1	Input state.
Out of service	Feedback	0 / 1	Channel is in maintenance state.

Multistate Input

This multistate input cluster provides an interface for reading measurement values with several states and for accessing to the various characteristics of this measurement.

Name of a command or feedback	Type	Admissible values	Description
Read state	Command	Any value	Request the current state.
State	Feedback	0 - 65535	Input state.
Out of service	Feedback	0 / 1	Channel is in maintenance state.

Curtain

Window covering cluster provides an interface for controlling and adjusting automatic window coverings such as curtain motors, automatic curtains and blinds.

Name of a command or feedback	Type	Admissible values	Description
Up	Command	Any value	Open / Raise thecurtain.
Down	Command	Any value	Close / Lower the curtain.
Stop	Command	Any value	Stop opening / closing the curtains.
Lift To Value	Command	0 - 65535	Open the curtain to the specified value.
Lift To Percentage	Command	0 - 100	Open the curtain to the specified percent.
Current Lift Value	Feedback	0 - 65535	Current value of curtain opening.
Current Lift Percentage	Feedback	0 - 100	Current percent of curtain opening.
Tilt To Value	Command	0 - 65535	Turn the roller shutter to the set value.
Tilt To Percentage	Command	0 - 100	Turn the roller shutter to the specified percent.
Current Tilt Value	Feedback	0 - 65535	Current value of the roller shutter rotation.
Current Tilt Percentage	Feedback	0 - 100	Current percent of the roller shutter rotation.

Humidity

The cluster provides an interface to relative humidity measurement functionality.

Name of a command or feedback	Type	Admissible values	Description
Value	Feedback	0.0 - 100.0	Current percent of humidity.

Temperature Measurement

The cluster provides an interface to temperature measurement functionality.

Name of a command or feedback	Type	Admissible values	Description
Value	Feedback	-273.15 - 327.67 ºC	Current temperature in degrees Celsius.

Pressure Measurement

The cluster provides an interface to pressure measurement functionality

Name of a command or feedback	Type	Admissible values	Description
Value	Feedback	-3276.7 - 3276.7 kPa	Current atmospheric pressure.

Occupancy Sensing

The server cluster provides an interface to occupancy sensing functionality, including configuration and provision of notifications of occupancy status.

Name of a command or feedback	Type	Admissible values	Description
State	Feedback	0 / 1	Presence status.

Electrical Measurement

This cluster provides a mechanism for querying data about the electrical properties as measured by the device.

Name of a command or feedback	Type	Admissible values	Description
Read Measurements	Command	Any value	Request current measurements.
DC Voltage	Feedback	Any value	DC voltage in volts.
DC Current	Feedback	Any value	DC value in amperes.
DC Power	Feedback	Any value	DC power in watts.
AC Frequency	Feedback	Any value	AC frequency in hertz.
AC Total Active Power	Feedback	Any value	Total apparent active power (kW).
AC Total Reactive Power	Feedback	Any value	Total apparent reactive power (kVAr).
AC Total Apparent Power	Feedback	Any value	Total instantaneous apparent power (kVAr).
AC Line Current	Feedback	Any value	Phase current.
AC Active Current	Feedback	Any value	Active phase current.
AC Active Power	Feedback	Any value	Active power per phase.
AC Reactive Current	Feedback	Any value	Reactive current per phase.
AC Reactive Power	Feedback	Any value	Phase reactive power.
AC RMS Voltage	Feedback	Any value	Phase rms voltage.
AC RMS Current	Feedback	Any value	RMS current per phase.
AC Apparent Power	Feedback	Any value	Instantaneous power per phase.

Thermostat

This cluster provides an interface to the functionality of a thermostat.

Name of a command or feedback	Type	Admissible values	Description
Read Values	Command	Any value	Request all current feedback values.
Set Mode	Command	0 - 9	Setting the system mode of the thermostat: 0 - Off, 1 - Auto, 3 - Cool , 4 - Heat , 5 - Emergency heating , 6 - Precooling, 7 - Fan only, 8 - Dry, 9 - Sleep.
Shift Heating Setpoint	Command	-1.27 - 1.27	Change heating setpoint.
Shift Cooling Setpoint	Command	-1.27 - 1.27	Change cooling setpoint.
Local Temperature	Feedback	-273.15 - 327.67	The temperature inside the room served by the thermostat sensor.
Outdoor Temperature	Feedback	-273.15 - 327.67	Outside temperature.
Occupancy State	Feedback	0 / 1	Room occupancy state.
System Mode	Feedback	0 - 9	Current system mode of the thermostat: 0 - Off, 1 - Auto, 3 - Cool, 4 - Heat, 5 - Emergency heating, 6 - Precooling, 7 - Fan only, 8 - Dry, 9 - Sleep.
Running Mode	Feedback	0, 3, 4	Current operating mode in System Mode = auto: 0 - Off, 3 - Cool, 4 - Heat.
Occupied Cooling Setpoint	Feedback	-273.15 - 327.67	Cooling setpoint for the current mode when the room is occupied.
Occupied Heating Setpoint	Feedback	-273.15 - 327.67	Heating setpoint for the current mode when the room is occupied.
Unoccupied Cooling Setpoint	Feedback	-273.15 - 327.67	Cooling setpoint for the current mode when the room is unoccupied.
Unoccupied Heating Setpoint	Feedback	-273.15 - 327.67	Heating setpoint for the current mode when the room is unoccupied.