Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@xyzroe
xyzroe committed May 10, 2024
1 parent e885ae9 commit ac8a81c
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 59 deletions.
56 changes: 0 additions & 56 deletions docs/capabilities.md
View file

This file was deleted.

57 changes: 57 additions & 0 deletions docs/features.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@

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 features and efficiency of your Zigbee Gateways. 🌍



<div class="badges">
<img src="https://img.shields.io/badge/Visual%20Studio%20Code-007ACC?logo=visualstudiocode&logoColor=fff&style=plastic" alt="Visual Studio Code Badge">
<img src="https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=fff&style=plastic" alt="npm Badge">
<img src="https://img.shields.io/badge/Arduino-00878F?logo=arduino&logoColor=fff&style=plastic" alt="Arduino Badge">
<img src="https://img.shields.io/badge/JSON-000?logo=json&logoColor=fff&style=plastic" alt="JSON Badge">
<img src="https://img.shields.io/badge/gulp-CF4647?logo=gulp&logoColor=fff&style=plastic" alt="gulp Badge">
<img src="https://img.shields.io/badge/Bootstrap-7952B3?logo=bootstrap&logoColor=fff&style=plastic" alt="Bootstrap Badge">
<img src="https://img.shields.io/badge/jQuery-0769AD?logo=jquery&logoColor=fff&style=plastic" alt="jQuery Badge">
<img src="https://img.shields.io/badge/i18next-26A69A?logo=i18next&logoColor=fff&style=plastic" alt="i18next Badge">
<img src="https://img.shields.io/badge/GitHub%20Actions-2088FF?logo=githubactions&logoColor=fff&style=plastic" alt="GitHub Actions Badge">
</div>


## 🍓 Key features

| | |
| :-------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Localized Translation | <div class="badges">🇬🇧 🇺🇦 🇨🇳 🇪🇸 🇵🇹 🇷🇺 🇫🇷 🇩🇪 🇯🇵 🇹🇷 🇮🇹 🇵🇱</div> |
| Zigbee OTA | Install new Zigbee firmware or change role <span style="color:red">Coordinator</span> / <span style="color:green">Router</span> / <span style="color:blue">OpenThread</span> using **only the Web UI** of your gateway 🚀 |
| NVRAM | Erase NVRAM using **only the Web UI** of your gateway 🎉 |
| Web UI theme | 🌞 Light *or* Dark 🌑 |
| Zigbee mode | :material-lan: Network *or* USB :fontawesome-brands-usb: |
| Network mode | :material-ethernet: RJ45 **and** Wi-Fi :material-wifi: *(simultaneously)* |
| VPN support | :simple-wireguard: WireGuard |
| MQTT client | :simple-mqtt: Publish gateway states to brokers and subscribes for commands |
| Access point | :material-antenna: If there isn't available any wire and wireless connection |
| NTP client | :material-clock: Yes |
| Custom DNS servers | :material-dns: Yes *(when DHCP is **off**)*, Ethernet and WiFi |
| Realtime web updates | :material-run-fast: Without page refreshing |
| Button | :material-button-pointer: Change current modes, factory reset :material-factory: |
| LEDs | :material-led-on: Different blinks helps to indicate current mode |
| Disable LEDs modes | :material-led-variant-off: Full disable and Night :material-weather-night: |
| Code | XZG is developed, coded and tested in Ukraine 🇺🇦 |
| Build | :fontawesome-brands-github: All builds are published using GitHub Actions. No more manual publishing of binaries. |

## 🎮 Supported devices

| | Button | Custom LEDs | Remote Network / USB mode selection |
| :-------------- | :----------------: | :----------------: | :---------------------------------: |
| [UZG-01]() | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [SLZB-06]() | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [Olizig PoE]() | :no_entry: | :no_entry: | :no_entry: |
| [LilyZig PoE]() | :no_entry: | :no_entry: | :no_entry: |
| [ZigStar LAN]() | :no_entry: | :no_entry: | :no_entry: |






2 changes: 1 addition & 1 deletion mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ extra_css:

nav:
- Home: index.md
- Capabilities: capabilities.md
- Features: features.md
- Web Installer: install.md
- Wiki:
- Quick start: quick-start.md
Expand Down
4 changes: 2 additions & 2 deletions overrides/home.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
</div>
<div class="mdx-hero__content">
<h1>XZG Firmware</h1>
<a href="/quick-start" title="Wiki" class="md-button md-button--primary">
Wiki
<a href="/features" title="Wiki" class="md-button md-button--primary">
Features
</a>
</div>
</div>
Expand Down

0 comments on commit ac8a81c

Please sign in to comment.