Homegear Manual

Edition 0.8 - The Homegear Team

This document describes how to install, upgrade, configure, and maintain Homegear on your system.

Table of Contents

• 1. Abstract
• 2. We Need Feedback
• 3. Hardware and Software Requirements
  • 3.1. Hardware Recommendations
  • 3.2. Software Requirements
• 4. Installation
  • 4.1. System Requirements
  • 4.2. Installing from Repository
  • 4.3. Raspberry Pi OS Image
  • 4.4. Compiling from Source
  • 4.5. Clients Without SSL Support
  • 4.6. Create Homegear’s Certificate Authority
• 5. Updating Homegear
  • 5.1. Updating from Repository
  • 5.2. Manual Update with Package
  • 5.3. Updating from Source
• 6. Backup and Restore
  • 6.1. Backup
  • 6.2. Restore
• 7. Files and Directories
  • 7.1. Directories
  • 7.2. Configuration files
• 8. First Steps
  • 8.1. How to Interact with Homegear
• 9. Configuration
  • 9.1. Main Configuration (main.conf)
  • 9.2. RPC Server Configuration (rpcservers.con)
  • 9.3. RPC Client (Event Server) Configuration (rpccliensts.conf)
  • 9.4. MQTT (mqtt.conf)
• 10. Command Line Interface (CLI)
  • 10.1. Starting the CLI
  • 10.2. Example usage of the CLI
• 11. Communication Protocols
  • 11.1. MQTT
  • 11.2. REST
  • 11.3. Binary RPC
• 12. Scripting
• 13. Troubleshooting
  • 13.1. Homegear Doesn’t Start
• 14. Legal Notice