Skip to main content
API docs by Redocly

Uberlogger API (1.1.4)

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

Data

Get current logger values

Responses

Response samples

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

Configuration

Get current logger configuration

Responses

Response samples

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

Set logger configuration

Request Body schema: application/json
required
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.

object

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

ADC_RESOLUTION
integer
Enum: 12 16

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

LOG_SAMPLE_RATE
integer
Enum: 0 1 2 3 4 5 6 7

Frequency at which the logger samples data.

  • 0 - 1 Hz
  • 1 - 2 Hz
  • 2 - 5 Hz
  • 3 - 10 Hz
  • 4 - 25 Hz
  • 5 - 50 Hz
  • 6 - 100 Hz
  • 7 - 250 Hz
LOG_MODE
integer
Enum: 0 1

Logging mode of the device.

  • 0 - RAW: Stores raw binary data.
  • 1 - CSV: Stores data in CSV format.
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_DECIMAL_CHAR
integer
Enum: 0 1

Character used for decimal notation in files.

  • 0 - DOT: Decimal point.
  • 1 - COMMA: Decimal comma.
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.
WIFI_SSID
string <= 32 characters

WiFi SSID of accespoint the Uberlogger needs to connect to.

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.

Responses

Request samples

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

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
}

Logger Control

Start the logging process

Responses

Stop the logging process

Responses

Reboot the Uberlogger

Responses