Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new OTA method #754

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions src/docs/devices/AC-DC-ESP32-Relay-x4/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,23 @@ If you'll power it up with 3.3V on 5V pin - the MCU will brownout.

```yaml
esphome:
name: ac-dc-relay-x4
friendly_name: ac-dc-relay-x4

esp32:
board: esp32dev
framework:
type: arduino
name: example-device
friendly_name: Example Device

# OTA flashing
ota:
- platform: esphome

wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:

# Enabling the logging component
logger:

# Enable Home Assistant API
api:

output:
- platform: gpio
Expand Down
35 changes: 15 additions & 20 deletions src/docs/devices/AGL-2-3-Gang-Switch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,33 +52,28 @@ PCB
## Basic Configuration (2-Gang)

```yaml
esphome:
name: agl-2-gang-switch
friendly_name: AGL 2 Gang Switch

esp8266:
board: esp01_1m

# Enable logging
logger:

wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
esphome:
name: example-device
friendly_name: Example Device
platform: ESP8266
board: esp01_1m

# OTA flashing
ota:
- platform: esphome

# Enable fallback hotspot (captive portal) in case wifi connection fails
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:
ssid: "ESPHOME"
password: "12345678"

# Enabling the logging component
logger:

# Enable Home Assistant API
api:
reboot_timeout: 15min
encryption:
key: !secret api_encryption_key

ota:
password: !secret ota_password

sensor:
- platform: uptime
Expand Down
23 changes: 8 additions & 15 deletions src/docs/devices/AHRise-AHR-083/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,28 +35,21 @@ esphome:
platform: ESP8266
board: esp01_1m
esp8266_restore_from_flash: true

# OTA flashing
ota:
- platform: esphome

# WiFi connection
wifi:
ssid: !secret iot_wifi_ssid
password: !secret iot_wifi_password
power_save_mode: none
fast_connect: true
# Enable fallback hotspot (captive portal) in case wifi connection fails
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:
ssid: "${displayname}"
password: !secret ap_mode_password

captive_portal:

# Enable logging
# Enabling the logging component
logger:

# Enable Home Assistant API
api:
reboot_timeout: 0s
encryption:
key: !secret api_encryption_key

text_sensor:
- platform: wifi_info
Expand Down
24 changes: 11 additions & 13 deletions src/docs/devices/Acenx-SOP04-US/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,26 @@ substitutions:
friendly_name: Acenx SOP04-US

esphome:
name: "${device_name}"
name: example-device
friendly_name: Example Device
platform: ESP8266
board: esp01_1m

wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
board: esp01_1m
# OTA flashing
ota:
- platform: esphome

# Enable fallback hotspot (captive portal) in case wifi connection fails
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:
ssid: "${device_name} Fallback Hotspot"
password: !secret wifi_fallback_pw

# Enable logging
# Enabling the logging component
logger:

# Enable Home Assistant API
api:

ota:
password: !secret ota

binary_sensor:
- platform: gpio
pin:
Expand Down
21 changes: 12 additions & 9 deletions src/docs/devices/AirGradient-DIY/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,25 @@ If you have multiple sensor boards, you will likely need to make each sensor nam

