1.0 KiB
1.0 KiB
Documentation
This directory contains the detailed Shelly Exporter documentation.
User guides
- Configuration reference describes every YAML field, product identifiers, authentication, and multi-device examples.
- Metrics reference lists metric types, labels, units, optional behavior, and energy counter semantics.
- Operations and troubleshooting covers deployment, Prometheus setup, example alerts and queries, security, and common failures.
Developer guide
- Architecture and adding products explains request flow, package responsibilities, Gen1 schema extension, metric conventions, and testing.
Protocol scope
The current implementation targets the Shelly Gen1 HTTP API:
GET <device-url>/status
Authorization: Basic ... # only when credentials are configured
Accept: application/json
Newer Shelly generations use a different RPC API and authentication model. They require a separate protocol client in addition to new response structures and collectors.