Add reference for other enocean gateways #36275
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes involve an update to the documentation for the EnOcean integration within Home Assistant. A new section titled "Unsupported controllers/gateways" has been added, explicitly listing unsupported controllers such as the Eltako FAM14, FGW14-USB, FAM-USB, and FTK14TS, as well as noting gateways based on the ESP2 protocol. The rest of the document remains unchanged, preserving existing information about supported device types, configuration examples, and EnOcean Equipment Profiles (EEPs). Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Integration
User->>Documentation: Check controller compatibility
Documentation->>User: Display supported and unsupported controllers
User->>Integration: Set up EnOcean integration
Integration->>User: Confirm setup
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
source/_integrations/enocean.markdown (1)
29-29: Improve clarity and link descriptionThe added information about controller compatibility is valuable, but the sentence structure could be clearer. Consider this revision:
-The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work. Not all controllers are supported by this integration. You can compare controllers like FAM14, FGW14, FTS14KS and USB300 at this excellent [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). +The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work. Note that not all controllers (such as FAM14, FGW14, FTS14KS) are supported by this integration. For a detailed comparison of available controllers, see the [EnOcean Gateway Comparison Guide](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md).Changes made:
- Combined related sentences for better flow
- Made the list of unsupported controllers parenthetical
- Made the link text more descriptive of its content
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
I can only confirm for sure that FTS14KS did not work with the standard enocean integration. In https://github.com/grimmpp/esp2_gateway_adapter it says “USB300 … which is using ESP3 protocol unlike all other Eltako devices which are using ESP2.”
And on https://github.com/grimmpp/home-assistant-eltako/blob/main/README.md:
* Eltako FAM14 and Eltako FGW14-USB (based on ESP2, rs485 bus and baud rate 57600, uses library eltako14bus<https://github.com/grimmpp/eltako14bus>)
* Eltako FAM-USB (based on ESP2, baud rate 9600, uses library eltako14bus<https://github.com/grimmpp/eltako14bus>)
* EnOcean USB300 (based on ESP3 but only ESP2 feature set supported, baud rate 57600, uses library Python EnOcean<https://github.com/kipe/enocean> and esp2_gateway_adapter<https://github.com/grimmpp/esp2_gateway_adapter>)
* PioTek FAM-USB 515<https://www.piotek.de/FAM-USB-515> (based on ESP3 but only ESP2 feature set supported, baud rate 57600, uses library Python EnOcean<https://github.com/kipe/enocean> and esp2_gateway_adapter<https://github.com/grimmpp/esp2_gateway_adapter>)
* PioTek MGW LAN<https://www.piotek.de/PioTek-MGW-POE> (ESP3 via TCP/LAN, port=5100, uses library Python EnOcean<https://github.com/kipe/enocean> and esp2_gateway_adapter<https://github.com/grimmpp/esp2_gateway_adapter>)
So I guess (but there is no way I can test it) that the enocean integration speaks only ESP3 and that every device speaking ESP2 (all Eltako gateways) is not supported.
If we can get this confirmed, it is surely a very useful information to add to the page.
Van: Franck Nijhof ***@***.***>
Verzonden: woensdag 11 december 2024 8:49
Aan: home-assistant/home-assistant.io ***@***.***>
CC: lvlerber ***@***.***>; Author ***@***.***>
Onderwerp: Re: [home-assistant/home-assistant.io] Add reference for other enocean gateways (PR #36275)
@frenck requested changes on this pull request.
________________________________
In source/_integrations/enocean.markdown<#36275 (comment)>:
@@ -26,7 +26,7 @@ related:
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary.
…-The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work.
+The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work. Not all controllers are supported by this integration. You can compare controllers like FAM14, FGW14, FTS14KS and USB300 at this excellent [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md).
As part of our integration quality scale, we aim to list the supported devices in our documentation.
Can we add it here?
For more information, see also: https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-supported-devices
—
Reply to this email directly, view it on GitHub<#36275 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKCJAVKGDHUILAXPUJ5N5F32E7VANAVCNFSM6AAAAABTLO6Z5CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIOJUGYYDSNBSHE>.
You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/enocean.markdown (2)
29-29: Remove trailing space and consider expanding device compatibility information.The content is accurate, but there's a trailing space at the end of the line that should be removed. Additionally, based on the previous review comment from frenck about the integration quality scale, consider adding a comprehensive list of supported controllers.
-The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work. +The EnOcean integration adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/product/usb-300/) in order for it to work.🧰 Tools
🪛 Markdownlint (0.37.0)
29-29: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
31-38: Add blank line before list and consider restructuring for clarity.The content effectively addresses the need to guide users about unsupported controllers. However, the markdown formatting needs improvement, and the section could be structured more clearly.
## Unsupported controllers/gateways The following gateways are not supported by the integration: -All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). - - Eltako FAM14 - - Eltako FGW14-USB - - Eltako FAM-USB - - Eltako FTK14TS + +All gateways that are based on the ESP2 protocol are not supported. Common examples include: + +- Eltako FAM14 +- Eltako FGW14-USB +- Eltako FAM-USB +- Eltako FTK14TS + +For alternative solutions and a comprehensive guide to controllers and suitable integrations, see this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md).This restructuring:
- Adds required blank lines around lists
- Improves readability by separating the ESP2 protocol information
- Moves the reference link to a dedicated paragraph
- Maintains consistent list formatting
🧰 Tools
🪛 Markdownlint (0.37.0)
34-34: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enocean.markdown(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/enocean.markdown
29-29: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
34-34: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
| ## Unsupported controllers/gateways | ||
|
|
||
| The following gateways are not supported by the integration: | ||
| - All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). |
There was a problem hiding this comment.
We shouldn't be sending users to library documentation. If this is relevant for the user reading this page, we should include it here.
../Frenck
There was a problem hiding this comment.
You're right. The relevant information is that a custom integration exists for the eltako gateways and that the gateways are explicitely listed. So I changed accordingly.
There was a problem hiding this comment.
Let's remove that link in that case, as the main comment still remain :D
| ## Unsupported controllers/gateways | ||
|
|
||
| The following gateways are not supported by the integration: | ||
| - All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). |
There was a problem hiding this comment.
Let's remove that link in that case, as the main comment still remain :D
|
I'm afraid the previous review was not for the latest version (5e718f6). |
What is going to be merged is https://github.com/home-assistant/home-assistant.io/pull/36275/files |
| The following gateways are not supported by the integration: | ||
| - All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). |
There was a problem hiding this comment.
| The following gateways are not supported by the integration: | |
| - All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md). | |
| Gateways that are based on the ESP2 protocol are not supported by this integration, including the devices listed below. For Eltako gateways, there is a custom integration. |
would this be an acceptable alternative?
There was a problem hiding this comment.
It is acceptable; People looking for homeassistant and FTS14KS (for instance) will know they have to search a custom integration. It would have been nice to have a link, but I understand that this is not possible. Do I have to do something now, or will you take it from here?
There was a problem hiding this comment.
Good to know. Thank you for your quick feedback! I will wait also for approval from the reviewers.
There was a problem hiding this comment.
We shouldn't be discussing custom integration in our documentation.
|
Maybe you could consider to make your integration work for ESP2 then. I rest my case.
By the way, I have no idea why this answer still refers to a text that contains the link to the custom integration.
Van: Franck Nijhof ***@***.***>
Verzonden: maandag 14 april 2025 22:14
Aan: home-assistant/home-assistant.io ***@***.***>
CC: lvlerber ***@***.***>; Author ***@***.***>
Onderwerp: Re: [home-assistant/home-assistant.io] Add reference for other enocean gateways (PR #36275)
@frenck commented on this pull request.
________________________________
In source/_integrations/enocean.markdown<#36275 (comment)>:
+The following gateways are not supported by the integration:
+- All gateways that are based on the ESP2 protocol. You can find an excellent guide to controllers and suitable integrations at this [gateway overview](https://github.com/grimmpp/home-assistant-eltako/blob/main/docs/gateways/readme.md).
We shouldn't be discussing custom integration in our documentation.
—
Reply to this email directly, view it on GitHub<#36275 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKCJAVP7UUF6T2WTN2O2XPL2ZQJHJAVCNFSM6AAAAABTLO6Z5CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDONRVGU2DSOBRGM>.
You are receiving this because you authored the thread.Message ID: ***@***.******@***.***>>
|
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit