Contents Introduction ..........................4 Initial setup ..........................4 Windows 10 setup ......................5 LUMA X setup ........................6 Setting the IP address ....................... 7 Testing the communication ..................... 8 Transmitting data ......................9 Modem configuration ......................9 Main page ........................10 Parameters page ......................
Page 3
WARNING: bright LED light source, do not look directly at emitter a few people may experience epileptic seizures when viewing flashing lights LUMA X 9/2023...
(see chapter 0 of the manual to access the LUMA X webpage). If your modem firmware is outdated, please contact Hydromea in order to get the latest version of the LUMA X firmware. 2 Initial setup Note: while submerging the LUMA X, a small number of bubbles may come out of the pressure compensation vent at the connector end of the modem.
Figure 1: Typical initial test setup. The IP addresses of the modems are not critical but useful to differentiate them 2.1 Windows 10 setup The following steps explain how to set an IP address on your Windows 10/11 PC go to → Settings → Network & Internet → Ethernet (in left column) → Network and Sharing Center (in right column) →...
Connect only one LUMA X to a computer via an Ethernet connection using Hydromea’s power/data cable. Connect the LUMA X to a suitable supply voltage (12 V – 36 V) using Hydromea’s power/data cable. Optional step: to test that the IP address has been set correctly, the computer should now be able to ping the LUMA X on its default IP address 192.168.102.101 and the...
All LUMA X have their IP address factory-set to 192.168.102.101. You can change the IP address of the modem through the web interface. 2.3 Setting the IP address For the initial test, modem (1) can remain at the default IP address. The other modem (2) must be set to a new IP address that is unique within the subnet.
Click “Set”. The new IP address is now temporarily applied, and the page will reload showing the new IP address: To store the new setting to flash memory, click “Save”. The modem is now set to the new IP address. 2.4 Testing the communication To test communication by exchanging messages between modems, the modem’s firmware provides a simple interface as shown in Figure 4.
Figure 4: messaging interface for modem-to-modem communication 2.5 Transmitting data On the operator PC, open a Shell, and type: ping 192.168.102.103 If everything is configured correctly, the modems will visibly flash with blue light, and the ping will show the response from the remote PC. The optical link is now ready and will forward any ethernet traffic from one side to the other side.
3.1 Main page Figure 5: main page of the web-based configuration-UI This page provides information about the current revision of the hardware, firmware and API. It also provides the firmware’s SHA and the unique processor ID. 3.2 Parameters page Figure 6: parameter page of the web-based configuration-UI LUMA X 9/2023...
Page 11
This is the main configuration page for the LUMA X. Hovering over the “?” next to each parameter provides a short description. Note: No change will become effective until the “Set” button has been pressed. After power- cycling the modem, the parameters will revert to the previous setting. Pressing the “Save” button will store the new set of parameters into the modem’s flash memory and make it the new permanent set of parameters.
Page 12
Auto-speed On: the modems automatically negotiate the optical speed at active which they should communicate. If the modems are close to each other or there is a lot of ambient light variation, the modems may switch their speed often and it can vary between 1Mbits/s and 10Mbits/s, which can be undesirable.
Page 13
if Auto gain control is On, the current gain value is displayed, but cannot be changed. if Auto gain control is Off, it is a mutable parameter Receiver In case the Auto gain control is Off or On - with fixed sensitivity sensitivity, this is a mutable parameter.
3.3 Status page Figure 7: status page of the web-based configuration-UI This page provides information about the current status of the LUMA modem and is updated once every second. For all data rates (throughput, packet CRC errors, received and loss), three values are displayed: per second, per minute and total since the start of the modem.
Page 15
Number receivers the number of receivers the modem is using (the sensitivity) to active detect light pulses (1 .. 4) LUMA voltage supply voltage of the modem LUMA voltage minimum value of the supply voltage observed over the last minute. (min over last This is useful to detect an input voltage drop minute)
3.4 IP address change page Figure 8: IP-setting page of the based configuration-UI This page lets you modify the IP address of the web-based configuration interface (which you are using right now). The current IP address of the of the web-based configuration interface is displayed and can be changed.
Start LumaConf Ensure that the LUMA X is connected to a computer through the serial connection. This is most easily achieved by using Hydromea’s power/data cable-box which provides a serial connection through a USB-to-serial conversion within the power/data cable and can be accessed via a micro-USB port.
Page 18
Note: please make sure that you select the proper firmware image, the last digits of the filename LX########## need to match the serial number engraved on the modem. o Factory reset only: clicking on Clear Settings will factory reset all LUMA X settings.
SubConn's instructions. 6 API Hydromea provides an API, based on REST, with which key operating parameters of the LUMA X can be changed or status parameters retrieved while the modem is running. The following tables provide a complete list of these parameters, followed by examples showing how to retrieve and change them (in case they are writable).
Page 20
crc_errors_sec Number of CRC errors that happened in the last second in the Luma. A high number could indicate some noise or that the Luma is at the edge of the maximal range pkt_recv_sec Number of packet received in the last second pkt_loss_sec Number of packet lost in the last second.
Page 21
nb_additional_rcv Number of extra receivers active status_electronics Status of the electronics, 0 indicates an internal problem volt_board The voltage the LUMA sees at its VCC input port. volt_board_min The voltage the LUMA sees at its VCC input port, sampled at a higher rate and displaying the minimum value observed over the last minute.
Page 22
fw_version_rev firmware version of the Luma, revision sha_version Specific firmware variant of the Luma api_version Version of the API. (16 bit value 8'MAJ, 8'MIN) concatenated in one parameter for compatibility api_version_maj Version of the API, major version api_version_min Version of the API, minor version api_version_rev Version of the API, revision bootloader_versio...
Page 23
LEDs, but will never go higher than this parameter encoding 0: no encoding, Enabling Encoding, improves the link quality at the cost of throughput 1: encoding led_tx_pwr_normal [0-100] Note this parameter does nothing, but is kept for compatibility’s sake led_tx_pwr_cooldown [0-100] Note this parameter does nothing, but is kept for compatibility’s sake auto_gain_control...
Page 24
signal_filtering_type 0: low filtering Filtering the data (smoothing it with a low pass filter) will remove the noise, but will also alter 1: normal filtering the light pulses thus reducing the range. (default) 2: high filtering 3: very high filtering auto_power 0: off, 1: on Activates or not the auto power...
read_parameters_from_rom Gets all parameters from ROM and replace the recent changes reset_parameters Resets all parameters back to default reboot Restart the Luma, makes it go into bootloader comm_eval.json (read/write) This API page will control the sending and receiving of messages, it is used in the “comm. test” page of the web interface Parameter Valid input...
RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL HYDROMEA BE LIABLE FOR ANY DIRECT, INDIRECT, ONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF HYDROMEA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
9 Errata Version Release date Errata 6.5.2021 Original version 25.5.2021 swapped Vcc and GND in connector pinout in table in chapter 5 added chapters Error! Reference source not found. and Error! Reference source not found. updated table in chapter Error! Reference source not found.
Need help?
Do you have a question about the LUMAX and is the answer not in the manual?
Questions and answers