Ot/Documentation

Quickstart

This guide takes you from a fresh account to live telemetry on a dashboard. You need an ESP32 or ESP8266 board, the Arduino IDE, and a WiFi network.

1. Create an account and a project

  1. 1

    Sign up

    Create a free account at the sign-up page. The free plan supports your first devices and dashboards.
  2. 2

    Create a project

    From the dashboard home, click New Project. A project groups devices, a dashboard canvas, and alert rules for one thing you are monitoring — a greenhouse, a fish pond, a classroom lab.

2. Register your device

  1. 1

    Open Devices and add one

    Go to Devices in the sidebar and click Add Device. Give it a name, choose your board type, set the report interval (how often it will send data), and assign it to your project.
  2. 2

    Download your credentials

    In step 2 of the wizard, download secrets.h — it contains the device token and project ID your board authenticates with. You can also download the OtTelemetry library ZIP and a ready-made .ino sketch there.

The token is shown once

The device token is generated at registration. Keep secrets.h private — anyone holding the token can write data as that device.

3. Flash the firmware

  1. 1

    Install the libraries

    In the Arduino IDE: Sketch → Include Library → Add .ZIP Library… and pick the downloaded OtTelemetry.zip. Also install PubSubClient from the Library Manager.
  2. 2

    Add your credentials

    Put the downloaded secrets.h next to your sketch and fill in your WiFi name and password inside it.
  3. 3

    Upload this sketch

    The downloaded sketch already looks like this — replace the hard-coded values with real sensor reads:
cpp
#include <OtTelemetry.h>
#include "secrets.h"   // downloaded from your Devices page

OtTelemetry ot(OT_PROJECT_ID, OT_DEVICE_TOKEN);

void setup() {
  ot.begin(OT_WIFI_SSID, OT_WIFI_PASS, "broker.hivemq.com");
}

void loop() {
  ot.loop();

  ot.beginPayload();
  ot.addField("temp", 27.4);      // replace with real sensor reads
  ot.addField("moisture", 61.2);
  ot.sendPayload();

  delay(10000);  // match your device's report interval
}

The wizard's final step listens for your device's first reading and completes automatically once it arrives — that confirms WiFi, the token, and the broker are all working. If your board isn't ready yet, choose Finish later; the device stays registered and connects whenever you flash it.

4. Watch data arrive

Open your project from the dashboard home. Click Edit Canvas, add a Line Chart from the widget inventory, select it, and set its Sensor field source to the field name your sketch sends (for example temp). Within one report interval you should see the first points plot, and the device will show Online.

Every field name you send becomes plottable. Send ph from the device and you can chart ph — no configuration needed anywhere else.