-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Iotty #29624
Add Iotty #29624
Conversation
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (1)
source/_integrations/iotty.markdown (1)
14-14
: Improve readability of the introductory paragraph.Consider rephrasing for better readability:
- The iotty family is focused on beautiful aesthetics and includes the Smart Switch for lights and gates, the Smart Shades Switch for blinds and shutters and the Smart Outlet. Install the iotty devices and enjoy your new Smart Home with ease! + The iotty family focuses on beautiful aesthetics and includes the Smart Switch for lights and gates, the Smart Shades Switch for blinds and shutters, and the Smart Outlet. Install iotty devices and enjoy your new Smart Home with ease!
source/_integrations/iotty.markdown
Outdated
|
||
More integrations are coming soon: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove multiple consecutive blank lines.
There are multiple consecutive blank lines that should be removed for better readability.
-
+
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
More integrations are coming soon: | |
More integrations are coming soon: |
Tools
Markdownlint
32-32: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discarded, as this is no longer present in the documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shapournemati-iotty Thank you for the update. I have verified the latest content of the source/_integrations/iotty.markdown
file, and it confirms that the issue of multiple consecutive blank lines has been resolved. No further action is needed.
Analysis chain
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Display the content of the `source/_integrations/iotty.markdown` file to verify the absence of multiple consecutive blank lines.
cat source/_integrations/iotty.markdown
Length of output: 2171
source/_integrations/iotty.markdown
Outdated
- https://iotty.fr/collections/frontpage/products/prise-intelligent-iotty | ||
- https://iotty.de/collections/frontpage/products/iotty-smart-steckdose | ||
- https://iotty.it/collections/frontpage/products/iotty-plus-presa-intelligente | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are there any prerequisites? Anything I need to do or have before I can install the iotty integration, for example, do I need an iotty account and login credentials?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
source/_integrations/iotty.markdown
Outdated
EU VERSION: | ||
- https://iotty.fr/collections/frontpage/products/prise-intelligent-iotty | ||
- https://iotty.de/collections/frontpage/products/iotty-smart-steckdose | ||
- https://iotty.it/collections/frontpage/products/iotty-plus-presa-intelligente |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add a section that gives more information about the supported entities. For example, Husquvarna or La Marzocco have sections on switches, for reference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In our integration things are pretty simple: one switch per device. I have added a small section about that, let me know if that is what you were thinking about
source/_integrations/iotty.markdown
Outdated
- https://iotty.it/collections/frontpage/products/iotty-plus-interruttore-intelligente-per-luci-e-cancelli | ||
|
||
|
||
More integrations are coming soon: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
More integrations are coming soon: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
source/_integrations/iotty.markdown
Outdated
|
||
- iotty Shades Switch \ | ||
EU VERSION: | ||
- https://iotty.uk/collections/frontpage/products/iotty-smart-shades-switch | ||
- https://iotty.it/collections/frontpage/products/iotty-plus-interruttore-intelligente-per-tende-e-tapparelle | ||
|
||
- iotty Smart Outlet: \ | ||
EU VERSION: | ||
- https://iotty.fr/collections/frontpage/products/prise-intelligent-iotty | ||
- https://iotty.de/collections/frontpage/products/iotty-smart-steckdose | ||
- https://iotty.it/collections/frontpage/products/iotty-plus-presa-intelligente |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- iotty Shades Switch \ | |
EU VERSION: | |
- https://iotty.uk/collections/frontpage/products/iotty-smart-shades-switch | |
- https://iotty.it/collections/frontpage/products/iotty-plus-interruttore-intelligente-per-tende-e-tapparelle | |
- iotty Smart Outlet: \ | |
EU VERSION: | |
- https://iotty.fr/collections/frontpage/products/prise-intelligent-iotty | |
- https://iotty.de/collections/frontpage/products/iotty-smart-steckdose | |
- https://iotty.it/collections/frontpage/products/iotty-plus-presa-intelligente |
I think the documentation should focus on the current status.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, it has been removed
…upported entities descriptions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny tweaks
|
||
## Supported entities | ||
|
||
Each iotty device gets mapped into one Home Assistant device per gang, each with its own Switch entity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what do you mean by "per gang"? group?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, "gang" is a pretty standard term used when referring to te single switches on a plate, as you can see in this wikipedia article: Light Switch.
I didn't want to reuse the word "Device" or "Switch" as it would be using the same word to define itself. Let me know if that is clear, or if you have any other suggestion to replace the word "gang"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the explanation. Learned something today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @pburgio and @shapournemati-iotty 👍
|
||
### Switches | ||
|
||
The main, unnamed, switch entity controls the light switch, turning it on or off the gang related to it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence has incorrect grammar. I can't make a suggestion since it's not clear to me what meaning is meant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hej Martin, thanks for the feedback. Since the PR has already been merged, what is the suggested course of action here? Open another PR to fix this? Wait for the next release in which some functionality will be added to my integration?
For what concerns the meaning, what I want to convey is:
- There is only one entity per device
- The main (and only) entity of the device is unnamed
- The switch entity is meant to control a light switch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please open a new PR and adjust the sentence.
Proposed change
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
New Features
Documentation