mirror of https://github.com/cassandra/home-information.git synced 2026-04-17 21:19:45 -04:00

Files

Thiago Trautwein Santos 10444fc165 Feature/234 homebox integration (#249 )

* finished Items and Locations
* finish maintenance, labels and start notifier
* finish v1 of HomeBox Client API
* sync now creates and updates entities and entities attributes
* create sync for homebox item attachments
* finish homebox integration
* finish test implementation

* Improve Homebox API client quality and pattern conformance

Align the Homebox integration with patterns established by the existing
Home Assistant (HASS) integration, and fix several minor issues found
during code review of PR #249:

- Assert required API options in HbClient.__init__ instead of silently
  logging a warning, matching the HASS client's defensive pattern
- Add warning log when login response lacks a token to aid debugging
- Translate Portuguese log message to English for consistency
- Reference HbClient constants in factory instead of magic strings
- Initialize all cache lists in HomeBoxManager.__init_singleton__
- Update factory test to work with constant references on mock class

* Fix sync bugs and remove dead code in Homebox converter

- Fix attachment order_id overlap: fields and attachments each
  enumerated from 0 independently, causing interleaved display since
  EntityAttribute orders by order_id. Attachments now start after the
  last field index.
- Fix variable shadowing in _sync_helper_entity_attributes where the
  loop variable 'hb_attachment' was immediately reassigned by tuple
  unpacking on the next line.
- Remove unused _create_entity_attributes_from_hb_fields method, which
  was superseded by the sync code using hb_item_to_attribute_field_list.

* Fix entity edit dialog for externally managed entities

HomeBox entities have non-editable attributes with disabled HTML form
fields. Browsers omit disabled fields from POST data, which caused
AttributeForm.clean() to see empty values and raise spurious validation
errors when updating the EntityType.

- Skip validation for non-editable attributes in AttributeForm.clean(),
  since save() already short-circuits without writing for these
- Add suppress_add_new property to AttributeForm to control whether the
  "Add New" attribute card is shown, following the existing pattern of
  display-hint properties (suppress_history, show_as_editable, etc.)
- Pass can_add_custom_attributes through form_kwargs in the entity
  formset so the form can suppress the add-new card for externally
  managed entities even after a bound form re-render

* Add HomeBox integration to documentation

Add HomeBox alongside Home Assistant and ZoneMinder across all
user-facing and developer documentation: Integrations guide, Features,
FAQ, Installation, architecture overview, integration guidelines, and
service patterns.

Also remove stale reference to non-existent hi.services.weather module
from integration guidelines example list.

---------

Co-authored-by: Anthony Cassandra <github@cassandra.org>

2026-03-28 09:53:46 -05:00

1.3 KiB

Raw Permalink Blame History

Service Patterns

Home Assistant Integration

Full two-way sync with Home Assistant including:

Entity mapping and state synchronization
Controller integration for device control
Real-time event handling

class HomeAssistantGateway(IntegrationGateway):
    def sync_entities(self):
        # Fetch entities from Home Assistant API
        # Map to local Entity models
        # Synchronize states and capabilities
        pass

ZoneMinder Integration

Camera and video surveillance system integration:

Security monitoring and alerts
Video stream management
Motion detection events

HomeBox Integration

Home inventory and asset management system integration:

Item synchronization with read-only entity attributes
Custom field and attachment downloads
Username/password authentication with token-based session management

Integration Patterns

HTTP API Clients: REST API integration patterns
WebSocket Connections: Real-time event handling
Polling Services: Periodic data synchronization
Webhook Handlers: External system notifications

Integration guidelines: Integration Guidelines
Architecture overview: Architecture Overview

1.3 KiB Raw Permalink Blame History