Casambi Lithernet 160301 User manual

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

2
Table of contents
1. Hardware ...............................................................................................................................................7
1.1. LED Status Display ......................................................................................................................8
1.2. Hardware Revision .......................................................................................................................9
1.2.1. Hardware Revision 0 .........................................................................................................10
1.2.2. Hardware Revision 1 .........................................................................................................11
1.2.3. Hardware Revision 2 .........................................................................................................12
1.3. Watchdog ....................................................................................................................................13
1.4. Reset Button ...............................................................................................................................14
1.5. Conformity ..................................................................................................................................15
1.5.1. Hardware Revision 1 .........................................................................................................16
1.5.2. Hardware Revision 2 .........................................................................................................17
1.6. Bluetooth module .......................................................................................................................18
1.6.1. Hardware Revision 0 und 1 ..............................................................................................20
1.6.2. Hardware Revision 2 .........................................................................................................22
1.7. Type label ...................................................................................................................................24
1.7.1. Hardware Revision 1 .........................................................................................................25
1.7.2. Hardware Revision 2 .........................................................................................................26
1.8. Firmware Version .......................................................................................................................27
1.9. Software Librarys .......................................................................................................................28
2. Areas of application .............................................................................................................................29
2.1. Gateway to an existing lighting control system (Netcomposer) .................................................30
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. ArtNet gateway ...........................................................................................................................39
2.7. BacNet/IP gateway .....................................................................................................................40
2.8. MQTT ..........................................................................................................................................41
2.9. Example implementations ..........................................................................................................42
3. Login ....................................................................................................................................................43
4. General setting ....................................................................................................................................45
4.1. Firmware warning .......................................................................................................................46
4.2. Network .......................................................................................................................................47
4.2.1. IP settings ..........................................................................................................................48
4.2.2. Webserver Login ...............................................................................................................49
4.2.3. NTP-Client .........................................................................................................................50
4.2.4. Restart gateway ................................................................................................................51
4.3. System ........................................................................................................................................52
4.3.1. Control system wizard .......................................................................................................55
4.3.1.1. Netcomposer system ................................................................................................57
4.3.1.2. Art-Net ......................................................................................................................58
4.3.1.3. Free commands over UDP ......................................................................................59
4.3.1.4. HelvarNet (TCP) .......................................................................................................60
4.3.1.5. Free commands over TCP .......................................................................................61
4.3.1.6. UDP Casambi Command .........................................................................................62
4.3.1.7. TCP Casambi Command .........................................................................................63
4.3.1.8. UDP Casambi Bridge ...............................................................................................64
4.3.1.9. BacNet/IP ..................................................................................................................65
4.3.1.10. MQTT ......................................................................................................................67
4.3.2. Casambi Settings ..............................................................................................................69

3
4.3.3. LED settings ......................................................................................................................70
4.3.4. Date and time ....................................................................................................................71
4.3.5. Automation .........................................................................................................................72
4.3.6. Restart gateway ................................................................................................................73
4.4. Memory .......................................................................................................................................74
4.4.1. Update firmware ................................................................................................................75
4.4.2. Import / Export ...................................................................................................................76
4.4.3. System memory ................................................................................................................77
4.4.4. UDP Debug Port ...............................................................................................................78
4.4.4.1. LanLog.exe ...............................................................................................................79
4.5. Reset device ...............................................................................................................................80
5. Protocol-specific settings .....................................................................................................................82
5.1. ArtNet ..........................................................................................................................................83
5.1.1. To Casambi .......................................................................................................................84
5.1.2. From Casambi ...................................................................................................................87
5.2. BacNet/IP ....................................................................................................................................88
5.2.1. View in the gateway ..........................................................................................................89
5.2.1.1. To Casambi ..............................................................................................................90
5.2.1.1.1. Commands ......................................................................................................91
5.2.1.1.2. Sensors ............................................................................................................92
5.2.1.1.2.1. Lightsensor .............................................................................................94
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. Polling ..............................................................................................................................109
5.3. Free commands over TCP .......................................................................................................110
5.3.1. To Casambi .....................................................................................................................111
5.3.1.1. Select storage location ...........................................................................................112
5.3.1.2. Trigger .....................................................................................................................113
5.3.1.3. Action ......................................................................................................................114
5.3.2. From Casambi .................................................................................................................115
5.3.2.1. Select storage location ...........................................................................................116
5.3.2.2. Trigger .....................................................................................................................117
5.3.2.3. Action ......................................................................................................................119
5.4. Free commands over UDP ......................................................................................................120
5.4.1. To Casambi .....................................................................................................................121
5.4.1.1. Select storage location ...........................................................................................122
5.4.1.2. Trigger .....................................................................................................................123
5.4.1.3. Action ......................................................................................................................124
5.4.2. From Casambi .................................................................................................................125
5.4.2.1. Select storage location ...........................................................................................126
5.4.2.2. Trigger .....................................................................................................................127
5.4.2.3. Action ......................................................................................................................129
5.5. HelvarNet (TCP) .......................................................................................................................130

