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

Added documentation for new service calls pause and resume as well as example #163

Merged
merged 9 commits into from
May 11, 2024

Conversation

evercape
Copy link
Contributor

@evercape evercape commented May 9, 2024

Hi Robert,

I have added the documentation for the new service calls pause and resume.

I felt they suit better at 7.2 and have subsequently renamed the other sections. Feel free to change that if you prefer to have it at the end of the existing service calls.

In addition I have added a sample for a global pause and resume button.

Hope this helps.

Thanks for your amazing work.

Thanks
Martin

@rgc99
Copy link
Owner

rgc99 commented May 10, 2024

Hi Martin,

Thanks for this, great work. A couple of things.

Some notes on section 7.2
The pause/resume only works on a sequence. It will not pause the controller or a zone. If a zone for example had a schedule it would keep running and the controller would be on. The solution there would be to make everything a sequence, even if it only had a single zone.
The entity_id can be the controller or sequence (not a zone). If the call is made via the controller the target is still the sequence.
The resume and resumes in first and second paragraph end with an apostrophe instead of a backtick.

Section 8.6
The pause_resume_button image is from a private collection and when I try to access it the file is empty (probably permissions). The image should go in the repository under the examples directory i.e. examples/pause_resume_button.png. From there link it in the documentation (./examples/pause_resume_button.png)

Thanks
Robert

Fixed typos

Better explanation of entity_id

sequence_id only applicable if entity_id is controller

added explanation next to sample link
…ption

The service calls are extremely useful and should be pointed out to HASS user prior install.
@evercape
Copy link
Contributor Author

Hi Robert, thanks for the feedback. Have amended as per your suggestions. For the apostrophes vs ticks I suppose I need my spectacles ;-)

Also amended info.md to refer to the many service calls you added over the past two years.

If there is anything else that is required, let me know. Happy to contribute.

@rgc99 rgc99 merged commit 9691dc9 into rgc99:master May 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants