new-device-skill

Building a device skill for this marketplace

This repo covers M5Stack hardware, one skill per product family, working toward the full catalog. The conventions below are load-bearing — several encode failures this project already hit. Read the relevant section before writing, not after.

First: which of the three kinds is this?

They're scoped differently on purpose.

Controller — a board that runs application firmware (Core2, AtomS3, Cardputer Adv, Tab5). Its skill needs pin/peripheral specs and how to set up a dev environment, initialize hardware, and debug bring-up across every framework M5Stack supports for it (usually some mix of Arduino, PlatformIO, ESP-IDF, UIFlow2/MicroPython). These are the heaviest skills.

Unit — a peripheral you talk to from a Controller (a Buzzer, a ToF sensor, a 4Relay board). There's no "which development platform" question — just wiring, protocol, register/command reference, and example host code. Much lighter: one SKILL.md is usually enough.

Chip — the SoC underneath one or more Controllers (ESP32-S3, ESP32-C6). Not a product anyone buys alone, but substantial content: what the silicon itself can do, independent of any board's wiring. M5Stack reuses the same chip across many boards — ESP32-S3 alone covers Cardputer, Cardputer Adv, AtomS3, AtomS3R, CoreS3, StickS3 — so writing this once and having every board skill point into it beats maintaining five drifting copies.

Naming

• Controller/Unit skill name and folder: m5stack-<slug>, lowercase kebab-case product family name — m5stack-cardputer-adv, m5stack-core2, m5stack-unit-tof, m5stack-unit-4relay.
• Chip skill name and folder: bare chip slug, no m5stack- prefix — esp32-s3, esp32-c6. They document Espressif silicon, not an M5Stack product, even though this repo maintains them for the M5Stack catalog.
• For a Unit whose generic name would collide (many vendors ship a "Relay" unit), keep M5Stack's product name as the slug — unit-4relay, not relay-module. That's what a user will actually type or paste.