How jvarhol/ha-family-hub works
Family Hub is a self-hosted Home Assistant integration for a family-tablet dashboard. People use its cards for calendar and meal planning, household tasks, and device-specific presentation; the chores/rewards/routines board is served by a websocket API and backend domain engines. The README documents additional calendar, pantry, privacy, notification, and theming capabilities. Several backend relationships below are documented or visible in the source index, but unsampled runtime wiring is not assumed.
Main entry points: chores_websocket_api.py Chores Websocket API · reward_engine.py Reward Engine · chore_engine.py Chore Engine · family-week-calendar-card.js Week Calendar
Components 29
Family Dashboard
- Week Calendar
custom_components/family_hub/card/family-week-calendar-card.js - Today Card
custom_components/family_hub/card/family-today-card.js - To-do Card
custom_components/family_hub/card/family-hub-todo-card.js - Recipe Box
custom_components/family_hub/card/family-hub-recipe-box-card.js - Pantry Card
custom_components/family_hub/card/family-hub-pantry-card.js
Household Activities
- Chores Board
custom_components/family_hub/card/family-hub-chores-card.js - My Chores
custom_components/family_hub/card/family-hub-my-chores-card.js - Rewards Board
custom_components/family_hub/card/family-hub-rewards-card.js - Goals Board
custom_components/family_hub/card/family-hub-goals-card.js - Active Timers
custom_components/family_hub/card/family-hub-active-timers-card.js
Integration Backend
- Chores Websocket API
custom_components/family_hub/chores_websocket_api.py - Chore Engine
custom_components/family_hub/chore_engine.py - Goal Engine
custom_components/family_hub/goal_engine.py - Reward Engine
custom_components/family_hub/reward_engine.py - Routine Engine
custom_components/family_hub/routine_engine.py - Timer Engine
custom_components/family_hub/timer_engine.py - Persistent Stores
custom_components/family_hub/store.py - Pantry Engine
custom_components/family_hub/pantry_engine.py - Grocery References
custom_components/family_hub/grocery_reference.py - Integration Setup
custom_components/family_hub/__init__.py - Scheduled Notifications
custom_components/family_hub/__init__.py
Device Experience
- Screen Saver
custom_components/family_hub/card/family-screensaver-card.js - Theme Builder
custom_components/family_hub/panel/theme-builder-panel.js - Theme Selector
custom_components/family_hub/panel/theme-selector-card.js - Device Settings API
custom_components/family_hub/device_settings_websocket_api.py - Device Settings Entities
custom_components/family_hub/device_settings_entity_shared.py
Other components
- Household members
- Home Assistant
- Calendar entities
Connections 32
- Household members → Week Calendar: uses
README.md - Household members → Today Card: uses
README.md - Household members → To-do Card: uses
README.md - Household members → Recipe Box: uses
README.md - Household members → Pantry Card: uses
README.md - Household members → Chores Board: uses
README.md - Household members → My Chores: uses
README.md - Household members → Rewards Board: uses
README.md - Household members → Goals Board: uses
README.md - Household members → Active Timers: uses
README.md - Household members → Screen Saver: uses
README.md - Household members → Theme Selector: uses
README.md - Week Calendar → Calendar entities: reads events
README.md - Chores Board → Chores Websocket API: uses websocket
custom_components/family_hub/chores_websocket_api.py - My Chores → Chores Websocket API: uses websocket
custom_components/family_hub/chores_websocket_api.py - Rewards Board → Chores Websocket API: uses websocket
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Chore Engine: dispatches
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Goal Engine: dispatches
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Reward Engine: dispatches
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Routine Engine: dispatches
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Timer Engine: dispatches
custom_components/family_hub/chores_websocket_api.py - Chores Websocket API → Persistent Stores: loads and saves
custom_components/family_hub/chores_websocket_api.py - Device Settings API → Device Settings Entities: syncs entities
custom_components/family_hub/device_settings_websocket_api.py - Chore Engine → Timer Engine: uses timers
custom_components/family_hub/chore_engine.py - Chore Engine → Reward Engine: uses rewards
custom_components/family_hub/chore_engine.py - Goal Engine → Reward Engine: uses rewards
custom_components/family_hub/goal_engine.py - Routine Engine → Reward Engine: awards stars
custom_components/family_hub/routine_engine.py - Household members → Theme Builder: customizes themes
README.md - Home Assistant → Integration Setup: hosts
README.md - Integration Setup → Scheduled Notifications: schedules
- Pantry Card → Grocery References: optional integration
- Home Assistant → Pantry Engine: optional Grocy data