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.

Sign up for GitHub

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

Updated Abode docs to point to jaraco.abode library #32722

Merged
merged 3 commits into from
May 14, 2024
Merged

Updated Abode docs to point to jaraco.abode library #32722

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf6e9d6
Updated Abode docs to point to jaraco.abode library
jaraco May 13, 2024
54945c1
Add link to the inferred groups and their ranges.
jaraco May 14, 2024
16e9619
Tiny tweak for the linter
c0ffeeca7 May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/_integrations/abode.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ All {% term events %} have the fields:
| `date` | The date of the event in the format `MM/DD/YYYY`. |
| `time` | The time of the event in the format `HH:MM AM`. |

There is a unique list of known event_codes that can be found
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
There is a unique list of known event_codes are defined in
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is the link to abodepy removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had checked the URL and thought it was 404. Turns out it wasn't 404, but when I first browsed to the URL, I included the trailing ), which was 404, then when I corrected it and removed the trailing ), Firefox quietly downloaded the file and left me on the 404 page (leading me to believe the URL itself was 404).

So I sought to find a suitable replacement in the jaraco.abode project, which supersedes the abodepy project. Now that I see the contents of timeline_events.txt, I see there is a bit of extra information in that text file, information which is lost outside of the previous project's GitHub repo. I'll restore that content in the project itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Aha. I see now that the "groups" is codified as well, so I'll update the docs to link to that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in cf6e9d6.

[events.csv](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/events.csv).

## Services

Expand All @@ -92,7 +92,7 @@ Available {% term services %}: `change_setting`, `capture_image`, `trigger_autom

Change settings on your Abode system.
For a full list of settings and valid values, consult the
[AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
[jaraco.abode settings section](https://github.com/jaraco/jaraco.abode/blob/main/README.rst#settings).
c0ffeeca7 marked this conversation as resolved.
Show resolved Hide resolved

| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
Expand Down
Loading