hausmeisterabe/uzg-firmware

Firmware for ZigStar UZG-01

ZigStar UZG-01 Zigbee 3.0 PoE Ethernet USB Adapter's Firmware

This repository contains the latest firmware for the ESP32 peripheral module of UZG-01 Zigbee Ethernet PoE USB Adapter. Firmware is opensource, so feel free to improve it by making a commit to this repository.

KEY FIRMWARE FEATURES

• Change Ethernet/USB adapter mode through firmware or by physical button short press (Red LED On = USB mode, RED LED Off = Ethernet mode);
• Adapter mode selector through web-interface: Zigbee-to-Ethernet, Zigbee-to-USB and Zigbee-to-WiFI;
• Support mDNS autodiscovery in your network (go in the browser to uzg-01.local), in Zigbee2MQTT (set port: mdns://uzg-01), and in ZHA;
• Secure login through username and password;
• Zigbee2MQTT and ZHA config helper;
• Control behavior of LED (you can disable Mode LED, Power LED through firmware, or toggle both by the button long press);
• DHCP or static IP address for Ethernet connection;
• ESP32 (peripheral) and CC2652P (Zigbee) OTA updates, ESP32 and CC2652P restart;
• Switch CC2652P (Zigbee) to flash mode;
• Pairing mode for the adapter in router mode;
• Filter IP addresses for incoming connections to secure your network;
• Fully responsive web interface based on the latest Bootstrap 5.3.
• WireGuard VPN
• MQTT client for gateway monitoring and control

Installation and Configuration

Please refer to the installation and configuration articles in our documentation.
Please follow this link for web-flasher - just plug-and-flash: ZigStar WebFlasher.

Compiling from source

If you made changes to the code and want to compile you own firmware, please do the following:

• Download repository;
• Install Microsoft Visual Code (MVC);
• Install PlatformIO extension to MVC;
• Press "PlatformIO: Build" and wait until firmware.bin is generated;

Contribute

You can contribute to UZG-01 Firmware by

• Providing Pull Requests (Features, Proof of Concepts or Fixes) - please read UZG-01 Firmware's contributing approach here
• Testing newly released features and reporting issues
• Contributing missing documentation;

Credits

People helping to keep the show on the road - developers and contributors:

• @xyzroe for initial firmware released for ZigStar devices and all work being doing till now
• @Tarik2142 for refactoring, code optimizations done under smlight-dev

Special thanks goes also to all authors of 3rd party libraries which are used in this project:

• espressif / arduino-esp32,
• esprfid / esp-rfid,
• fairecasoimeme / zigate-ethernet,
• bblanchon / arduinojson,
• rlogiacco / circularbuffer,
• sstaub / ticker,
• vurtun / lib,
• ciniml / WireGuard-ESP32-Arduino,
• plerup / EspSoftwareSerial,
• marian-craciunescu / ESP32Ping,
• sstaub / Ticker,
• knolleary / PubSubClient,
• ESP Async WebServer,
• Martin-Laclaustra / CronAlarms

License and attribution

UZG-01-Firmware is licensed under GNU General Public License v3. 3rd party libraries that are used by this project are licensed under different license schemes, please check them out as well.
Copyright (c) 2023 ZigStar.
The GNU General Public License v3 ensures that if you use any part of this software in any way, your software must be released under the same license.