Getting started

Introduction

This guide will help you get up and running quickly, whether you’re setting up your first device or expanding your system into a complete smart home ecosystem. In the following sections, you’ll find everything you need to know to start using ZyraX Home with confidence:

  • Changelog – Stay up to date with the latest features, improvements, and fixes.
  • Installing Software – Step-by-step instructions to install ZyraX Home on your preferred hardware.
  • Configuring – Initial setup and system configuration to tailor ZyraX Home to your environment.
  • User Interface – An overview of the dashboard and tools to control and monitor your devices.
  • Over-The-Air Updates – Keep your system secure and up to date with automatic software updates.
  • Expand System – Add new devices, integrations, and features as your smart home grows.
  • Troubleshooting – Solutions to common issues and tips for ensuring a smooth experience.
    Roadmap – A look ahead at upcoming features and the future direction of ZyraX Home.

By the end of this guide, you’ll have a fully operational smart home setup and the knowledge to maintain, expand, and optimize your system.

Changelog

The ZyraX Home changelog provides a concise overview of updates across the entire system, covering all ZyraX Home components. It highlights the most important changes so you can quickly understand what’s new, improved, or fixed.

For the full and detailed changelog of all the ZyraX Home components, please visit:

Version 1.0.0

  • Not released yet

Installing Software

The installation process varies for each component. Refer to the specific installation instructions provided below. If you encounter any issues or need assistance, please open an issue on the specific GitHub repository.

Configuring

After successfully completing the installation process, the system must be configured. On first launch, you will be prompted to create an account and set up your profile. Once this is done, you can configure the available modules. Modules can also be enabled or disabled at any time later.

To enable the VisualCrossing Weather API, you will need to create an API key here.
To enable the Telegram API for real-time messaging, please follow the instructions provided here.

Figure 1 includes a short instructional video to guide you through the process.

User Interface

The UI is developed with ease of use and efficiency as spear points. The UI is web based and runs on the Main Controller. It can be used on desktop, tablet or mobile. The UI roughly consists of three main pages: Automations, Dashboard and Configuration.

Automations page

The Automations page shows an overview of the current automations. Click on an automation tile to edit it or enable/disable it with the toggle.

Over-The-Air Updates

XX

Expand System

XX

Throubleshooting

XX

Roadmap

XX