Skip to content

Technical: Users

ccpk1 edited this page Mar 2, 2026 · 3 revisions

Target Audience: Developers, automation builders, advanced dashboard users Covers: User-scoped entity naming, role/capability mapping, sensors, buttons, and core attributes


User entity naming

User-scoped entities follow these patterns:

  • sensor.<user>_choreops_*
  • button.<user>_choreops_*
  • calendar.<user>_choreops

Examples:

sensor.alex_choreops_points
sensor.alex_choreops_chores
sensor.alex_choreops_chore_status_feed_dog
sensor.alex_choreops_ui_dashboard_helper
button.alex_choreops_chore_claim_feed_dog
button.alex_choreops_chore_approval_feed_dog
button.alex_choreops_reward_claim_ice_cream
calendar.alex_choreops

Note

The suffix segment in * is generated from configured item names (chores, rewards, badges, bonuses, penalties).


Capability-to-entity matrix

This table shows what is created for a user profile by selected capabilities.

Capability set Sensors Buttons
can_approve only (no assignment) No assignee sensor set for that user profile Approval/disapproval actions across the user's associated users
allow_chore_assignment sensor.<user>_choreops_chores, sensor.<user>_choreops_chore_status_<chore>, sensor.<user>_choreops_ui_dashboard_helper, calendar.<user>_choreops button.<user>_choreops_chore_approval_<chore>
allow_chore_assignment + enable_chore_workflow Same as above Adds button.<user>_choreops_chore_claim_<chore> and button.<user>_choreops_chore_disapproval_<chore>
allow_chore_assignment + enable_chore_workflow + enable_gamification Adds sensor.<user>_choreops_points, sensor.<user>_choreops_badges, and per-item status sensors (reward_status, badge_status, achievement_status, challenge_status) Adds reward claim/approval/disapproval and points/bonus/penalty action buttons
can_manage (with or without can_approve) No extra sensor family by itself No unique button family by itself; unlocks elevated management operations

Entity families by user role

This page defines what gets created for a user profile. Detailed state/attribute contracts are documented in domain-specific technical pages.

User-scoped families

  • Chore family: sensor.<user>_choreops_chores, sensor.<user>_choreops_chore_status_<chore>, and chore action buttons
  • Points family: sensor.<user>_choreops_points and points/bonus/penalty/reward action buttons
  • Badge/progression family: per-item status sensors for rewards, badges, achievements, and challenges
  • Dashboard helper family: sensor.<user>_choreops_ui_dashboard_helper and related helper pointers

Canonical contracts

Note

Use this page for capability-driven creation rules. Use the linked technical pages for full entity contracts and automation examples.


User role recipes

  • Assignee only: allow_chore_assignment
  • Assignee with full workflow: allow_chore_assignment + enable_chore_workflow
  • Assignee with points/rewards: add enable_gamification
  • Approver: can_approve + associated users
  • Admin approver: can_approve + can_manage + associated users

Related documentation


Last Updated: February 2026 (role-based user technical reference)

Clone this wiki locally