Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 5.16 KB

README.md

File metadata and controls

110 lines (79 loc) · 5.16 KB

XZG Firmware

GitHub version GitHub Actions Workflow Status GitHub download GitHub Issues or Pull Requests License


XZG logo

XZG Firmware unifies the best innovations from
previous Zigbee gateway projects into a single, comprehensive solution.

By focusing the community's efforts on enhancing one product, XZG aims to streamline development,
thereby improving the capabilities and efficiency of your Zigbee Gateways. 🌍


🍓 Firmware features

Visit features page to get information

XZG.mp4

📔 Documentation

Visit Wiki page to get information

🚀 Installation

For a quick setup, use XZG Web Flasher for an easy plug-and-flash experience.

Please follow the installation guide tailored to your hardware.

🛠️ Compiling from source

Local

  • You need npm and Python installed
  • Install Visual Studio Code (VSC)
  • Install PlatformIO extension to VSC
  • Clone this repository
    git clone --recurse-submodules https://github.com/xyzroe/XZG.git
  • Open XZG.code-workspace in VSC
  • Press "PlatformIO: Build" and wait until XZG*.bin are generated

Github

  • Fork this repository;
  • Made your changes;
  • Push a new tag to run workflow;
  • Just wait and get new release;

Gitpod

Open in Gitpod

🖥️ Contribute

Contributions are welcome! If you'd like to help improve the XZG Firmware, you can:

  • Provide Pull Requests with enhancements or fixes. Please see our contribution guidelines.
  • Test newly released features and report issues.
  • Help expand our documentation for better user support.

🎉 Credits

Active Contributors of xyzroe/XZG - Last 28 days

Thanks to all the developers and contributors who make this project possible, and special thanks to @mercenaruss for Zig Star devices development.

All contributors:

Special thanks to all third-party library authors. Their work has significantly contributed to this project:

📄 License

XZG Firmware is released under the GNU General Public License v3.0. See the LICENSE file for more details.

Third-party libraries used in this project are under their respective licenses. Please refer to each for more information.


Created with ❤️ by xyzroe © 2024