Skip to content

[nrf52] Document optional reset_pin for DFU component #5742

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.

Sign up for GitHub

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

Open
lboue wants to merge 1 commit into
base: next
Choose a base branch
from
Open

[nrf52] Document optional reset_pin for DFU component #5742

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions content/components/nrf52.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ There are two ways to reference GPIO pins:

The `dfu` component enables automatic entry into **DFU (Device Firmware Update)** mode by monitoring
the USB CDC serial connection. When a host opens the port at **1200 baud**, the component triggers
a reset via a GPIO pin to put the device into DFU mode.
a reset to put the device into DFU mode.

ESPHome uses this component internally when uploading firmware via:

Expand All @@ -88,6 +88,8 @@ esphome upload d.yaml

### Example Configuration

With reset pin (recommended):

```yaml
nrf52:
dfu:
Expand All @@ -96,9 +98,16 @@ nrf52:
inverted: true
```

Without reset pin (less reliable):

```yaml
nrf52:
dfu: {}
```

### Configuration variables

- **reset_pin** (*Required*, [Pin](/guides/configuration-types#pin)): The pin to use for trigger a hardware reset. This pin should be connected to the MCU's reset line or to a circuit that causes the bootloader to enter DFU mode after reset.
- **reset_pin** (*Optional*, [Pin](/guides/configuration-types#pin)): The pin to use to trigger a hardware reset. This pin should be connected to the MCU's reset line or to a circuit that causes the bootloader to enter DFU mode after reset. When omitted, the device will attempt to enter DFU mode without a hardware reset, which is less reliable and may require multiple attempts.

## REGOUT0

Expand Down