|
@@ -1,6 +1,6 @@
|
|
|
# ESP Web Tools
|
|
|
|
|
|
-Allow flashing ESPHome or other ESP-based firmwares via the browser. Will automatically detect the board type and select a supported firmware.
|
|
|
+Allow flashing ESPHome or other ESP-based firmwares via the browser. Will automatically detect the board type and select a supported firmware. [See website for full documentation.](https://esphome.github.io/esp-web-tools/)
|
|
|
|
|
|
```html
|
|
|
<esp-web-install-button
|
|
@@ -8,7 +8,7 @@ Allow flashing ESPHome or other ESP-based firmwares via the browser. Will automa
|
|
|
></esp-web-install-button>
|
|
|
```
|
|
|
|
|
|
-Manifest definition:
|
|
|
+Example manifest:
|
|
|
|
|
|
```json
|
|
|
{
|
|
@@ -63,34 +63,6 @@ Manifest definition:
|
|
|
}
|
|
|
```
|
|
|
|
|
|
-## Styling
|
|
|
-
|
|
|
-### Attributes
|
|
|
-
|
|
|
-The following attributes are automatically added to `<esp-web-install-button>` and can be used for styling:
|
|
|
-
|
|
|
-| Attribute | Description |
|
|
|
-| -- | -- |
|
|
|
-| `install-supported` | Added if installing firmware is supported
|
|
|
-| `install-unsupported` | Added if installing firmware is not supported
|
|
|
-
|
|
|
-### CSS custom properties (variables)
|
|
|
-
|
|
|
-The following variables can be used to change the colors of the default UI elements:
|
|
|
-
|
|
|
-- `--esp-tools-button-color`
|
|
|
-- `--esp-tools-button-text-color`
|
|
|
-
|
|
|
-### Slots
|
|
|
-
|
|
|
-The following slots are available:
|
|
|
-
|
|
|
-| Slot name | Description |
|
|
|
-| -- | -- |
|
|
|
-| `activate` | Button to start the flash progress
|
|
|
-| `unsupported` | Message to show when the browser is not supported
|
|
|
-| `not-allowed` | Message to show when not a secure context
|
|
|
-
|
|
|
## Development
|
|
|
|
|
|
Run `script/develop`. This starts a server. Open it on http://localhost:5001.
|