Device Info

Endpoint for receiving device hardware and diagnostics information

Receive device information

post

Overview

This endpoint provides detailed hardware specifications, firmware versions, and technical diagnostics regarding the device's health and modem performance.

Important: The endpoint paths shown in this documentation (/measurements, /configuration, /device-info) are examples only.

The actual endpoint URLs are fully configurable in the CoAP Loader's application.yml file

When is it called?

• During the first communication after sensor boot/reset
• Periodically (frequency depends on sensor configuration)
• After firmware updates

What data do you receive?

• Software information: firmware version, commit ID
• Runtime diagnostics: uptime, MCU temperature, battery voltage, message statistics
• Modem information: modem type, network quality parameters (34 values for BC66 modem)
• Memory statistics: internal memory usage/allocation
• Error tracking: runtime error codes (if any)

Use cases:

• Monitor device health and battery status
• Track firmware versions across your sensor fleet
• Diagnose connectivity issues using modem parameters
• Alert on critical conditions (low battery, high temperature, errors)

Request Structure

Method: POST

Endpoint: Configurable in application.yml under the endpointDeviceInfo key. The path /device-info shown here is just an example.

Headers:

• Content-Type: application/json
• charset: UTF-8
• X-Api-Token: "optional api token" (if configured on sensor via CLOUD_TOKEN parameter)

Body: JSON object containing device information fields (see DeviceInfo schema below for complete structure)

Response

Your platform must respond with HTTP status code 2xx (e.g., 200, 201, or 204) with an empty body to confirm receipt.

Note: This endpoint does NOT support returning configuration updates in the response.

Header parameters

X-Api-TokenstringOptional

Optional API token for authentication (if configured)

Example: your_api_token

Content-TypestringRequiredDefault: application/json

charsetstringRequiredDefault: UTF-8

Body

serialNumberstringRequired

Unique serial number of the sensor

Example: 282C024FFFB1

softwareVersionstringRequired

Current firmware version

Example: 1546

commitIdstringRequired

Unique identifier of the specific software build

Example: a1b2c3d4

cloudTokenstringRequired

Unique token used for cloud authentication

Example: token123

memoryStatisticsinteger[]Required

A list of numbers representing internal memory usage/allocation

Example: [1024,2048]

updateTimestampinteger · int64Required

The timestamp of the last firmware or configuration update

Example: 1707830000

updateStatusintegerRequired

Numeric code representing the status of the last update attempt

Example: 0

Responses

401

Unauthorized.

HTTP to CoAP mapping: HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.

No content

403

Forbidden.

HTTP to CoAP mapping: HTTP 401 or 403 will be converted to CoAP 4.01 UNAUTHORIZED.

2XX

Success - Device information received successfully. Response body should be empty.

HTTP to CoAP mapping: Any 2xx HTTP status code (200, 201, 204, etc.) will be converted to CoAP 2.01 CREATED.

Note: This endpoint does NOT support returning configuration updates to the sensor. The sensor only sends device information and does not expect configuration in response.

application/json

3XX

Redirection.

HTTP to CoAP mapping: Any 3xx HTTP status code (301, 302, 304, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.

4XX

Client Error.

HTTP to CoAP mapping: Any 4xx HTTP status code (except 401/403) will be converted to CoAP 4.00 BAD REQUEST.

5XX

Server Error.

HTTP to CoAP mapping: Any 5xx HTTP status code (500, 502, 503, etc.) will be converted to CoAP 5.00 INTERNAL SERVER ERROR.

post/device-info

POST /device-info HTTP/1.1
charset: UTF-8
Content-Type: application/json
Accept: */*
Content-Length: 543

{
  "serialNumber": "282C024FFFB1",
  "softwareVersion": "1546",
  "runtimeInfo": {
    "uptime": 12345,
    "confirmableMessagesAttempts": 50,
    "nonConfirmableMessagesAttempts": 10,
    "succeededMessages": 58,
    "mcuTemperature": 22,
    "minBatteryVoltage": 3600,
    "minBatteryMcuTemperature": 20,
    "batteryResetTimestamp": 1707830000,
    "maxMcuTemperature": 35,
    "minMcuTemperature": 15,
    "runtimeErrors": []
  },
  "modemInfo": {
    "modemType": "MODEM_TYPE_BC66",
    "parameters": [
      5,
      12,
      3
    ]
  },
  "commitId": "a1b2c3d4",
  "cloudToken": "token123",
  "memoryStatistics": [
    1024,
    2048
  ],
  "updateTimestamp": 1707830000,
  "updateStatus": 0
}

No content