Эта страница является
переводом страницы
Clipsal. Перевод выполнен на 100%.
iRidium for Clipsal
a set of tools for creating interfaces to control Clipsal equipment
The documentation was updated on 27.6.2025
Warning: Driver is outdated, functionality may work incorrectly or not be supported.
Description
iRidium for Clipsal is a set of tools for creating interfaces to control homes or offices on the basis of Clipsal equipment.
iRidium for Clipsal enables connection of control panels (iOS, Android, Windows, Mac) to equipment directly, via the CNI Ethernet interface or the C-Gate program. When working via the CNI Ethernet interface Clipsal supports 1 connection (1 control panel at a time). When working via C-Gate the number of connections is regulated in the program settings. You can increase the number of connections via the CNI Ethernet interface with the help of iRidium Server.
Connection
Equipment configuration and settings required for iRidium to control Clipsal.
Ways of connection to Clipsal
Different ways of connection enable local work or work via the Internet
1. CNI Ethernet interface
1. CNI Ethernet interface (the Clipsal driver) enables direct connection to C-Bus but provides work only for one control panel at a time
2. C-Gate (the Clipsal Gate driver) requires software installation on PC but provides work of several panels at a time.
Both ways of connection provide a possibility to connection to C-Bus via the Internet.
Adding of the Clipsal driver in iRidium
Import the list of devices which can be controlled from the C-Bus Toolkit *.xml file.
Create and set up a Clipsal control project in C-Bus Toolkit. The command names will be formed as "Application_Group name > Lighting_Group 1"
The project file is located in the Clipsal software folder: Clipsal\C-Gate2\tag and has the .xml format
Select the way of connection: Clipsal (CNI Ethernet interface) or Clipsal Gate (C-Gate)
When working via Clipsal (CNI Ethernet interface) you can select only 1 Network
When working via Clipsal Gate (C-Gate) you can select several Networks
Mark the check-box near the driver to add it to the project. Click OK.
Settings of Clipsal drivers:
- Host - the controller IP-address
- Port - the TCP port of connection (10001);
- Keep Alive - an interval to check TCP connection. In case there is no answer to Keep Alive requst, the driver will be forced into the off state. The parameter is created to display the correct on-line status, if the client was disconnected in an emergency or in a wrong way. 0 - turns off the setting.
- Log Level - the level of logging;
- Host - the controller IP-address
- Port - the TCP port of connection (20023)
- Parameters - the project name in C-Bus Toolkit considering the register
Commands & Feedbacks
Commands and Feedbacks - the commands and feedbacks inside the driver. They enable control of equipment. The commands are device properties available for writing, the channels are properties available for reading.
Clipsal commands in iRidium Studio:
Clipsal
- Name - the command name
- Unit Address - the number of the module to which the command is addressed (Network/Units/Address in C-Bus Toolkit)
- Application - the application from C-Bus Toolkit
- Application Number - the application number from C-Bus Toolkit (when using a non-default application)
- Group - a group address from C-Bus Toolkit
- Command - the command sent to the group address
- Parameter - the additional condition for the command (it is used with some applications )
- ParamArg - the parameter argument (it is used with some applications)
Clipsal Gate
- Name - the command name
- Unit Address - the number of the module to which the command is addressed (Network/Units/Address in C-Bus Toolkit)
- Network ID - the network number in the project from C-Bus Toolkit
- Application - the application from C-Bus Toolkit
- Application Number - the application number from C-Bus Toolkit (when using a non-default application)
- Group - the group address from C-Bus Toolkit
- Command - the command sent to the group address
- Parameter - the additional condition for the command (it is used with some applications )
- ParamArg - the parameter argument (it is used with some applications)
Commands and feedback channels have to be assigned to project graphic items to control equipment:
- Commands are assigned to graphic items indicating the value to be sent to registers when clicking on the items
- Feedback channels are assigned to graphic items to display the register state
To assign commands or channels to graphic items use the drag&drop method.
for fast creation of Feedback with the same settings with Command, right-click on Command and select the "Create Feedback" option. You can create Feedback for several registers at a time.
Setting up of C-Gate
C-Gate enables connection only for those IP-addresses which are indicated in its settings. Add the IP-address of the control panel in the list of allowed ones: the access.txt file in the software directory Clipsal: Clipsal\C-Gate2\config.
Each control panel has to be described in the file as a new string:
interface 192.168.0.1 Program
Save the changes in the file and restart the C-Gate service via the Start menu:
Changing the connection settings
You need the possibility to change connection properties when you disconnect from the Wi-Fi network of the automation object and start using 3G or another Wi-Fi network. To maintain control of the object you need to switch from the local to public IP-address of the Internet router.
The switch is not automatic. You have to select the connection mode. For remote acces you have to make ports for controlling the automation system public. In order to do that you have o set up the Port Forwarding service on your Internet router. VPN can provide protected connection.
1 Download the template (*.js) (right-click button: "Save object as ..."), add the template in the script editor with the button
(+) Add Script from file
2 Set up script properties as it is shown in the example:
- function Internal_1() {
- IR.GetDevice("Clipsal").SetParameters({Host: "192.168.0.100", Port: 10001});
- }
- function External_1() {
- IR.GetDevice("Clipsal").SetParameters({Host: "215.110.10.10", Port: 10001});
- }
Copy the driver name from Projeсt Device Panel - the list of properties has to be copied from the example.
3 Select the button which will be responsible for the switch of Internal and External properties. Open Macros Editor for the Press event (Object Properties > Programming), select the Script Call command and add it by double-clicking on it. Select the name of the function which will be activated by the button:
Now each pressing on the button will apply the corresponding connection properties.
Control of equipment
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.
Possible settings of commands, channels and graphic items are presented below:
Lighting
You can send one of the commands from the Command list in Application Lighting:
Command:
| Unit Address |
1...n |
the number of the module to which the command is addressed
|
| Network ID |
1...n |
the network number in the C-Bus Toolkit project
|
| Application |
Lighting |
the C-Bus Toolkit application
|
| Group |
0...7 |
the group address of C-Bus Toolkit
|
| Command * |
On |
to turn on
|
| Off |
to turn off
|
| Ramp |
to increase up to the indicated value
|
| Terminate Ramp |
to stop the Ramp process
|
| ParamArg |
instantaneously |
to set up the brightness value - it is applied right away
|
| over N seconds / N minutes |
to set up the brightness value with increment over the indicated time
|
| Value * |
- |
for Command: On, Off, Terminate Ramp leave Value empty
|
| 0...255 |
for Command: Ramp brightness is changed in the range 0...255.
|
*Value - indicate when dragging the command on graphic items
Feedback:
Feedback has to be received with the following settings:
| Unit Address |
1...n |
the number of the module to which the command is addressed
|
| Network ID |
1...n |
the network number in the C-Bus Toolkit project
|
| Application |
Lighting |
the C-Bus Toolkit application
|
| Group |
0...7 |
the C-Bus Toolkit group address
|
| Command * |
Ramp |
to get the current brightness value
|
| ParamArg |
instantaneously |
to get the brightness value
|
| Value * |
0...255 |
the current brightness value
|
* Value comes to the feedback channel. It can be used for displaying on items
