ha-chore-helper icon indicating copy to clipboard operation
ha-chore-helper copied to clipboard

Unclear documentation for custom chores

Open colececil opened this issue 4 months ago • 2 comments

System Health details

System Information

version core-2024.3.3
installation_type Unsupported Third Party Container
dev false
hassio false
docker true
user abc
virtualenv false
python_version 3.12.2
os_name Linux
os_version 5.10.131-2-rockchip-g8802564cbf09
arch aarch64
timezone America/Chicago
config_dir /config
Home Assistant Community Store
GitHub API ok
GitHub Content ok
GitHub Web ok
GitHub API Calls Remaining 5000
Installed Version 1.34.0
Stage running
Available Repositories 1400
Downloaded Repositories 12
Home Assistant Cloud
logged_in false
can_reach_cert_server ok
can_reach_cloud_auth ok
can_reach_cloud ok
Dashboards
dashboards 5
resources 7
views 5
mode storage
Recorder
oldest_recorder_run March 21, 2024 at 7:02 AM
current_recorder_run March 30, 2024 at 6:43 PM
estimated_db_size 19.76 MiB
database_engine sqlite
database_version 3.44.2

Checklist

  • [X] I have enabled debug logging for my installation.
  • [X] I have filled out the issue template to the best of my ability.
  • [X] This issue only contains 1 issue (if you have multiple issues, open one issue for each issue).
  • [X] This issue is not a duplicate issue of currently previous issues..

Describe the issue

Hi @bmcclure, thanks so much for creating this project! I've been planning on setting up a chore system in Home Assistant, and what you've created almost exactly fits what I envisioned, which is amazing.

One issue I've run into - it seems like there are some details missing from the documentation in how to use custom chores. I've tried a bunch of stuff, but I can't get them to show up on the calendar. Here are the things that are unclear to me:

  1. When I call the add_date service, I can see the date gets added in the sensor's "Add dates" field, but nothing else really seems to happen. I'm also not clear on what the "Add dates" field means or how it affects things.
  2. The documentation says the update_state service is useful for custom chores, but it doesn't seem to explain how. I tried calling it after calling the add_date service, but it doesn't look like it's doing anything besides updating the "Last updated" timestamp.
  3. When creating a new chore sensor, there is an option called "Manual update - sensor state updated manually by a service (Blueprint)". I don't see this option mentioned in the documentation, and I'm unclear on what it does. I tried both with it enabled and with it disabled, but I couldn't find the difference in behavior.

If you can fill me in on these details, I'd be happy to create a pull request with updates to the documentation. Thanks!

Reproduction steps

See details included in the issue description.

Debug logs

I don't think these are needed, but I can provide them later if requested.

Diagnostics dump

No response

colececil avatar Mar 31 '24 04:03 colececil