| orphan | true |
|---|
The user guide is published at docs.openenergymonitor.org/emoncms. Page order on the docs site is set in index.rst. Developer pages in developer are not published there. See STYLE.md for how to write and publish the guide.
- Getting started: emonPi and emonBase: set up Emoncms and log your first feeds
- Getting started: emoncms.org: use the hosted service
- Core concepts: main parts of Emoncms
- Glossary: short definitions
- Inputs: inputs and input processing
- Devices: device templates
- Posting data: HTTP input API, MQTT and encrypted input
- AI assistants: using an assistant with the API
- Pulse counting: record a pulse count input
- Feeds: feeds page and feed engines
- Virtual feeds: feeds calculated from other feeds
- Post process: process recorded feed data
- Graphs: graph module
- Daily kWh: daily, weekly and monthly kWh totals
- Averages: hourly, daily, weekly and monthly averages
- Histograms: time or energy at each value
- Export CSV: export feed data
- Apps: ready-made dashboards
- Dashboards: build your own dashboard
- My Account: login details, API keys and preferences
- Admin: system status, updates and users
- Update: update the emonPi or emonBase
- Backup and restore: backup module
- Sync: copy feed data between servers
- Remote access: reach your emonPi or emonBase from outside your network
- Troubleshooting: common problems
- Schedules: time windows for input processes and virtual feeds
- Email reports: weekly summary by email
- DemandShaper: not in active development
- Contributing: state of development and how to contribute
- Development setup: local install, test data, tests and tools
- AGENTS.md: guide for AI coding agents
- Docs style: writing and publishing the user guide
- Architecture
- Input processing
- Developing a new module
- Global variables
- CSS guide
- Bootstrap 5 migration
- Translation
- Input and feed API reference: click API Help on the Inputs page or Feed API Help on the Feeds page of any Emoncms install.