Compare commits
2
Commits
2f3db9272b
...
ota
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
892ccaec71 | ||
|
|
d6331a105c |
No files matched your search
@@ -11,6 +11,7 @@ Connection is always via **`-p` / `--port`** (default `/dev/ttyACM0`). There is
|
||||
| `-p`, `--port` | Serial device (default `/dev/ttyACM0`) |
|
||||
| `-s`, `--show` | Print current settings from the device |
|
||||
| `-n`, `--name` | Device **name** |
|
||||
| `--reset-device-name` | Set **name** to firmware default (`led-` + STA MAC hex, same as `Settings.set_defaults` on led-driver) |
|
||||
| `--id` | Numeric device id (ESP-NOW, 0–255) |
|
||||
| `--pin` | LED GPIO (`led_pin`) |
|
||||
| `-b`, `--brightness` | Brightness 0–255 |
|
||||
@@ -28,6 +29,7 @@ Connection is always via **`-p` / `--port`** (default `/dev/ttyACM0`). There is
|
||||
| `--src`, `--lib` | Upload `src/` or a tree to `/lib` |
|
||||
| `-e` | Erase device code (keeps `settings.json`) |
|
||||
| `--rm` | Remove a path on the device |
|
||||
| `--ota` | Update a v2 controller over Ethernet: `--ota HOST [IMAGE]` (no serial port; image defaults to `led_controller_v2.bin` in `./v2/build`, `./build` or `../v2/build`) |
|
||||
| `--flash` | Flash a firmware binary (uses **esptool** on the host) |
|
||||
|
||||
**Default behaviour:** the tool always downloads `settings.json`, prints the merged view, and uploads again **only** when you pass setting edits (`--name`, `--leds`, …), **`--preset`**, or the relevant upload/flash/erase actions in order.
|
||||
|
||||
@@ -16,7 +16,8 @@ from typing import Dict, Any, List, Optional
|
||||
|
||||
import tempfile
|
||||
import os
|
||||
from device import copy_file, DeviceConnection
|
||||
from ota import ota_update
|
||||
from device import copy_file, DeviceConnection, firmware_default_device_name
|
||||
|
||||
|
||||
def resolve_flash_binary(path: str) -> Optional[str]:
|
||||
@@ -148,14 +149,14 @@ _FLAGS_WITH_VALUE = frozenset({
|
||||
'-p', '--port', '-n', '--name', '--pin', '-b', '--brightness',
|
||||
'-l', '--leds', '-d', '-debug', '--debug', '-o', '--order',
|
||||
'--preset', '--pattern', '--default', '--transport', '--ssid',
|
||||
'--wifi-password', '--wifi-channel', '--src', '--lib', '--patterns', '--paterns',
|
||||
'--wifi-password', '--wifi-channel', '--ota', '--src', '--lib', '--patterns', '--paterns',
|
||||
})
|
||||
|
||||
|
||||
def _get_ordered_actions(argv: List[str]) -> List[tuple]:
|
||||
"""
|
||||
Scan argv and return list of (action_name, value) in order of appearance.
|
||||
Actions: flash, pause, reset, upload, ls, erase_all, rm, follow.
|
||||
Actions: flash, ota, pause, reset, upload, ls, erase_all, rm, follow.
|
||||
"""
|
||||
actions = []
|
||||
i = 1
|
||||
@@ -179,6 +180,16 @@ def _get_ordered_actions(argv: List[str]) -> List[tuple]:
|
||||
else:
|
||||
raise ValueError("--flash requires an argument")
|
||||
continue
|
||||
if arg == '--ota':
|
||||
vals = []
|
||||
i += 1
|
||||
while i < len(argv) and not argv[i].startswith('-') and len(vals) < 2:
|
||||
vals.append(argv[i])
|
||||
i += 1
|
||||
if not vals:
|
||||
raise ValueError("--ota requires a host (and optionally an image path)")
|
||||
actions.append(('ota', vals))
|
||||
continue
|
||||
if arg in ('-r', '--reset'):
|
||||
actions.append(('reset', None))
|
||||
i += 1
|
||||
@@ -304,11 +315,18 @@ Examples:
|
||||
%(prog)s --flash firmware.bin
|
||||
%(prog)s -p /dev/ttyUSB0 --flash /path/to/firmware.bin
|
||||
|
||||
# Update a v2 controller over Ethernet (image defaults to led_controller_v2.bin under ./v2/build, ./build or ../v2/build)
|
||||
%(prog)s --ota 10.1.1.180
|
||||
%(prog)s --ota 10.1.1.180 /path/to/led_controller_v2.bin
|
||||
|
||||
# Reset, pause 2 seconds, then follow output
|
||||
%(prog)s --reset --pause 2 --follow
|
||||
|
||||
# Set name, num_leds, default pattern, and upload
|
||||
%(prog)s --name "MyStrip" -l 60 --default rainbow
|
||||
|
||||
# Reset logical device name to firmware default (STA MAC based)
|
||||
%(prog)s --reset-device-name
|
||||
"""
|
||||
)
|
||||
|
||||
@@ -323,6 +341,12 @@ Examples:
|
||||
help="Device name"
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--reset-device-name",
|
||||
action="store_true",
|
||||
help="Set name to firmware default (led-<STA MAC hex>, same as fresh settings.json on led-driver)",
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--id",
|
||||
dest="device_id",
|
||||
@@ -500,6 +524,13 @@ Examples:
|
||||
help="Delete a file or directory on the device (recursive for directories)"
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--ota",
|
||||
nargs="+",
|
||||
metavar=("HOST", "IMAGE"),
|
||||
help="Update a v2 controller over Ethernet: HOST [IMAGE]. No serial port is used and the tool exits afterwards"
|
||||
)
|
||||
|
||||
parser.add_argument(
|
||||
"--flash",
|
||||
metavar="BINARY",
|
||||
@@ -541,6 +572,15 @@ Examples:
|
||||
print("Error: esptool not found. Install it with: pip install esptool", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
elif action_name == 'ota':
|
||||
try:
|
||||
ota_update(value[0], value[1] if len(value) > 1 else None)
|
||||
except Exception as e:
|
||||
print(f"Error: OTA failed: {e}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if all(a[0] in ('ota', 'pause') for a in ordered_actions):
|
||||
return # network-only: nothing to download over serial
|
||||
|
||||
elif action_name == 'reset':
|
||||
ran_reset = True
|
||||
try:
|
||||
@@ -662,11 +702,35 @@ Examples:
|
||||
sys.exit(1)
|
||||
return # follow blocks; when interrupted we're done
|
||||
|
||||
default_name_from_device: Optional[str] = None
|
||||
if args.reset_device_name:
|
||||
if args.name is not None:
|
||||
print(
|
||||
"Error: use either --name or --reset-device-name, not both.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
sys.exit(1)
|
||||
try:
|
||||
print(
|
||||
f"Reading firmware default device name (STA MAC) on {port}...",
|
||||
file=sys.stderr,
|
||||
)
|
||||
default_name_from_device = firmware_default_device_name(port)
|
||||
print(
|
||||
f"Default name will be {default_name_from_device!r}.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
except Exception as e:
|
||||
print(f"Error: {e}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
# Collect all edit parameters
|
||||
edits: Dict[str, Any] = {}
|
||||
|
||||
if args.name is not None:
|
||||
edits["name"] = args.name
|
||||
elif default_name_from_device is not None:
|
||||
edits["name"] = default_name_from_device
|
||||
|
||||
if args.pin is not None:
|
||||
edits["led_pin"] = args.pin
|
||||
|
||||
@@ -23,12 +23,15 @@ if lib_path not in sys.path and os.path.exists(lib_path):
|
||||
sys.path.insert(0, lib_path)
|
||||
|
||||
from mpremote.transport_serial import SerialTransport
|
||||
from mpremote.transport import TransportError
|
||||
from mpremote.transport import TransportError, TransportExecError
|
||||
|
||||
|
||||
class DeviceConnection:
|
||||
"""Wrapper for device communication."""
|
||||
|
||||
|
||||
#: Feed interval during uploads (led-driver uses WDT(timeout=10000) ms).
|
||||
WDT_FEED_INTERVAL_SEC = 5.0
|
||||
|
||||
def __init__(self, device):
|
||||
"""Connect to a device."""
|
||||
self.device = device
|
||||
@@ -53,7 +56,39 @@ class DeviceConnection:
|
||||
except Exception:
|
||||
pass
|
||||
self.transport = None
|
||||
|
||||
|
||||
def _feed_wdt(self) -> None:
|
||||
"""Best-effort feed of the ESP task WDT between chunked FS writes."""
|
||||
if self.transport is None:
|
||||
return
|
||||
try:
|
||||
self.transport.exec(
|
||||
"try:\n import machine\n machine.WDT(timeout=10000).feed()\nexcept Exception:\n pass\n"
|
||||
)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def _make_wdt_upload_progress_callback(self):
|
||||
"""Progress hook for Transport.fs_writefile: feed WDT every WDT_FEED_INTERVAL_SEC."""
|
||||
last_feed = [time.monotonic()]
|
||||
|
||||
def progress(written: int, total: int) -> None:
|
||||
now = time.monotonic()
|
||||
if now - last_feed[0] >= self.WDT_FEED_INTERVAL_SEC:
|
||||
self._feed_wdt()
|
||||
last_feed[0] = now
|
||||
|
||||
return progress
|
||||
|
||||
def _fs_writefile_with_wdt(self, remote_path: str, data: bytes) -> None:
|
||||
"""Write file to device with periodic WDT feeds during long transfers."""
|
||||
self._feed_wdt()
|
||||
self.transport.fs_writefile(
|
||||
remote_path,
|
||||
data,
|
||||
progress_callback=self._make_wdt_upload_progress_callback(),
|
||||
)
|
||||
|
||||
def copy_from_device(self, remote_path, local_path):
|
||||
"""Copy a file from device to local filesystem."""
|
||||
self.connect()
|
||||
@@ -70,7 +105,7 @@ class DeviceConnection:
|
||||
try:
|
||||
with open(local_path, 'rb') as f:
|
||||
data = f.read()
|
||||
self.transport.fs_writefile(remote_path, data)
|
||||
self._fs_writefile_with_wdt(remote_path, data)
|
||||
finally:
|
||||
self.disconnect()
|
||||
|
||||
@@ -133,7 +168,7 @@ class DeviceConnection:
|
||||
print(f"Uploading: {remote_file}", file=sys.stderr)
|
||||
with open(local_file, 'rb') as f:
|
||||
data = f.read()
|
||||
self.transport.fs_writefile(remote_file, data)
|
||||
self._fs_writefile_with_wdt(remote_file, data)
|
||||
files_copied += 1
|
||||
|
||||
return files_copied, dirs_created
|
||||
@@ -235,6 +270,37 @@ class DeviceConnection:
|
||||
raise TransportError(f"Failed to follow output: {e}") from e
|
||||
|
||||
|
||||
def firmware_default_device_name(device: str) -> str:
|
||||
"""
|
||||
Default logical device name on led-driver firmware: led-<sta_mac_hex>,
|
||||
matching Settings.set_defaults() in led-driver/src/settings.py.
|
||||
"""
|
||||
conn = DeviceConnection(device)
|
||||
conn.connect()
|
||||
try:
|
||||
code = (
|
||||
"import network, ubinascii\n"
|
||||
"sta = network.WLAN(network.STA_IF)\n"
|
||||
"sta.active(True)\n"
|
||||
"mac = ubinascii.hexlify(sta.config('mac')).decode().lower()\n"
|
||||
"print('led-' + mac)\n"
|
||||
)
|
||||
out = conn.transport.exec(code)
|
||||
except TransportExecError as e:
|
||||
raise RuntimeError(
|
||||
"Could not read STA MAC from device (is this MicroPython with network?): "
|
||||
+ (e.error_output or str(e)).strip()
|
||||
) from e
|
||||
finally:
|
||||
conn.disconnect()
|
||||
text = out.decode("utf-8", errors="replace").strip()
|
||||
for line in reversed(text.splitlines()):
|
||||
line = line.strip()
|
||||
if line.startswith("led-"):
|
||||
return line
|
||||
raise RuntimeError("Device did not return a led-<mac> default name")
|
||||
|
||||
|
||||
def copy_file(from_device, device, remote_path, local_path):
|
||||
"""
|
||||
Copy a file to/from device.
|
||||
|
||||
@@ -0,0 +1,77 @@
|
||||
"""
|
||||
Over-the-air firmware update for the v2 ESP32-S3 controller (Ethernet, plain HTTP).
|
||||
|
||||
The controller takes the raw app image on POST /ota, writes it to the idle slot and reboots.
|
||||
"""
|
||||
|
||||
import http.client
|
||||
import json
|
||||
import os
|
||||
import time
|
||||
from typing import Optional
|
||||
|
||||
IMAGE_NAME = "led_controller_v2.bin"
|
||||
# Searched in order when no image is given (relative to where the tool is run, since the
|
||||
# PyInstaller binary has no useful location of its own)
|
||||
DEFAULT_IMAGES = [
|
||||
os.path.join("v2", "build", IMAGE_NAME),
|
||||
os.path.join("build", IMAGE_NAME),
|
||||
os.path.join("..", "v2", "build", IMAGE_NAME),
|
||||
]
|
||||
|
||||
|
||||
def _default_image() -> Optional[str]:
|
||||
return next((p for p in DEFAULT_IMAGES if os.path.isfile(p)), None)
|
||||
|
||||
|
||||
def _info(host: str, port: int) -> Optional[dict]:
|
||||
try:
|
||||
conn = http.client.HTTPConnection(host, port, timeout=5)
|
||||
conn.request("GET", "/ota")
|
||||
r = conn.getresponse()
|
||||
return json.loads(r.read().decode()) if r.status == 200 else None
|
||||
except (OSError, ValueError):
|
||||
return None
|
||||
|
||||
|
||||
def ota_update(host: str, image: Optional[str] = None, port: int = 80) -> None:
|
||||
"""Upload image to host and wait for it to come back. Raises RuntimeError on failure."""
|
||||
image = image or _default_image()
|
||||
if not image:
|
||||
raise RuntimeError(f"no image given and {IMAGE_NAME} not found under ./v2/build, ./build or ../v2/build")
|
||||
if not os.path.isfile(image):
|
||||
raise RuntimeError(f"image not found: {image}")
|
||||
size = os.path.getsize(image)
|
||||
|
||||
before = _info(host, port)
|
||||
if before is None:
|
||||
raise RuntimeError(f"no OTA endpoint at http://{host}:{port}/ota (is this the v2 controller?)")
|
||||
print(f"Running {before['partition']} (built {before['built']})")
|
||||
|
||||
print(f"Uploading {image} ({size} bytes)...")
|
||||
conn = http.client.HTTPConnection(host, port, timeout=60)
|
||||
with open(image, "rb") as f:
|
||||
conn.request("POST", "/ota", body=f, headers={
|
||||
"Content-Length": str(size),
|
||||
"Content-Type": "application/octet-stream",
|
||||
})
|
||||
r = conn.getresponse()
|
||||
body = r.read().decode()
|
||||
if r.status != 200:
|
||||
try:
|
||||
body = json.loads(body).get("error", body)
|
||||
except ValueError:
|
||||
pass
|
||||
raise RuntimeError(f"update rejected ({r.status}): {body}")
|
||||
|
||||
print("Written, waiting for reboot...")
|
||||
time.sleep(3)
|
||||
for _ in range(30):
|
||||
after = _info(host, port)
|
||||
if after:
|
||||
print(f"Back up on {after['partition']} (built {after['built']})")
|
||||
if after["partition"] == before["partition"]:
|
||||
raise RuntimeError("controller came back on the same slot: new image was rejected or rolled back")
|
||||
return
|
||||
time.sleep(1)
|
||||
raise RuntimeError("controller did not come back within 30 s")
|
||||
Reference in new issue
Block a user