Skip to content

Commit 8d51828

Browse files
committed
LLDP: tidy, remove enabled setting
Remove mentions of the now-deleted `ethernet.lldp.enabled` setting, general tidy, document minimum useful `lldp: {}` configuration.
1 parent bcdd776 commit 8d51828

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

content/components/ethernet.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,11 @@ If you are using a framework that does not support SPI-based ethernet modules wi
143143

144144
- **id** (*Optional*, [ID](#config-id)): Manually specify the ID used for code generation.
145145

146-
- **lldp** (*Optional*): Configure the Link Layer Discovery Protocol (IEEE 802.1AB) transmitter
146+
- **lldp** (*Optional*): Configure and enable the Link Layer Discovery Protocol (IEEE 802.1AB) transmitter. The simplest useful configuration is `lldp: {}`, which enables transmission with the default settings.
147147

148-
- **enabled** (*Optional*, boolean): set to `true` to enable LLDP transmission. The default values for the other LLDP
149-
settings should be suitable for most users.
150-
- **port** (*Optional*, string): Override the default Port-ID TLV value (default: `ETH_DEF`, 128 character maximum).
151-
- **system_name** (*Optional*, string): Override the default System Name TLV (defaults to the value of `esphome.name`, 128 character maximum).
152-
- **system_description** (*Optional*, string): Override the default System Description TLV (default is the combination of
148+
- **port** (*Optional*, string): Override the Port-ID TLV value (default: `ETH_DEF`, 128 character maximum).
149+
- **system_name** (*Optional*, string): Override the System Name TLV (defaults to the value of `esphome.name`, 128 character maximum).
150+
- **system_description** (*Optional*, string): Override the System Description TLV (default is the combination of
153151
`esphome.project.name` and `esphome.project.version` if these are set, otherwise of the form `ESPHome.io
154152
<esphome-version> <board-name>`, 128 character maximum).
155153
- **tx_fast_count** (*Optional*, int): number of packets to burst upon startup or reconnect (1-8, default 4)
@@ -355,11 +353,12 @@ ethernet:
355353

356354
**QEMU qemu-system-xtensa with LLDP enabled**:
357355

356+
LLDP transmission enabled with default settings.
357+
358358
```yaml
359359
ethernet:
360360
type: OPENETH
361-
lldp:
362-
enabled: true
361+
lldp: {}
363362
```
364363

365364
**Waveshare ESP32-S3-ETH PoE**:

0 commit comments

Comments
 (0)