Skip to content
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

Merged
merged 26 commits into from
Jul 22, 2024
Merged

Add Iotty #29624

merged 26 commits into from
Jul 22, 2024

Conversation

pburgio
Copy link
Contributor

@pburgio pburgio commented Oct 31, 2023

Proposed change

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features

    • Introduced comprehensive documentation for integrating iotty smart devices with Home Assistant, enhancing user experience and installation ease.
    • Detailed instructions for connecting devices such as Smart Switch, Smart Shades Switch, and Smart Outlet, including links to US and EU versions.
  • Documentation

    • Added a new markdown file that serves as a crucial resource for users looking to incorporate iotty devices into their Home Assistant setup.

@home-assistant home-assistant bot added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Oct 31, 2023
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@pburgio pburgio changed the base branch from next to current October 31, 2023 11:43
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Oct 31, 2023
@home-assistant home-assistant bot added the current This PR goes into the current branch label Oct 31, 2023
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Nov 2, 2023
@home-assistant
Copy link

home-assistant bot commented Nov 2, 2023

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 next branch. Please change the target branch of this PR to next and rebase if needed.

@pburgio pburgio changed the base branch from current to next November 2, 2023 16:30
@home-assistant home-assistant bot removed current This PR goes into the current branch needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Nov 2, 2023
@home-assistant home-assistant bot added the next This PR goes into the next branch label Nov 2, 2023
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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!

Comment on lines 32 to 33

More integrations are coming soon:
Copy link
Contributor

@coderabbitai coderabbitai bot Jul 19, 2024

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.

Suggested change
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)

Copy link
Contributor

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

Copy link
Contributor

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

- 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

Copy link
Contributor

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?

Copy link
Contributor

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 Show resolved Hide resolved
source/_integrations/iotty.markdown Outdated Show resolved Hide resolved
source/_integrations/iotty.markdown Show resolved Hide resolved
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
Copy link
Contributor

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.

Copy link
Contributor

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

@c0ffeeca7 c0ffeeca7 marked this pull request as draft July 19, 2024 12:39
- https://iotty.it/collections/frontpage/products/iotty-plus-interruttore-intelligente-per-luci-e-cancelli


More integrations are coming soon:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
More integrations are coming soon:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment on lines 41 to 51

- 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.

Copy link
Contributor

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

source/_integrations/iotty.markdown Show resolved Hide resolved
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny tweaks

source/_integrations/iotty.markdown Outdated Show resolved Hide resolved
source/_integrations/iotty.markdown Outdated Show resolved Hide resolved
source/_integrations/iotty.markdown Outdated Show resolved Hide resolved
source/_integrations/iotty.markdown Outdated Show resolved Hide resolved
source/_integrations/iotty.markdown Outdated Show resolved Hide resolved

## Supported entities

Each iotty device gets mapped into one Home Assistant device per gang, each with its own Switch entity.
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 Jul 22, 2024

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?

Copy link
Contributor

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"

Copy link
Contributor

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.

@pburgio pburgio marked this pull request as ready for review July 22, 2024 13:51
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a 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 👍

@c0ffeeca7 c0ffeeca7 merged commit 99b2d1f into home-assistant:next Jul 22, 2024
6 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Jul 22, 2024

### Switches

The main, unnamed, switch entity controls the light switch, turning it on or off the gang related to it.
Copy link
Member

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.

Copy link
Contributor

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:

  1. There is only one entity per device
  2. The main (and only) entity of the device is unnamed
  3. The switch entity is meant to control a light switch

Copy link
Member

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.

@github-actions github-actions bot locked and limited conversation to collaborators Jul 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants