Revise eWelink Inching Relay documentation#1679
Draft
nouser2013 wants to merge 2 commits into
Draft
Conversation
Added note indicating a change in the hardware making the use of ESPhome impossible. Link to further information added.
✅ Deploy Preview for esphome-devices ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the device documentation for the eWelink 5V/12V Inching Relay to warn readers that newer hardware revisions are no longer ESP-based and therefore cannot run ESPHome.
Changes:
- Adds an “IMPORTANT” note describing the newer Bouffalo-based variant (e.g., BL602 /
EWL-B04) and ESPHome incompatibility. - Links to an external thread with more details on the hardware change and alternatives.
Contributor
There was a problem hiding this comment.
❌ Device configuration checks failed
The automated checks for the device pages in this pull request found 1 issue. Please address the items below and push an update — this review refreshes automatically and will be dismissed once the checks pass.
src/docs/devices/eWelink-5V-12V-Inching-Relay/index.md
- line 46 — added or modified device pages must use
file=- orurl=-based yaml fences — inline yaml is no longer accepted; move the config into a sibling yaml file and reference it. See https://devices.esphome.io/devices/adding-devices#configuration-yaml-files
Need help? See the Adding Devices guide.
Contributor
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Added note indicating a change in the hardware making the use of ESPhome impossible. Link to further information added.
Brief description of the changes
Added link to description of newer hardware -incompatible with ESPhome- on this device.
Type of changes
Checklist:
The rules below are enforced in CI by
npm run validate-devicesandnpm run validate-yaml. The full reference is at Configuration YAML files..yamlfile alongsideindex.mdand is pulled into the page with a fenced block of the form```yaml file=<name>.yaml— no inline yaml on added or modified pages.file=fence on the page referencesconfig.yaml.config.yamlis hardware-only: no top-levelapi:,ota:,mqtt:,web_server:,web_server_idf:,improv_serial:,captive_portal:,bluetooth_proxy:, ordashboard_import:, and noplatform: homeassistant,platform: mqtt, orplatform: templateanywhere in the tree.config.yamlhas awifi:block, it contains only radio tunables (country,power_save_mode,output_power, …) — nossid,password,networks,manual_ip,eap, oruse_address. An emptyap:block is allowed.!secret) onpassword:,*_password:, orpsk:keys, and no!secretreferences anywhere in any example yaml.made-for-esphome: truein frontmatter: at least one```yaml url=…fence points at a.yamlfile in the manufacturer's GitHub repo (github.com/<owner>/<repo>/(blob|raw)/<ref>/<path>.yamlor theraw.githubusercontent.comequivalent) so the rendered page shows the upstream config live.