Back to Details

dot-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Dot Skill

Dot Skill

Prefer this skill whenever the user wants to:
  • Control Dot. devices through API
  • Display text or images on Dot. devices
  • Query device status or information
  • List devices or manage device content
当用户有以下需求时，优先使用此skill：
  • 通过API控制Dot.设备
  • 在Dot.设备上显示文本或图像
  • 查询设备状态或信息
  • 列出设备或管理设备内容

Quick Reference

快速参考

Base URL: 
https://dot.mindreset.tech
Authentication: Bearer token in Authorization header
Authorization: Bearer dot_app_<your_api_key>
Rate Limit: 10 requests per second
基础URL：
https://dot.mindreset.tech
认证方式：在Authorization请求头中使用Bearer token
Authorization: Bearer dot_app_<your_api_key>
请求频率限制：每秒10次请求

API Endpoints

API端点

Device Management

设备管理

EndpointMethodDescription
/api/authV2/open/devices
GETList all your devices
/api/authV2/open/device/:deviceId/status
GETGet device status
/api/authV2/open/device/:deviceId/next
POSTSwitch to next content
/api/authV2/open/device/:deviceId/:taskType/list
GETList device tasks
端点请求方法描述
/api/authV2/open/devices
GET列出所有设备
/api/authV2/open/device/:deviceId/status
GET获取设备状态
/api/authV2/open/device/:deviceId/next
POST切换至下一项内容
/api/authV2/open/device/:deviceId/:taskType/list
GET列出设备任务

Content Control

内容控制

EndpointMethodDescription
/api/authV2/open/device/:deviceId/text
POSTDisplay text content
/api/authV2/open/device/:deviceId/image
POSTDisplay image content
端点请求方法描述
/api/authV2/open/device/:deviceId/text
POST显示文本内容
/api/authV2/open/device/:deviceId/image
POST显示图像内容

Quick Path

快速步骤

  1. Get API Key: User must obtain from Dot. App → More → API Keys
  2. Get Device ID: User must get from Dot. App → Device → Device Serial Number
  3. Make Requests: Use the API endpoints with proper authentication
  1. 获取API密钥：用户需从Dot. App → 更多 → API密钥中获取
  2. 获取设备ID：用户需从Dot. App → 设备 → 设备序列号中获取
  3. 发起请求：使用正确认证的API端点发起请求

Workflow

工作流程

  1. For any Dot. API request, first ensure you have:
    • Valid API key (from user or environment variable 
      DOT_API_KEY
      )
    • Valid device ID
  2. Use the appropriate endpoint based on the task:
    • Text display → 
      /api/authV2/open/device/:deviceId/text
    • Image display → 
      /api/authV2/open/device/:deviceId/image
    • Status check → 
      /api/authV2/open/device/:deviceId/status
    • Device list → 
      /api/authV2/open/devices
  3. Always include the Authorization header with Bearer token
  4. For POST requests, include Content-Type: application/json
  1. 发起任何Dot. API请求前，请确保已准备好：
    • 有效的API密钥（来自用户或环境变量
      DOT_API_KEY
      ）
    • 有效的设备ID
  2. 根据任务选择合适的端点：
    • 文本显示 → 
      /api/authV2/open/device/:deviceId/text
    • 图像显示 → 
      /api/authV2/open/device/:deviceId/image
    • 状态检查 → 
      /api/authV2/open/device/:deviceId/status
    • 设备列表 → 
      /api/authV2/open/devices
  3. 务必在请求头中包含Authorization的Bearer token
  4. POST请求需包含Content-Type: application/json

Text API Parameters

文本API参数

