Skip to content

Commit

Permalink
WebUI -> Frontend. Koenkk#991
Browse files Browse the repository at this point in the history
  • Loading branch information
Koenkk committed Nov 5, 2021
1 parent 9935518 commit 4ed536e
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/devices/E1744.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ pageClass: device-page
Press the button on the device 4 times (until the red light turns on).

### Binding
If you want to [bind](../guide/usage/binding.md) this remote directly to a group or light, bind cluster `LevelCtrl` only (**not** `LevelCtrl` and `OnOff`). If both clusters are bound, a click on the remote toggles the bound group or light twice, thus neither turning it on or off. Cluster-specific binding is most easily done in the [frontend](../guide/configuration/webui.md).
If you want to [bind](../guide/usage/binding.md) this remote directly to a group or light, bind cluster `LevelCtrl` only (**not** `LevelCtrl` and `OnOff`). If both clusters are bound, a click on the remote toggles the bound group or light twice, thus neither turning it on or off. Cluster-specific binding is most easily done in the [frontend](../guide/configuration/frontend.md).


### Legacy integration
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ next: adapter-settings.md
# Configuration

Zigbee2MQTT is configured using [YAML](https://en.wikipedia.org/wiki/YAML) based `configuration.yml` file.
The file have to be located in the `data` directory within your installation. The `data` directory and the `configuration.yml` has to be writeable for Zigbee2MQTT process because it can get updated - e.g. if you change the settings in the WebUI. It's possible specify a custom data directory by setting the `ZIGBEE2MQTT_DATA` environment variable.
The file have to be located in the `data` directory within your installation. The `data` directory and the `configuration.yml` has to be writeable for Zigbee2MQTT process because it can get updated - e.g. if you change the settings in the frontend. It's possible specify a custom data directory by setting the `ZIGBEE2MQTT_DATA` environment variable.

```yaml
# Minimal configuration.yml example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebarDepth: 1
---

# WebUI
# Frontend
::: tip
Ongoing discussion about the frontend can be found [here](https://github.com/Koenkk/zigbee2mqtt/issues/4266)
:::
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ mqtt:
# Zigbee Adapter path
serial:
port: /dev/ttyUSB0
# Enable the Zigbee2MQTT WebUI
# Enable the Zigbee2MQTT frontend
frontend:
port: 8080
# Let Zigbee2MQTT generate a new network key on first start
Expand All @@ -123,7 +123,7 @@ $ docker-compose logs -f
```

After some short time you should see some log messages that Mosquitto and Zigbee2MQTT is running now.
You can open the WebUI using [http://localhost:8080](http://localhost:8080) (or the hostname of your remote server).
You can open the frontend using [http://localhost:8080](http://localhost:8080) (or the hostname of your remote server).

We can now go on and pair our first device.

Expand All @@ -134,7 +134,7 @@ Search the [supported devices](../../supported-devices/) for your device and fol

If no instructions are available, the device can probably be paired by factory resetting it.

Once you see something similar to below in the log your device is paired and you can start controlling it using the WebUI and MQTT messages.
Once you see something similar to below in the log your device is paired and you can start controlling it using the frontend and MQTT messages.

```
Zigbee2MQTT:info 2019-11-09T12:19:56: Successfully interviewed '0x00158d0001dc126a', device has successfully been paired
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/usage/integrations/home_assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To achieve the best possible integration (including MQTT discovery):

## Device/group page
Since Home Assistant 2021.11 the device/group page in Home Assistant can directly link to the frontend (*Visit device* button).
To enable this set the `url` in the [WebUI](../../configuration/webui.md) configuration.
To enable this set the `url` in the [frontend](../../configuration/frontend.md) configuration.

## Home Assistant device registry
When using Home Assistant MQTT discovery, Zigbee2MQTT integrates
Expand Down
4 changes: 2 additions & 2 deletions docs/information/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
head:
- - meta
- http-equiv: refresh
content: 0; URL=https://www.zigbee2mqtt.io/guide/configuration/webui.html
content: 0; URL=https://www.zigbee2mqtt.io/guide/configuration/frontend.html
- - link
- rel: canonical
href: https://www.zigbee2mqtt.io/guide/configuration/webui.html
href: https://www.zigbee2mqtt.io/guide/configuration/frontend.html
---
2 changes: 1 addition & 1 deletion sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export const sidebar: SidebarConfig = {
'/guide/configuration/adapter-settings.md',
'/guide/configuration/mqtt.md',
'/guide/configuration/zigbee-network.md',
'/guide/configuration/webui.md',
'/guide/configuration/frontend.md',
'/guide/configuration/devices-groups.md',
'/guide/configuration/logging.md',
'/guide/configuration/block-pass-list.md',
Expand Down

0 comments on commit 4ed536e

Please sign in to comment.