Device API

Introduction

The Device API is a crucial part of our system, designed to facilitate seamless interaction between various devices and our backend services. This section provides an in-depth overview of the capabilities and functionalities of the Device API, including how to retrieve and save data in AtlatoDB, collect data from devices using multiple communication protocols (Socket, TCP, HTTPS, MQTT), and the process for integrating new protocol types, such as LoRa network devices. This document aims to equip developers with the knowledge and tools necessary to effectively interface with our system, ensuring robust and reliable data handling across different devices and communication methods.

Retrieving and Saving Data in AtlatoDB

AtlatoDB is database for storing device data due to its flexibility, scalability, and ability to handle large volumes of data. The Device API provides methods to easily retrieve and save data in AtlatoDB, ensuring that device data is efficiently managed and accessible.

Collecting Data from Devices

Our system supports data collection from devices using a variety of communication protocols, ensuring compatibility with a wide range of devices and data transmission methods. The following protocols are supported.

TCP

Socket.IO

HTTPS

MQTT

TCP (Transmission Control Protocol) ensures reliable and ordered data transmission between devices and servers. This protocol is commonly used for applications where data integrity and reliability are critical. The Device API supports TCP communication, allowing developers to establish client-server connections, receive data from devices, and send acknowledgments or responses back to the devices.

Integrating New Protocol Types

Our system is designed to be extensible, allowing for the integration of new protocol types as they emerge. If your device uses a protocol that is not currently supported, such as LoRa network, the following steps outline the process for integrating it into our system.

Submit Documentation

To integrate a new protocol, developers must provide a detailed documentation file that includes a comprehensive overview of the new protocol, how it works, and its key features. The documentation should also describe the data transmission mechanism, including any specific requirements or configurations needed for data transmission, as well as step-by-step instructions on how to set up and configure the devices using the new protocol.

Review Process

Once the documentation is prepared, it should be submitted to our admin team for review. The review process involves evaluating the feasibility and compatibility of the new protocol with our existing system. The admin team will provide feedback and suggestions for any necessary modifications to ensure that the new protocol can be seamlessly integrated.

Integration

Upon approval, the admin team will provide guidance on integrating the new protocol into our system. This may involve implementing custom handlers to process data transmitted using the new protocol and updating system configurations to support the new protocol. The goal is to ensure that the new protocol is seamlessly integrated with existing protocols and does not disrupt current operations.

Introduction#

Retrieving and Saving Data in AtlatoDB#

Collecting Data from Devices#

Integrating New Protocol Types#

Submit Documentation#

Review Process#