PEAT

Current version:

v2026.2.10

Warning

The documentation is a work in progress since open-sourcing, there may be out of date information. If you spot anything that’s obviously wrong, please open an issue or PR!

Quickstart

To get started, jump to Operate.

Table of Contents

• 1. Introduction
• 2. System requirements
• 3. Install
• 4. Configure
• 5. Operate
• 6. Reference Documents
• 7. Design Documents
• 8. Developer Reference
  • 8.1. Data model
  • 8.2. Module developer guide
  • 8.3. PEAT API
  • 8.4. Module API
  • 8.5. Device module implementations
  • 8.6. General APIs
  • 8.7. HEAT API
  • 8.8. Python examples
  • 8.9. Elasticsearch internals
  • 8.10. Database Schema
  • 8.11. Dependencies
• 9. Release Notes
• 10. Glossary
• 11. Authors
• 12. Contributing
• 13. Development Infrastructure