Gateway Documentation
From Yombo
< docs
Getting started
- Quick start - Install and setup home automation in 3 steps or less.
- Installation methods:
- Debian (Ubunu, Mint, Etc)
- Vagrant - Run Yombo Gateway inside a VirtualBox image.
- Raspberry PI (1, 2, 3, 4, Zero, Zero W, etc)
- Starting and stopping the Yombo Gateway
- Setup Wizard - Setup and configure the software quickly. This is also used to restore an existing gateway.
Configuration & Setup
- Web interface - Change gateway settings, configure devices, and manage modules.
- yombo.ini - Configuration file.
Interfacing with Yombo
- Gateway API - Get device status and control devices using the API.
- Authentication Keys - Create access keys so other applications, scripts, and programs can access the Yombo Gateway without the login credentials.
- MQTT - Receive live system events and control devices using MQTT messages.
Other topics
- Gateway clustering - Connect multiple instances together to act as one
- Backups - Simple one click gateway backup. This should be done shortly after setting up a new gateway.
- Release notes - Review release notes for various versions.
See Also
- Knowledge Base articles - Help with many common tasks.
- Developing modules - Develop beginner through advanced automation rules.