HYDROMEA Luma X, Manual

Page: 22 / 28

22 LUMA X 3/2022
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). The examples are written in Python
6.1 API parameters
status.json (read only)
Parameter Description
amplitude Current amplitude value of the Luma, selected by the auto gain
ambient Ambient value read by the Luma sensor
temperature Current temperature of the Luma
throughput_received Data received successfully by the modem in bits per seconds
crc_errors
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 Number of packet received in the last second
pkt_loss Number of packet lost in the last second. Note that the Luma can only
detect packet loss after it has received a
packet out of sequence
gain Current gain value of the receiver
nb_additional_rcv Number of extra receivers active
status_electronics Status of the electronics, 0 indicates a internal problem
uptime Time since start of the Luma firmware in miliseconds
general_info.json (read only)
Parameter Description
hw_version Hardware version of the Luma (16 bit value 8'MAJ, 8'MIN)
fw_version firmware version of the Luma (16 bit value 8'MAJ, 8'MIN)
sha_version Specific firmware variant of the Luma
api_version Version of the API. (16 bit value 8'MAJ, 8'MIN)
proc_id_0 Unique identifier of the Luma (MSB 32bit)
proc_id_1 Unique identifier of the Luma (32bit)
proc_id_2 Unique identifier of the Luma (32bit)
proc_id_3 Unique identifier of the Luma (LSB 32bit)