Skip to content

Commit

Permalink
Add guide page, describe LEDs and a button options
Browse files Browse the repository at this point in the history
  • Loading branch information
xyzroe committed Apr 21, 2024
1 parent 10a45da commit cac4d4c
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 2 deletions.
85 changes: 85 additions & 0 deletions docs/guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Device Operation Guide

!!! question "Check your device"
Not all devices with this firmware support an LED and a button. These features are only available on devices that have them physically present.
If your device does not support these features, the corresponding options will not appear in the web interface.

## LED Indicators

There are three LEDs on the device: Power, Mode, and Zigbee. Each LED behaves differently depending on the device's state and configuration.

### Power LED

- **Blinks at 1 Hz (1)**: Indicates no TCP connection in network mode.
{ .annotate }

1. :light_bulb: 1 Hz means the LED blinks once per second.

- **Constantly on**: Signifies an active TCP connection with the Zigbee chip in network mode.

### Mode LED

- **Blinks at 1 Hz (1)**: Active during the Zigbee chip connection check at bridge startup.
{ .annotate }

1. :light_bulb: 1 Hz means the LED blinks once per second.

- **Constantly on**: Indicates USB mode is active.
- **Off**: Indicates network mode is active.
- **Blinks at 3 Hz (1)**: Signals a communication error with the Zigbee chip.
{ .annotate }

1. :light_bulb: 3 Hz means the LED blinks three times per second.

### Zigbee LED

- **Controlled by the Zigbee software**: The state can be toggled from the Tools menu.

### LED Control Options

Through the General menu, you can:

- **Disable either LED**: Completely deactivates the selected LED.
- **Enable Night Mode**: Specify start and end times to completely turn off the LEDs during these periods.

## Button Operations

The device button supports multiple types of presses to manage various functions:

### Types of Button Presses

1. **Short Press (under 3 seconds)**:
- Deactivates the LEDs temporarily (this setting resets upon reboot).


2. **Long Press (over 3 seconds but under 5 seconds)**:
- Switches between network and USB mode.
- The Mode LED will start blinking at 1 Hz (1) to indicate that you can release the button.
{ .annotate }

1. :light_bulb: 1 Hz means the LED blinks once per second.

3. **Extended Press (over 5 seconds)**:
- Activates BSL mode on the Zigbee chip.
- The Mode LED will start blinking at 3 Hz (1) to indicate that you can release the button.
{ .annotate }

1. :light_bulb: 3 Hz means the LED blinks three times per second.

!!! note
This functionality is particularly useful in USB mode with the network disabled.

### Factory Reset

To perform a factory reset:

1. Power off the device.
2. Hold down the button.
3. Power on the device.
4. Release the button when both the Power and Mode LEDs start flashing at 3 Hz(1).
{ .annotate }

1. :light_bulb: 3 Hz means the LED blinks three times per second.

!!! danger "Factory Reset"
Performing a factory reset will erase all your settings and restore the device to its original factory state.
5 changes: 4 additions & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,10 @@ Flash or Find your device using next options:
<span slot="unsupported">Use Chrome Desktop</span>
<span slot="not-allowed">Not allowed to use this on HTTP!</span>
</esp-web-install-button>
<a href="http://xzg.local/"><button class="md-button">OPEN DEVICE</button></a>
<br>
<div>
<a href="http://xzg.local/" target="_blank"><button class="md-button">Open XZG web UI via local network</button></a>
</div>

<br>Powered by <a href="https://esphome.github.io/esp-web-tools/" target="_blank">ESP Web Tools</a><br>

Expand Down
6 changes: 5 additions & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,9 @@ 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. 🌍


!!! success "Begin"
Now you can start from [Guide](/guide)

!!! TO-DO
Write Wiki
Write Wiki
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ nav:
- Web Installer: install.md
- Wiki:
- Quick start: quick-start.md
- Guide: guide.md
- Lifehacks: lifehacks.md
- FAQ: faq.md
- About:
Expand Down

0 comments on commit cac4d4c

Please sign in to comment.