trmnl

📟 e-ink 墨水屏内容推送专家

基于 TRMNL 官方 CSS 框架的 e-ink 墨水屏内容生成工具,支持通过 CLI 向电子纸设备推送自定义仪表盘与通知,适合极客用户打造低功耗信息展示终端。

收藏
15.4k
安装
3.5k
版本
v1.0.3
CLS 安全性认证2026-05-16
点击查看完整报告 >

使用说明

核心用法

TRMNL Content Generator 是一款面向 TRMNL 系列 e-ink 墨水屏设备的专用内容生成技能。用户通过安装 trmnl-cli 命令行工具,配置 webhook 插件后,即可利用该技能生成符合 TRMNL CSS 框架规范的 HTML 内容,并推送至电子纸设备显示。核心工作流包括:安装/更新 CLI、检查插件配置、确认设备型号(默认 TRMNL OG 800×480 2-bit 灰度)、读取参考文档、生成 HTML、写入临时文件并通过 trmnl send 命令发送。技能内置完整的布局系统(flexbox、10 列网格)、排版工具(等宽数字 value--tnums、自动缩放 data-fit-value)和组件库(标题栏、分隔线、数据项),支持构建从简单通知到复杂数据仪表盘的各类界面。

显著优点

1. 专业 e-ink 优化:针对电子纸显示特性设计,提供 2-bit 灰度专用的 dithered 背景类(bg--gray-*),避免传统 CSS 颜色在墨水屏上的显示问题。

2. 完善的框架支持:涵盖布局、排版、组件、数据属性等完整设计系统,参考文档结构清晰(patterns、framework-overview、css-utilities、layout-systems、components 等),降低学习成本。

3. 严格的边界控制:内置 payload 大小验证(Free 2KB / TRMNL+ 5KB)、速率限制提示(12/30 请求每小时)和 trmnl validate 预检机制,帮助用户避免发送失败。

4. 极简交互设计:遵循"最小确认"原则,发送成功后仅返回简短确认,不冗余回显内容,符合终端用户的使用习惯。

5. 透明可审计:纯文档型资产,无隐藏代码,所有操作均需用户显式授权和配置,安全可控。

潜在缺点与局限性

1. 硬件依赖性强:必须拥有 TRMNL 物理设备并配置 webhook 插件才能使用,无设备用户无法验证效果。

2. 外部工具依赖:需用户自行安装 Node.js 环境和 trmnl-cli npm 包,对非技术用户存在门槛。

3. 速率与容量限制:免费用户仅 12 请求/小时、2KB 单条限制,不适合高频实时数据场景;复杂布局需精心优化 HTML 体积。

4. 静态内容为主:e-ink 特性决定其适合信息展示而非交互,无法支持动画、视频或复杂用户输入。

5. T3 来源风险:虽本次审查通过,但来源为社区/个人仓库,长期维护更新存在不确定性。

适合的目标群体

  • TRMNL 设备持有者:已购买 TRMNL OG 或其他型号 e-ink 显示屏的极客用户
  • 智能家居/IoT 爱好者:希望构建低功耗信息看板(天气、股价、待办、GitHub 统计等)
  • 开发者与设计师:熟悉前端技术,愿意通过代码定制专属显示内容的用户
  • 极简主义追求者:偏好电子纸显示效果,需要减少屏幕蓝光干扰的场景

使用风险

1. CLI 环境配置风险npm install -g 可能因权限问题失败,建议使用 nvm 或检查 Node.js 版本兼容性。

2. Webhook 配置错误:插件 URL 配置不当会导致发送失败,需通过 trmnl configtrmnl history --failed 排查。

3. 内容超限截断:超出 tier 限制的 payload 将被拒绝,重要信息可能无法完整显示,务必使用 trmnl validate 预检。

4. 速率限制触发:高频调用可能触发 429 错误,需合理规划更新频率或升级至 TRMNL+。

5. 临时文件残留:虽使用标准 /tmp 目录,但异常中断时可能遗留 HTML 文件,建议定期清理。

安全解读

核心用法

TRMNL Content Generator 是一个专门面向 TRMNL 电子墨水屏设备的文档型 Skill,用于生成符合 TRMNL CSS 框架规范的 HTML 内容,并通过 trmnl-cli 工具推送至用户设备。

工作流程:
1. 确认用户已安装 trmnl-clinpm install -g trmnl-cli@latest

2. 检查/配置 webhook plugin(trmnl plugin add <name> <url>

3. 确认设备类型(默认 TRMNL OG,2-bit 灰度,800×480 分辨率)

4. 根据需求读取对应的参考文档(CSS 工具、布局系统、组件等)

5. 生成符合 TRMNL 框架的 HTML 结构

6. 写入临时文件并通过 CLI 发送(trmnl send --file /tmp/trmnl-content.html

标准插件结构:

<div class="layout layout--col gap--space-between">
  <!-- 内容区域 -->
</div>
<div class="title_bar">
  <span class="title">插件名称</span>
  <span class="instance">上下文</span>
</div>

关键约束:

  • 2-bit 灰度显示(黑/灰/白),使用 bg--gray-*text--gray-*
  • 10 列网格系统(col--span-N
  • 数字必须使用 value--tnums 类确保等宽对齐
  • Free 用户:2 KB 负载,12 次/小时;TRMNL+ 用户:5 KB 负载,30 次/小时

显著优点

1. 专业化设计:深度适配电子墨水屏特性,考虑刷新率、残影、对比度限制
2. 框架完整:提供 flexbox、grid、表格、进度条、排版工具等全套 CSS 工具

3. 数据属性增强:支持 data-fit-value 自动缩放、data-clamp 行数限制等智能特性

4. CLI 集成简洁:通过标准 CLI 工具推送,无需处理底层 API 细节

5. 文档详尽:包含 6 份参考文档,覆盖模式、框架、CSS、布局、组件、API 及反模式

潜在缺点与局限性

1. 硬件依赖:必须拥有 TRMNL 设备并配置 webhook 才能使用,无法独立运行
2. CLI 前置要求:用户需自行安装 npm 包,对非技术用户有一定门槛

3. 严格尺寸限制:2-5 KB 的负载上限对复杂 UI 构成约束

4. 静态内容:不支持实时交互或动态更新,仅适合展示型场景

5. 速率限制:每小时 12-30 次的调用上限,不适合高频刷新场景

适合人群

  • TRMNL 设备用户:希望自定义电子墨水屏显示内容的现有用户
  • 极简仪表盘爱好者:偏好低功耗、常显信息屏的用户
  • 开发者/极客:熟悉 CLI 操作,希望将 TRMNL 集成到自动化工作流中
  • IoT 场景:需要静态信息展示(天气、股价、待办、GitHub 状态等)

常规风险

1. Webhook URL 泄露风险:UUID 相当于 API 密钥,泄露后他人可向你的设备推送内容
2. CLI 供应链风险trmnl-cli 为第三方 npm 包,需确保从官方 registry 安装

3. 内容刷新延迟:电子墨水屏物理特性导致无法实时更新,不适合时效性极强的场景

4. 带宽成本:频繁推送可能触发速率限制或超额费用

trmnl 内容

assets文件夹
good-examples文件夹
references文件夹
手动下载zip · 22.7 kB
simple-message.htmltext/plain
请选择文件