- 版面重排:主体左 Claude Usage(5h/7d/Fable 7d 三行),右 ChatGPT Usage(目前 mock,标「示例数据」);每行为一张用量卡:标签+F24 百分比+pace/全宽进度条/「重置 HH:MM」+「已过 NN%」 - 移除上一版的橘喵今日实时与 30 天趋势图及 trend totals 合计(业务数据留给 400×300 小屏),绿色暂不再使用 - data 用量结构新增 scoped(按模型限定额度)、reset(重置时刻文本)、updated(快照落盘时刻),新增 _usage_gpt mock 数据源,接入真实数据时保持结构替换即可 - usage_local 读取 statusline 新增的 seven_day_fable 与 updated_at;400×300 小屏 render 跳过 scoped 行 - 同步更新 CLAUDE.md 分支说明 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
18 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
项目定位
eink-push 是 JM monorepo 中一个独立的 Python 工具,与其余 Java/Vue 子项目技术栈无关,不受父级 CLAUDE.md 的 jm-cloud/uniapp/admin 开发约束。
作用:把日期天气、Claude Code 用量、橘喵今日经营合成为一张 400×300 三色(黑/白/红,BWR) PNG,推送到局域网墨水屏设备(喵喵固件,开源:https://gitee.com/gxp666111/miaomiao)。纯 Python + Pillow,无浏览器依赖,适合 cron 定时运行。
分支
feature/colorful:新设备在黑白外支持红色,本分支把渲染升级为黑/白/红三色。当前版式为上中下三段:A 大时钟+日期 / 天气(定位南京·江宁);B Claude Usage 主角(5h/7d 用量进度条 + 时间维度对比 pace,用量吃紧转红预警);C 橘喵今日实时三列。红作语义强调(用量预警、涨、定位、天气太阳/闪电),仍无真灰阶、不抖动,全图只三种纯色。近30天趋势图当前隐藏(renderer._trend_chart及依赖保留、未调用,随时可挂回)。
分支
feature/reterminal-e1002(基于feature/colorful):新增第二个目标设备 Seeed reTerminal E1002(7.3 寸 800×480,E Ink Spectra 6 原生六色:黑/白/黄/红/绿/蓝,真机已验证六色量化干净)。该设备不接受局域网直推,而是由 SenseCraft HMI 云端的 HTML 控件按设备刷新间隔(最小 5 分钟)每周期重新抓取一个公网 HTTPS URL、无头浏览器截图后量化下发;不支持 ETag/304,内容不变也会整屏重绘(全刷约 17 秒)。因此本分支产出的是一张固定 800×480 的静态页output/e1002/index.html+ 同目录dashboard.png,需部署到公网 HTTPS(局域网地址/明文 HTTP 云端抓不到)。渲染由renderer_e1002.py完成:继承DashboardRenderer组件、k=1 字号与三色版完全相同(不放大,放大后字太大很傻)。版面定位为 AI 用量看板:顶部时钟/天气不变;主体左 Claude Usage 三行(5h / 7d / Fable 7d)、右 ChatGPT Usage(目前 mock,标「示例数据」),每行是一张「用量卡」(标签 + F24 百分比 + pace / 全宽进度条 / 重置时刻 + 已过时间)。橘喵今日实时与 30 天趋势图不在本版面(业务数据留给 400×300 小屏)。六色语义:红=预警/pace 超前/定位/太阳闪电,黄=用量「注意」档填充,蓝=雨雪,绿暂未用。
命令
pip install -r requirements.txt # 仅 Pillow>=10.0;urllib 用标准库
cp .env.example .env # 首次:复制模板并填入真实凭证 + 设备 host
python3 main.py # 取数据 → 渲染 → 推送(设备 host 取自 .env 的 EPD_HOST)
python3 main.py --render-only # 只渲染到 output/dashboard.png,不推送(本地调试渲染时用这个)
python3 main.py --target e1002 # reTerminal E1002:渲染 800x480 六色图 + 固定尺寸 index.html 到 output/e1002/,不推送
sh run.sh # cron 包装脚本:cd 项目目录 + vfox python 绝对路径 + 追加日志到 output/cron.log
# 临时覆盖:真实环境变量优先级高于 .env
EPD_HOST=epd400a44.local python3 main.py
无测试、无 lint。调试渲染效果就跑 --render-only 看 output/dashboard.png。
配置统一走 .env:所有凭证/参数放同目录 .env(已在 .gitignore,本机专用;模板见已提交的 .env.example)。config.py 顶部用零依赖加载器 _load_dotenv() 把 .env 写入 os.environ,再由各 os.environ.get(...) 读取;采用 setdefault,故真实环境变量(cron/命令行注入)优先级高于 .env。config.py 内不再保留任何明文凭证(fallback 为空串)。可配置项:EPD_HOST(局域网设备 mDNS host,默认 epd400a44.local)、JM_BASE_API/JM_CLIENT_ID/JM_CLIENT_SECRET/JM_GRANT_TYPE/JM_TENANT_ID、QWEATHER_HOST/QWEATHER_KEY/WEATHER_LOCATION(默认南京·江宁)/WEATHER_TTL、USAGE_LOCAL_PATH/USAGE_WARN/USAGE_CAUTION(仅 E1002 黄档)、E1002_COLOR_STRIP。
定时部署:由 macOS launchd LaunchAgent 触发 run.sh(不再用 cron——cron 在现代 macOS 上易被 TCC/权限静默拦截,launchd 是系统原生调度器)。LaunchAgent plist 装在 ~/Library/LaunchAgents/com.jm.eink-push.plist(机器专用,未入库,等价于 run.sh/.env 的本机产物),StartInterval=300 + RunAtLoad=true:登录/重启后立即跑一次,此后每 5 分钟一次。用 LaunchAgent(非 LaunchDaemon)是因为脚本依赖当前用户目录下的文件(~/.claude/usage-snapshot.json、.env),必须在用户会话下运行——机器需已登录(或开了自动登录)才能保证开机即触发。run.sh 内部逻辑不变:cron 不继承登录环境,故脚本内 python 写死 vfox 绝对路径、并 cd 到项目目录后追加日志到 output/cron.log(cd 后 config.py 才能就近找到 .env);launchd 自身的 stdout/stderr 另落 output/launchd.log(正常应为空,非空说明进程本身起不来,而非业务报错)。常用排查:launchctl list | grep com.jm.eink-push 看是否常驻及最近退出码,launchctl kickstart -k gui/$(id -u)/com.jm.eink-push 手动立即触发一次;改 plist 后需 launchctl bootout + bootstrap 重新加载才生效(热改文件不会自动生效)。每 5 分钟触发:业务数据每次都刷新,天气靠缓存、用量读本地文件,避免高频打接口(见 data.py)。
架构(数据 → 渲染 → 推送 三层)
main.py 串联三层,各层职责单一、低耦合:
data.py— 唯一数据入口get_dashboard_data(),返回固定结构的 dict:date/weather/mao/usage。日期时间用真实系统时间;橘喵今日经营由_mao()经jm_api、天气由_weather()经weather_api(和风,定位南京·江宁)、Claude 用量由_usage()经usage_local,任何异常都回退占位"--",不回退 mock。改数据保持返回结构不变即可(renderer 依赖其 key:weather.icon为和风图标代码;mao.cols[].hb/tb为环比/同比(direction, text),direction 为None时不画三角;usage.bars[]为{k, pct(或 None), time_pct?, reset?, scoped}、usage.warn/usage.caution为转红/转黄阈值、usage.updated为快照落盘时刻;usage_gpt与usage同构,目前是 mock(mock: True),接真实数据源时替换_usage_gpt()即可)。注:_mao仍会拉mao.trend,但两个版面当前都不画趋势图(renderer 不使用它)。- 缓存(为 launchd 每 5 分钟独立进程而设,必须落盘):天气
.weather_cache.json(TTL=WEATHER_TTL,默认 15min)、趋势.trend_cache.json(按日期 key,每天只拉一次);两者拉取失败沿用旧缓存。用量不自建缓存——直接读 statusline 生产的本地快照~/.claude/usage-snapshot.json(见usage_local),失败即"--"。两个缓存文件已在.gitignore。 - 用量的 pace(时间维度对比):
_usage()每次按当前时间现算time_pct=(窗口已流逝/窗口长)、pace=pct−time_pct(>0 超前↑ / <0 节余↓);故即使utilization来自可能滞后的本地缓存,pace 仍随时钟准确推进。5h 窗口 18000s、7d 窗口 604800s。
- 缓存(为 launchd 每 5 分钟独立进程而设,必须落盘):天气
jm_api.py— jm-devops 后端统计接口客户端,设备密钥授权(grant_type=client_secret,免验证码)。先用CLIENT_ID + CLIENT_SECRET调POST /auth/login换 token(进程内缓存、按expire_in提前刷新),再带Authorization: Bearer <token>+clientid头调/system/statistics/{realtime,recent-days};遇 401 清 token 重登一次重试。token 字段为蛇形access_token/expire_in。注:历史上曾免鉴权直调、更早曾用账号密码+验证码 OCR 登录(ddddocr 不稳定),现统一为 client_secret 授权——密钥即长期凭证,务必走 HTTPS、优先用JM_CLIENT_SECRET环境变量、可在后端sys_client轮换。weather_api.py— 和风天气(QWeather)客户端。用用户专属 API Host(QWEATHER_HOST)+X-QW-Api-Key头鉴权;响应 gzip 压缩(按 magic number 手动解压)、返回code为字符串。get_now()取实时(now.text中文天气 /now.temp/now.icon图标代码),get_today()取/3d的daily[0]今日温区。QWEATHER_HOST/QWEATHER_KEY未配置时直接抛错→天气区显示"--"。usage_local.py— Claude Code 用量本地读取,不发任何网络请求(生产者/消费者模式):只读config.USAGE_LOCAL_PATH(默认~/.claude/usage-snapshot.json)。生产者 = 打过补丁的 claude-statusline(本机~/.claude/statusline.sh):把每次 Claude Code 经 stdin 喂来的权威实时额度落盘为该快照(schema 同/api/oauth/usage:five_hour/seven_day的utilization+resets_at),并额外写入seven_day_fable(Fable 模型限定的 7 天额度——stdin 里没有,只在/api/oauth/usage返回的limits[]中scope.model.display_name == "Fable"那项;statusline 在 stdin 分支也会每 5 分钟刷新一次 API 缓存/tmp/claude/statusline-usage-cache.json以拿到它,无 token/断网时该键为null);data.USAGE_WINDOWS用scoped=True标记这一行,400×300 小屏render()跳过 scoped 行、800×480 宽版显示。本模块作消费者读取。活跃使用时快照几乎持续刷新、准确;空闲时停在最后一次。文件缺失/损坏→用量区"--"。注:resets_at可能是 epoch 数字(Claude Code stdin 给的就是 epoch)或 ISO 串,data._parse_reset_ts两者兼容。(曾评估直调/api/oauth/usage,改为读本地快照以免网络请求。)renderer.py—DashboardRenderer.render(data)返回 PIL'RGB'模式、仅黑/白/红三色图;组件层提供两个可覆写钩子/参数供六色版复用:_usage_colors()(用量行 填充/边框/文字 三色元组)、_weather_icon(wet=)(降水元素颜色);_label(x0,x1)可指定左右边界。render_to_file()落盘。布局硬编码为上中下三段,两道hdash横规分隔(y=90 / 200):- A 顶部(0–90):大时钟(F48)+日期(左)/ 天气(右:红定位水滴 + 温度 + 天气·温区 + 全矢量图标)。
- B 中部主角 Claude Usage(
_label标题 + 两条_usage_row):每条单行 = 左标签5h/7d(F13) + 粗进度条 + 百分比(F16) + 时间维度对比 pace(F13,_pace);pct≥warn→该条进度条(含边框)与百分比转红预警;pace 用上/下三角替代 +/−(超前↑ / 节余↓)。整行「标签·进度条·百分比·三角」用_mid()按墨迹竖直中心对齐到同一中线。 - C 底部 橘喵今日实时(
_label+ 三列,版式对齐主分支):■ 橘喵·今日实时+上次更新,列内 名(F12)/值(F24 粗)/环比·同比(_cmp_line),相对标题偏移 +18/+34/+64/+82,底部留 ~11px 下边距。 - 红色点缀系统(改配色务必克制):模块顶部
BLACK/WHITE/RED,RED=(255,0,0)是给设备红通道的明确信号。红只用在:① 定位水滴(_loc_pin(fg=RED))② 天气太阳/闪电(_weather_icon(accent=RED),云/雨/雪/雾/月仍黑)③ 用量进度条与百分比(pct≥warn) + pace 超前(↑) ④ 环比/同比「涨」的三角与数值(_cmp_line,跌/标签仍黑)。配色铁律:红与黑同属深色、红叠黑对比极低,故红只压白底或作大块实心(白字压红),绝不红字压黑底。加红先问「是否承载语义」。 _trend_chart(当前隐藏):近30天三指标折线,用_styled_polyline()按 solid/dashed/dotted 区分、主指标(流水)红线,各指标按自身极值独立归一化。已保留但render()未调用,想恢复即在 C 前挂回。- 天气图标全矢量手绘(无图片资源):
_weather_category()把和风 icon 代码归并为 8 类(sunny/clear_night/cloudy/overcast/thunder/rain/snow/fog,识别不了回退 cloudy),再由_weather_icon()用_sun/_cloud等基元按 1bit 描边画出;改天气展示从这里动。
pusher.py— 直连局域网墨水屏设备(喵喵固件,开源:https://gitee.com/gxp666111/miaomiao,web/即设备自带管理页,可浏览器打开http://<EPD_HOST>/调试同一套接口)。push_image()先调GET /images拿画廊已存图片名单,逐个POST /delete_image?name=清空(单张删除失败不阻塞后续),再POST /upload(Content-Type: image/png,body 为原始 PNG 字节,非 multipart)触发设备转换+刷屏。清空画廊是刻意设计:设备把每次/upload都追加存一份到画廊(GET /images可见),不清理会越推越多、且设备当前current_mode为 slideshow 会轮播到旧图;先清后传使画廊恒为 1 张,等价于始终静态展示最新一张。清理非核心:拉取画廊列表本身失败也不阻塞后续/upload(跳过清理,直接推)。_request()对连接类异常(urllib.error.URLError,含 mDNS.local域名解析瞬时失败)内置重试(RETRY_TIMES=2,间隔RETRY_DELAY=2s)——mDNS 基于组播 UDP,偶发丢包很正常,单次失败不该让整轮推送直接跳过。注:历史上曾走 Zectrix 公网 API(POST /devices/{id}/display/image+ 设备 MAC +ZECTRIX_API_KEY),现统一为局域网直连。renderer_e1002.py— reTerminal E1002 目标:E1002Renderer(DashboardRenderer)以 k=1 复用组件(字号 12/24/48 与三色版一致),只重写版式与配色钩子。版式:A 顶部 0–90 时钟/日期左、天气右(贴 x=790);B 主体 y=100 起,左半usage(10–386)|竖规 x=400|右半usage_gpt(414–790),各自一个_usage_block(_label标题 + 右侧「快照 HH:MM」或 mock 的「示例数据」,然后逐行_usage_card,行距 116)。_usage_card三层:① 标签 F13 粗 + 百分比 F24 粗 +_pace三角 ② 全宽进度条 H=14 ③ F12 说明行「重置 …」/「已过 NN%」;pct 为 None 显示--。配色钩子_usage_colors三档:≥USAGE_WARN红|≥USAGE_CAUTION(默认 60)黄填充+黑框黑字|其余黑——黄字压白底不可读,黄只作填充。天气图标wet=BLUE让雨滴/雪花着蓝。可选六色测试色条_color_strip(E1002_COLOR_STRIP=1打开,默认关)。write_page()写出固定 800×480 的index.html(零边距、image-rendering: pixelated、PNG 带时间戳参数防缓存)。为何固定尺寸而非自适应:云端截图视口/DPR 不可控,自适应会重排+抗锯齿产生中间色再被平台抖动;固定页里的 1:1 PNG 每个像素本就是六色之一,截图零损失——已用无头 Chrome--window-size=800,480截图验证与 PNG 逐像素一致。设备端 HTML 控件须铺满整个画布。历史:曾有过 k=2 整体放大版与「左用量/右今日实时/下 30 天趋势」版,均已按用户反馈弃用。config.py— 顶部_load_dotenv()先加载同目录.env,再定义 API、设备、画布尺寸、字体路径、推送参数;凭证 fallback 为空串,真实值来自.env/环境变量。
墨水屏渲染约束(改 renderer.py 必读)
设备是 三色(黑/白/红)、无真灰阶——灰阶只能抖动成网点(难看),所以底色只用黑白 + 红作稀缺强调,靠构图/字号/留白建立层级,不要引入灰色填充或抖动:
-
红只作语义强调:方向(涨)、警示(闪电)、强调(定位/主折线);红占墨保持很小(<10% 墨迹),滥用会稀释注意力、破坏层级。整图只允许三种纯色
(0,0,0)/(255,255,255)/(255,0,0)——渲染后可用img.getcolors()自查,出现第四种色(多为抗锯齿灰边)即为 bug。矢量图元(line/ellipse/polygon/arc)默认不抗锯齿故为纯色;文字靠fontmode="1"保持纯色。 -
DashboardRenderer(k=…)缩放系数:所有组件(_label/_cmp_line/_usage_row/_pace/tri等)的像素常量与伪粗体偏移都乘k,字体按12*k/24*k/48*k创建;k=1为 400×300 原版(改组件后务必用固定夹具比对k=1输出逐像素不变),E1002 版当前用k=1(k=2 整体放大在 800×480 上字过大,已否决),k 参数保留供更高分辩率设备使用。字体属性名(F12/F24/F48)表达层级而非绝对像素。 -
字体固定用 Fusion Pixel 12px 点阵字体(
fonts/,OFL 协议),首选整数倍尺寸 12/24/48(F12/F24/F48)最锐利;用量区为拿到合适的字号层级另用了 F13/F16(1.08x/1.33x 非整数倍,笔画略不均,属有意取舍),靠d.fontmode = "1"关抗锯齿仍保持纯色不糊。跨字号竖直居中统一用_mid()(按getbbox墨迹中心对齐)。 -
加粗用「伪粗体」:
_draw()按 1~bold px 水平偏移叠绘笔画(点阵字体只有单一字重)。 -
推送时
DITHER = False(硬阈值),纯黑白图最锐利,勿改成true。 -
坐标、字号均为像素网格上的硬编码常量;调布局时注意各区分隔线
hdash的 y 值与下方组件位置联动。
注意
- 所有凭证均在
.env(不提交);config.py不再内置明文 fallback。分享代码时给出.env.example即可,真实.env切勿入库。 .gitignore已忽略:output/、__pycache__/、*.pyc、两个缓存文件.weather_cache.json/.trend_cache.json、本机专用的run.sh、含凭证的.env(模板.env.example入库)。改缓存逻辑后想强制重拉,删掉对应缓存文件即可。