Phasmida logoPhasmida
ContactSign in
Phasmida logoPhasmida
HomeSmart CloudBlogShopAbout UsFor DevelopersContact
DiscordLogin to Smart Cloud

FOR DEVELOPERS

Install firmware on M5Stack hardware. Build with us in public.

Early Access

Join early, get Hobby plan for free

Register now as an early access user or tester and unlock the full cloud experience.

  • Free Hobby plan for all early users

    During Early Access, all testers and community members get the Hobby plan at no cost. You only need to sign up and start using it.

  • Everything is free except hardware

    Phasmida is an open source project and all core features are available for free. You can order compatible hardware yourself, flash firmware from our public GitHub, claim your device, and connect it with your own API keys.

  • Pick DIY or plug-and-play bundles

    If you prefer out-of-the-box, we can order M5Stack hardware, provision device claim, install firmware with a bundled API key, pack it, and ship it ready to use. If you enjoy tinkering, you can do the same flow yourself with a bit of effort and technical know-how.

FIRMWARE-FIRST ONBOARDING

Bring your own M5Stack setup and ship real telemetry.

Start with firmware install on supported hardware. Then claim your device and ship telemetry into Smart Cloud. No long onboarding maze.

Start with supported M5Stack hardware only: CoreS3 and Timer Camera F.
Use one device API key per physical identity and complete claim in Smart Cloud.
Get API keyInstall firmware

Public firmware release

Focused scope, clear setup, real hardware only.

CoreS3 and Timer Camera F are the current path. We are expanding hardware support with contributors in public.

SUPPORTED HARDWARE

Supported now: two stable targets.

We are keeping the first release narrow on purpose so setup is predictable and easier to support.

PRIMARY HUB

M5Stack CoreS3 + ENV III / ENV PRO

Main firmware target for enclosure monitoring. Includes touchscreen UX, provisioning flow, telemetry publishing, and command handling.

  • ESP32-S3 + touchscreen
  • Grove I2C probe support
  • Runtime probe hot-plug
  • Smart Cloud claim-ready
CAMERA NODE

M5Stack Timer Camera F

Companion camera firmware for live terrarium visuals. Ships as a focused stream path that can evolve independently from sensor nodes.

  • ESP32 camera path
  • WebSocket JPEG stream flow
  • Designed for paired deployment

INSTALL PATH

Three steps from board to cloud.

Current release is USB-first. Treat README on GitHub as canonical installation guide.

01

Get your API key

Request BYOH access and receive one key for one device identity.

02

Clone and flash firmware

Use the public repository README and flash over USB with PlatformIO.

03

Claim and monitor in Smart Cloud

Connect device, complete pairing code claim, and verify telemetry flow.

Canonical local flash command

platformio run -e core_s3 -t upload -t monitor

Starter targets

platformio run -e core_s3
platformio run -e timer_camera_f

Keep secrets in include/secrets.local.h only. Do not commit keys, Wi-Fi credentials, or local provisioning values.

CONTRIBUTE

Contribute in one evening, not one month.

Firmware repo is public and ready for focused contributions. If you can test on real hardware, you can ship useful improvements quickly.

Fast contribution flow

01

Pick one issue with hardware impact

Start small. One board behavior, one probe bug, or one install pain point.

02

Validate on real hardware

Test your fix on CoreS3 or Timer Camera F and record exact validation steps.

03

Open focused PR with notes

Keep PR scope tight and include what changed, why, and how you verified it.

Rule of thumb: one problem per PR and include hardware validation notes.

API BRIDGE

After install, wire your device into Smart Cloud.

Keep this simple: validate auth in Swagger and follow the three protocol rules below.

API REFERENCE

Validate auth and payloads in live Swagger.

Keep integration aligned with current backend behavior and auth requirements.

Open SwaggerOpen OpenAPI JSON
  • MQTT credentials: username = <mac_slug>, password = <api_key>, clientId = phasmida-<mac_slug>
  • MQTT topics: publish and subscribe under phasmida/<mac_slug>/*
  • Claim flow: POST /devices/claim with an 8-character pairing code

START BUILDING

Install firmware, then contribute what you improve.

Keep it focused: one install path, one claim flow, one public repo for collaboration.

Get API keyInstall firmware