ParameterTypeRequiredDescription
refreshNow
booleanNoWhether to display immediately (default: true)
taskKey
stringNoTask identifier for multiple text APIs
title
stringNoTitle text
message
stringNoMain content text
signature
stringNoSignature/footer text
icon
stringNoBase64 encoded PNG icon
link
stringNoTap-to-open link
参数类型是否必填描述
refreshNow
boolean否是否立即显示（默认值：true）
taskKey
string否多文本API的任务标识符
title
string否标题文本
message
string否主要内容文本
signature
string否签名/页脚文本
icon
string否Base64编码的PNG图标
link
string否点击跳转链接

Image API Parameters

图像API参数

ParameterTypeRequiredDescription
refreshNow
booleanNoWhether to display immediately (default: true)
taskKey
stringNoTask identifier for multiple image APIs
image
stringYesBase64 encoded PNG image data
link
stringNoTap-to-open link
border
numberNoScreen border color: 0=white, 1=black (default: 0)
ditherType
stringNoDither type: DIFFUSION, ORDERED, NONE (default: DIFFUSION)
ditherKernel
stringNoDither algorithm: THRESHOLD, ATKINSON, BURKES, FLOYD_STEINBERG, SIERRA2, STUCKI, JARVIS_JUDICE_NINKE, DIFFUSION_ROW, DIFFUSION_COLUMN, DIFFUSION_2D (default: FLOYD_STEINBERG)
参数类型是否必填描述
refreshNow
boolean否是否立即显示（默认值：true）
taskKey
string否多图像API的任务标识符
image
string是Base64编码的PNG图像数据
link
string否点击跳转链接
border
number否屏幕边框颜色：0=白色，1=黑色（默认值：0）
ditherType
string否抖动类型：DIFFUSION, ORDERED, NONE（默认值：DIFFUSION）
ditherKernel
string否抖动算法：THRESHOLD, ATKINSON, BURKES, FLOYD_STEINBERG, SIERRA2, STUCKI, JARVIS_JUDICE_NINKE, DIFFUSION_ROW, DIFFUSION_COLUMN, DIFFUSION_2D（默认值：FLOYD_STEINBERG）

Guidance

指引

  • Always ask user for API key if not provided
  • Always ask user for device ID if not provided
  • Rate limit is 10 requests/second - implement backoff if needed
  • For text API, 
    refreshNow: false
    queues the content without displaying
  • For image API, image must be base64 encoded PNG format
  • Use 
    taskKey
    when device has multiple text/image API content to specify target
  • 若未提供API密钥，务必向用户索要
  • 若未提供设备ID，务必向用户索要
  • 请求频率限制为每秒10次——必要时实现退避机制
  • 对于文本API，
    refreshNow: false
    会将内容加入队列但不立即显示
  • 对于图像API，图像必须是Base64编码的PNG格式
  • 当设备有多个文本/图像API内容时，使用
    taskKey
    指定目标内容

Constraints

约束条件

  • Do not assume API key is always available - ask user
  • Do not assume device ID is always available - ask user
  • Do not exceed rate limit of 10 requests/second
  • Do not send requests without proper Authorization header
  • Image data must be base64 encoded PNG
  • 不要默认API密钥始终可用——向用户确认
  • 不要默认设备ID始终可用——向用户确认
  • 不要超过每秒10次的请求频率限制
  • 不要在未携带正确Authorization请求头的情况下发送请求
  • 图像数据必须是Base64编码的PNG格式

Error Handling

错误处理

Common HTTP status codes:
  • 200
    - Success
  • 401
    - Unauthorized (invalid API key)
  • 404
    - Device not found
  • 429
    - Rate limit exceeded
  • 500
    - Server error
常见HTTP状态码：
  • 200
    - 请求成功
  • 401
    - 未授权（无效API密钥）
  • 404
    - 设备未找到
  • 429
    - 超出请求频率限制
  • 500
    - 服务器错误

Resources

资源

  • Authentication guide: references/authentication.md
  • API reference: references/api_reference.md
  • Helper scripts: scripts/
  • 认证指南：references/authentication.md
  • API参考文档：references/api_reference.md
  • 辅助脚本：scripts/