API Reference

Note: API documentation is continuously being improved. Below is a summary — detailed interface definitions will be added in future versions.

Communication Protocol Overview

BLE Communication

Bluetooth communication between phone and device uses the GATT protocol:

  • Service UUID: TBD
  • Characteristic UUID: TBD
  • Data format: TBD

Cloud API

Phone and device interact through the cloud API:

  • Base URL: TBD
  • Authentication: TBD
  • Data format: JSON

Device Management API

Register Device

POST /api/v1/devices/register

Bind a new device to the user account.

Device List

GET /api/v1/devices

Get all devices bound to the current user.

Device Status

GET /api/v1/devices/{device_id}/status

Get the online status, battery level, and other info for a specific device.

Content Push API

Text Push

POST /api/v1/devices/{device_id}/push/text

Push text content to the device.

Image Push

POST /api/v1/devices/{device_id}/push/image

Push image content to the device.

App Management API

Install App

POST /api/v1/devices/{device_id}/apps/install

Push and install an app to the device.

Uninstall App

DELETE /api/v1/devices/{device_id}/apps/{app_id}

Remove an app from the device.

Update App

PUT /api/v1/devices/{device_id}/apps/{app_id}/update

Update a specific app on the device.

Device Settings API

Get Settings

GET /api/v1/devices/{device_id}/settings

Get the device’s current settings.

Update Settings

PUT /api/v1/devices/{device_id}/settings

Update the device’s configuration parameters.

OTA Update API

Check for Updates

GET /api/v1/devices/{device_id}/ota/check

Check if firmware updates are available.

Trigger Update

POST /api/v1/devices/{device_id}/ota/update

Trigger an OTA update on the device.

Next Steps

Back to Docs