Skip to main content
API docs by Redocly

Uberlogger API (1.2.0)

Download OpenAPI specification:Download

The Uberlogger API provides functionalities for managing logger operations. It encompasses endpoints for triggering calibration, formatting the SD card, retrieving file lists, obtaining current measurment values, and controlling the logger. Each endpoint is thoroughly described, including their operations, expected responses, and code samples, facilitating seamless integration and utilization for developers.

Limitation: don't call the endpoints more than twice per second. There is no throttling implemented, so calling them too often may overload the Uberlogger and could lead to unstable behaviour.

Calibration

Trigger calibration process

Responses

SD Card Management

Format the SD card

Responses

Unmount the SD card safely

Responses

Configuration

Get current logger configuration

Responses

Response samples

Content type
application/json
{
  • "ADC_RESOLUTION": 12,
  • "AIN_ENABLED": {
    },
  • "AIN_RANGE_SELECT": {
    },
  • "DIN_ENABLED": {
    },
  • "EXT_TRIGGER_MODE": 0,
  • "EXT_TRIGGER_PIN": 1,
  • "EXT_TRIGGER_DEBOUNCE_TIME": 100,
  • "FILE_DECIMAL_CHAR": 0,
  • "FILE_NAME_MODE": 1,
  • "FILE_NAME_PREFIX": "logfilename",
  • "FILE_SEPARATOR_CHAR": 0,
  • "LOG_MODE": 0,
  • "LOG_SAMPLE_RATE": 1,
  • "NTC_SELECT": {
    },
  • "AVERAGE_SAMPLES": 0,
  • "WIFI_CHANNEL": 1,
  • "WIFI_PASSWORD": "your_secret_password",
  • "WIFI_SSID": "My Router SSID"
}

Set logger configuration

Request Body schema: application/json
required
ADC_RESOLUTION
integer
Enum: 12 16

Resolution of ADC measurements. Can be either 12 bits or 16 bits.

object

Enables or disables an analog channel AINx. True = enabled, false = disabled.

object

Select the range of an analog channel. False = +/- 10V, true = +/- 60V

object

Enables or disables a digital input. True = enabled, false = disabled.

EXT_TRIGGER_MODE
integer
Enum: 0 1 2

Sets the external trigger mode of the logger. - 0 - Continuous measurement (default) - 1 - External trigger - after starting the logger and arming it by activating "Start logger", the Uberlogger will acquire data when a digital pin is set to HIGH. The trigger pin can be set using the EXT_TRIGGER_PIN setting. - 2 - External control - the Uberlogger will start logging and acquiring data after the digital pin with value EXT_TRIGGER_PIN will be put HIGH. When this pin is LOW, the logger will stop logging. The physical start/stop button and the start/stop buttons in the web UI cannot be used when setting measurement mode is used.

EXT_TRIGGER_PIN
integer
Enum: 1 2 3 4 5 6

Sets the pin for the external trigger input.

EXT_TRIGGER_DEBOUNCE_TIME
integer [ 0 .. 60000 ]

Debounce time for the external trigger in milliseconds.

FILE_DECIMAL_CHAR
integer
Enum: 0 1

Character used for decimal notation in files. - 0 - DOT: Decimal point. - 1 - COMMA: Decimal comma.

FILE_NAME_MODE
integer
Enum: 0 1

File naming convention used by the logger. - 0 - SEQ_NUM: Sequential numbering. - 1 - TIMESTAMP: Based on the timestamp.

FILE_NAME_PREFIX
string <= 70 characters

Log file prefix. Cannot contain special characters or spaces.

FILE_SEPARATOR_CHAR
integer
Enum: 0 1

Character used as a separator in files. - 0 - COMMA: Comma is used as a separator. - 1 - SEMICOLON: Semicolon is used as a separator.

LOG_MODE
integer
Enum: 0 1

Logging mode of the device. - 0 - RAW: Stores raw binary data. - 1 - CSV: Stores data in CSV format.

LOG_SAMPLE_RATE
integer
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12

Frequency at which the logger samples data. - 0 - Once per hour - 1 - Once per 10 minutes - 2 - Once per 5 minutes - 3 - Once per minute - 4 - Once per 10 seconds - 5 - 1 Hz - 6 - 2 Hz - 7 - 5 Hz - 8 - 10 Hz - 9 - 25 Hz - 10 - 50 Hz - 11 - 100 Hz - 12 - 250 Hz

object

Sets the analog input AINx as analog (=false) or NTC input (=true).

AVERAGE_SAMPLES
integer
Enum: 0 1

Sets the sampling mode. - 0 - Normal sampling (default) - 1 - Average samples over time (use an IIR filter to average samples over time for sample rates below 1 Hz).

WIFI_CHANNEL
integer [ 1 .. 13 ]

WiFi channel used by the device. Range is from 1 to 13.

WIFI_PASSWORD
string <= 20 characters

WiFi password of access point the Uberlogger needs to connect to.

WIFI_SSID
string <= 32 characters

WiFi SSID of access point the Uberlogger needs to connect to.

Responses

Request samples

Content type
application/json
{
  • "ADC_RESOLUTION": 12,
  • "AIN_ENABLED": {
    },
  • "AIN_RANGE_SELECT": {
    },
  • "DIN_ENABLED": {
    },
  • "EXT_TRIGGER_MODE": 0,
  • "EXT_TRIGGER_PIN": 1,
  • "EXT_TRIGGER_DEBOUNCE_TIME": 100,
  • "FILE_DECIMAL_CHAR": 0,
  • "FILE_NAME_MODE": 1,
  • "FILE_NAME_PREFIX": "logfilename",
  • "FILE_SEPARATOR_CHAR": 0,
  • "LOG_MODE": 0,
  • "LOG_SAMPLE_RATE": 1,
  • "NTC_SELECT": {
    },
  • "AVERAGE_SAMPLES": 0,
  • "WIFI_CHANNEL": 1,
  • "WIFI_PASSWORD": "your_secret_password",
  • "WIFI_SSID": "My Router SSID"
}

Set the current time of the logger

Request Body schema: application/json
required
TIMESTAMP
integer

Unix timestamp to set the logger's current time in ms.

Responses

Request samples

Content type
application/json
{
  • "TIMESTAMP": 1711368350281
}

File Management

Retrieve a list of files or download a file from the SD card

path Parameters
file_path
required
string
Example: 2024_05_05_13_30.csv

The path to the file or directory on the SD card. Supports wildcard (*) to match multiple files.

Responses

Response samples

Content type
application/octet-stream
Binary data representing the file contents

Data

Get current logger values

Responses

Response samples

Content type
application/json
{
  • "ERRORCODE": 0,
  • "FW_VERSION": "1.2.0_2024.09.21.14.40",
  • "LOGGER_STATE": 1,
  • "READINGS": {
    },
  • "SD_CARD_FREE_SPACE": 15097344,
  • "SD_CARD_STATUS": 2,
  • "TIMESTAMP": 1711207016573,
  • "WIFI_TEST_IP": "192.168.6.3",
  • "WIFI_TEST_RSSI": -54,
  • "WIFI_TEST_STATUS": 0
}

Logger Control

Start the logging process

Responses

Stop the logging process

Responses

Reboot the Uberlogger

Responses