46 lines
2.7 KiB
Plaintext
46 lines
2.7 KiB
Plaintext
---
|
|
description: led-driver — MicroPython ESP32: mpremote, imports, layout, I/O, no pycache in src
|
|
globs: led-driver/**
|
|
alwaysApply: false
|
|
---
|
|
|
|
# led-driver (MicroPython / ESP32)
|
|
|
|
## Device and tests
|
|
|
|
1. Validate **MicroPython behaviour** under **`led-driver/`** with **`mpremote connect <PORT> …`** on the chip. Host **`python3`** does **not** prove the firmware build.
|
|
|
|
2. **Execution target is fixed:** treat **`led-driver/`** code as firmware that runs **only on MicroPython ESP32 devices**. Do **not** run `led-driver/src/main.py` (or other firmware modules) with host CPython as a normal execution path.
|
|
|
|
3. **Flow:** `mpremote connect <PORT> cp <local> :<on-flash>` then `run <script>.py`. Inline commands only — no **`.sh`** wrappers unless the user asks. Default serial placeholder: **`/dev/ttyACM0`**.
|
|
|
|
4. Checks that **import and run** code from **`led-driver/src/`** belong in **`led-driver/tests/`** and run with **`mpremote run …`**. **Do not** add **`pytest`** under **`led-controller/tests/`** that **`sys.path`**-loads **`led-driver/src`** and runs those modules on CPython.
|
|
|
|
## Import layout
|
|
|
|
4. **No** **`sys.path.insert`**, **`__file__`** path stitching, or other import-path hacks under **`led-driver/`**. Use device flash search path, or host **`PYTHONPATH`** / layout you control.
|
|
|
|
5. **No** “import fixer” code — fix copy order, flash paths, or env instead.
|
|
|
|
## Imports (fail loudly)
|
|
|
|
6. If a dependency does not load, **crash** and fix deployment or filesystem. **Do not** catch **`ImportError`** / **`ModuleNotFoundError`** around **`import`** / **`from … import`** for app/firmware modules (`settings`, `utils`, `network`, `machine`, …).
|
|
|
|
7. **Allowed — stdlib name pairs only** (MicroPython vs CPython): one **`except ImportError`**, then **one** fallback import, **no** extra logic in **`except`**:
|
|
- `uos` → `os`
|
|
- `ubinascii` → `binascii`
|
|
- `utime` → `time`
|
|
Not for “maybe the file exists on flash” — only different **stdlib** names.
|
|
|
|
8. **No** large inline reimplementations after **`except ImportError`** — deploy the real module.
|
|
|
|
## I/O
|
|
|
|
9. Non-blocking **recv** / **accept**: use plain **`except OSError:`** (or **break** on empty). **No** errno / EAGAIN / EWOULDBLOCK tables or **`getattr(errno, …)`** unless fixing a **documented** target bug.
|
|
|
|
10. Minimal **`try` / `except OSError`** around optional socket options (e.g. **`SO_REUSEADDR`**) is fine.
|
|
|
|
## Host Python and `src/`
|
|
|
|
11. **Do not** leave **`__pycache__/`** or **`.pyc`** under **`led-driver/src/`** from host runs. Remove if created; **`.gitignore`** already ignores it. Prefer **`PYTHONDONTWRITEBYTECODE=1`** or **`-B`** when host Python must touch **`led-driver/src/`**.
|