Skip to content

JeffreyDissmann/ha-homebox

Repository files navigation

HomeBox for Home Assistant (HACS)

A custom Home Assistant integration that connects to HomeBox, exposes inventory statistics, and supports linking Home Assistant devices to HomeBox items.

Open your Home Assistant instance and add this repository inside HACS Open your Home Assistant instance and start setting up HomeBox

Features

  • UI config flow (host, username, password, integration name, optional area)
  • Polling-based HomeBox statistics sensors:
    • homebox_total_items
    • homebox_total_locations
    • homebox_total_value
    • homebox_maintenance_due_today
    • homebox_maintenance_due_next_week
  • Device linking workflow (Home Assistant device <-> HomeBox item)
  • HomeBox backlink field on linked items (links back to the HA device page)
  • Home Assistant area -> HomeBox location synchronization
  • Per-linked-device sensors:
    • Linked HomeBox item ID (diagnostic)
    • Estimated battery depletion date (diagnostic, requires a battery entity on the device)
  • Automatic HomeBox maintenance entry sync from battery depletion forecasts
  • Optional Battery Notes enrichment for maintenance entries
  • Tag-driven discovery: HomeBox items tagged HomeAssistant are surfaced for linking in the HA UI
  • Auto-unlink when the HomeAssistant tag is removed from a HomeBox item
  • Automatic backlink restoration if a linked item's backlink field is cleared in HomeBox
  • Service actions for triggering maintenance entries from automations (see below)
  • Manual resync and stale backlink cleanup from integration options
  • Bulk area import wizard to create and link multiple HomeBox items at once

Requirements

  • Home Assistant version 2024.1.0 or newer
  • A reachable HomeBox instance
  • HomeBox user credentials

Common HomeBox endpoints:

  • default port: 7745
  • common Docker host mapping: 3100

Examples:

  • http://192.168.1.20:7745
  • http://homebox.local:3100

Installation (HACS)

Quick action:

  • Click: Add repository to HACS button above.
  1. Open HACS -> Integrations.
  2. Open the menu -> Custom repositories.
  3. Add https://github.com/JeffreyDissmann/ha-homebox.
  4. Select category Integration.
  5. Install HomeBox.
  6. Restart Home Assistant.
  7. Go to Settings -> Devices & Services -> Add Integration -> HomeBox.

Configuration

During setup, provide:

  • HomeBox host URL
  • HomeBox username
  • HomeBox password
  • Integration display name (default: HomeBox)
  • Optional Home Assistant area

Entity Model

Primary HomeBox device:

  • homebox_total_items
  • homebox_total_locations
  • homebox_total_value
  • homebox_maintenance_due_today
  • homebox_maintenance_due_next_week

Linked Home Assistant devices (one virtual device per link):

  • Linked HomeBox item ID — diagnostic sensor exposing the HomeBox item ID
  • Battery depletion date — diagnostic sensor with the estimated date the battery will run out (only present when a battery entity is detected on the HA device)

Service Actions

Three actions are available under Developer Tools → Actions and in automations:

homebox.add_maintenance

Creates a pending maintenance entry in HomeBox for the item linked to the given entity's device.

Field Required Description
entity_id yes Any entity whose device is linked to a HomeBox item
name yes Name of the maintenance entry
description no Optional details (default: empty)
scheduled_date no Due date (default: today)

homebox.delete_maintenance

Deletes all pending maintenance entries with the given name for the linked item.

Field Required Description
entity_id yes Any entity whose device is linked to a HomeBox item
name yes Name of the entries to delete

homebox.clear_maintenance

Deletes all pending maintenance entries for the linked item.

Field Required Description
entity_id yes Any entity whose device is linked to a HomeBox item

Example automation: When a sensor reports a warning, log it as a maintenance task:

automation:
  trigger:
    platform: state
    entity_id: binary_sensor.smoke_detector
    to: "on"
  action:
    service: homebox.add_maintenance
    data:
      entity_id: binary_sensor.smoke_detector
      name: "Smoke detector triggered — check device"

Linking Workflow

From HomeBox integration options:

  1. Link HA device: choose an unlinked tagged HomeBox item, then choose a HA device.
  2. Unlink HA device: remove an existing mapping.
  3. Refresh HomeBox items: re-scan tagged items and clean stale backlinks.

Tag-driven behavior:

  • The integration manages/uses the HomeBox tag HomeAssistant.
  • Tagged items that are not linked are surfaced for linking.

Troubleshooting

  • Invalid authentication:
    • verify username/password
    • verify URL and port
    • verify reverse proxy/auth setup if used
  • Cannot connect:
    • verify network reachability from Home Assistant to HomeBox
    • verify protocol (http vs https)
  • Link removed but still visible:
    • run Refresh HomeBox items in integration options
    • reload the integration

Issues

Please report bugs and feature requests here:

Project Status

Active custom integration focused on HomeBox inventory stats + HA device linking.

About

Home Assistant custom integration for HomeBox: inventory statistics, HA-device to HomeBox-item linking, and area-to-location sync (HACS).

Topics

Resources

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors