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

[irobot] Update documentation regarding button names #17806

Merged
merged 10 commits into from
Nov 26, 2024

Conversation

lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Nov 25, 2024

Fixes: #10388

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@jlaur
Copy link
Contributor

jlaur commented Nov 25, 2024

Thanks! This seems to fix the "small nit" mentioned in the linked issue, but I'm not sure this is fully addressed?

Add a mention to the docs that the password will be populated in the Thing and that you must copy that into the config files in order for it to persist. Without this detail it causes confusion because the Roomba will appear to work temporarily, but as soon as the Things file is edited, the password is lost and the button needs to be pushed again. I believe this issue is specific to working with config files.

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel
Copy link
Contributor Author

lsiepel commented Nov 25, 2024

hat the password will be populated in the Thing and that you must copy that into the config files in order for it to persist. Without this detail it causes confusion because the Roomba will appear to work temporarily, but as soon as the Things file is edited, the password is lost and the button needs to be pushed again.

Saving the password was already there, but maybe better to be explicit. While adapting it, i also made some other changes so it would be possible to use links.

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

Thanks for explicitly mentioning copying the password, only some nit picking left.

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
lsiepel and others added 4 commits November 26, 2024 22:49
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Co-authored-by: Jacob Laursen <jacob-github@vindvejr.dk>
Signed-off-by: lsiepel <leosiepel@gmail.com>
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
…b-addons into irobot-doc-button

Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Jacob Laursen <jacob-github@vindvejr.dk>
@jlaur jlaur merged commit 6e81a76 into openhab:main Nov 26, 2024
4 of 5 checks passed
@jlaur jlaur added this to the 4.3 milestone Nov 26, 2024
@lsiepel lsiepel deleted the irobot-doc-button branch November 26, 2024 22:19
matchews pushed a commit to matchews/openhab-addons that referenced this pull request Dec 16, 2024
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
cipianpascu pushed a commit to cipianpascu/openhab-addons that referenced this pull request Jan 2, 2025
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[irobot] Request for more detailed authentication steps when using config files
2 participants