Languages: English | 简体中文 | 日本語

A skill for AI agents to interact with Dot. devices through the OpenAPI.

📚 Official Documentation: https://dot.mindreset.tech/docs/service/open/skill

Dot Skill allows you to:

• Control device content: Display text, images, Canvas API layouts, and other content on your Dot. devices
• Design Canvas layouts: Build windowData cards, dashboards, list views, conditions, and formatting with a dedicated Canvas designer skill
• Name API content: Set a task alias for text, image, and Canvas API items so they are easy to identify
• Query device status: Get real-time information about device battery, WiFi signal, and current display
• Manage devices: List your devices, get device IDs, and switch between content

The repository now splits responsibilities into:

• dot-device-openapi: device interaction, API calls, and helper scripts
• dot-canvas-designer: Canvas API windowData design and layout guidance
• dot-openapi: compatibility router for older installs

• A Dot. account with at least one device
• An API key from the Dot. App
• python3 installed locally (for using the helper scripts)

Add this repository as a Codex marketplace:

codex plugin marketplace add git@github.com:MindReset/dot_skill.git

Then install the plugin:

codex plugin add dot-skill@mindreset-dot-skill

Start a new Codex thread after installation so Codex can load the plugin's skills.

Import the OpenAPI schema:

https://raw.githubusercontent.com/MindReset/dot_skill/master/openapi/dot-openapi.yaml

Configure Bearer authentication with a Dot. API key:

Authorization: Bearer dot_app_<your_api_key>

Public GPTs or agents that call Dot. APIs should include the Dot. privacy policy and terms:

• Privacy Policy: https://dot.mindreset.tech/docs/privacy
• Terms of Service: https://dot.mindreset.tech/docs/terms

npx skills add https://github.com/MindReset/dot_skill.git

Install only the device interaction skill:

npx skills add https://github.com/MindReset/dot_skill.git --skill dot-device-openapi

Install only the Canvas designer skill:

npx skills add https://github.com/MindReset/dot_skill.git --skill dot-canvas-designer

mkdir -p ~/.agents/skills
ln -sfn /path/to/dot_skill/skills/dot-device-openapi ~/.agents/skills/dot-device-openapi
ln -sfn /path/to/dot_skill/skills/dot-canvas-designer ~/.agents/skills/dot-canvas-designer

Restart your agent after installation.

1. Get your API key: Follow the official documentation
2. Get your device ID: Follow the official documentation
3. Start using the API: See Device API Reference for endpoints and Canvas windowData Reference for Canvas layout design

The skills/dot-device-openapi/scripts/ directory contains Python helper scripts:

• send_text.py: Send text to a device
• send_image.py: Send an image to a device
• send_canvas.py: Send a Canvas API JSON layout to a device
• get_device_status.py: Get current device status
• get_device_settings.py: Get device settings
• update_device_settings.py: Update device settings
• list_devices.py: List all your devices
• list_tasks.py: List device loop or fixed tasks
• switch_next.py: Switch to the next content

Text, image, and Canvas helper scripts support --task-alias to set the human-readable task name shown in the device task list.

• Device API Reference - Device interaction and endpoint documentation
• Canvas windowData Reference - Canvas layout design rules
• Canvas Examples - Example Canvas payloads
• Authentication - How to authenticate requests
• OpenAPI Schema - Importable schema for Actions and OpenAPI-compatible tools
• Security Policy - Credential handling and vulnerability reporting
• Official Dot. Security Policy - Responsible disclosure process
• Support - Issue reporting guidance
• Changelog - Release notes

This repository is the public, user-facing skill package for Dot. device control and Canvas design. When Dot Web changes API behavior, keep these surfaces aligned:

• openapi/dot-openapi.yaml for OpenAPI-compatible agents and GPT Actions
• skills/dot-device-openapi for device interaction scripts and endpoint guidance
• skills/dot-canvas-designer for Canvas API payload design rules
• plugins/dot-skill for Codex plugin packaging
• Dot Web public docs under dot_web_docs

Internal-only Studio V2 implementation, MongoDB migration, and render-debugging workflows belong in dot_internal_skill, not this public package.

MIT License - see LICENSE for details.