API documentation (all series & models)

API documentation (all series & models)

External control/discovery with our intelligent light models are possible through the following methods:


API guide (excel file) for LX and RX lights with firmware 2.2.27 and above.


TCP socket guide (python script) for products with firmware up to 2.2.27.


UDP discovery protocol (terse reference description). Mainly for L4A lights but may also be used with LX/RX lights. The User Datagram Protocol (UDP) is one of the core members of the Internet protocol suite. With UDP, the light (or computer) application can send messages to other hosts on an Internet Protocol (IP) network. Practically this means you can get info about the light from the Ethernet socket. This requires setup by a computer and programming. To do this, you need to build/program a code in a suitable environment (Python, Java, C, C++ or C# are some good examples).

Start from the base code provided in the link above, listen to port 50632 and set the light you want to listen to as a master light. If you don’t know how to set a light as a master, please follow this article (link). The master light sends out packages of information regarding light schedule (see example below) that can be used to integrate the light in other systems, like into HVAC-system or cooling room were you need information from the light to integrate.


The message/package of information is built as follows:
- A timestamp, a rolling counter to determine how old the message is created/sent (MSB) (8 bytes)
- CRC a crc32 checksum of the message (MSB) (4 bytes)
- The message data length of the message (MSB) (2 bytes)
- The command that is sent in the message. Only command for light setting is supported at this time.  (MSB) (2 bytes)
- Command data, any data that could be needed for the command. For the light setting it is the number of wavelengths. (MSB) (4 bytes)
- The master multicast ip address. Used by the slave to filter settings from the correct master. The same as in the master information message (4 bytes)
- The light setting in pairs of wavelength and set value (in relative power 0-1000) (MSB) (2 bytes+2 bytes). The total number of bytes shall be the same as in the previous data length information.

Example:
timestamp crc data_length command command_data muticast [wavelength+value]*no_of_wavelengths
Example of a message (all shall be as a long byte stream, only separated on lines to be readable):
0000000000000005
0b7e643
0001c
0001
00000007
ef3ffda5
0190 0064
01a4 0064
01c2 0064
0212 0064
0276 0064
0294 0064
02df 0064

________________________________________________________________________________________

You may also find external sources regarding scripts like this (link) and use this at your own responsibility.


    • Related Articles

    • Router setup - detailed

      Pre-steps For detailed information about your specific router setup, please contact your router manufacturer. The following example complies to a WIFI Netgear N150 WNR1000 router.   Make sure all your physical equipment is connected properly. Each ...
    • Integration with external (climate controlling) systems

      The Heliospectra intelligent light series (LX and RX-series) can communicate one or two way, with API among others. Some common examples of external climate controlling systems integration and methodology are described as follows:  Argus Through TCP ...
    • Name and identify your fixtures

      Heliospectra’s fixture(s) can be identified in several ways:   IP address - an identification number assigned to a fixture in the network that can be set in static or dynamic. MAC address - an identification number that is always static/same for each ...
    • Latest firmware (3.2.2)

      Download the files at the bottom of this page under the heading "Attachments" Applicable products: LX60 Series (LX601C, LX601G, LX602C, LX602G) LX50 Series (LX501C, LX501G, LX502C, LX502G) RX30 NOTE Do not use on L4 Lights! WiFi will only be ...
    • Connect to your lights (with helioCONNECT)

      To establish connections to your LX/RX light(s) and get all started, the first step is to install "helioCONNECT", our free software that’s designed to monitor and control all aspects of your light(s) in one place. This document will help you on how ...