OmniTeq Website OmniTeq Cloud

Developer Guide

Hardware Integration Suite

Sections

Connecting ESP32 / ESP8266

OmniTeq Cloud provides a real-time, low-latency API ingest gateway that connects remote physical microcontrollers to smart dashboards. Remote microcontrollers can transmit sensor values using standard REST packets and receive active remote commands over simple HTTP polling loops.

1

Establish Internet Handshake

Connect your ESP node to the local 2.4GHz WiFi access point using standard network adapters.

2

Obtain Device Secret Keys

Deploy a device under a project to generate a specific Device ID and access Secret Key.

3

Deploy Production Firmware

Compile and flash the production C++ template to stream metrics and poll commands instantly.

Step 1: Device Credentials

To authorize physical boards with the OmniTeq Cloud, you must provide credential parameters in the ingest packet payload.

Required Credentials:

  • device_id: The unique resource UUID generated during device addition (e.g., dev_gh_sensor).
  • secret_key: The live secure hash key presented only once during provisioning (e.g., sk_live_ghsensorsecretkey12345).

Note: Never check your raw secret keys into public source repositories. Treat them as private system credentials.

Step 2: C++ Arduino Code

Select your targeted board chip to view production-ready, fully compilable Arduino C++ source code that establishes network connectivity, transmits sensor values, and handles inbound cloud command logs.

ESP32_Ingest_Demo.ino 
Loading code...

Step 3: Ingest Protocol Specs

Devices communicate directly with the local server over HTTP REST endpoints. All requests must provide device_id and secret_key in the JSON payload.

POST /api/v1/ingest/telemetry
Transmit Sensor Data

Sends sensor readings under active variables. Variable IDs must align with mapped keys.

GET /api/v1/ingest/commands/pending
Poll Awaiting Instructions

Queries the server for queued instructions. Automatically transitions command states to "sent" on return.

POST /api/v1/ingest/commands/:instanceId/ack
Acknowledge Instruction Result

Submits executing state results (success or failed) back to the dashboard command tables.