A documentation-first workflow and local knowledge base for professional-grade ESPHome configuration, troubleshooting, and device management.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install esphome-encyclopedia
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install esphome-encyclopedia using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is ESPHome Encyclopedia?
ESPHome Encyclopedia is a specialized skill designed to bring high-precision documentation and operational memory to your ESPHome projects. It eliminates the risks of guessing YAML syntax or misremembering pin assignments by enforcing a docs-first approach. By integrating official documentation lookups with a local caching system, this Openclaw Skills extension ensures your AI agent always works with the most accurate, version-sensitive information.
Beyond just looking up data, this skill creates a durable operational memory for your local environment. It separates official behavior from your specific hardware quirks, pin mappings, and dashboard configurations, allowing for faster and safer OTA updates and configuration reviews over time.
ESPHome Encyclopedia Use Cases
- Authoring complex ESPHome YAML configurations for ESP32 and ESP8266 devices.
- Troubleshooting compile errors, boot loops, or Wi-Fi provisioning issues.
- Planning and executing safe Over-the-Air (OTA) updates for production nodes.
- Mapping physical hardware pins and sensors to internal component definitions.
- Managing a local inventory of smart home devices, including dashboard access and secrets handling logic.
How ESPHome Encyclopedia Works
- Classification: The skill identifies if a request involves ESPHome-specific syntax, components, or hardware operations.
- Cache Search: It first checks the local .ESPHome-Encyclopedia directory for existing documentation or device-specific notes.
- Documentation Retrieval: If the answer isn't local, it fetches fresh data from the official ESPHome component index to ensure accuracy.
- Local Archiving: Consulted pages are cached locally to speed up future interactions and build an offline knowledge base.
- Note Generation: After performing work, it records operational learnings—like hardware quirks or specific pinouts—into a structured note system.
ESPHome Encyclopedia Setup
To initialize your local workspace and prepare the directory structure, run the following commands:
# Navigate to your project root
cd your-esphome-project
# Initialize the encyclopedia directory structure
python3 scripts/init_workspace.py
# (Optional) Cache specific component documentation
python3 scripts/cache_doc.py https://esphome.io/components/sensor/dht.html
ESPHome Encyclopedia Data Schema & Taxonomy
The skill maintains a structured hierarchy within the .ESPHome-Encyclopedia/ directory to keep official data separate from user observations:
| Directory | Purpose |
|---|---|
/docs/esphome.io/ |
Mirrored official documentation pages (HTML/Markdown). |
/notes/devices/ |
Markdown files detailing specific hardware nodes and their roles. |
/notes/components/ |
Custom observations and tuning details for specific ESPHome components. |
/notes/patterns/ |
Reusable YAML snippets, substitutions, and package logic. |
/inventory/ |
Environment-wide dashboard lists and device access maps. |
ESPHome Encyclopedia Advanced Features
- Multi-agent support for collaborative hardware debugging and configuration review.
- Automated documentation caching using dedicated Python utility scripts.
- Environment-specific operational boundaries to prevent unsafe OTA updates or pin changes.
- Integration with local secret management logic via secrets.yaml pointers.
- Topic mapping for rapid lookup of grouped ESPHome components (e.g., all climate or light entities).
SKILL.md
Loading
Related Openclaw Skills
PEST Analysis
A specialized strategic analysis tool designed to evaluate political, economic, socio-cultural, and technological factors affecting a business or industry.
Amazon Books
A powerful book discovery tool that finds titles, provides summaries, and generates direct Amazon purchase links.
Quant Trading API
A professional-grade API integration for automating trades and analyzing market data across major Chinese securities brokers.
Quant Risk Dashboard
A professional-grade quantitative trading risk management system featuring real-time VaR calculation, stress testing, and comprehensive risk metric visualization.
Simple Weather
A minimalist tool for retrieving real-time weather data and atmospheric conditions for major metropolitan areas.
Einstein Research Backtest
A comprehensive methodology for stress-testing and validating quantitative trading strategies to ensure real-world robustness.
Featured*
