Documentation for Ekey Bionyx Integration #37646
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
2a02f3a to
18ae218
Compare
18ae218 to
9884dbc
Compare
9884dbc to
5915155
Compare
📝 WalkthroughWalkthroughA new documentation file for the Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 2
🧹 Nitpick comments (6)
source/_integrations/ekeybionyx.markdown (6)
17-17: Fix missing preposition for clarity.
Add "to" in the sentence for proper grammar.-The `ekeybionyx` integration allows you get events from your [ekey fingerprint reader](https://www.ekey.net) to Home Assistant. +The `ekeybionyx` integration allows you to get events from your [ekey fingerprint reader](https://www.ekey.net) to Home Assistant.🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Possible missing preposition found.
Context: ...Theekeybionyxintegration allows you get events from your [ekey fingerprint read...(AI_HYDRA_LEO_MISSING_TO)
27-28: Unify casing and punctuation in limitation bullets.
Make list items consistent in case and style:-- Ekey allows only 5 Webhooks per Device -- You cannot link multiple HA instances to the same ekey System +- Ekey allows only five webhooks per device +- You cannot link multiple Home Assistant instances to the same ekey system
32-33: Simplify and punctuate the installation sentence.
Refactor for brevity and consistent API casing:-In order to use the integration the ekey device needs to be set up in **plus mode** and the ekey Bionyx Third Party Api needs to be enabled in the App. +To use the integration, the ekey device must be set up in **Plus mode**, and the ekey Bionyx third party API must be enabled in the app.
34-34: Enhance image alt text for accessibility.
Provide a more descriptive alt text rather than the filename:- +
36-36: Add comma and improve phrasing.
Combine sentences and remove repetition:-After setting up Home Assistant you need to go to the app and manually assign the created Events to fingers that will trigger them. +After setting up Home Assistant, go to the ekey Bionyx app and manually assign the created events to the fingers that will trigger them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...d_party_api.png) After setting up Home Assistant you need to go to the app and manually ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...g) After setting up Home Assistant you need to go to the app and manually assign the c...(REP_NEED_TO_VB)
42-43: Clarify and unify uninstallation steps.
Improve grammar, replace abbreviations, and use US spelling:-- Delete from HA and then turn the API off and on again in the App. (all webhooks will be reset even outside of HA) -- Delete from HA, Set it up again in HA (it will go through the deletion process) and confirm the deletion in the App afterwards. +- Delete the integration from Home Assistant, then toggle the API off and on in the app (this resets all webhooks, even outside of Home Assistant). +- Delete the integration from Home Assistant, set it up again (it will go through the deletion process), and confirm the deletion in the app afterward.🧰 Tools
🪛 LanguageTool
[locale-violation] ~43-~43: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.(AFTERWARDS_US)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
source/images/integrations/ekeybionyx/activate_third_party_api.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_integrations/ekeybionyx.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ekeybionyx.markdown
[uncategorized] ~17-~17: Possible missing preposition found.
Context: ...The ekeybionyx integration allows you get events from your [ekey fingerprint read...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~31-~31: Consider a more concise word here.
Context: ...y System ## Installation Instructions In order to use the integration the ekey device nee...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...d_party_api.png) After setting up Home Assistant you need to go to the app and manually ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~36-~36: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...g) After setting up Home Assistant you need to go to the app and manually assign the c...
(REP_NEED_TO_VB)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...s Based on the limited lifetime of the token you have 2 options of cleanly resetting...
(AI_HYDRA_LEO_MISSING_COMMA)
[locale-violation] ~43-~43: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.
(AFTERWARDS_US)
🔇 Additional comments (1)
source/_integrations/ekeybionyx.markdown (1)
1-15: Verify front matter keys against documentation standards.
The YAML front matter usesha_category, which may not be recognized by the documentation generator. Confirm you’re using the correct keys (e.g.,ha_component_category) as per Home Assistant docs guidelines.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/ekeybionyx.markdown (5)
17-17: Fix missing preposition in introductory sentence.
Add "to" after "allows you" for grammatical correctness.-The `ekeybionyx` integration allows you get events from your [ekey fingerprint reader](https://www.ekey.net) to Home Assistant. +The `ekeybionyx` integration allows you to get events from your [ekey fingerprint reader](https://www.ekey.net) to Home Assistant.🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: Possible missing preposition found.
Context: ...Theekeybionyxintegration allows you get events from your [ekey fingerprint read...(AI_HYDRA_LEO_MISSING_TO)
25-29: Standardize bullet formatting and capitalization.
Use lowercase for "webhooks", "device", and "system", and consider spelling out small numbers for consistency with style.-## Current Limitations - -- Ekey allows only 5 Webhooks per Device -- You cannot link multiple HA instances to the same ekey System +## Current Limitations + +- Ekey allows only five webhooks per device +- You cannot link multiple HA instances to the same ekey system
31-34: Improve sentence structure and API capitalization.
Add a comma after "integration", update "Api" to "API", and lowercase "app" for consistency.-In order to use the integration the ekey device needs to be set up in **plus mode** and the ekey Bionyx Third Party Api needs to be enabled in the App. +To use the integration, the ekey device needs to be set up in **plus mode**, and the ekey Bionyx Third Party API needs to be enabled in the app.Also update the image alt text:
- +🧰 Tools
🪛 LanguageTool
[style] ~31-~31: Consider a more concise word here.
Context: ...y System ## Installation Instructions In order to use the integration the ekey device nee...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...ation Instructions In order to use the integration the ekey device needs to be set up in *...(AI_HYDRA_LEO_MISSING_COMMA)
40-40: Clarify grammar and event labeling.
Add a comma after the introductory clause and lowercase "Events".-After setting up Home Assistant you need to go to the app and manually assign the created Events to fingers that will trigger them. +After setting up Home Assistant, you need to go to the app and manually assign the created events to fingers that will trigger them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: A comma might be missing here.
Context: ...ve. {% endtip %} After setting up Home Assistant you need to go to the app and manually ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...%} After setting up Home Assistant you need to go to the app and manually assign the c...(REP_NEED_TO_VB)
44-47: Polish uninstallation instructions.
Ensure commas and capitalization are consistent, replace numerals under ten with words, and improve readability of parentheticals.-Based on the limited lifetime of the token you have 2 options of cleanly resetting the connection to Home Assistant: +Based on the limited lifetime of the token, you have two options for cleanly resetting the connection to Home Assistant: -- Delete the integration from Home Assistant, then turn the API off and on again in the app. All webhooks will be reset, even outside of HA. -- Delete the integration from Home Assistant, set it up again in Home Assistant (which will trigger deletion), and then confirm the deletion in the app afterward.🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...s Based on the limited lifetime of the token you have 2 options of cleanly resetting...(AI_HYDRA_LEO_MISSING_COMMA)
[locale-violation] ~47-~47: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.(AFTERWARDS_US)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/ekeybionyx.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ekeybionyx.markdown
[uncategorized] ~17-~17: Possible missing preposition found.
Context: ...The ekeybionyx integration allows you get events from your [ekey fingerprint read...
(AI_HYDRA_LEO_MISSING_TO)
[style] ~31-~31: Consider a more concise word here.
Context: ...y System ## Installation Instructions In order to use the integration the ekey device nee...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~32-~32: Possible missing comma found.
Context: ...ation Instructions In order to use the integration the ekey device needs to be set up in *...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~40-~40: A comma might be missing here.
Context: ...ve. {% endtip %} After setting up Home Assistant you need to go to the app and manually ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...%} After setting up Home Assistant you need to go to the app and manually assign the c...
(REP_NEED_TO_VB)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...s Based on the limited lifetime of the token you have 2 options of cleanly resetting...
(AI_HYDRA_LEO_MISSING_COMMA)
[locale-violation] ~47-~47: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.
(AFTERWARDS_US)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/ekeybionyx.markdown (4)
1-15: Frontmatter looks correct.
The metadata fields (title, description, category, codeowners, etc.) follow Home Assistant documentation standards and include all required keys.
19-19: Config flow include is correctly added.
This ensures the integration’s configuration UI steps are documented.
21-23: Event Platform section is clear.
The heading and description accurately explain how webhooks map to Home Assistant events.
36-38: Tip block is informative.
The performance recommendation is clear, concise, and follows tip formatting conventions.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/ekeybionyx.markdown (4)
17-17: Refine wording for clarity.
Consider rephrasing to emphasize that Home Assistant receives the events, e.g.:- The `ekeybionyx` integration allows you to get events from your [ekey fingerprint reader](https://www.ekey.net) to Home Assistant. + The `ekeybionyx` integration allows Home Assistant to receive events from your [ekey fingerprint reader](https://www.ekey.net).
46-46: Use consistent terminology and improve clarity.
Replace abbreviations and refine the first reset option for readability:- Delete from HA and then turn the API off and on again in the App. (all webhooks will be reset even outside of HA) + Delete the integration in Home Assistant, then disable and re-enable the Third Party API in the ekey app. This resets all webhooks.
47-47: Fix grammar and American English usage.
Improve the second reset option and use “afterward”:- Delete from HA, Set it up again in HA (it will go through the deletion process) and confirm the deletion in the App afterwards. + Delete the integration in Home Assistant, set it up again (triggering the deletion process), and confirm the deletion in the ekey app afterward.🧰 Tools
🪛 LanguageTool
[locale-violation] ~47-~47: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.(AFTERWARDS_US)
🪛 markdownlint-cli2 (0.17.2)
47-47: Files should end with a single newline character
null(MD047, single-trailing-newline)
47-47: Add a single trailing newline.
Ensure the file ends with exactly one newline to satisfy Markdown lint rule MD047.🧰 Tools
🪛 LanguageTool
[locale-violation] ~47-~47: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.(AFTERWARDS_US)
🪛 markdownlint-cli2 (0.17.2)
47-47: Files should end with a single newline character
null(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/ekeybionyx.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ekeybionyx.markdown
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p in plus mode, and the ekey Bionyx Third Party API needs to be enabled in the app. ![...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...} After setting up Home Assistant, you need to go to the app and manually assign the c...
(REP_NEED_TO_VB)
[locale-violation] ~47-~47: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ss) and confirm the deletion in the App afterwards.
(AFTERWARDS_US)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/ekeybionyx.markdown
47-47: Files should end with a single newline character
null
(MD047, single-trailing-newline)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (7)
source/_integrations/ekeybionyx.markdown (7)
4-15: Frontmatter metadata is complete.
The YAML header includes all required Home Assistant fields (title, description, ha_category, release, domain, codeowners, etc.).
19-19: Verify the config flow include renders properly.
Ensureintegrations/config_flow.mdexists and follows the standard pattern for configuration UI documentation.
21-23: Event platform section looks good.
The heading and description accurately reflect that this integration provides events for automations.
25-29: Current limitations are clearly stated.
This section concisely lists the integration’s known constraints.
30-38: Installation instructions and tip are clear.
Good use of atipblock to emphasize using local IPs for better responsiveness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p in plus mode, and the ekey Bionyx Third Party API needs to be enabled in the app. ![...(EN_COMPOUND_ADJECTIVE_INTERNAL)
32-32: Skip hyphenation suggestion.
The static hint to hyphenate “plus mode” is a false positive, as “plus mode” is the official device mode name.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p in plus mode, and the ekey Bionyx Third Party API needs to be enabled in the app. ![...(EN_COMPOUND_ADJECTIVE_INTERNAL)
42-45: Uninstallation instructions heading and context are appropriate.
This section clearly explains token lifetime and reset options for a clean teardown.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
source/_integrations/ekeybionyx.markdown (2)
21-21: Duplicate fix: corrected heading typo.
The heading now reads “## Event Platform,” addressing the previous typo comment from outdated commits. Great catch!
23-23: Duplicate fix: clarified event usage.
The description now accurately states that webhooks are represented as events and used as triggers, aligning with Home Assistant conventions.
🧹 Nitpick comments (3)
source/_integrations/ekeybionyx.markdown (3)
32-32: Use hyphens in compound adjectives.
Improve readability by hyphenating “Third-Party API”:- the ekey Bionyx Third Party API needs to be enabled in the app. + the ekey Bionyx Third-Party API needs to be enabled in the app.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p in plus mode, and the ekey Bionyx Third Party API needs to be enabled in the app. ![...(EN_COMPOUND_ADJECTIVE_INTERNAL)
40-40: Refine phrasing for clarity.
Consider rewording to be more concise and active:- After setting up Home Assistant, you need to go to the app and manually assign the created events to fingers that will trigger them. + Once Home Assistant is set up, open the ekey app and assign events to the fingers you wish to use as triggers.🧰 Tools
🪛 LanguageTool
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...} After setting up Home Assistant, you need to go to the app and manually assign the c...(REP_NEED_TO_VB)
47-47: Apply hyphenation and punctuation.
Hyphenate “Third-Party API” and add a period at the end for consistency:- then disable and re-enable the Third Party API in the ekey app. This resets all webhooks + then disable and re-enable the Third-Party API in the ekey app. This resets all webhooks.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...sistant, then disable and re-enable the Third Party API in the ekey app. This resets all we...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/ekeybionyx.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/ekeybionyx.markdown
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p in plus mode, and the ekey Bionyx Third Party API needs to be enabled in the app. ![...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...} After setting up Home Assistant, you need to go to the app and manually assign the c...
(REP_NEED_TO_VB)
[uncategorized] ~47-~47: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...sistant, then disable and re-enable the Third Party API in the ekey app. This resets all we...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Proposed change
Add Documentation for Ekey Bionyx Integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit