• General Guides and References
  • Swagger OpenAPI
  • Definition Model includes Features not accessible by user
  • Thingsboard API Reference
  • Cital Guide
  • Overview of Customer <> Telemetry Structure
  • REST API Meta Data Structure
    • Relations/Hierarchy
    • Customers
  • REST API Device/Telemetry Structure
    • Device Information
    • Device Metadata
    • Telemetry
  • Graphical User Interface
  • Contact & Help

General Guides and References

The Following Section will include some Guides and References to Understand usage of Cital Insights API Interfaces.

Swagger OpenAPI

• https://iot.cital.io/swagger-ui/ 

• Definition Model includes Features not accessible by user

Thingsboard API Reference

• General Reference: ThingsBoard API reference 
• server-side API is relevant for accessing Data: REST API 
• REST Clients available: Java REST Client,  Python REST Client, Dart API Client 
• Python MQTT SDK for Stable Access to IoT Data Stream: Python Client SDK 

Cital Guide

Basically, the Database consists of two parts: Telemetry and Metadata. Both parts are only usefully in combination.

Overview of Customer <> Telemetry Structure

REST API Meta Data Structure

Relations/Hierarchy

• Relations group Entities together according to the ER Diagramm
• Relations can be accessed via Relations Controller 
• From = Parent Asset
• To = Child Asset

Customers

• can be accessed via Customer Controller
• Access related Customers via Relations

REST API Device/Telemetry Structure

Device Information

• Can be access via Entity View Controller 
• Base Identification of Devices

Device Metadata

• Can be accessed via Telemetry Controller (Server Attributes)
• Available Data: sensor_length | Unit: Total Length of Sensor in centimetres

Telemetry

• Can be accessed via Telemetry Controller
• Units & Representations: 
• "firmware" | Unit: major.minor.fix
• "tempOffBoard" | Unit: Temperature in °C
• "tempOnBoard" | Unit: Temperature in °C
• "waterPotOffBoard" | Unit: Soil Waterpotential in kPa
• "batteryRelative" | Unit: Status in %
• "moistOffBoard" | Unit: relative Moisture in %
• Examples on Data Queries: REST HTTP Data Query  

Graphical User Interface

• https://iot.cital.io/
• Good for understanding Background Mechanisms
  • Use Browser Inspector to trace API Calls

Contact & Help

• Customer Care: [email protected]
• Questions on Implementation: [email protected]