Эта страница является
переводом страницы
EIDE. Перевод выполнен на 98%.
iRidium for EIDE
It's a set of tools for creating a visualization interface to control equipment working via EIDE protocol.
The documentation was updated on 19.7.2021
Use the following example of a project to learn about driver capabilities.
Description
iRidium for EIDE is a set of tools to create an interface to control Smart home or office on the basis of equipement working via EIDE protocol. It realizes commands of EIDE protocol.
List of supported equipment:
- Energy metter EM01;
- R0405 4-output relay;
- C02 control of blinds;
- MAC01 conditioner;
- RCU01 gateway (IR is not supported);
- D0610-DA 6-output relay/ dimmer ;
- R0801C 8-output relay controlling the outcoming current rate;
- 5 in 1 sensor (5ch_sensor);
- GW01 gateway;
- DMX512 gateway supporting DMX512 protocol.
Connection
To connect the driver to equipment, it's required to know the IP-address of the gateway or use Broadcast address 224.0.0.100.
The IP-address of the gateway can be found and set in the Background Editor native app.
Work in iRidium
Create a new project and add EIDEdriver to it with the help of a scanner or by entering data manually.
Scanning devices
During scanning iRidium Studio scans the EIDE bus anf adds all EIDE devices with preset commands and feedback channela to iRidium project.
1 Click Scan > Scan Eide Device in the Devices window in the created project:
2 Enter the IP-address, the port and time of bus scanning (in ms):
3 Add required devices to the project:
Do not use the Background Editor app together with the scanner as they use the same port to connect to equipment!
If the scanner can't find equipment, you can enter the driver settings manually:
Adding Driver Manually
Add EIDE driver to your project from iRidium database
1 Open the Devices panel in the created project and add EIDE driver to it with the help of Add driver:
2 Click the left mouse button on the added EIDE driver and add required devices (Add subdevice). All devices are devided into folders according to its type.
3 Enter additional parameters for subdevices according to its settings, set with the help of the Background Editor app (on Win).
Setting connection parameters
When the driver is added to a project, enter connection settings.
- Log Level - the level of driver logging;
- Host - IP-address of equipment;
- Port - connection port (by default it is 8642);
- MAC - MAC address that will recieve i3 pro to work with EIDE (by default 01:02:03:04:05:06:07:08);
- Delay between initial reqests - a period of time in which i3 pro will request values from equipment if the values could not be received at the app start (there are 3 attempts after which Request timeout delay is activated);
- Request timeout delay - a period of time after which i3 pro will renew request of equipment;
- Version - version (the parameter is always 1);
- Local Port - port of local connection (by default it is 8642).
Setting Subdevices
Parameters of scanned devices (from the Background Editor app) must be entred in the settings of driver subdevices:
- Name - the name of a group of subdevices;
- MAC - MAC address of a group of subdevices (it is found with the help of a scanner in the Background Editor app).
- Name - the name of a subdevice;
- Driver Type - a type of driver;
- Device id - the ID of the subdevice on a device;
- Device type - a type of device (it is found with the help of the Background Editor app).
Parameters of commads / feedback channels:
- Name - the name of a command / a feedback channel;
- Function id - the number of a function (it is found with the help of the Background Editor app);
- Function type - a type of a function (it is found with the help of the Background Editor app);
- Command type - a type of command (get is responsible for comulsory getting the state of a function in a feedback channel; set is responsible for sending values).
If set is chosen:
- Value type is set automatically or can be found in the Background Editor app;
- Min / Max appears when certain function types are chosen, they mean the max and the min value od a function (it is set automatically);
- Use value chanel sends a value that is set in the opened subpoint ignoring the value sent to the channel when it is drag'n'dropped on an item;
- Unit - a measure unit (it is set automatically).
Devices
Each device has a list of preset commands and feedback channels according to its type. You can add or delete required commands and feedback channels, as well as change their parameters.
If you can't find your device in the list, but it has the same type of commands (Function type), you can add it yourself using given devices as an example.
Sensor (5 in 1)
Commands
| Subdevice |
Command |
Values |
Description
|
| Sensor_PIR |
Get state Someone/nobody |
no |
A command of obligatory update of the status of a proximity sensor.
|
| Sensor_Temp |
Get state Current temperature |
no |
A command of obligatory update of the status of a temperature sensor.
|
| Sensor_Lux |
Get state Current illumination |
no |
A command of obligatory update of the status of a brightness sensor.
|
| Sensor_But |
Get state Switch |
no |
A command of obligatory update of the status of a sensor of closing the dry contact.
|
| Sensor_Vol |
Set state Output voltage |
0 - 10 |
Set the level of voltage on the output.
|
| Get state Output voltage |
no |
A command to get the level of voltage on the output.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| Sensor_PIR |
State Someone/nobody |
1 / 0 |
Proximity sensor
(1 - movement is detected, 0 - no movement).
|
| Sensor_Temp |
State Current temperature |
-40 - 125 |
Temperature from -40 to +125 degrees Celsius.
|
| Sensor_Lux |
State Current illumination |
0 - 5000 |
Lighting from 0 to 5000 Lux.
|
| Sensor_But |
State Switch |
1 / 0 |
The state of a sensor of closing a dry contact (1 - closed, 0 - open).
|
| Sensor_Vol |
State Output voltage |
0 - 10 |
The level of voltage on the output.
|
C02 (Curtain 2ch)
Commands
| Subdevice |
Command |
Values |
Description
|
| C02_Curtain (1-2) |
Set state Open/Close/Stop |
0.Stop,
1.Open,
2.Close. |
Send a command to open / close / stop blinds.
|
| Get state Open/Close/Stop |
no |
A command of obligatory update of the status of blinds.
|
| Set state Percentage (horizontal) |
0 - 100 |
Send a command to open blinds (in %).
|
| Get state Percentage (horizontal) |
no |
A command of obligatory update of the status of opening blinds. (in %).
|
| C02_Curtain group 1 |
Set state Open/Close/Sto |
0.Stop,
1.Open,
2.Close. |
Send a command to open / close / stop blinds to a group of blinds.
|
| Get state Open/Close/Stop |
no |
A command of obligatory update of the status of blinds.
|
| Set state Percentage (horizontal) |
0 - 100 |
Send a command to a group of blinds to open blinds at a set value (in %).
|
| Get state Percentage (horizontal) |
no |
A command of obligatory update of the status of closing blinds (in %).
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| C02_Curtain (1-2) |
State Open/Close/Stop |
0.Stop,
1.Open,
2.Close. |
The state of blinds.
|
| State Percentage (horizontal) |
1 - 100 |
The state of opening blinds (in %).
|
| C02_Curtain group 1 |
State Open/Close/Stop |
0.Stop,
1.Open,
2.Close. |
The state of a group of blinds.
|
| State Percentage (horizontal) |
0 - 100 |
The state of opening a group of blinds (in %).
|
MAC01 (Air conditioning)
Commands
| Subdevice |
Command |
Values |
Desciption
|
| MAC01_Air_Controller |
Set state Switch |
1 / 0 |
Turning on / off air conditioner.
|
| Get state Switch |
no |
Getting the state of an air conditioner (on / off).
|
| Set state Mode |
1.Cooling,
2.Heating,
3.Auto,
4.Ventilation,
5.Dehumidification. |
A change of the work mode of an air conditioner.
|
| Get state Mode |
no |
Getting the work mode.
|
| Set state Wind speed |
1.Auto,
2.High,
3.Middle,
4.Low. |
A change of the fan speed.
|
| Get state Wind speed |
no |
Getting the fan speed.
|
| Set state Target temperature |
16 - 30 |
Setting the temperature in a room (in Celsius).
|
| Get state Target temperature |
no |
Getting the set temperature in the room.
|
| Get state Current temperature |
no |
Getting the real temperature in the room.
|
| MAC01_Temperature |
Get state Current temperature |
no |
Getting the current temperature of the sensor.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| MAC01_Air_Controller |
State Switch |
1 / 0 |
The state of an air conditioner (1 - on, 0 - off);
|
| State Mode |
1.Cooling,
2.Heating,
3.Auto,
4.Ventilation,
5.Dehumidification. |
The set mode of air conditioner work;
|
| State Wind speed |
1.Auto,
2.High,
3.Middle,
4.Low. |
The set speed of the fan.
|
| State Target temperature |
16 - 30 |
Set temperature in the room.
|
| State Current temperature |
-55 - 125 |
Real temperature in the room.
|
| MAC01_Temperature |
State Current temperature |
-55 - 125 |
The current temperature of the sensor.
|
R0810C (Relay with current amperage 8ch)
Commands
| Subdevice |
Command |
Values |
Description
|
| R0810C_Relay (1-8) |
Set state Switch |
1 / 0 |
Turning on / off a relay.
|
| Get state Switch |
no |
Getting the state of a relay (on / off).
|
| Get state Current current |
no |
Getting the current rate on the relay output.
|
| R0810C_Group 1 |
Set state Switch |
1 / 0 |
Turning on / off a group of relays.
|
| Get state Switch |
no |
Getting the state of a group of relays (on / off).
|
| Get state Current current |
no |
Getting the current rate on the output for a group of relays.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| R0810C_Relay (1-8) |
State Switch |
1 / 0 |
The state of a relay (on / off).
|
| State Current current |
0 - 25500 |
The current rate on the relay output.
|
| R0810C_Group 1 |
State Switch |
1 / 0 |
The state of a group of relays (1 - all relays in a group are on,
0 - all relays in a group are off).
|
| State Current current |
0 - 25500 |
The current rate on the relay output (it is more than 0, if the current rate on all relays is equal).
|
R0405 (Relay 4ch
Commands
| Subdevice |
Command |
Values |
Description
|
| R0405_Relay (1-4) |
Set state Switch |
1 / 0 |
Turning on / off a relay.
|
| Get state Switch |
no |
Getting the state of a relay.
|
| R0405_Group 1 |
Set state Switch |
1 / 0 |
Turning on / off a group of relays.
|
| Get state Switch |
no |
Getting the state of a group of relays.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| R0405_Relay (1-4) |
State Switch |
1 / 0 |
The state of a relay.
|
| R0405_Group 1 |
State Switch |
1 / 0 |
The state of a group of relays (1 - all relays is a group are on, 0 - all relays is a group are off).
|
EC01/EM01 (Energy meter)
Commands
| Subdevice |
Command |
Values |
Description
|
| EC01/EM01_Energy meter |
Get state Current current |
no |
Getting the value of the current rate.
|
| Get state Current voltage |
no |
Getting the level of voltage.
|
| Get state Voltage frequency |
no |
Getting the frequency of voltage.
|
| Get state Active power |
no |
Getting active power.
|
| Get state Power usage |
no |
Getting the value of consumed power.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| EC01/EM01_Energy meter |
State Current current |
0 - 30000 |
The current rate in the converter.
|
| State Current voltage |
0 - 300 |
The level of voltage.
|
| State Voltage frequency |
0 - 100 |
The frequency of voltage.
|
| State Active power |
Value |
The value of active power.
|
| State Power usage |
Value |
The value of consumed power.
|
RCU01 (Gateway/Relay/Dry сontact/IR)
Commands
| Subdevice |
Command |
Values |
Description
|
| RCU01_GateWay |
|
|
Not supported.
|
| RCU01_Relay (1-18) |
Set state Switch |
1 / 0 |
Turning on / off a relay.
|
| Get state Switch |
no |
Getting the state of a relay.
|
| RCU_DryContact_(1-18) |
Get state Switch |
no |
A command of obligatory update of the state of the dry contact
|
| RCU01_Voltage (1-12) |
Set state Output voltage |
0 - 10 |
Set the level of voltage on the output.
|
| Get state Output voltage |
no |
Getting the level of voltage on the output.
|
| RCU_Temperature_1 |
Get state Current temperature |
no |
A command of obligatory update of the state of a temperature sensor.
|
| RCU_IRout_(1-2) |
|
|
Not supported.
|
| AirCondition_IR(1-2) |
Set state Switch |
1 / 0 |
Turning on / off an air conditioner.
|
| Get state Switch |
no |
Getting the state of an air conditioner (on / off).
|
| Set state Mode |
1.Cooling,
2.Heating,
3.Auto,
4.Ventilation,
5.Dehumidification. |
A change of the wokr mode.
|
| Get state Mode |
no |
Getting the work mode.
|
| Set state Wind speed |
1.Auto,
2.High,
3.Middle,
4.Low. |
A change of the fan speed.
|
| Get state Wind speed |
no |
Getting the speed of the fan.
|
| Set state Target temperature |
19 - 30 |
The target temperature in the room (in degrees Celsius).
|
| Get state Target temperature |
no |
Getting the set temperature in the room.
|
Feedbacks
| Подустройство |
Фидбэк |
Значения |
Описание
|
| RCU01_GateWay |
|
|
Не поддерживается.
|
| RCU01_Relay (1-18) |
State Switch |
1 / 0 |
Состояние реле (1 - включено, 0 - выключено).
|
| RCU_DryContact_(1-18) |
State Switch |
1 / 0 |
Состояние сухого контакта (1 - зажат, 0 - не зажат).
|
| RCU01_Voltage (1-12) |
State Output voltage |
1 -10 |
Уровень напряжения на выходе.
|
| RCU_Temperature_1 |
State Current temperature |
-40 - 125 |
Температура от -40 до 125 градусов по Цельсию.
|
| RCU_IRout_(1-2) |
|
|
Не поддерживается.
|
| AirCondition_IR(1-2) |
State Switch |
1 / 0 |
Состояние включения кондиционера.
|
| State Mode |
1.Cooling,
2.Heating,
3.Auto,
4.Ventilation,
5.Dehumidification. |
Выбранный режим работы.
|
| State Wind speed |
1.Auto,
2.High,
3.Middle,
4.Low. |
Установленная скорость работы вентилятора.
|
| State Target temperature |
19 - 30 |
Установленная температура в помещении.
|
D0610-DA (Dimming Relay 6ch)
Commands
| Subdevice |
Command |
Values |
Description
|
| D0610-DA_Dimmer (1-6) |
Set state Switch |
1 / 0 |
Turning on / off a relay.
|
| Get state Switch |
no |
Getting the state of a relay.
|
| Set state Brightness |
0 - 100 |
Measuring the level of brighness on the relay.
|
| Get state Brightness |
no |
Getting the level of brightness on the relay.
|
| Set state Dimming |
1.Start,
2.Forward,
3.Reverse,
4.Finish. |
A change of a dimming type:
Start - a gradual increase of brightness and then fading,
Forward - gradual increase of brighness without fading,
Reverse - gradual fading,
Finish - stop changing brightness on the current level.
|
| Get state Dimming |
no |
Getting the type of dimming.
|
| D0610-DA_Group 1 |
Set state Switch |
1 / 0 |
Turning on / off a group of relays.
|
| Get state Switch |
no |
Getting the state of a group of relays.
|
| Set state Brightness |
0 - 100 |
Changing the brightness of a group of relays.
|
| Get state Brightness |
no |
Getting the level of brightness of a group of relays.
|
| Set state Dimming |
1.Start,
2.Forward,
3.Reverse,
4.Finish. |
A change of a dimming type of a group of relays:
Start - a gradual increase of brightness and then fading,
Forward - gradual increase of brighness without fading,
Reverse - gradual fading,
Finish - stop changing brightness on the current level.
|
| Get state Dimming |
no |
Getting the dimming type of a group of relays.
|
Feedbacks
| Subdevice |
Feedback |
Values |
Description
|
| D0610-DA_Dimmer (1-6) |
State Switch |
1 / 0 |
The state of a relay (on / off).
|
| State Brightness |
0 - 100 |
The current brightness on the relay.
|
| State Dimming |
1.Start,
2.Forward,
3.Reverse,
4.Finish. |
The current type of dimming:
Start - a gradual increase of brightness and then fading,
Forward - gradual increase of brighness without fading,
Reverse - gradual fading,
Finish - stop changing brightness on the current level.
|
| D0610-DA_Group 1 |
State Switch |
1 / 0 |
The state of a group of relays (1 - all relays of the group are on).
|
| State Brightness |
0 - 100 |
The current brightness of a group of relays (it is more than 0, if the same level of brightness is set on all relays, and it is not 0).
|
| State Dimming |
1.Start,
2.Forward,
3.Reverse,
4.Finish. |
The current dimming type of a group (1-4, if the same type of dimming is set on all relays)
|
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 or display a value.
Read more about work with graphic items in the
"Types of graphic items" article.