4
5.5.1. To Casambi .....................................................................................................................131
5.5.1.1. Commands .............................................................................................................132
5.5.1.1.1. Select storage location ..................................................................................133
5.5.1.1.2. Trigger ............................................................................................................134
5.5.1.1.3. Action .............................................................................................................135
5.5.1.2. Sensors ...................................................................................................................136
5.5.2. From Casambi .................................................................................................................137
5.5.2.1. Select storage location ...........................................................................................138
5.5.2.2. Trigger .....................................................................................................................139
5.5.2.3. Action ......................................................................................................................141
5.5.3. HelvarNet Command Builder ..........................................................................................142
5.5.3.1. Recall Scene (Group) .............................................................................................143
5.5.3.2. Recall Scene (Device) ............................................................................................144
5.5.3.3. Direct Level (Group) ...............................................................................................145
5.5.3.4. Direct Level (Device) ..............................................................................................146
5.5.3.5. Dimm (Group) .........................................................................................................147
5.5.3.6. Dimm (Device) ........................................................................................................148
5.6. MQTT ........................................................................................................................................149
5.6.1. View in the gateway ........................................................................................................150
5.6.1.1. To Casambi ............................................................................................................151
5.6.1.1.1. Commands ....................................................................................................152
5.6.1.1.2. Sensors MQTT ..............................................................................................153
5.6.1.1.2.1. Lightsensor ...........................................................................................154
5.6.1.1.2.2. Presence ...............................................................................................155
5.6.1.2. From Casambi ........................................................................................................156
5.6.2. View in MQTT .................................................................................................................157
5.6.2.1. MQTT data received ..............................................................................................158
5.6.2.1.1. Gateway .........................................................................................................159
5.6.2.1.2. Broadcast .......................................................................................................160
5.6.2.1.3. Device ............................................................................................................161
5.6.2.1.4. ungrouped ......................................................................................................164
5.6.2.1.5. Groups ...........................................................................................................165
5.6.2.1.6. Scenes ...........................................................................................................166
5.6.2.2. Send MQTT data ....................................................................................................167
5.6.3. Poling ...............................................................................................................................171
5.7. Netcomposer ............................................................................................................................172
5.7.1. To Casambi .....................................................................................................................173
5.7.1.1. Select storage location ...........................................................................................174
5.7.1.2. Trigger .....................................................................................................................175
5.7.1.3. Action ......................................................................................................................176
5.7.2. From Casambi .................................................................................................................177
5.7.2.1. Select storage location ...........................................................................................178
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

5
5.8.1.1. To Casambi ............................................................................................................190
5.8.1.2. From Casambi ........................................................................................................191
5.8.2. Control in the network .....................................................................................................192
5.8.2.1. Commands from the Casambi system ...................................................................194
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. 0x46 - target status .......................................................................................202
5.8.2.1.9. 0x49 - Target Color .......................................................................................203
5.8.2.1.10. 0x4B - NotifyControlValues Responses ......................................................204
5.8.2.2. Commands to the Casambi system .......................................................................206
5.8.2.2.1. 0x10 - Push Button Pressed .........................................................................207
5.8.2.2.2. 0x11 - Push Button Released .......................................................................208
5.8.2.2.3. 0x1D - GetParameterValue ...........................................................................209
5.8.2.2.4. 0x1E - Set the level of a scene ....................................................................210
5.8.2.2.5. 0x1F - Set level of a group ...........................................................................211
5.8.2.2.6. 0x20 - Set the level of a target .....................................................................212
5.8.2.2.7. 0x21 - Set the level of a button's target ........................................................213
5.8.2.2.8. 0x28 - Request time from the Casambi network ...........................................214
5.8.2.2.9. 0x28 - Set time in the Casambi network .......................................................215
5.8.2.2.10. 0x2B - Set presence sensor .......................................................................216
5.8.2.2.11. 0x2C - Set light sensor ................................................................................217
5.8.2.2.12. 0x2F - Set color via RGBW ........................................................................218
5.8.2.2.13. 0x31 - SetTargetVerticalRatio ......................................................................219
5.8.2.2.14. 0x38 - SetColor X/Y ....................................................................................220
5.8.2.2.15. 0x39 - Node state ........................................................................................221
5.8.2.2.16. 0x3D - Set Color via Hue / Sat ...................................................................222
5.8.2.2.17. 0x3E - SetTargetDimmers ...........................................................................223
5.8.2.2.18. 0x3F - SetTargetElements ...........................................................................224
5.8.2.2.19. 0x45 - Scene state ......................................................................................225
5.8.2.2.20. 0x46 - Target Status ....................................................................................226
5.8.2.2.21. 0x48 - Set color temperature ......................................................................227
5.8.2.2.22. 0x49 - Target Color .....................................................................................228
5.8.2.2.23. 0x4A - Resume Automation ........................................................................229
5.8.2.2.24. 0x4B - NotifyControlValues .........................................................................230
5.8.2.3. Demo programs ......................................................................................................231
5.9. TCP Casambi Command .........................................................................................................232
5.9.1. View in the gateway ........................................................................................................233
5.9.1.1. To Casambi ............................................................................................................234
5.9.1.2. From Casambi ........................................................................................................235
5.9.2. Control in the network .....................................................................................................236
5.10. UDP Casambi Bridge .............................................................................................................237
5.10.1. Bridge Mode Command Builder ....................................................................................238
5.10.2. To Casambi ...................................................................................................................239
5.10.2.1. Select storage location .........................................................................................240
5.10.2.2. Action ....................................................................................................................241
5.10.3. From Casambi ...............................................................................................................242
5.10.3.1. Select storage location .........................................................................................243

