Glossary

API

Application Programming Interface. A programming interface/part of a program that is made available by a software system to other programs for connection to the system.

API calls

An API call or API request is a message sent to a server asking an API to provide a service or information (response).

Bulk action

A specific action (e.g. configuration, firmware update, etc.) to be performed on multiple vehicles in one go.

Command

A command is an API call that is sent to a vehicle and results in a vehicle interaction, e.g., opening the doors.

Connected vehicle

A vehicle with integrated telematics unit and capabilities, therefore it is ready to operate. It is connected to a server and software to deliver collected driving data.

Credentials

Credentials provided by the OEM or telematics unit manufacturer which are needed to communicate with the vehicle.

Event

Events are generated by the CloudBoxx and will be sent to the CloudBoxx server when a status change is detected. So, every event is triggered by a reason like ignition changed or central lock changed. Each event contains the current device state. Starting with OneAPI Events as a concept will continue but will be replaced with VehicleStateReceived messages.

Fleet unit

A specific vehicle, a telematics unit, or a conected vehicle with a unique ID. Each fleet unit belongs to exactly one fleet.

Heartbeat

Heartbeats are generated by CloudBoxx devices and will be sent periodically (every 15 minutes) to the CloudBoxx server. A heartbeat contains connectivity information like provider and signal strength.

Modem

Hardware component, which connects the CloudBoxx to the mobile data network.

QNR

A QNR is a telematics unit ID and the unique identifier for CloudBoxxes. It consists of 16 digits in hexadecimal (0-9A-F), e.g., ‘DA00001A2D837101’. The QNR is not the only identifier used for CloudBoxxes. You can refer to CloudBoxxes by either QNR or serial number.

Vehicle commands

An API call that is sent to a vehicle and results in a vehicle interaction, e.g. opening the doors.

Vehicle equipment ID

An individual identifier that is chosen by the customer to identify a specific vehicle.

VIN

A series of letters and numbers that uniquely identifies a vehicle. It is usually printed in various places across the chassis.

Telematics unit ID

A telematics unit ID is an identifier for a telematics unit. A specific telematics unit can only be uniquely identified by its telematics brand combined with the identifier assigned by the manufacturer, e.g., the telematics brand CloudBoxx and the telematics unit ID QNR or the telematics brand NIU and the telematics unit ID scooter id. In our ecosystem, there is no globally unique identifier for telematics units that we create and assign ourselves. Instead, we use the identifier which is assigned by the manufacturer. As a consequence, a specific telematics unit can only be uniquely identified by its telematics brand combined with the identifier assigned by the manufacturer.

Trip

A detected movement of a vehicle from a start position to an end position. All events received from a vehicle during the movement are collected and attached to the Trip.