📄 Receiver API

Receiver API

This API is used to monitor the receiver status and its parameters.

The receiver REST API is on the endpoint:

https://api.involi.live/receiver

Authorization is granted via a bearer token in the HTTP header.

Example: Authorization: bearer <token>

The token must be requested from the authentication server with your client id and client secret.

Request

An HTTP GET request on the endpoint returns a list or receivers

Data format

A JSON response contains an array of receiver records.

Example receiver object:

{
      "ids": {
        "serial_number": "AG-02-000999"
      },
      "type": "involi_receiver",
      "latitude": 41.123456,
      "longitude": 2.123456,
      "wgs84_altitude": 1234.123,
      "temperature": 12.34,
      "relative_humidity": 12.34,
      "pressure": 956.64,
      "power_consumption": 1.1,
      "last_update": [1512345600, 318027132],
      "last_gnss_fix": [1512345600, 318027132]
      "is_online": false,
      "components": [
        {
            "id": "component_0",
            "type": "radio",
            "last_received_message": [1512345600, 388661712]
        }
      ],
      "label": "receiver label",
      "primary_id": "4e63d7bb52a5cff81989303955cadc49b38b6dbf",
      "model": "G-1090",
      "operational_status": "Test",
      "firmware": "1.5.0",
      "update_status": "success",
      "additional_permissions": ["receiver:write"]
}

Receiver Fields Description:

Field	Type	Unit	Description
ids.serial_number	string		Serial number of the receiver
type	string		Type of the receiver (e.g. ‘involi_receiver’)
longitude	float	°	Longitude
latitude	float	°	Latitude
wgs84_altitude	float	m	Elevation above WGS84 reference ellispoid
temperature	float	°C	Temperature pressure measured inside the receiver box
relative_humidity	float	%	Humidity measured inside the receiver box
pressure	float	hPa	Barometric pressure measured inside the receiver box
power_consumption	float	W	Electrical power consumption
last_update	array	[s, ns]	Timestamp of last receiver status update (separated in seconds and nanoseconds)
last_gnss_fix	array	[s, ns]	Timestamp of last GNSS position fix (separated in seconds and nanoseconds)
is_online	boolean		True if the receiver is sending data to the server
components	array		Dictionary of receiver components
label	string		Label of the receiver
primary_id	string		Unique Identifier
model	string		Receiver model (e.g. ‘G-1090’)
operational_status	(optional) string		Operational status of the receiver, this can be set by the operator in the involi.live receiver panel (Only available if operational status has been set on receivers page: https://involi.odoo.com/knowledge/article/62) Possible values: - Test - Production
firmware	string		Receiver installed firmware version
update_status	(optional) string		Status of the last receiver firmware update: (Only available if update is ongoing) Possible value: - in-progress - aborting - aborted - success - failed
additional_permissions	string array		Information about client permissions concerning this receiver

Restrictions

The INVOLI server can respond to 5 requests per 1 sec using one token. The recommended rate is 2 requests per 1 second. If the number of requests is higher, the server will reply with status code 429 too many requests. If multiple servers or clients need to access an API, each one should have its unique token.