Table of Contents

Advertisement

Quick Links

Lithernet - Casambi Gateway v3.26
User Manual
Revision: 14.03.2023

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Lithernet 160301 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Casambi Lithernet 160301

  • Page 1 Lithernet - Casambi Gateway v3.26 User Manual Revision: 14.03.2023...
  • Page 2: Table Of Contents

    2.2. Gateway to an existing lighting control system (Helvar) ............32 2.3. Gateway to a system using UDP or TCP (ASCII based commands) ........34 2.4. Bridge between individual Casambi networks ................35 2.5. Coupling to an existing evaluation system / visualization ............37 2.6.
  • Page 3 5.2.1.1.2.2. Presence ....................95 5.2.1.2. From Casambi ......................96 5.2.2. View in BacNet ........................97 5.2.2.1. To Casambi ......................99 5.2.2.2. From Casambi ......................101 5.2.2.3. Sensor Value To Casambi ..................102 5.2.2.4. Broadcast ........................103 5.2.2.5. Device ........................104 5.2.2.6. Ungouped .......................106 5.2.2.7. Group ........................107 5.2.2.8. Scene ........................108 5.2.3.
  • Page 4 5.7.2.2. Trigger ........................179 5.7.2.3. Action ........................181 5.7.3. Netcomposer Command Builder ..................182 5.7.3.1. Device Level ......................183 5.7.3.2. Scene ........................184 5.7.3.3. Group with Scene ....................185 5.7.3.4. Group with Level ....................186 5.7.3.5. Sequence ........................187 5.8. UDP Casambi Command ......................188 5.8.1. View in the gateway ......................189...
  • Page 5 5.8.2.1.1. 0x0D - scene called ..................195 5.8.2.1.2. 0x1A - SetParameterValue ................196 5.8.2.1.3. 0x1B - ParametersComplete .................197 5.8.2.1.4. 0x28 - time received from the Casambi network ..........198 5.8.2.1.5. 0x39 - node status ..................199 5.8.2.1.6. 0x3A - notify node removed ................200 5.8.2.1.7. 0x45 - scene status ..................201 5.8.2.1.8.
  • Page 6 5.11.16. SetTargetElements .......................263 6. Console ..............................264 6.1. console .............................267 6.2. Parameter ..........................268 7. Settings in the Casambi app ......................269 7.1. Profile selection ........................270 7.2. Behave as a lamp ........................271 7.3. Settings as a lamp ........................272 7.4. Settings as a button .........................274 7.5.
  • Page 7: Hardware

    1. Hardware The device has only one connection for network (RJ-45). The power is supplied via POE. The gateway consumes one address in the Casambi network. There are 4 LEDs on the front panel for status indication.
  • Page 8: Led Status Display

    1.1. LED Status Display The module has 4 LEDs on the front. From bottom to top: 1) Operating LED - flashes green regularly (1 second) 2) Network status - lights up yellow when the network is plugged in 3) UDP LED - Lights up red when there is no UDP connection, green when one is established 4) TCP / IP LED - Lights up red when there is no TCP / IP connection, green when one has been opened The LEDs can also be switched off in the software.
  • Page 9: Hardware Revision

    1.2. Hardware Revision...
  • Page 10: Hardware Revision 0

    1.2.1. Hardware Revision 0 Hardware Revision 0 Supports firmware versions 1.XX with "_REV0" in the name.
  • Page 11: Hardware Revision 1

    1.2.2. Hardware Revision 1 Hardware Revision 1 Supports firmware versions 1.XX and 2.XX as well as 3.XX with "_REV1" in the name. On the type plate recognizable by the "01-XXXXX" to begin.
  • Page 12: Hardware Revision 2

    1.2.3. Hardware Revision 2 Hardware Revision 2 Supports firmware versions 3.XX and 4.XX with "_REV2" in the name. On the type plate recognizable by the "02-XXXXX" to begin.
  • Page 13: Watchdog

    1.3. Watchdog A watchdog runs in the gateway with a set time of 90s in order to restart the device automatically if necessary.
  • Page 14: Reset Button

    1.4. Reset Button The hardware button is only functional from devices with manufacturing date > 03/2022. There is a small push button on the circuit board. This can be reached by opening the 4 screws on the underside. Depending on how long the button is pressed, different actions are performed. >...
  • Page 15: Conformity

    1.5. Conformity...
  • Page 16: Hardware Revision 1

    1.5.1. Hardware Revision 1 EC Declaration of Conformity Lichtmanufaktur Berlin GmbH hereby declares that the radio equipment type "Lithernet - Casambi Gateway" is in compliance with Directive 2014/53/EU. The full text of the EU Declaration of Conformity is available at the following internet address: https:// archiv.intelligent-lighting.de/index.php/s/XoR27GRkiMWLyeD...
  • Page 17: Hardware Revision 2

    1.5.2. Hardware Revision 2 EC Declaration of Conformity Currently being created. Device is still in beta test stage. UKCA Currently being created. Device is still in beta test stage.
  • Page 18: Bluetooth Module

    All information on this page relates only to the radio module used. Not the entire product. The CBM-002A module from Casambi Oy is used as the Bluetooth module The declaration of conformity for the radio module can be found at the following Internet address: https:// casambi.com/static/datasheets/CBM-002-DoC.pdf...
  • Page 20: Hardware Revision 0 Und 1

    All information on this page refers only to the radio module used. Not to the complete product. The Bluetooth module used is the CBM-002A module from Casambi Oy. The declaration of conformity of the radio module can be found at the following Internet address: https:// casambi.com/static/datasheets/CBM-002-DoC.pdf...
  • Page 22: Hardware Revision 2

    All information on this page refers only to the radio module used. Not to the complete product. The Bluetooth module used is the CBM-002B module from Casambi Oy. The declaration of conformity of the radio module can be found at the following Internet address: https:// f.hubspotusercontent40.net/hubfs/7177595/Data%20sheets/English/CBM-003/CBM-003_DoC_2022-01-14.pdf...
  • Page 23 Le dispositif de a été évalué à répondre général rf exposition exigence. Pour maintenir la conformité avec les directives d’exposition du RSS-102-Radio Fréquence (RF). Ce matériel doit être installé et exploité à une distance minimale de 20 cm entre le radiateur et votre corps. Contains IC: 22496-CBM003B...
  • Page 24: Type Label

    1.7. Type label...
  • Page 25: Hardware Revision 1

    There are 2 nameplates on the back of the device. Here you can see in the barcode that: 01 : Litehrnet - Casambi Gateway Revision 1 41/2020: week and year of production in this case week 41 in 2020 00000001: Serial number of the device...
  • Page 26: Hardware Revision 2

    There are 2 nameplates on the back of the device. Here is recognizable in the barcode that: 02 : Litehrnet - Casambi Gateway Revision 2 41/2020: week and year of production in this case week 41 in 2020 00000001: Serial number of the device...
  • Page 27: Firmware Version

    Between version 3.04 and 3.10 there were some memory adjustments. It could happen that an older backup will be not successfuly imported. The system will show a warning if the Casambi firmware version does not match the gateway firmware version.
  • Page 28: Software Librarys

    1.9. Software Librarys Here is a list of the software libraries used by the Lithernet Casambi Gateway: 1) AsyncTCP-esphome Version: 1.2.2 URL: https://github.com/esphome/AsyncTCP Lizenz: LGPL-3.0 License 2) Async MQTT client for ESP8266 and ESP32 Version: 0.8.6 URL: https://github.com/OttoWinter/async-mqtt-client Lizenz: MIT License 3) ArduinoJson Version: 6.19.1...
  • Page 29: Areas Of Application

    2.1 Gateway to an existing lighting control system (Netcomposer) 2.2 Gateway to an existing lighting control system (Helvar) 2.3 Gateway to a system using UDP or TCP (ASCII based commands) 2.4 Bridge between individual Casambi networks 2.5 Coupling to an existing evaluation system / visualization 2.6 ArtNet gateway 2.7 BacNet/IP gateway...
  • Page 30: Gateway To An Existing Lighting Control System (Netcomposer)

    2.1. Gateway to an existing lighting control system (Netcomposer) In this operating mode it is possible to establish a coupling to a system with the Eutrac Netcomposers. It is possible to communicate bidirectionally between the two systems. A total of 32 triggers can be set in each direction per gateway.
  • Page 31 Video: https://youtu.be/fxEkgmIicBc...
  • Page 32: Gateway To An Existing Lighting Control System (Helvar)

    2.2. Gateway to an existing lighting control system (Helvar) In this operating mode it is possible to establish a coupling to a system with the Helvar router system.
  • Page 33 It is possible to communicate bidirectionally between the two systems. A total of 32 triggers can be set in each direction per gateway. The programming uses a wizard, which simplifies the creation of the commands. An IP address of a router must be specified as the destination of the connection. The operating mode to choose would be here "HelvarNet (TCP)".
  • Page 34: Gateway To A System Using Udp Or Tcp (Ascii Based Commands)

    2.3. Gateway to a system using UDP or TCP (ASCII based commands) In this operating mode it is possible to establish a link to a system that has not been defined in advance using UDP / TCP ASCII commands. This could be e.g. media controls (Crestron, ...) or KNX systems where this integration is possible via network. It is possible to communicate bidirectionally between the two systems.
  • Page 35: Bridge Between Individual Casambi Networks

    2.4. Bridge between individual Casambi networks In this operating mode it is possible to connect several autarkic Casambi networks via the gateway. It is possible to communicate bidirectionally between the two systems. A total of 32 triggers can be set in each direction per gateway.
  • Page 36 The gateways communicate with each other via UDP broadcast commands on a freely adjustable port. The operating mode to choose would be here "UDP Casambi Bridge". The connection via "UDP Casmabi Brige" is explained here: "Protokolle/Casambi Bridge"...
  • Page 37: Coupling To An Existing Evaluation System / Visualization

    Of course, several gateways can also react to the same commands. The gateways communicate with each other via UDP broadcast commands on a freely adjustable port. The operating mode to choose would be here "UDP Casambi Command" or "TCP Casambi...
  • Page 38 The connection via "UDP Casambi Command" is explained here: "Protocol-specific setting/UDP Casambi Command" "Protocol-specific setting/TCP Casambi Command" There are also demo programs that show you the connection and use on the evaluation page.
  • Page 39: Artnet Gateway

    2.6. ArtNet gateway In this operating mode it is possible to address the gateway directly with ArtNet commands. It is possible to control 512 Casambi commands (scenes, groups,devices,broadcast) using ArtNet The level is sent from the ArtNet to the Casambi system.
  • Page 40: Bacnet/Ip Gateway

    - Scenes in the values: brightness, scene, color temperature, fade time can be controlled. The Casambi devices / groups are queried cyclically and the corresponding value is also made available in the BacNet in the event of a change. A parameter-based system is available for special commands, with which many special commands can also be transmitted.
  • Page 41: Mqtt

    In this operating mode it is possible to integrate the gateway directly via MQTT. It is possible to send an unlimited number of commands to the Casambi system. The Casambi system also reports back which scene has currently been called up.
  • Page 42: Example Implementations

    "UDP Casambi Command" operating mode. https://github.com/KLKG/Casambi_Gateway_API_Test There is a program (UDP_Test) that cyclically queries all Casambi participants in a command line. Source code in C++. The other program (UDP_WPF) is a C# application with a graphical interface. Other commands can also be sent here than just the cyclic query.
  • Page 43: Login

    3. Login From 2023, the devices will be delivered with version 3.14. In this version, the device is set to DHCP in the delivery state and uses a fallback IP of 192.168.1.90. The settings that can be made on the gateway website are described here. Up to version 3.14: On delivery, the gateway is equipped with the address 192.168.1.90.
  • Page 44 The MAC of the device is also displayed at the top under "Mac Address". You should make a note of this and keep it. With this you can reset the device in case of emergency. The password is stored encrypted and can not be read out in plain text. After pressing "Continue"...
  • Page 45: General Setting

    There are 3 subcategories. Network, System, Memory. Network: Setting of all values that have something to do with the network. System: All system related settings like "Control System", Casambi settings, time. Memory: Firmware update, creating and importing backups and diagnostic settings.
  • Page 46: Firmware Warning

    4.1. Firmware warning This warning message appears if the Casambi firmware is smaller than the one needed for all functions. If this is the case not all commands used by the gateway are supported. If an older firmware is used, an older firmware version of the gateway should be used.
  • Page 47: Network

    4.2. Network...
  • Page 48: Ip Settings

    4.2.1. IP settings Settings for the IP configuration can be made here. In the factory state, it is delivered with the IP address 192.168.1.90. DHCP: DHCP active or inactive Host name: host name of the device IP address: IP address of the device Subnet: subnet mask Gateway: Gateway address Name servers 1 and 2: The DNS entries for the gateway...
  • Page 49: Webserver Login

    4.2.2. Webserver Login Here you can set the username and password of the user who should have access to all functions of the system. Only one user can be created. With the button "Change Login" username and password are transferred. The password field is always empty, since this cannot be read out and is stored in encrypted form.
  • Page 50: Ntp-Client

    4.2.3. NTP-Client The parameters for the built-in NTP client are set here. The NTP client field can either be activated or deactivated. If it is activated, the gateway gets the current time of the NTP server when it starts and when queried via the "Date and Time" function. NTP server is the address / URL of the server.
  • Page 51: Restart Gateway

    4.2.4. Restart gateway This can be used to restart the gateway.
  • Page 52: System

    4.3. System...
  • Page 55: Control System Wizard

    - ArtNet - Free commands over UDP - HelvarNet (TCP) - Free commands over TCP - UDP Casambi Command - TCP Casambi Command - BacNet/IP - MQTT The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step...
  • Page 56 After entering all the settings, the device can be restarted directly with reboot and the set values are adopted.
  • Page 57: Netcomposer System

    4.3.1.1. Netcomposer system The Eutrac Netcomposersystem transmits its data via broadcast on port 10009. These values are also permanently stored in the profile.
  • Page 58: Art-Net

    4.3.1.2. Art-Net With Art-Net it is possible to address the gateway via DMX commands. In this case, the port is fixed at 6454. The universe is freely adjustable. "Art-Net ™ Designed by and Copyright Artistic License Holdings Ltd"...
  • Page 59: Free Commands Over Udp

    4.3.1.3. Free commands over UDP Here commands are sent by broadcast to the specified port.
  • Page 60: Helvarnet (Tcp)

    4.3.1.4. HelvarNet (TCP) The TCP port and the delimiter between the commands are fixed according to the protocol and cannot be adjusted. For the IP address of the router, an existing HelvarNet router address must be specified, to which the gateway then connects.
  • Page 61: Free Commands Over Tcp

    4.3.1.5. Free commands over TCP The "System IP" is the address of the controller / server to which the gateway is to connect. The delimiter is the separator between the individual commands. The ASCII number of the corresponding character must be entered here. 35 corresponds to the "#".
  • Page 62: Udp Casambi Command

    4.3.1.6. UDP Casambi Command To identify from which bridge the command comes the parameter "Net ID" is needed. It can be selected from 0 - 254. 255 is the broadcast ID. This cannot be selected here. But it can be used in commands for all gateways connected to the network.
  • Page 63: Tcp Casambi Command

    4.3.1.7. TCP Casambi Command To identify from which bridge the command comes the parameter "Net ID" is needed. It can be selected from 0 - 254. 255 is the broadcast ID. This cannot be selected here. But it can be used in commands for all gateways connected to the network.
  • Page 64: Udp Casambi Bridge

    4.3.1.8. UDP Casambi Bridge The "Bridge ID" parameter is required to identify which bridge the command comes from. It can be selected from 0-254. With the UDP port parameter, you select which port is to be used for listening and sending.
  • Page 65: Bacnet/Ip

    Start Scene / Scene Count (0 to 255): From the start scene, as many scenes are polled as Scene Count is large. These values are also used to poll information from the Casambi network. Only within the limits set here devices in BacNet/IP mode are cyclically polled for status changes and these are then displayed.
  • Page 67: Mqtt

    4.3.1.10. MQTT The port and the IP address can be specified here. Net ID is a unique number (0-255) with which the gateway can be identified on the MQTT side. Authentication switches the authentication with user and password on and off. For Device Count, Group Count, Scene Count a 0 means that this value is inactive and not used.
  • Page 69: Casambi Settings

    "active": The Casambi nodes are polled cyclically. This can cause somewhat slow status messages. But the polling is very stable. "passive": The Casambi devices report their status change via notification and are then polled for their current values. current values. This results in somewhat faster status changes.
  • Page 70: Led Settings

    4.3.3. LED settings Various LED features can be deactivated or activated here. LED on inactive means that the LEDs have no function. They are always out. With the Identify button, the 3 upper LEDs of the device start to go up and down in ascending and descending order.
  • Page 71: Date And Time

    With "Get Date and Time from Casambi" the current time can be fetched from the Casambi network. Because Casambi needs some time to send the data, the page can be reloaded with the Refresh button. This time is then taken over from the Casambi system into the system time.
  • Page 72: Automation

    Here a time span can be specified in hours. Always after X hours the current time is fetched either with activated NTP from the NTP server or fetched from the Casambi system and taken over into the system time. The time from the NTP server is then also sent to the Casambi system every X hours.
  • Page 73: Restart Gateway

    4.3.6. Restart gateway This can be used to restart the gateway.
  • Page 74: Memory

    4.4. Memory...
  • Page 75: Update Firmware

    4.4.1. Update firmware A firmware update of the gateway can be carried out here. The firmware file is selected with "Select file". The update button then transfers it. If the update was successful, you will be redirected to the start page after a short time.
  • Page 76: Import / Export

    4.4.2. Import / Export The Export button generates a file with the format "* .ceg". This file is downloaded and can then be saved as a backup. The filename of the file is always automatically "export_ [IP address with _ instead of.]. Ceg Such a * .ceg file can be selected and re-imported via import.
  • Page 77: System Memory

    4.4.3. System memory The system can be reset to the factory settings with the "Reset" button. To do this, the "Slide for Reset" slider must be set to "On". With the "Diagnostic Data" button, a website is displayed in which the currently available parameterization of the gateway is displayed.
  • Page 78: Udp Debug Port

    4.4.4. UDP Debug Port A debug port can be opened here. This can only send data, not receive data. It runs on port 10006 and sends everything via UDP broadcast. Using an appropriate program, more information can now be recorded here for diagnostic purposes. The device also remembers that this option has been activated and activates it again after a restart if it was active before.
  • Page 79: Lanlog.exe

    4.4.4.1. LanLog.exe The tool can be found at the following URL: https://archiv.intelligent-lighting.de/index.php/s/V6uglwZDel3HR3V After starting, "ASCII" must be selected as the protocol. Under Local, select the appropriate network interface based on the IP address and enter 10006 for the port. Then you connect with connect and see the first entries. The lower area is not functional here because the gateway does not receive any commands on port 10006:...
  • Page 80: Reset Device

    4.5. Reset device For devices from the date of manufacture 3/2022, a reset of the device can be initiated via an internal button. More information under 1.4 Reset button. From firmware 2.11 it is possible to reset the entire memory of the device under the URL "/reset_full_flash". After the call you will (if not already logged in) be greeted with the login screen.
  • Page 81 This reset can last between 30 and 180s. During this time, the device is no longer accessible.
  • Page 82: Protocol-Specific Settings

    The settings that are possible for the respective control system are described here. These refer to the two tabs "To Casambi" and "From Casambi". These two points can be found under the respective protocol and explain the settings in this.
  • Page 83: Artnet

    5.1. ArtNet In this operating mode, various actions can be carried out on the Casambi in an ArtNet universe. All 512 channels are available in total. Our ESTA ID is: 0x02F1 Our Artistic License OEM Code: 0x2AB4 Once it has been set up on ArtNet, the gateway can also be configured on the network side via ArtNet. So e.g.
  • Page 84: To Casambi

    5.1.1. To Casambi The DMX address range can be selected in the upper area of the page. 50 channels are displayed per page. page 0: address 1 - 25 1: address 26 - 50 20: address 501-512 The channels and their functions are then listed below this page.
  • Page 85 The following functions are available: After the command the type must be selected. Here are available for selection:...
  • Page 86 2) Set Level => type and address needed, DMX level is transmitted to Casambi (0 - 255) 3) Set Scene => Address 1 - 255 specify the scene address in the Casambi, type is ignored, DMX level is transmitted to Casambi (0 - 255) 4) Set PushButton Level =>...
  • Page 87: From Casambi

    5.1.2. From Casambi This page is not used under ArtNet.
  • Page 88: Bacnet/Ip

    5.2. BacNet/IP In this operating mode, the gateway can be addressed via BacNet / IP and also accepts control commands.
  • Page 89: View In The Gateway

    5.2.1. View in the gateway Settings of the gateway via the internal website.
  • Page 90: To Casambi

    5.2.1.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network.
  • Page 91: Commands

    5.2.1.1.1. Commands These settings are not used in the BacNet / IP operating mode.
  • Page 92: Sensors

    5.2.1.1.2. Sensors The parameters for setting sensor messages can be set here. This looks like this in the BacNet: For the light sensor part:...
  • Page 93 Here, the value for the value of the light sensor can simply be transferred for Present Value. For the motion detector part: Here, the value for the presence sensor can simply be transferred for Present Value. 0 = no presence detected 1 = presence detected...
  • Page 94: Lightsensor

    Der Wert Faktor kann benutzt werden um den Wert der über BacNet/IP geliefert wird anzupassen. Bei Value wird einem der Wert angezeigt der an das Casambi System übertragen wird. Er wird mti der Formel: Value = Raw Value * Faktor berechnet.
  • Page 95: Presence

    5.2.1.1.2.2. Presence Mit der Dropdown Liste "Presence Detection" kann die weitergabe eines Wertes als Präsenzerkennung gestartet werden. Bei State wird einem inactive oder active angezeigt. Je nach Parameter der per BacNet/IP übertragen wird. 0 = inactive 1 = active...
  • Page 96: From Casambi

    5.2.1.2. From Casambi This page is not used in the BacNet / IP operating mode.
  • Page 97: View In Bacnet

    5.2.2. View in BacNet The device can be found in the network via BacNet / IP. The port and the local device ID can be freely set. The device has three structured views, each with its own parameters.
  • Page 98 Casambi" is responsible for feedback from the Casambi system. "Sensor Value To Casambi" is used to pass on light sensor values and presence reports from the BacNet a Casambi. The Structured_Views are currently used to simplify the assignment of the variables. Unfortunately not all BacNet programs support this.
  • Page 99: To Casambi

    In this operating mode, the values index and optional data 1 - 4 are set first. As soon as this is done, the value "run" can be set to 1 / true and the command is transferred to the Casambi system.
  • Page 100 Duration: value is given in 10ms. 0 Means that he uses the value from the luminaire module.
  • Page 101: From Casambi

    Evolution firmware lower than 33.22. If the gateway is added to a scene in the Casambi system, a binary number can be set using the gateway's 8 sliders. This number is then returned when the scene is called via the value index. With timestamp, the time in seconds that the gateway runs is set.
  • Page 102: Sensor Value To Casambi

    5.2.2.3. Sensor Value To Casambi These settings are the same as in version 1 and are still available for reasons of compatibility. These also work with Evolution firmware lower than 33.22. For the light sensor part: Here, the value for the value of the light sensor can simply be transferred for Present Value.
  • Page 103: Broadcast

    Red, Green, Blue, White, Sat and Hue from Evolution firmware greater than or equal to 34.50. Vertical from Evolution firmware greater or equal 37.00. start_automation from Evolution firmware greater or equal 37.80. The fade time is set with Broadcast Duration. The value is taken internally in Casambi * 10ms. 0 = default 1 = 0s 100 = 1s The values to be called up are entered in Level, Tc, Red, Green, Blue, White, Hue and Sat.
  • Page 104: Device

    Vertical from Evolution firmware greater or equal 37.00. start_automation, sensor_lux, sensor_pir from Evolution firmware greater or equal 37.80. The fade time is set with Duration. The value is taken internally in Casambi * 10ms. 0 = default 1 = 0s 100 = 1s The values to be called up are entered in Level, Tc, Red, Green, Blue, White, Hue and Sat.
  • Page 105 Active Scene" shows which scene is currently active in the participant. Sensor_pir as well as sensor_lux show the values of a Casambi sensor, if the participant is one, or if it is assigned with the corresponding information in the profiles.
  • Page 106: Ungouped

    Red, Green, Blue, White, Sat and Hue from Evolution firmware greater than or equal to 34.50. Vertical from Evolution firmware greater or equal 37.00. start_automation from Evolution firmware greater or equal 37.80. The fade time is set with Duration. The value is taken internally in Casambi * 10ms. 0 = default 1 = 0s 100 = 1s The values to be called up are entered in Level, Tc, Red, Green, Blue, White, Hue and Sat.
  • Page 107: Group

    Red, Green, Blue, White, Sat and Hue from Evolution firmware greater than or equal to 34.50. Vertical from Evolution firmware greater or equal 37.00. start_automation from Evolution firmware greater or equal 37.80. The fade time is set with Duration. The value is taken internally in Casambi * 10ms. 0 = default 1 = 0s 100 = 1s The values to be called up are entered in Level, Tc, Red, Green, Blue, White, Hue and Sat.
  • Page 108: Scene

    Red, Green, Blue, White, Sat and Hue from Evolution firmware greater than or equal to 34.50. start_automation from Evolution firmware greater or equal 37.80. The fade time is set with Duration. The value is taken internally in Casambi * 10ms. 0 = default...
  • Page 109: Polling

    5.2.3. Polling In this operating mode, certain values are queried and the variables are automatically adjusted. Polled are: - The level of the scenes and whether they are active. If not active then the level is 0 - The level of a group - The level of the broadcast entry - If the device is reachable (online) and how its state is - Red, Green, Blue, White, Hue, Sat of a device...
  • Page 110: Free Commands Over Tcp

    5.3. Free commands over TCP In this operating mode, the gateway can connect to a TCP server and exchange ASCII-based texts with it.
  • Page 111: To Casambi

    5.3.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 112: Select Storage Location

    5.3.1.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 113: Trigger

    5.3.1.2. Trigger The command to which the gateway should react is entered in the text field.
  • Page 114: Action

    The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. Descriptions of the commands in the wizard are available here: "Protokoll/Casambi" After setting the action-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 115: From Casambi

    5.3.2. From Casambi Here you can set what the gateway should send on the network as soon as e.g. Scene calls from the Casambi world are available. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 116: Select Storage Location

    5.3.2.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 117: Trigger

    5.3.2.2. Trigger The trigger specifies when an action should be triggered. The triggers are used to set at which scene recall in the Casambi the command stored under "Action" is to be sent on the network. In the Casambi system you can choose which bits are active in the trigger for a scene. (Picture below)
  • Page 118 With the Submit button the entered is saved. With the test button you can check whether the entered action is the right one.
  • Page 119: Action

    5.3.2.3. Action The command that the gateway should send is entered in the text field.
  • Page 120: Free Commands Over Udp

    5.4. Free commands over UDP In this operating mode, the gateway sends out defined ASCII strings via UDP broadcast or reacts to them and triggers corresponding actions in the Casambi system.
  • Page 121: To Casambi

    5.4.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 122: Select Storage Location

    5.4.1.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 123: Trigger

    5.4.1.2. Trigger The command to which the gateway should react is entered in the text field.
  • Page 124: Action

    The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. Descriptions of the commands in the wizard are available here: "Protokoll/Casambi" After setting the action-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 125: From Casambi

    5.4.2. From Casambi Here you can set what the gateway should send on the network as soon as e.g. Scene calls from the Casambi world are available. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 126: Select Storage Location

    5.4.2.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 127: Trigger

    5.4.2.2. Trigger The trigger specifies when an action should be triggered. The triggers are used to set at which scene recall in the Casambi the command stored under "Action" is to be sent on the network. In the Casambi system you can choose which bits are active in the trigger for a scene. (Picture below)
  • Page 128 With the Submit button the entered is saved. With the test button you can check whether the entered action is the right one.
  • Page 129: Action

    5.4.2.3. Action The command that the gateway should send is entered in the text field.
  • Page 130: Helvarnet (Tcp)

    5.5. HelvarNet (TCP) Bei dieser Betriebsart, sendet das Gateway definierte HelvarNet Befehle an ein Imagine Router System der Firma Helver. Ebenso kann es auf Befehle aus diesem reagieren.
  • Page 131: To Casambi

    5.5.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. Depending on the system, you can either go directly to the "Commands" page.
  • Page 132: Commands

    5.5.1.1. Commands Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 133: Select Storage Location

    5.5.1.1.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 134: Trigger

    5.5.1.1.2. Trigger The command to which the gateway should react is entered in the text field. Descriptions of the commands in the wizard are available here: "Wizard/HelvarNet"...
  • Page 135: Action

    The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. Descriptions of the commands in the wizard are available here: "Protokoll/Casambi" After setting the action-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 136: Sensors

    This value can then be scaled using a factor. The factor can be set from 0 in steps of 0.01. The value that is transmitted to the Casambi system is then in Value. This then takes the entered factor into...
  • Page 137: From Casambi

    5.5.2. From Casambi Here you can set what the gateway should send on the network as soon as e.g. Scene calls from the Casambi world are available. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 138: Select Storage Location

    5.5.2.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 139: Trigger

    5.5.2.2. Trigger The trigger specifies when an action should be triggered. The triggers are used to set at which scene recall in the Casambi the command stored under "Action" is to be sent on the network. In the Casambi system you can choose which bits are active in the trigger for a scene. (Picture below)
  • Page 140 With the Submit button the entered is saved. With the test button you can check whether the entered action is the right one.
  • Page 141: Action

    5.5.2.3. Action The command that the gateway should send is entered in the text field.
  • Page 142: Helvarnet Command Builder

    5.5.3. HelvarNet Command Builder The wizard supports you in creating the commands to which the Casambi system should react. With "Command, various commands are available that can be reacted to. Recall Scene (Group) Recall Scene (Device) Direct Level (Group) Direct Level (Device)
  • Page 143: Recall Scene (Group)

    5.5.3.1. Recall Scene (Group) The group number from the Designer software is entered in the "Address" field "Block" and "Scene" indicate which scenes are called. When the "Constant Light" slide switch is set to On, the scene is called up in the constant light control of the Helvar system.
  • Page 144: Recall Scene (Device)

    5.5.3.2. Recall Scene (Device) The device number from the Designer software is entered in the "Address" field "Block" and "Scene" indicate which scenes are called. "FadeTime" indicates the fade time to be used. Specification in seconds. Ignore Fading indicates that the fade time sent with the call should be ignored.
  • Page 145: Direct Level (Group)

    5.5.3.3. Direct Level (Group) The group number from the Designer software is entered in the "Address" field Level indicates the brightness in (0-254). "FadeTime" indicates the fade time to be used. Specification in seconds. Ignore Fading indicates that the fade time sent with the call should be ignored.
  • Page 146: Direct Level (Device)

    5.5.3.4. Direct Level (Device) The device number from the Designer software is entered in the "Address" field Level indicates the brightness in (0-254). "FadeTime" indicates the fade time to be used. Specification in seconds. Ignore Fading indicates that the fade time sent with the call should be ignored.
  • Page 147: Dimm (Group)

    5.5.3.5. Dimm (Group) The group number from the Designer software is entered in the "Address" field. "FadeTime" specifies the fade time to be used. Specified in seconds. Ignore Fading specifies that the fade time sent with the call is to be ignored. For dimming it is best to set Ignore Fading to On.
  • Page 148: Dimm (Device)

    5.5.3.6. Dimm (Device) The device number from the Designer software is entered in the "Address" field. "FadeTime" specifies the fade time to be used. Specified in seconds. Ignore Fading specifies that the fade time sent with the call is to be ignored. For dimming it is best to set Ignore Fading to On.
  • Page 149: Mqtt

    5.6. MQTT In this operating mode, the gateway can be addressed via MQTT and also accepts control commands.
  • Page 150: View In The Gateway

    5.6.1. View in the gateway Settings of the gateway via the internal website.
  • Page 151: To Casambi

    5.6.1.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network.
  • Page 152: Commands

    5.6.1.1.1. Commands These settings are not used in the MQTT operating mode.
  • Page 153: Sensors Mqtt

    5.6.1.1.2. Sensors MQTT The parameters for setting sensor messages can be set here.
  • Page 154: Lightsensor

    The value factor can be used to adjust the value that is delivered via BacNet / IP. With Value, the value that is transferred to the Casambi system is displayed. It is calculated using the formula: Value = Raw Value * Factor.
  • Page 155: Presence

    5.6.1.1.2.2. Presence The transfer of a value as presence detection can be started with the drop-down list "Presence Detection". In the case of State, an inactive or active is displayed. Depending on the parameters that are transmitted via BacNet / IP. 0 = inactive 1 = active...
  • Page 156: From Casambi

    5.6.1.2. From Casambi This page is not used under MQTT.
  • Page 157: View In Mqtt

    5.6.2. View in MQTT Description of the commands and options in MQTT. All values are transferred as a JSON structure. [id] must be replaced by the ID of the number set as NET ID in the settings.
  • Page 158: Mqtt Data Received

    5.6.2.1. MQTT data received...
  • Page 159: Gateway

    5.6.2.1.1. Gateway Return call of a scene For this purpose, the gateway is added to the scene in the Casambi software. By means of the 8 sliders a unique number (binary) can now be generated, which is returned accordingly with a call of the scene over this value.
  • Page 160: Broadcast

    = average value of the luminaires last_level = last level something was called with cct_level = color temperature value vertical = direct/indirect proportion last_change = time in s at which the last change was made casambi/[id]/get/poll_broadcast "level": 0, "last_level": 255, "cct_level": 127, "vertical": 130,...
  • Page 161: Device

    = address of the device that was removed casambi/[id]/get/node_deleted "device":1 The following commands require Casambi Evolution 37.90 or higher. Return settings retrieved for a device. A description of the parameters can be found here. last_change = time in s at which the last change was made...
  • Page 162 "last_change": 76808 Return dimmers that have been changed for a device last_change = time in s at which the last change was made [device_address] = address of the device (1 - 250) casambi/[id]/get/poll_devicet/[device_address]/element_dimmer "dimmer_1": 255, "dimmer_2": 0, "dimmer_3": 0, "dimmer_4": 0, "last_change": 76868...
  • Page 163 Return buttons that have been changed for a device last_change = time in s at which the last change was made [device_address] = address of the device (1 - 250) casambi/[id]/get/poll_devicet/[device_address]/element_button "button_1": 0, "button_2": 0, "button_3": 0, "button_4": 0, "button_5": 0, "button_6": 0,...
  • Page 164: Ungrouped

    5.6.2.1.4. ungrouped Return values that were retrieved internally for ungrouped. A description of the parameters can be found here. last_change = time in s at which the last change was made casambi/[id]/get/poll_ungrouped "level": 0, "last_level": 255, "cct_level": 127, "vertical": 130,...
  • Page 165: Groups

    Return values that were retrieved internally for a group. A description of the parameters can be found here. last_change = time in s at which the last change was made [group] = group (1 - 255) casambi/[id]/get/poll_group/[group] "level": 0, "last_level": 255, "cct_level": 127, "vertical": 127,...
  • Page 166: Scenes

    Return values that were retrieved internally for a scene. A description of the parameters can be found here. last_change = time in s at which the last change was made [scene] = scene (1 - 255) casambi/[id]/get/poll_scene/[scene] "active": 0, "level": 255, "last_change": 79925...
  • Page 167: Send Mqtt Data

    5.6.2.2. Send MQTT data As of Casambi Evolution firmware 34.50 up to 8 buttons are prepared. Set the light sensor value that the gateway can supply casambi/[id]/set/light_sensor "lux_level":10 Set the PIR status that the gateway can provide 1 = Sensor presence detected...
  • Page 168 "group":2, "duration":2, "level":254 PushButton Call target with level casambi/[id]/set/push_button_level "level":185, "button":1 The following commands require Casambi Evolution 33.22 or higher. Set target to level A description of the parameters can be found here. casambi/[id]/set/target_level "level":171, "duration":1, "targetid":1, "targettype":1 Set target to Tc A description of the parameters can be found here.
  • Page 169 A description of the parameters can be found here. casambi/[id]/set/target_huesat "hue":65000, "sat":254, "white":255, "targetid":1, "targettype":1, "level":255 The following commands require Casambi Evolution 37.00 or higher. Set target to vertical A description of the parameters can be found here. casambi/[id]/set/target_vertical "vertrical":127, "duration":1, "targetid":1, "targettype":1 The following commands require Casambi Evolution 37.80 or higher.
  • Page 170 "dimmer_index":0, "dimmer_value":1, "duration":1, "targetid":1, "targettype":1 Set Target Elements A description of the parameters can be found here. casambi/[id]/set/target_elements "element_index":0, "element_value":1, "duration":1, "targetid":1, "targettype":1...
  • Page 171: Poling

    5.6.3. Poling In this operating mode, certain values are queried cyclically and the variables are automatically adjusted. Polled cyclically: - The level of the scenes and whether they are active. If not active then the level is 0 - The level of a group - The level of the broadcast entry - Whether the device is reachable (online) and what its state is.
  • Page 172: Netcomposer

    5.7. Netcomposer In this operating mode, the gateway sends defined Netcomposer commands to a Netcomposer system from Eutrac. It can also react to commands from this.
  • Page 173: To Casambi

    5.7.1. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 174: Select Storage Location

    5.7.1.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 175: Trigger

    5.7.1.2. Trigger The command to which the gateway should react is entered in the text field.
  • Page 176: Action

    The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. Descriptions of the commands in the wizard are available here: "Protokoll/Casambi" After setting the action-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 177: From Casambi

    5.7.2. From Casambi Here you can set what the gateway should send on the network as soon as e.g. Scene calls from the Casambi world are available. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 178: Select Storage Location

    5.7.2.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 179: Trigger

    5.7.2.2. Trigger The trigger specifies when an action should be triggered. The triggers are used to set at which scene recall in the Casambi the command stored under "Action" is to be sent on the network. In the Casambi system you can choose which bits are active in the trigger for a scene. (Picture below)
  • Page 180 With the Submit button the entered is saved. With the test button you can check whether the entered action is the right one.
  • Page 181: Action

    5.7.2.3. Action The command that the gateway should send is entered in the text field.
  • Page 182: Netcomposer Command Builder

    5.7.3. Netcomposer Command Builder The wizard supports you in creating the commands to which the Casambi system should react. The "NCR Address" specifies which NCR address is to be responded to. 255 is "all". With "Command" various commands are available which can be reacted to.
  • Page 183: Device Level

    5.7.3.1. Device Level The device address of the destination is specified for Device. The desired brightness is specified under Level. In the case of fading, the corresponding fade time. "Ignore Fading" lets you ignore the fade time in the call.
  • Page 184: Scene

    5.7.3.2. Scene The desired scene is specified for Scene. In the case of fading, the corresponding fade time. "Ignore Fading" lets you ignore the fade time in the call.
  • Page 185: Group With Scene

    5.7.3.3. Group with Scene For Group, the group number of the destination is specified. The desired scene is specified for Scene. In the case of fading, the corresponding fade time. "Ignore Fading" lets you ignore the fade time in the call.
  • Page 186: Group With Level

    5.7.3.4. Group with Level The device address of the destination is specified for Device. The desired brightness is specified under Level. In the case of fading, the corresponding fade time. "Ignore Fading" lets you ignore the fade time in the call.
  • Page 187: Sequence

    5.7.3.5. Sequence "Sequence" is the sequence number. "State" indicates whether the sequence is started or stopped.
  • Page 188: Udp Casambi Command

    5.8. UDP Casambi Command In this operating mode, an external control, for example a visualization or a central control device, can connect to the gateway and carry out actions there or react to scene calls / status changes.
  • Page 189: View In The Gateway

    5.8.1. View in the gateway Settings of the gateway via the internal website.
  • Page 190: To Casambi

    5.8.1.1. To Casambi This page is not used in this mode.
  • Page 191: From Casambi

    5.8.1.2. From Casambi This page is not used in this mode.
  • Page 192: Control In The Network

    The first byte is the previously assigned "Net ID" in the General Setting dialog. The second byte indicates whether it is a command from the Casambi system (0x70) or one to this (0x72). Now comes the part of the command that is to be sent to the Casambi network.
  • Page 193 Data transmission 1 "hex with dot": 0x_Net_ID.0x70.0x_Casambi_Data[1...X].ACK/r/n Data transmission 2 "dec with hash": Net_ID#112#0x_Casambi_Data[1...X]#ACK/r/n To make a request to all gateways, the ID 255 / 0xFF can be used.
  • Page 194: Commands From The Casambi System

    5.8.2.1. Commands from the Casambi system If a packet comes from the Casambi system, the part 0x_Command_Direction is 0x70 or 112. We only consider the part Casambi_Data [1 ... X] from the general data frame from 5.1...
  • Page 195: 0X0D - Scene Called

    5.8.2.1.1. 0x0D - scene called The gateway must be added to the corresponding scene. Via the slide switches Bit_1 to Bit_8 up to 255 different scenes can be encoded. Each time the scene is called up, the corresponding command is sent to the network. Length: 9 Opcode: 0x0D or 13 Data transmission 1 "hex with dot":...
  • Page 196: 0X1A - Setparametervalue

    5.8.2.1.2. 0x1A - SetParameterValue Transfer of a parameter from the Casambi system. Response to GetParameterValue. Length: 0x03 Opcode: 0x1B or 26 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Paramter_Number.0x_Paramter_Value Data transmission 2 "dec with hash": Casambi_Data[1...X]: Paramter_Number#Paramter_Value...
  • Page 197: 0X1B - Parameterscomplete

    5.8.2.1.3. 0x1B - ParametersComplete Indication that the parameter transfer is completely finished. Response to GetParameterValue. Length: 0x01 Opcode: 0x1B or 27 No further data.
  • Page 198: 0X28 - Time Received From The Casambi Network

    5.8.2.1.4. 0x28 - time received from the Casambi network Response of the Casambi system to the request to send the current time. Length: 8 Opcode: 0x28 or 40 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_year_high.0x_year_low.0x_month.0x_day.0x_hour.0x_minute.0x_second Example: 0.70.8.28.7.e4.3.5.e.13.1d/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: year_high#year_low#month#day#hour#minute#second...
  • Page 199: 0X39 - Node Status

    5.8.2.1.5. 0x39 - node status Details about the current status of a node are transmitted. Responses may come in a burst. Length: 6 Opcode: 0x39 or 57 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Unit_ID.0x_Scene.0x_Priority_Node_Type.0x_Condition.0x_Online Data transfer 2 "dec with hash": Casambi_Data[1...X]: Unit_ID#Scene#Priority_Node_Type#Condition#Online 0x_Scene the currently active scene ID...
  • Page 200: 0X3A - Notify Node Removed

    5.8.2.1.6. 0x3A - notify node removed Notification that a device has been removed from the network. This response can also come when a status of a Nodes was queried that does not exist. Length: 0x2 Opcode: 0x3A or 58 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Unit_ID Example: 2.3a.1/r/n Data transfer 2 "dec with hash":...
  • Page 201: 0X45 - Scene Status

    5.8.2.1.7. 0x45 - scene status Details about the current status of a scene are transmitted. Length: 4 Opcode: 0x45 or 69 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Scene.0x_Active.0x_Level Data transfer 2 "dec with hash": Casambi_Data[1...X]: Scene#Active#Level 0x_Scene the currently active scene ID 0x_Active (bit 0 all other bits are ignored) 0 = scene inactive...
  • Page 202: 0X46 - Target Status

    5.8.2.1.8. 0x46 - target status VerticalRatio was added from Evolution firmware greater than 36.70. Details about the current status of a target are transmitted. Length: 0x6 Opcode: 0x46 or 70 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Target_ID.0x_level.0x_last_level.0x_cct_level.0x_Target_Type Data transfer 2 "dec with hash": Casambi_Data[1...X]: Target_ID#level#last_level#cct_level#Target_Type 0x_Level average level of the lights in the group.
  • Page 203: 0X49 - Target Color

    5.8.2.1.9. 0x49 - Target Color Only works with Evolution firmware greater than 36.70. Details about the current color of a target are transmitted. Length: 0x15 or as requested in the query. Opcode: 0x49 or 73 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Target_Type.0x_Target_ID.0x_level.0x_R.0x_G.0x_B.0x_W.
  • Page 204: 0X4B - Notifycontrolvalues Responses

    5.8.2.1.10. 0x4B - NotifyControlValues Responses Attention only works with Evolution firmware greater than 37.90 Länge: variable Opcode: 0x4B or 75 Response messages contain Unit ID and list of controls values as (Type, Value), where value can be 1 byte for Presence, 2 bytes (u16 value, little-endian) for Lux (Daylight) sensor, etc.
  • Page 205 Device Temperature [C˚], low-resolution value [1..255] of measured reading (0 ~ undefined) Battery level [1..100%]; 0 ~ undefined Overheating indicatore [bool] General failure indicator “Vertical” control; depending on fixture type it can be either mixer of dimmers, or TW and colours, or direct/indirect light parts of the device.
  • Page 206: Commands To The Casambi System

    5.8.2.2. Commands to the Casambi system If a packet comes from the Casambi system, the part 0x_Command_Direction is 0x72 or 114. We only consider the part Casambi_Data [1 ... X] from the general data frame.
  • Page 207: 0X10 - Push Button Pressed

    5.8.2.2.1. 0x10 - Push Button Pressed Set the state of a Button[0..3] to pressed. Length: 2 Opcode: 0x10 or 16 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Button_Number Example: 0.72.2.10.0/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: Button_Number Example: 0#114#2#16#0/r/n...
  • Page 208: 0X11 - Push Button Released

    5.8.2.2.2. 0x11 - Push Button Released Set the state of a Button[0..3] to released. Length: 2 Opcode: 0x11 or 17 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Button_Number Example: 0.72.2.11.0/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: Button_Number Example: 0#114#2#17#0/r/n...
  • Page 209: 0X1D - Getparametervalue

    5.8.2.2.3. 0x1D - GetParameterValue Read out scenes + group parameters currently stored in the Casambi app for the gateway. Length: 0x01 Opcode: 0x1D or 29 Is called without further parameters. individual parameters and a parameter complete package are then sent in response.
  • Page 210: 0X1E - Set The Level Of A Scene

    5.8.2.2.4. 0x1E - Set the level of a scene Set all Casambi lights in a scene to a value. Length: 5 Opcode: 0x1E or 30 Fadetime = Value* 10ms Data transmission 1 "hex with dot": The fade time value is optional and does not need to be sent. However, the length must then be reduced accordingly to 3.
  • Page 211: 0X1F - Set Level Of A Group

    5.8.2.2.5. 0x1F - Set level of a group Set all Casambi lights in a group to a value. Length: 5 Opcode: 0x1F or 31 Fadetime = Value* 10ms Data transmission 1 "hex with dot": The fade time value is optional and does not need to be sent. However, the length must then be reduced accordingly to 3.
  • Page 212: 0X20 - Set The Level Of A Target

    5.8.2.2.6. 0x20 - Set the level of a target Set all Casambi lights in a network to one value. Length: 6 Opcode: 0x20 or 32 Fadetime = Value* 10ms Data transmission 1 "hex with dot": The fade time value is optional and does not need to be sent. However, the length must then be reduced accordingly to 4.
  • Page 213: 0X21 - Set The Level Of A Button's Target

    5.8.2.2.7. 0x21 - Set the level of a button's target Set the target of a Button[0..3] to an absolute level. Length: 3 Opcode: 0x21or 33 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Button_Number.0x_Level Example: 0.72.3.21.0.ff/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: Button_Number#Level Example: 0#114#3#33#0#255/r/n...
  • Page 214: 0X28 - Request Time From The Casambi Network

    5.8.2.2.8. 0x28 - Request time from the Casambi network Requests the Casambi network to send its current time. Length: 1 Opcode: 0x28 or 50 Data transmission 1 "hex with dot": Example: 0.72.1.28/r/n Data transfer 2 "dec with hash": Example: 0#114#1#50/r/n...
  • Page 215: 0X28 - Set Time In The Casambi Network

    5.8.2.2.9. 0x28 - Set time in the Casambi network Sets the time in the Casambi network to the specified values. Length: 8 Opcode: 0x28 or 50 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_year_high.0x_year_low.0x_month.0x_day.0x_hour.0x_minute.0x_second Data transfer 2 "dec with hash":...
  • Page 216: 0X2B - Set Presence Sensor

    5.8.2.2.10. 0x2B - Set presence sensor Sets the device's presence sensor to 0 = no presence or 1 = presence. Length: 2 Opcode: 0x2B or 43 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_sensor_state Example: 0.72.2.2B.0/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: sensor_state Example: 0#114#2#43#0/r/n...
  • Page 217: 0X2C - Set Light Sensor

    5.8.2.2.11. 0x2C - Set light sensor Sets the device's light sensor to a value. Length: 3 Opcode: 0x2C or 44 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Sensor_Value_low.0x_Sensor_Value_high Example: 0.72.3.2C.ff.0/r/n Data transfer 2 "dec with hash": Casambi_Data: Sensor_Value Example: 0#114#3#44#2000/r/n...
  • Page 218: 0X2F - Set Color Via Rgbw

    5.8.2.2.12. 0x2F - Set color via RGBW Set the color of different targets. Length: 7 Opcode: 0x2F or 47 The values for R,G,B go from 0-254 respectively. The value for W goes from 0-254, 255 means ignore. The value for Level goes from 0-254, 255 means ignore. Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_R.0x_G.0x_B.0x_W.0x_Target_Type.0x_Target_ID.0x_Level Example: 0.72.7.2f.ff.0.0.ff.1.1.ff/r/n...
  • Page 219: 0X31 - Settargetverticalratio

    5.8.2.2.13. 0x31 - SetTargetVerticalRatio Set the vertical ratio of a target. Length: 6 Opcode: 0x31 or 49 Fade time = value * 10ms Data transmission 1 "hex with dot": The value for the fadetime is optional and does not have to be sent. However, the length must then also be reduced to 4 accordingly.
  • Page 220: 0X38 - Setcolor X/Y

    5.8.2.2.14. 0x38 - SetColor X/Y Set the color of different targets. Length: 8 Opcode: 0x38 or 56 The value for X goes from 0-65,535. The value for Y goes from 0-65.535. The value for Level goes from 0-254, 255 means ignore. Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_X_h.0x_X_l.0x_Y_h.0x_Y_l.0x_Target_Type.0x_Target_ID.0x_Level Data transfer 2 "dec with hash":...
  • Page 221: 0X39 - Node State

    5.8.2.2.15. 0x39 - Node state Queries the state of a node. Attention only works with Evolution firmware. The request can be: 0x00: Disable automatic state change notification 0x01 - 0xFB: Query a unit using its ID 0xFE: activate automatic notification when all nodes change status 0xFF: automatic notification when the status of your own node changes Do not send the query command too quickly and always send a single unit, otherwise the system may be overloaded.
  • Page 222: 0X3D - Set Color Via Hue / Sat

    5.8.2.2.16. 0x3D - Set Color via Hue / Sat Set the color of different targets. Length: 7 Opcode: 0x3D or 61 The value for Hue goes from 0-65,535. The value for Sat goes from 0-255. The value for W goes from 0-254, 255 means ignore. The value for Level goes from 0-254, 255 means ignore.
  • Page 223: 0X3E - Settargetdimmers

    5.8.2.2.17. 0x3E - SetTargetDimmers Set dimmer of a target. There is a maximum of 4 dimmers per device (0-3). Length: varies according to the number of dimmers - minimum 7 Opcode: 0x3E or 62 Fade time = value * 10ms Fade time = 0 =>...
  • Page 224: 0X3F - Settargetelements

    5.8.2.2.18. 0x3F - SetTargetElements Set custom elements of a target. There is a maximum of 8 elements per device (0-7). Length: varies according to the number of elements - minimum 7. Opcode: 0x3E or 62 Fade time = value * 10ms Fade time = 0 =>...
  • Page 225: 0X45 - Scene State

    5.8.2.2.19. 0x45 - Scene state Queries the state of a scene. Attention only works with Evolution firmware higher than 33.22. Length: 2 Opcode: 0x45 or 69 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Scene_ID Example: 0.72.2.45.1/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: Scene_ID Example: 0#114#2#69#1/r/n Answer:...
  • Page 226: 0X46 - Target Status

    5.8.2.2.20. 0x46 - Target Status Queries the status of a target. Attention only works with Evolution firmware higher than 34.50. Length: 3 Opcode: 0x46 or 70 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Target_ID.0x_Target_Type Example: 0.72.2.46.1.0/r/n Data transfer 2 "dec with hash": Casambi_Data[1...X]: Target_ID#Target_Type Example: 0#114#2#70#1#0/r/n Answer:...
  • Page 227: 0X48 - Set Color Temperature

    5.8.2.2.21. 0x48 - Set color temperature Set the color temperature of different targets. Length: 7 Opcode: 0x48 or 72 Data transmission 1 "hex with dot": The value for the fade time is not optional and must be sent. Casambi_Data[1...X]: 0x_Tc_high.0x_Tc_low.0x_Duration_low.0x_Duration_high.0x_Target_Type.0x_Target_ID Example: 0.72.7.48.0.ff.0.10.0.0/r/n Data transfer 2 "dec with hash": In this variant, the fade time is transmitted as a value.
  • Page 228: 0X49 - Target Color

    5.8.2.2.22. 0x49 - Target Color Only works with Evolution firmware greater than 36.70. Queries the color of a target. Length: 4 Opcode: 0x49 or 73 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Target_Type.0x_Target_ID.0x_ResponseSize Example: 0.72.4.49.0.15/r/n Data transmission 2 "dec with hash": Casambi_Data[1...X]: Scene_ID Example: 0#114#2#69#1/r/n Target_Type and Target_ID:...
  • Page 229: 0X4A - Resume Automation

    5.8.2.2.23. 0x4A - Resume Automation Attention only works with Evolution firmware greater than 37.80 Resume automatic sequence. Length: 0x3 Opcode: 0x4A or 74 Data transmission 1 "hex with dot": Casambi_Data[1...X]: 0x_Target_Type.0x_Target_ID Example: 3.4A.1.1/r/n Data transmission 2 "dec with hash": Casambi_Data[1...X]: Target_Type#Target_ID Example: 003#074#001#001/r/n Target_Type and Target_ID: Target_Type...
  • Page 230: 0X4B - Notifycontrolvalues

    5.8.2.2.24. 0x4B - NotifyControlValues Attention only works with Evolution firmware greater than 37.80 Details of the current control values can be retrieved or subscribed. Length: 4 or 8 for SetDefaultMask. Opcode: 0x4B or 75 Basically SetDefaultMask should be set first. Then either values are requested automatically via Subscribe or read via Read.
  • Page 231: Demo Programs

    "UDP Casambi Command" using UDP. https://github.com/KLKG/Casambi_Gateway_API_Test There is a program (UDP_Test) that cyclically queries all Casambi participants in a command line. Source code in C ++. The other program (UDP_WPF) is a C # application with a graphical user interface. Other commands can also be sent here than just the cyclical query.
  • Page 232: Tcp Casambi Command

    5.9. TCP Casambi Command In this operating mode, an external control, for example a visualization or a central control device, can connect to the gateway and carry out actions there or react to scene calls / status changes.
  • Page 233: View In The Gateway

    5.9.1. View in the gateway Settings of the gateway via the internal website.
  • Page 234: To Casambi

    5.9.1.1. To Casambi This page is not used in this mode.
  • Page 235: From Casambi

    5.9.1.2. From Casambi This page is not used in this mode.
  • Page 236: Control In The Network

    5.9.2. Control in the network The structure of the telegrams is the same as in the "UDP Casambi Command" mode. The description is in chapter 5.8.2.
  • Page 237: Udp Casambi Bridge

    5.10. UDP Casambi Bridge In this operating mode, several gateways can exchange information and actions directly with one another.
  • Page 238: Bridge Mode Command Builder

    5.10.1. Bridge Mode Command Builder The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. After setting the command-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 239: To Casambi

    5.10.2. To Casambi Here you can set which actions the device should carry out in the Casambi system when a command comes to the gateway via the network. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 240: Select Storage Location

    5.10.2.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 241: Action

    The "next step" button switches to the next step in the wizard. The button "step Back" allows you to take a step back. Descriptions of the commands in the wizard are available here: "Protokoll/Casambi" After setting the action-specific settings, the generated command is displayed. You can try it out with a test and apply it with Apply.
  • Page 242: From Casambi

    5.10.3. From Casambi Here you can set what the gateway should send on the network as soon as e.g. Scene calls from the Casambi world are available. The "Save" button saves the entry in the selected slot. The "Test" button carries out the action in order to be able to check whether the correct action has been selected.
  • Page 243: Select Storage Location

    5.10.3.1. Select storage location As a first step, a memory location must be selected on which the action is to be saved: The storage location can be selected using the drop-down list and the content can be displayed on the website with the "Load ..."...
  • Page 244: Trigger

    5.10.3.2. Trigger The trigger specifies when an action should be triggered. The triggers are used to set at which scene recall in the Casambi the command stored under "Action" is to be sent on the network. In the Casambi system you can choose which bits are active in the trigger for a scene. (Picture below)
  • Page 245 With the Submit button the entered is saved. With the test button you can check whether the entered action is the right one.
  • Page 246: Action

    5.10.3.3. Action The command that the gateway should send is entered in the text field.
  • Page 247: Casambi

    5.11. Casambi Description of the commands possible via the Casambi Wizard.
  • Page 248: Ping

    5.11.1. Ping Sends a "ping" signal to the Casambi system. In the Art-Net operating mode, the command is triggered. If the DMX level is above 128, the command is triggered.
  • Page 249: Set Level

    5.11.2. Set Level Sets the device that is defined via the target type and the target address to the set value. Target_Type Target_ID comment broadcast 1-250 device ungrouped 1-255 group 1-255 scene (only currently active lights) 1-255 Scenes (all lights) 0-255 all lights with the same manufacturer ID In the case of a connection via HelvarNet or to a Netcomposer system, the window looks like this:...
  • Page 250: Push Button Pressed

    5.11.3. Push Button Pressed From Casambi Evolution firmware 34.50 up to 8 buttons are prepared. Transmits the status "button pressed" to the Casambi system, which then carries out the corresponding stored action.
  • Page 251: Push Button Released

    5.11.4. Push Button Released From Casambi Evolution firmware 34.50 up to 8 buttons are prepared. Transmits the status "Button released" to the Casambi system, which then carries out the corresponding stored action.
  • Page 252: Set Presence

    5.11.5. Set Presence Transmits to the Casambi system whether a movement has been detected or not.
  • Page 253: Set Scene Level

    5.11.6. Set Scene Level Calls up a scene in the Casambi system. A scene number must be entered for the scene. The level indicates at which dimming level the scene should be called up. Duration determines the fade time. In the case of a connection via HelvarNet or to a Netcomposer system, the window looks like this: Here, "Level from Network"...
  • Page 254: Set Group Level

    5.11.7. Set Group Level With this action a group can be set to a certain level. Duration defines the fade time again. In the case of a connection via HelvarNet or to a Netcomposer system, the window looks like this: Here, "Level from Network"...
  • Page 255: Set Push Button Level

    From Casambi Evolution firmware 34.50 up to 8 buttons are prepared. Sets the level of the device that is specified as the target of the button in the Casambi app. In the case of a connection via HelvarNet or to a Netcomposer system, the window looks like this: Here, "Level from Network"...
  • Page 256: Set Lux Sensor

    5.11.9. Set Lux Sensor Displays the lux value to be sent.
  • Page 257: Set Tc

    5.11.10. Set Tc Sets the device that is defined via the target type and the target address to the set value. In the time entered under Duration. Target_Type Target_ID comment broadcast 1-250 device ungrouped 1-255 group 1-255 scene (only currently active lights) 1-255 Scenes (all lights) 0-255...
  • Page 258: Set Rgbw

    5.11.11. Set RGBW Set the target to the set color values. White and Level to 255 means that the values are ignored. Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255 group 1-255 scene(nur aktuell aktive Leuchten) 1-255 scene(alle Leuchten) 0-255 all devices with same manufacturer id If Dimm Group or Dimm Device is selected in HelvarNet, then dimming is automatically applied to the Mode SetLevel, SetSceneLevel, SetGroupLevel, SetRGBW and SetHue/Sat to the level.
  • Page 259: Set Hue / Sat

    5.11.12. Set Hue / Sat Set the target to the set color values. White and Level to 255 means that the values are ignored. Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255 group 1-255 scene(nur aktuell aktive Leuchten) 1-255 scene(alle Leuchten) 0-255 all devices with same manufacturer id If Dimm Group or Dimm Device is selected in HelvarNet, then dimming is automatically applied to the Mode...
  • Page 260: Set Vertical

    5.11.13. Set Vertical Set the target to the set vertical. Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255 group 1-255 scene(nur aktuell aktive Leuchten) 1-255 scene(alle Leuchten) 0-255 all devices with same manufacturer id...
  • Page 261: Start Automation

    5.11.14. Start Automation 5.11.14. Start Automation The automatic mode is activated for the target. Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255 group 1-255 scene(nur aktuell aktive Leuchten) 1-255 scene(alle Leuchten) 0-255 all devices with same manufacturer id...
  • Page 262: Settargetdimmers

    5.11.15. SetTargetDimmers With dimmer he dimming channel of the luminaire is selected. Up to 4 channels per device are possible. These are defined by the manufacturer of the profile. Duration = Value * 10ms Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255 group...
  • Page 263: Settargetelements

    5.11.16. SetTargetElements With Custom Elements the control element of the luminaire is selected. Up to 8 elements per device are possible. These are defined by the manufacturer of the profile. Duration = Value * 10ms Target_Type Target_ID Kommentar Broadcast 1-250 Device ungrouped 1-255...
  • Page 264: Console

    6. Console...
  • Page 267: Console

    6.1. console A display of the last commands that were exchanged between the Casambi system and the network. A command can be sent directly to the Casambi system in the text line. The submit button transmits the command. The Refresh button updates the display.
  • Page 268: Parameter

    The Parameter area can be used to display values for a parameter that were previously specified in the Casambi app. With the button "Get Parameter" the query is sent to the Casambi module. With "Refresh" this page must then be updated once afterwards.
  • Page 269: Settings In The Casambi App

    7. Settings in the Casambi app On the part of the Casambi network, the system behaves like a normal lamp / button / sensor. You can find it in the Casambi software as a Bluetooth device and add it. It then appears on the one hand in the luminaire overview, but also as a sensor and switch.
  • Page 270: Profile Selection

    7.1. Profile selection In the selection list for devices in the vicinity, the profiles can be changed for unpaired devices The profile without "_EVO" can also be used in Classic networks. => 4 buttons, 16 groups and 16 scenes as parameters The programs that include "_EVO"...
  • Page 271: Behave As A Lamp

    7.2. Behave as a lamp You can pack the gateway into scenes or groups in the normal way. Instead of one level, it has 8 switches. These can be used to carry out the actions within the gateway. Depending on the state of the switches, a stored trigger can be executed.
  • Page 272: Settings As A Lamp

    7.3. Settings as a lamp On the settings page of the luminaire, the parameters can then also be set, e.g. to have group addresses or scene addresses output. Depending on the profile either - 16 groups + 16 scenes - 32 groups + 32 scenes - 64 groups - 64 scenes are displayed.
  • Page 274: Settings As A Button

    7.4. Settings as a button In the Casambi software, the gateway can be selected in the button area on the settings page. Here, depending on the profile, 4 or, for profiles with "_EVO", 8 buttons can now be defined.
  • Page 275: Settings As A Pir Sensor

    7.5. Settings as a PIR sensor In the Casambi software, the gateway can be selected in the Sensor area on the settings page. This can now be set in the motion detector area.
  • Page 276: Settings As A Lux Sensor

    7.6. Settings as a lux sensor In the Casambi software, the gateway can be selected in the Sensor area on the settings page. This can now be set in the task light sensor area.
  • Page 277: Identify

    7.7. Identify It is now possible to identify the gateway when inserting the device into the wireless network. As long as the identification via the app is activated, the device behaves as if you press the identify button on the website.
  • Page 278: Changelog Firmware

    8. Changelog Firmware The backup files of version 2 are not compatible with those of version 3. In case of an update, the device must be set up again. The hardware button is currently still without function due to a hardware error and will be fixed from devices with manufacturing date >...
  • Page 279: Support

    9. Support We offer support via e-mail. Simply send an e-mail to support@lithernet.de. We will get back to you as soon as possible. A ticket can also be created online on the website https://support.lithernet.de/. For this purpose, however, an account must be registered. With this account you can also access previously written support requests.

Table of Contents