[openthread] add mesh_local_eid openthread_info sensor#6059
[openthread] add mesh_local_eid openthread_info sensor#6059mrene wants to merge 1 commit intoesphome:nextfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation for exposing the OpenThread Mesh-Local EID as a new openthread_info text sensor, enabling users to reference a stable IPv6 unicast address for device-to-device communication within a Thread mesh.
Changes:
- Extend the
openthread_infotext sensor YAML example to includemesh_local_eid. - Document the new
mesh_local_eidconfiguration option and its purpose.
| - **mesh_local_eid** (*Optional*): Expose the Mesh Local EID (Endpoint Identifier) address as a text sensor. This is | ||
| an IPv6 address unique to the device within the Thread mesh, used for communication between Thread devices | ||
| regardless of network topology changes. | ||
| All options from [Text Sensor](/components/text_sensor#config-text_sensor). |
There was a problem hiding this comment.
Thread/OpenThread terminology is typically written as “Mesh-Local EID”. Consider updating the heading text and example name to use the hyphenated form (and keep it consistent across the page) to match the spec and avoid confusion with other mesh-local concepts.
| pan_id: | ||
| name: "Thread PAN ID" | ||
| mesh_local_eid: | ||
| name: "Thread Mesh Local EID" |
There was a problem hiding this comment.
The YAML example order is inconsistent with the configuration-variable list below (example places mesh_local_eid after pan_id, but the docs describe mesh_local_eid before pan_id). Please reorder one of the sections so the option ordering matches throughout the page (easier to scan and avoids implying a different underlying order).
| pan_id: | |
| name: "Thread PAN ID" | |
| mesh_local_eid: | |
| name: "Thread Mesh Local EID" | |
| mesh_local_eid: | |
| name: "Thread Mesh Local EID" | |
| pan_id: | |
| name: "Thread PAN ID" |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
1 participant
The Mesh-Local EID is an ipv6 unicast address that remains stable after an openthread device joins a network. This exposes it as an openthread_info diagnostic sensor.
It should then be possible to perform direct udp communication between devices.
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/_index.mdwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/static/images/folder of this repository.Use the image in your component's index table entry in
/components/_index.md.Example: For a component called "DHT22 Temperature Sensor", use: