Skip to main content

Quick start

Prerequisites​

  • ESP-IDF installed on your machine (v5 or v6; both are supported).
  • An iotmer.com account with console access (workspace, devices, templates) — documentation.

Open the project​

git clone <iotmer-sdk-esp-idf-repo-url>
cd iotmer-sdk-esp-idf/examples/02_telemetry

Pick any project under examples/ (more will be added over time). For first-time registration with the current pair, run 01_provisioning first, then flash 02_telemetry to the same device for day-to-day MQTT telemetry.

Target chip and configuration​

idf.py set-target esp32c3
idf.py menuconfig

Under Component config → IOTMER, set at least:

  • Wi‑Fi SSID and password
  • For first registration: Provision auth code and Workspace ID (UUID)
  • Workspace slug for MQTT topics {workspace_slug}/{device_key}/… comes from the provision JSON and is saved to NVS — you do not need to duplicate it in menuconfig for normal builds. IOTMER_WORKSPACE_SLUG exists only as an optional override (e.g. lab / legacy).

For a telemetry-only field image, you may leave the auth code empty; HTTPS is skipped when NVS holds a full session (slug + device_key + MQTT fields).

Build, flash, and monitor​

idf.py build flash monitor

With monitor, you can follow serial logs tagged iotmer_wifi, iotmer_provision, and iotmer_client.

Further reading​