Skip to content

ZyraX Home is an open-source project combining multiple software packages and electronic components to create a modular smart home platform. The system currently integrates LED strips, sensors, automations, and multiple APIs. In the future, ZyraX Home aims to evolve into a complete, fully-featured home automation ecosystem. Please read README.MD.

License

Notifications You must be signed in to change notification settings

LukedeMunk/zyrax-home-main-controller

Repository files navigation

ZyraX Home | Main controller

ZyraX Home is an open-source platform engineered as a unified smart home system. It provides centralized control and real-time monitoring of home electronics, integrates sensor data, and manages programmable LED lighting. The platform supports extensible modules and automation rules, enabling fine-grained control over connected devices.

banner_image

See documentation/images for more product images.

Note: For those who prefer not to program it themselves, plug-and-play solutions are also available for purchase on ZyraX Home.

Features

ZyraX Home is in early-stage development, with continuous improvements planned. See section 7.2 Roadmap for a complete overview of upcoming features and components. Key features in version 0.9.0 Beta include:

  • Easy device onboarding and configuration
  • Customizable dashboards:
    • Device and group widgets with detailed status and controls
    • Date/time and weather forecast widgets
  • Device grouping:
    • Synchronize devices or assign groups as automation targets
  • RF sensor support. Tested models:
  • Automation engine:
    • Triggers: scheduled events, sensor input
    • Targets: individual devices, device groups
  • Alarm: Alarm can be triggered by RF sensors and can send real-time messages via Telegram
  • Over-The-Air LED strip updates: LED strip firmware can be updated remotely

About the ZyraX Home platform

The ZyraX Home platform is designed for modularity and extensibility, allowing developers to integrate custom devices, extend automation logic, and interface with external APIs.

The vision of the ZyraX Home platform is to provide a high-end, fully integrated smart home experience. Every component, from lighting and sensors to automations and third-party devices/services, will work seamlessly together under a single platform, creating a unified, intelligent home environment. The system aims to combine luxury, flexibility, and advanced functionality, making it easy for users to manage and expand their smart home setup while ensuring reliability and performance.

This main ZyraX Home controller serves as the central interface and management hub for all connected components. It supports integration of modules such as RF sensors, automations and LED strips, with additional modules currently in development.

The controller software is cross-platform and can run on Windows and Linux systems, though a Raspberry Pi is recommended for deployment. This repository includes software and documentation for the main controller.

Other ZyraX Home devices

The platform can integrate with other open-source components developed for the ZyraX Home ecosystem:

1. Bill of Materials

The bill of materials is presented below.

2. Compatible firmware of other ZyraX Home devices

The table below lists the compatible firmware versions for each version of the main controller.

Version Device Compatible firmware versions
v0.9.0 Beta RGBW LED strip controller v0.9.0 Beta

3. Getting Started (Raspberry Pi 4 - Raspbian OS)

These instructions provide an overview for setting up and running the ZyraX Home main controller application.

Note: While the application is compatible with Windows, a Linux environment is recommended for optimal performance.

3.1 Connect RF receiver to Raspberry Pi OS (optional)

Use the schematic to connect the RF receiver to the Raspberry Pi, to be able to connect RF sensors to the system.

schematic

3.2 Make Raspberry Pi OS ready

  1. Flash the Raspi OS Lite (64-bit) image on the SD card (with the imager):
    • Configure OS:
      • Hostname: mastercontroller
      • Username: ZyraXHome
      • Password: Use a strong password (At least one upper case character, one lowercase character, one number and one symbol. At least 8 characters long.)
      • Using Wifi:
        • SSID: Network with internet
        • Password: Password of that network (To connect to a hidden WiFi network after flashing, use sudo raspi-config nonint do_wifi_ssid_passphrase "SSID" "PASSWORD" 1)
      • Enable SSH.
  2. Boot Raspberry Pi and connect with ssh.
    • Use mastercontroller.local
    • Or to find IP:
      • Connect to a monitor with HDMI, login and then: ifconfig
      • Install Advanced IP scanner and do a network scan. Make sure to use the right IP range.

