Эта страница является
переводом страницы
Xicato. Перевод выполнен на 100%.
iRidium for Xicato
A set of tools to create control interfaces for equipment by Xicato.
The documentation was updated on 17.10.2022
Description
iRidium for Xicato is a set of tools that allow to create an interface to control Xicato lighting equipment.
Tested with the following equipment:
Connection
Xicato driver works via the HTTP protocol. The status becomes online only during data transfer, the rest of the time the status is always offline.
To connect to Xicato equipment, do the following:
1 Download the Ximtroller app (for iOS), Admin Panel (on Win) or another official app by Xicato and set equipment;
2 Add the Xicato driver to a created server or panel project and set it ';
3 Assign commands and feedback channels to items of the interface and set required project logic.
Work in iRidium
Create a new project and add Xicato driver to it with the help of a scanner or entering data manually.
Network scanning
Scanning works only in the local network - it allows to add all Xicato devices to iRidium project. Here is how to do it:
- Create a new project and click Scan > Xicato Scanner in the Devices tab;
- Fill in the IP-address, port, login and password to connect to equipment;
- Choose a device that you plan to control.
If the scanner can't find equipment, you can enter the driver settings manually:
Setting Driver
1 Add the Xicato driver in the DEVICES tab to a created project.
2 Enter the driver connection settings:
- Log Level - the level of logging;
- Host - IP-address of equipment;
- Port - port (8000 by default);
- Login / Password - a login and password to access equipment;
- Driver Version - a driver version.
3 Click left mouse button on the added Tion Network driver and add required subdevices (Add subdevice). Each device has a preset list of commands and feedback channels according to its type.
Setting Subdevices
- Name - the name of a subdevice;
- Driver Type - a type of the driver (Xicato);
- Device ID - a unique ID of the device (it must agree with the ID in the web-interface of the equipment);
- Network - the name of a network. A network can be created with the help of the Admin Panel app (on Win), if there is no network, write "unsecured";
- Device Type - a type of a device (a lamp, a group, a multichannel device).
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.
Lamp
Controlling a lamp.
Command
| Parameter |
Values |
Description
|
| Command |
Intensity |
Setting the brightness of a lamp.
|
| Use Value Channel |
True / False |
True - send the value of a parameter of the channel Intensity.
False - send Value to the channel.
|
| Intensity |
0 - 100.0 |
Set the brightness of a lamp.
|
| Is Need Fading |
True / False |
Use light fading, when a lamp is turned off/on.
|
| Fading |
0 - n |
Fading / lighting time of a lamp (in ms.).
|
| Value* |
0 - 100.0 |
Set the brightness of a lamp.
|
* - enter it when drag'n'dropping a command on a graphic item
| Parameter |
Values |
Description
|
| Command |
Recall Scene |
Calling a scene of lam p work (brightness, fading, delay at start).
|
| Scene Number |
1 - n |
The number of a scene.
|
| Is Need Fading |
True / False |
Use smooth light fading in a scene.
|
| Fading |
0 - n |
Fading / lighting time of lamps in a scene (in ms.).
|
| Value* |
- |
Not used.
|
* - enter it when drag'n'dropping a command on a graphic item
Feedback
| Parameter |
Values |
Description
|
| Feedback |
Intensity |
The state of lamp brightness.
|
| Value* |
0 - 100.0 |
The current brightness of a lamp.
|
* Value - a value given by equipment
Group
Control of lamps in a group.
Command
| Parameter |
Values |
Description
|
| Command |
Intensity |
Setting the brightness of a lamp.
|
| Use Value Channel |
True / False |
True - send the value of a parameter of the channel Intensity.
False - send Value to the channel.
|
| Intensity |
0 - 100.0 |
Set the brightness of a lamp.
|
| Is Need Fading |
True / False |
Use fading, when a lamp is turned off/on.
|
| Fading |
0 - n |
Fading / lighting time of a lamp (in ms.).
|
| Value* |
0 - 100.0 |
Set the brightness of a lamp.
|
* - enter it when drag'n'dropping a command on a graphic item
| Parameter |
Values |
Description
|
| Command |
Recall Scene |
Calling a scene of lamp work (brightness, fading, delay at start).
|
| Scene Number |
1 - n |
The number of a scene.
|
| Is Need Fading |
True / False |
Use smooth light fading in a scene.
|
| Fading |
0 - n |
Fading / lighting time of lamps in a scene (in ms.).
|
| Value* |
- |
Not used.
|
* - enter it when drag'n'dropping a command on a graphic item
Multi-Channel Device
Controlling a multi-channel device
Command
| Parameter |
Values |
Description
|
| Command |
Multi-Channel Intensity |
Set brightness of lamps of a multi-channel device .
|
| Quantity Sub-Channel |
1 - n |
Number of master channels (without a master channel).
|
| Channel Number |
0 - n |
The number of a channel (0 - master, 1 and more - subchannels).
|
| Use Value Channel |
True / False |
True - send the value of a parameter of the channel Intensity.
False - send Value to the channel.
|
| Intensity |
0 - 100.0 |
Set brightness of lamps of a multi-channel device
|
| Is Need Fading |
True / False |
Use smooth light fading of a multi-channel device when a lamp is turned off/on.
|
| Fading |
0 - n |
Fading / lighting time of lamps (in ms.).
|
| Value* |
0 - 100.0 |
Set brightness of lamps of a multi-channel device
|
* - enter it when drag'n'dropping a command on a graphic item
Feedback
| Parameter |
Values |
Description
|
| Feedback |
Multi-Channel Intensity |
The state of lamp brightness of a multi-channel device.
|
| Channel Number |
0 - n |
The number of a channel (0 - master, 1 and more - subchannels).
|
| Value* |
0 - 100.0 |
The current brightness of a lamp in a multi-channel device.
|
* Value - a value given by equipment
Multi-Channel Group Devices
Controlling a group of multi-channels devices
Command
| Parameter |
Values |
Description
|
| Command |
Multi-Channel Intensity |
Set brightness of lamps in a group of a multi-channel devices.
|
| Quantity Sub-Channel |
1 - n |
Number of master channels (without a master channel).
|
| Channel Number |
0 - n |
The number of a channel (0 - master, 1 and more - subchannels).
|
| Use Value Channel |
True / False |
True - send the value of a parameter of the channel Intensity.
False - send Value to the channel.
|
| Intensity |
0 - 100.0 |
Set brightness of lamps in a group of a multi-channel devices
|
| Is Need Fading |
True / False |
Use smooth light fading in a group of a multi-channel device when a lamp is turned off/on.
|
| Fading |
0 - n |
Fading / lighting time of lamps (in ms.).
|
| Value* |
0 - 100.0 |
Set brightness of lamps in a group of a multi-channel devices
|
* - enter it when drag'n'dropping a command on a graphic item.
