cosmo/terminal/tools/release_firmware.py

177 lines
8.1 KiB
Python
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

#!/usr/bin/env python3
"""发布一版终端固件:编译 -> 上传后端 -> 登记,一步到位。
/usr/bin/python3 terminal/tools/release_firmware.py --notes "详情页中文换行修正"
/usr/bin/python3 terminal/tools/release_firmware.py --board xingzhi-cube-1.54tft
/usr/bin/python3 terminal/tools/release_firmware.py --skip-build --file /tmp/fw/cosmo_terminal.ino.bin
版本号只认 terminal/firmware/cosmo_terminal/src/version.h:**先改版本号再发布**。
同版本号后端直接拒收——镜像文件不允许覆盖(nginx 对 /upload/ 设了一年缓存,
覆盖同名文件的话已经拿过旧包的终端永远拿不到新的)。
只用标准库,走本地直连(忽略 *_proxy 环境变量,本机 127.0.0.1 常被代理吃掉)。
"""
import argparse
import getpass
import json
import os
import re
import subprocess
import sys
import urllib.error
import urllib.request
import uuid
from pathlib import Path
ROOT = Path(__file__).resolve().parents[2]
SKETCH_DIR = ROOT / "terminal" / "firmware"
SKETCH = "cosmo_terminal"
VERSION_H = SKETCH_DIR / SKETCH / "src" / "version.h"
# 必须和 README「构建 / 烧录」那条 FQBN 一模一样。CDCOnBoot 尤其别动:
# OTA 镜像会把 USB 口配置一起换掉,发成 cdc 的话升级完控制台就从
# /dev/cu.usbserial-210 跑到原生 usbmodem 口上,看着像设备死了。
FQBN = ("esp32:esp32:esp32s3:PSRAM=opi,FlashSize=16M,FlashMode=dio,CDCOnBoot=default,"
"PartitionScheme=app3M_fat9M_16MB,UploadSpeed=460800")
# 上面那条是按 atk 那块写的:它板载 CH340 之类的 USB-UART,控制台走串口芯片,
# CDCOnBoot=default 不影响。waveshare-3p49 只有 ESP32-S3 原生 USB 一个口,
# 必须 USBMode=hwcdc + CDCOnBoot=cdc,配错 OTA 之后 /dev/cu.usbmodem* 直接消失。
FQBN_OVERRIDES = {
"waveshare-3p49":
"esp32:esp32:esp32s3:PSRAM=opi,FlashSize=16M,FlashMode=dio,USBMode=hwcdc,"
"CDCOnBoot=cdc,PartitionScheme=app3M_fat9M_16MB,UploadSpeed=460800",
}
CLI = Path.home() / "esp-tools" / "arduino-cli"
CLI_CFG = Path.home() / "esp-tools" / "arduino-cli.yaml"
# 板型 -> 编译期开关。发错板型 = 终端黑屏,只能拆机接串口,所以这里列全。
BOARDS = {
"atk-dnesp32s3": [], # 出货用的 320x240 横屏(默认板型)
"xingzhi-cube-1.54tft": ["-DCOSMO_BOARD=2"], # 1.54 寸 240x240 方屏样机
"waveshare-3p49": ["-DCOSMO_BOARD=3"], # 640x172 长条触摸屏,原生 USB
}
def die(msg):
print(f"[release] {msg}", file=sys.stderr)
sys.exit(1)
def read_version():
text = VERSION_H.read_text(encoding="utf-8")
m = re.search(r'#define\s+FW_VERSION\s+"([^"]+)"', text)
if not m:
die(f"{VERSION_H} 里找不到 FW_VERSION")
return m.group(1)
def build(board, out_dir):
"""编译并把 .bin 落到 out_dir,返回 bin 路径。"""
cmd = [str(CLI), "--config-file", str(CLI_CFG), "compile",
"--fqbn", FQBN_OVERRIDES.get(board, FQBN), "--warnings", "none",
"--build-path", str(out_dir / "build"),
"--output-dir", str(out_dir)]
flags = BOARDS[board]
if flags:
# 只能用 compiler.cpp.extra_flags:esp32 core 的 platform.txt 把 USB 那几个
# -D(ARDUINO_USB_MODE / ARDUINO_USB_CDC_ON_BOOT)塞在 build.extra_flags 里,
# --build-property 是整体覆盖而不是追加,覆盖掉之后原生 USB 那几块板的
# Serial 会退回 UART0(少 isPlugged() 之类),FQBN 里的 CDCOnBoot 也一并失效。
cmd += ["--build-property", "compiler.cpp.extra_flags=" + " ".join(flags)]
cmd.append(str(SKETCH_DIR / SKETCH)) # arduino-cli 认位置参数,缺它就是在编译 cwd 下的空目录
env = {k: v for k, v in os.environ.items()
if k.lower() not in ("http_proxy", "https_proxy", "all_proxy")}
print(f"[release] compiling {board} ...")
r = subprocess.run(cmd, cwd=str(SKETCH_DIR), env=env)
if r.returncode:
die("编译失败,见上面的 arduino-cli 输出")
bin_path = out_dir / "cosmo_terminal.ino.bin"
if not bin_path.exists():
die(f"编译产物缺失:{bin_path}")
return bin_path
def request(url, method="GET", token=None, body=None, content_type=None):
req = urllib.request.Request(url, data=body, method=method)
if token:
req.add_header("Authorization", "Bearer " + token)
if content_type:
req.add_header("Content-Type", content_type)
opener = urllib.request.build_opener(urllib.request.ProxyHandler({}))
try:
with opener.open(req, timeout=300) as resp:
return resp.status, resp.read()
except urllib.error.HTTPError as exc:
return exc.code, exc.read()
except urllib.error.URLError as exc:
die(f"{url} 连不上:{exc.reason}(后端起来了吗?)")
def multipart(path, fields):
"""手工拼 multipart/form-data:固件 1.5MB,标准库够用,不为这个引第三方包。"""
bound = "----cosmo" + uuid.uuid4().hex
head = b""
for key, val in fields.items():
head += (f"--{bound}\r\nContent-Disposition: form-data; name=\"{key}\"\r\n\r\n"
f"{val}\r\n").encode("utf-8")
head += (f"--{bound}\r\nContent-Disposition: form-data; name=\"file\"; "
f"filename=\"{path.name}\"\r\nContent-Type: application/octet-stream\r\n\r\n"
).encode("utf-8")
tail = f"\r\n--{bound}--\r\n".encode("utf-8")
return head + path.read_bytes() + tail, f"multipart/form-data; boundary={bound}"
def main():
ap = argparse.ArgumentParser(description="编译并发布 ESP32 终端固件")
ap.add_argument("--board", default="atk-dnesp32s3", choices=sorted(BOARDS),
help="目标板型,必须和终端编译期 BOARD_NAME 一致(默认 atk-dnesp32s3)")
ap.add_argument("--notes", default="", help="更新说明,会显示在终端 UPDATE 页")
ap.add_argument("--server", default="http://127.0.0.1:8000/api", help="后端 API 根地址")
ap.add_argument("--user", default=os.environ.get("COSMO_ADMIN_USER", ""), help="管理员账号")
ap.add_argument("--password", default=os.environ.get("COSMO_ADMIN_PASSWORD", ""),
help="管理员密码(缺省时交互输入)")
ap.add_argument("--skip-build", action="store_true", help="不编译,直接上传 --file")
ap.add_argument("--file", help="现成的 .bin(配合 --skip-build)")
args = ap.parse_args()
version = read_version()
if args.skip_build:
if not args.file:
die("--skip-build 需要同时给 --file")
bin_path = Path(args.file).resolve()
if not bin_path.exists():
die(f"找不到 {bin_path}")
else:
bin_path = build(args.board, Path("/tmp/cosmo_fw") / args.board)
size = bin_path.stat().st_size
print(f"[release] {bin_path} version={version} board={args.board} {size} bytes")
print(f"[release] 终端拿到的是 {args.server}/terminal/firmware/check 里 "
f"firmware/{args.board}-{version}.bin")
if not args.user:
args.user = input("管理员账号: ")
password = args.password or getpass.getpass("管理员密码: ")
code, raw = request(args.server + "/auth/login", "POST",
body=json.dumps({"username": args.user, "password": password}).encode(),
content_type="application/json")
if code != 200:
die(f"登录失败 HTTP {code}: {raw[:200].decode('utf-8', 'replace')}")
token = json.loads(raw)["access_token"]
body, ctype = multipart(bin_path, {"board": args.board, "version": version,
"notes": args.notes})
code, raw = request(args.server + "/admin/firmware", "POST", token=token,
body=body, content_type=ctype)
if code not in (200, 201):
die(f"上传失败 HTTP {code}: {raw[:300].decode('utf-8', 'replace')}")
item = json.loads(raw)
print(f"[release] 已登记 id={item['id']} path={item['path']} enabled={item['enabled']}")
print(f"[release] 老固件没有 OTA 能力:第一版仍需串口烧;此后终端会自己弹 UPDATE 页")
if __name__ == "__main__":
main()