3.3 Install application

  1. Download the latest release.
  2. Run install.sh:
    • sudo sh install.sh
    • Unexpected end of file error? -> sudo dos2unix install.sh
  3. Navigate to mastercontroller.local
  4. (Optional) To configure the weather API, check Visual Crossing website.
  5. (Optional) To configure the Telegram alarm messages, check the Telegram documentation.

Note: When visiting mastercontroller.local, a browser security notification will appear because local SSL keys are being used. This warning can be safely ignored.

4. Configure RF sensors (optional)

A few RF sensors have been tested, but any 433 MHz sensor should work. On the configuration page, you can select the model that matches your sensor, map its RF codes, and use the sensor in automations or with the alarm.

5. Configure ledstrips (optional)

To add new RGBW LED strip controllers to the system, please boot the LED controller (with a compatible firmware version) and connect it to the same network as the main controller.

At the configuration page -> Add device -> Choose device or choose My accessory is not shown here -> Configure options -> Configure LED addressing

6. Documentation

Several documentation files describe this project and system. The list of these files is provided below.

7. Remarks

7.1 Risk assessment

This security risk assessment evaluates potential threats and vulnerabilities related to the Zyrax Home application. The goal is to identify key risks, assess their impact and likelihood, and provide guidance on appropriate mitigation measures. This ensures the application remains secure and reliable for its users.

Threat Effect Vulnerability Probability Impact Mitigation
Unauthorized SSH server access Exposure of credentials, unauthorized access to devices Weak SSH credentials Rare Critical Use of strong SSH credentials
Data exfiltration Exposure of credentials and data Weak encryption Rare Moderate Use of strong encryption and hash algorithms
MITM attacks Exposure of credentials and data Use of HTTP Unlikely Moderate Use of HTTPS

7.2 Roadmap

Below is a roadmap for the ZyraX Home main controller, highlighting the key versions. Minor updates are not included, as listing every change would be impractical. This roadmap is intended as a brainstorming outline, and all features are subject to change. Any suggestions? Please contact Luke de Munk.

Version Expected release Key features
v0.9.0 Beta 10-2025 First public release
v1.0.0 11-2025 User management, login page, improved security
Improved LED strip addressing configuration UI
Improved OTA update functionality
Improved alarm functionality
Device location and location based automation targets
Tap-to-run dashboard shortcut and automation, multiple actions
Scenarios: configure scenarios for LED strip groups
Language pack support
Multiple UI languages
Sender verification (by hash) for HTTPS commands
v1.1.0 2026 Alarm functionality improvements
RF & Zigbee bridge support
Athom GU10 bulb support
iOS app integration
Alarm notifications over MQTT (only with iOS app)
Auto arm/disarm alarm by geofencing (only with iOS app)
v1.2.0 2026 Automatic bluetooth LED strip configuration
v1.3.0 2026 IP camera support
v1.4.0 2026 Data insights (RF sensor data, LED strip data)
Automatic scenarios based on machine learning
v1.5.0 2026 AI chatbot for controlling the system
v1.6.0 2026 AI voice control integration
v1.7.0 2027 ElectriControl support
Improved data insights for electrics
v1.8.0 2027 Smart electronic schemes based on machine learning

8. Issues, recommendations, feedback & security reports

I truly appreciate the opportunity to resolve issues and receive feedback on my work. This is a one-person hobby project into which I've invested many hours. If you have any recommendations, tips, or feedback, please feel free to open an issue or contact me directly.

9. Contributing

When contributing to this repository, please read CONTRIBUTING.md, HTML/CSS/JavaScript conventions and C/C++ conventions.

10. Authors

About

ZyraX Home is an open-source project combining multiple software packages and electronic components to create a modular smart home platform. The system currently integrates LED strips, sensors, automations, and multiple APIs. In the future, ZyraX Home aims to evolve into a complete, fully-featured home automation ecosystem. Please read README.MD.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published