Skip to content

Commit

Permalink
update readme ins usage of https
Browse files Browse the repository at this point in the history
  • Loading branch information
DutchmanNL committed Nov 16, 2023
1 parent e07f3d3 commit a04a200
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ All our adapter documentation can be found at [The DrozmotiX Docu Page](https://
* For admin tabs (optional)
* ESPHome Dashboard IP is provided in instance settings

## Using the built-in ESPHome Dashboard
You can either use an external installation of ESPHome (like docker) or activate the ESPHome Dashboard process included in this adapter.
In any case, it is possible to integrate the dashboard into ioBroker Admin interface, for this purpose you must specify the ip where the Dashboard is running

![Logo](admin/img/ESPhomeDashboardIP.png)

> [!IMPORTANT]
> is currently not possible to show the ESPHome DashBoard integrated in ioBroker when https is enabled, see [#159](https://github.com/DrozmotiX/ioBroker.esphome/issues/159)
## How to use this adapter

### Activate API in YAML
> [!IMPORTANT]
> ioBroker ESPHome allows to integrate Devices by Encryption Key (recommended) or API-Password (legacy),
Expand Down Expand Up @@ -85,7 +96,7 @@ Please enter IP-Address (if a device is already known, you can select it from th
- Will send a message to the backend to remove this device

> [!WARNING]
> THis action will remove selected device and all its related states from ioBroker!
> This action will remove a selected device and all its related states from ioBroker!
> [!NOTE]
> After a device has been added, a message will be indicated if successfully or error,
Expand Down
2 changes: 1 addition & 1 deletion admin/i18n/en/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"lblConnectDetails-Line-2": "After adding an api: line to your ESPHome configuration you can go to this page and and wait for the ESPHome device to show up under the discovered devices section (can take up to 5 minutes) or add the device manually by choosing “add Device” from the devices overview and entering “<NODE_NAME>.local” or the IP address of the unit in the “Host” field.",
"lblConnectDetails-Line-3": "The ESPHome native API is based on a custom TCP protocol using protocol buffers. You can find the protocol data structure definitions here:",
"lblConnectIobroker": "ioBroker communicates directly by Native API instead of MQTT to provide you the best possible experience and support of encryption keys (recommend) instead of API/MQTT passwords",
"lblDashboardLink": "To show ESPHome dashboard in ioBroker admin tab, its required to provide the IP-Ares on which installation its running",
"lblDashboardLink": "To show ESPHome dashboard in ioBroker admin tab, its required to provide the IP-Ares on which installation its running. Https is currently not supported",
"lblDefaultCredentials": "Default API / Encryption keys settings devices (not recommended)",
"lblDefaultCredentials-Line-1": "Each devices should have its own unique encryption Key (recommended) or API password, device discovery (when enabled) detects all devices and tries to connect with credentials below",
"lblDefaultCredentials-Line-2": "If you assign an unique encryption key (recommended) or API password, new devices will show up on Discovered Devices tab (or must be added) and you must provide the unique credentials manually",
Expand Down
Binary file added admin/img/ESPhomeDashboardIP.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a04a200

Please sign in to comment.