6
5.10.3.2. Trigger ...................................................................................................................244
5.10.3.3. Action ....................................................................................................................246
5.11. Casambi ..................................................................................................................................247
5.11.1. Ping ................................................................................................................................248
5.11.2. Set Level ........................................................................................................................249
5.11.3. Push Button Pressed .....................................................................................................250
5.11.4. Push Button Released ...................................................................................................251
5.11.5. Set Presence .................................................................................................................252
5.11.6. Set Scene Level ............................................................................................................253
5.11.7. Set Group Level ............................................................................................................254
5.11.8. Set Push Button Level ...................................................................................................255
5.11.9. Set Lux Sensor ..............................................................................................................256
5.11.10. Set Tc ...........................................................................................................................257
5.11.11. Set RGBW ...................................................................................................................258
5.11.12. Set Hue / Sat ...............................................................................................................259
5.11.13. Set Vertical ...................................................................................................................260
5.11.14. Start Automation ..........................................................................................................261
5.11.15. SetTargetDimmers .......................................................................................................262
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. Settings as a PIR sensor .........................................................................................................275
7.6. Settings as a lux sensor ..........................................................................................................276
7.7. Identify ......................................................................................................................................277
8. Changelog Firmware .........................................................................................................................278
9. Support ..............................................................................................................................................279

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

8
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.
When the device is set to identify mode via the surface, the LEDs 2-4 start to flash in ascending and descending
order for 10 seconds.
The LEDs with the numbers 3 and 4 can take up to 60s to display the status after a restart.

9
1.2. Hardware Revision

10
1.2.1. Hardware Revision 0
Hardware Revision 0
Supports firmware versions 1.XX with "_REV0" in the name.

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

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

13
1.3. Watchdog
A watchdog runs in the gateway with a set time of 90s in order to restart the device automatically if necessary.

14
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.
> 0s and < 15s = LED test program
>15s and <30s = soft reset
> 30s = hard reset
With a soft reset, only the IP-> settings and the login data are set to factory settings.
With a hard reset, all settings are set to factory settings and the memory is also completely erased.

15
1.5. Conformity

16
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
UKCA
The full text of the UKCA declaration of conformity is available at the following internet address: https://
archiv.intelligent-lighting.de/index.php/s/wH7fddqRoGSK7dE

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

18
1.6. 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
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions:
(1) This device may not cause harmful interference, and
(2) this device must accept any interference received,
including interference that may cause undesired operation.
Contains FCC ID: 2ALA3-CBM002A
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
This device complies with Industry Canada’s licenseexempt RSSs. Operation is subject to the following two
conditions:
(1) This device may not cause interference; and
(2) This device must accept any interference, including
interference that may cause undesired operation of the
device.
Le présent appareil est conforme aux CNR d’Industrie
Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions
suivantes:
(1) l’appareil ne doit pas produire de brouillage;
(2) l’utilisateur de l’appareil doit accepter tout brouillage
radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement.
Contains IC: 22496-CBM002A
-------------------------------------------------------------------------------------------------------------------------------------------------------------------

19

20
1.6.1. 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
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions:
(1) This device may not cause harmful interference, and
(2) this device must accept any interference received,
including interference that may cause undesired operation.
Contains FCC ID: 2ALA3-CBM002A
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
This device complies with Industry Canada’s licenseexempt RSSs. Operation is subject to the following two
conditions:
(1) This device may not cause interference; and
(2) This device must accept any interference, including
interference that may cause undesired operation of the
device.
Le présent appareil est conforme aux CNR d’Industrie
Canada applicables aux appareils radio exempts de licence. L’exploitation est autorisée aux deux conditions
suivantes:
(1) l’appareil ne doit pas produire de brouillage;
(2) l’utilisateur de l’appareil doit accepter tout brouillage
radioélectrique subi, même si le brouillage est susceptible d’en compromettre le fonctionnement.
Contains IC: 22496-CBM002A
-------------------------------------------------------------------------------------------------------------------------------------------------------------------