```yaml
esphome:
name: airgradient
name: example-device
friendly_name: Example Device
platform: ESP8266
board: d1_mini

# OTA flashing
ota:
- platform: esphome

wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:

# Enable logging
# Enabling the logging component
logger:

# Enable Home Assistant API
api:
encryption:
key: !secret api_encryption_key

ota:
password: ""

captive_portal:

i2c:
sda: D2
Expand Down
24 changes: 12 additions & 12 deletions src/docs/devices/Alfawise-SJ-7/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@ esphome:
- switch.turn_on: wifi_blinkin_slow
- delay: 5s
- switch.turn_off: wifi_blinkin_slow

# OTA flashing
ota:
- platform: esphome

wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:

# Enable Home Assistant API
api:

esp8266:
board: esp01_1m
Expand All @@ -82,9 +94,6 @@ logger:
level: debug
esp8266_store_log_strings_in_flash: False

ota:
password: "xxx"

uart:
id: uart_bus
tx_pin: GPIO1
Expand All @@ -100,15 +109,6 @@ uart:
# sequence:
# - lambda: UARTDebug::log_hex(direction, bytes, ':');

wifi:
ssid: "xxx"
password: "xxx"

# Enable fallback hotspot (captive portal) in case wifi connection fails
ap:
ssid: "${friendly_name} Fallback Hotspot"
password: "xxx"
api:
web_server:
port: 80

Expand Down
29 changes: 7 additions & 22 deletions src/docs/devices/Aoycocr-EU6S/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,35 +35,20 @@ esphome:
esp8266:
board: esp8285

# Enable logging
logger:
# OTA flashing
ota:
- platform: esphome

# WiFi connection
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:
ssid: ${device_name}_fallback
password: !secret ap_password
ap_timeout: 1min
use_address: ${device_name}.local
manual_ip:
static_ip: 192.168.XXX.XX
gateway: 192.168.XXX.X
subnet: 255.255.255.0

captive_portal:
# Enable logging
# Enabling the logging component
logger:

# Enable Home Assistant API
api:
encryption:
key: !secret encryption_key

# Enable over-the-air updates
ota:
password: !secret ota_password

web_server:
port: 80
Expand Down
23 changes: 9 additions & 14 deletions src/docs/devices/Aoycocr-X10S-Plug/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,22 @@ esphome:
platform: ESP8266
board: esp01_1m
esp8266_restore_from_flash: true #writes each state change to flash for switch or light with restore_mode: RESTORE_DEFAULT_OFF/ON, see https://esphome.io/components/esphome.html#esp8266-restore-from-flash
# OTA flashing
ota:
- platform: esphome

wifi:
ssid: !secret wifissid
password: !secret wifipass
fast_connect: on #we only have one WiFi AP so just use the first one that matches
ap: #since we listed an SSID above, this AP mode will only enable if no WiFi connection could be made
ssid: ${friendly_name}_AP
password: !secret wifipass
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:

captive_portal:
# Enable Home Assistant API
api:

# Enable logging
logger:
baud_rate: 0 #disable UART logging

# Enable Home Assistant API
api:

# Enable OTA updates
ota:

# Enable web server
web_server:
port: 80
Expand Down
21 changes: 10 additions & 11 deletions src/docs/devices/Aoycocr-X13-Outdoor-Plug-2AKBP-X13/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,22 +72,21 @@ esphome:
platform: ESP8266
board: esp01_1m
arduino_version: [email protected]

# OTA flashing
ota:
- platform: esphome

wifi:
ssid: !secret ssid
password: !secret ssid_password
use_address: "$devicename.home"

# Enable fallback hotspot (captive portal) in case wifi connection fails
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:
ssid: "$proper_devicename Hotspot"
password: !secret ap_password


captive_portal:
# Enabling the logging component
logger:

# Enable Home Assistant API
api:
ota:

# https://tasmota.github.io/docs/Components/
# https://templates.blakadder.com/aoycocr_X13.html
Expand Down
26 changes: 10 additions & 16 deletions src/docs/devices/AquaPing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,27 +31,21 @@ esphome:

esp8266:
board: d1_mini

# OTA flashing
ota:
- platform: esphome

# Enable logging
wifi: # Your Wifi network details

# Enable fallback hotspot in case wifi connection fails
ap:

# Enabling the logging component
logger:

# Enable Home Assistant API
api:
encryption:
key: ""

ota:

wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password

# Enable fallback hotspot (captive portal) in case wifi connection fails
ap:
ssid: ""
password: ""

captive_portal:

binary_sensor:
- platform: gpio
Expand Down
Loading
Loading