Internet Box Card

Features

• Two cards: a full Internet Box Card and a compact Internet Box Mini Card
• Detail button at the top right of the mini card: it shows the full card in its place (same box and options), and the collapse button, or a click anywhere outside the card, brings the compact view back (zoom: false removes it)
• Automatic discovery of the box entities, whatever the language of the entity ids (several boxes supported)
• Header icon of the kind of connection (fibre, xDSL, 4G / 5G, satellite, else a box) coloured with the state of the internet link like the status pill (green online, orange while the DSL line syncs, red offline or on a line fault, grey unavailable; the operator colour when the box reports no link state), with the operator logo as a badge; accent colour, website and admin links follow the detected operator, and the internet provider of the box model when it is not the integration's (a Bell Home Hub on the Sagemcom F@st integration, a KPN Box 12 on the Livebox one)
• Picture and commercial name of the box model, detected automatically or set with the model option, and firmware version
• Connection status and type (FTTH, xDSL, LTE, satellite…), public IPv4 (IPv6 on hover) and uptime, from the box tracker or the integration's own external IP and uptime sensors. The status is the real link state when the integration exposes it (Livebox WAN status, SFR Box WAN / DSL / FTTH status, with "Syncing" while the DSL line trains and "Line fault" on a line defect), else the box's own tracker
• The last speed test of the Speedtest.net or Fast.com integration (download, upload, ping) next to the uptime, found automatically, or of another speed test (LibreSpeed…) set in entities, with a button that runs a new test (its icon turns while it runs)
• Sensors of your choice for the box's values and the speed test, in YAML or in the visual editor
• Download / upload rates, in bytes (kB/s, MB/s) or bits (kb/s, Mb/s), with their last 24 hours drawn behind each tile, on the full card and the mini card (recorder statistics)
• Temperature gauges and fans speed
• Storage: free space of the disk partitions and RAID status
• Services: Wi-Fi state, missed calls and connected devices (the mini card footer always shows the missed calls, orange when there are some)
• A switch next to the Wi-Fi state (Services tile, header chip and mini card footer) turns the box's Wi-Fi on, or off after a confirmation popup; hidden while the Wi-Fi switch is unavailable
• A check button next to the missed calls marks them as read, shown only when there are missed calls and the integration has that button
• A restart button at the top right of the full card reboots the box, after a confirmation popup; shown only when the integration exposes it
• Colors turn orange / red when a threshold is crossed (temperatures, disk usage, missed calls); the temperature and disk usage thresholds can be set
• Click any value (except the connected devices count, a total over several trackers) to open its Home Assistant history (more-info dialog)
• Click the operator logo to open its website, and the box picture to open the box admin interface
• Visual editor in the dashboard UI for both cards (no YAML needed)
• Light and dark mode, 22 languages (English, French, German, Spanish, Serbian Cyrillic and Latin, Italian, Dutch, European Portuguese, Polish, Romanian, Danish, Swedish, Bulgarian, Russian, Ukrainian, Hungarian, Slovak, Czech, Slovenian, Latvian and Greek, see Translations)
• Unavailable entities (for example while the box restarts) are shown as unavailable, not as Wi-Fi off or 0 missed calls; the restart button is disabled meanwhile
• Sections view: the full card needs at least 9 columns, the mini card 6; on a narrow card the box picture gets smaller then hidden, and the status pill shows only its coloured dot
• Single file, no external dependency: the box pictures and operator logos are embedded (a provider whose logo file is not in images/ shows the connection icon without a badge)

Supported integrations

Each section shows only what the integration exposes. Built-in integrations ship with Home Assistant; custom ones are installed from their repository.

France#

Germany#

Italy, United Kingdom, Ireland#

Switzerland#

Netherlands, Belgium#

Spain, Nordics#

Canada, Australia#

Any country: 4G / 5G and satellite#

Prerequisites

Home Assistant 2024.8 or later, and one of the integrations above configured.

The connected devices count uses the device_tracker entities of the integration, which are often disabled by default: enable the ones you want to follow.

On a Freebox, the restart button needs the Freebox settings modification permission: if pressing it fails with an insufficient_rights error, open Freebox OS (mafreebox.freebox.fr) → Freebox settings → Access management → Applications, and allow Modification des réglages de la Freebox for the Home Assistant application.

Configuration

Visual editor#

Edit a dashboard, click Add card and search for Internet Box Card or Internet Box Mini Card. The box is preselected; pick another one in the list if you have several, set an optional title, choose the sections to display, the rate unit and the language. The preview updates live, and options left at their default are kept out of the generated YAML.

Minimal#

type: custom:internet-box-card

type: custom:internet-box-mini-card

Full options#

type: custom:internet-box-card
box: 0123456789abcdef0123456789abcdef
title: My box
model: delta
admin_url: https://mafreebox.freebox.fr
show_image: true
show_logo: true
show_network: true
show_system: true
show_storage: true
show_services: true
temp_warning: 70
temp_critical: 85
disk_warning: 80
disk_critical: 95
rate_unit: bits
language: fr
entities:
  speedtest:
    download: sensor.librespeed_download
    upload: sensor.librespeed_upload
    ping: sensor.librespeed_ping
    run: button.librespeed_run

type: custom:internet-box-mini-card
box: 0123456789abcdef0123456789abcdef
title: My box
model: livebox_7
admin_url: http://livebox.home
show_image: true
show_logo: true
show_network: true
show_system: true
zoom: true
rate_unit: bits
language: fr

Options reference#

Sensors of your choice#

The cards find the box's sensors and the speed test by themselves. entities sets others: a speed test of another integration (LibreSpeed, Speedtest Tracker, a sensor of your own) or a box value read from another sensor. The box rates and the speed test can be picked in the visual editor too, under Sensors of your choice.

Supported models

The model is detected from the box device (model id or name); set model to force another picture, for example when the detection fails. The French operators' boxes have their own stylised drawings; the boxes of the other integrations are drawn with a generic form factor (router, hub, tower, 4G / 5G box, dish), never a copy of the product, and keep their own model name from the device (a "FRITZ!Box 7590", a "Huawei B535-232").

France#

Freebox (Free)#

Without a detected model or model option, no box picture is shown.

Freebox Ultra	Freebox Pop	Freebox Delta	Freebox Revolution	Freebox mini 4K
ultra (v9)	pop (v8)	delta (v7)	revolution (v6)	mini_4k

Livebox (Orange)#

Livebox 7	Livebox 6	Livebox 5	Livebox 4	Livebox S
livebox_7	livebox_6	livebox_5	livebox_4	livebox_s

SFR Box#

SFR Box 8	SFR Box 7	SFR Box (NB6VAC)
sfr_box_8	sfr_box_7	sfr_nb6vac

Bbox (Bouygues Telecom)#

The legacy Bbox integration (and its custom_bbox fork) exposes no device model: set the picture with the model option. With the Bouygues Bbox integration (hass-bbox2), the Bbox Wi-Fi 7 (Sagemcom F@st 5696b) is detected from its device model.

Bbox Wi-Fi 7	Bbox Fibre	Bbox Ultym	Bbox Miami
bbox_wifi7	bbox_fibre	bbox_ultym	bbox_miami

Germany#

FRITZ!Box#

The model name comes from the device; the picture is a generic router, or a tower for the cable models (FRITZ!Box 6xxx).

FRITZ!Box	FRITZ!Box Cable
fritz_box	fritz_box_cable

Vodafone Station (Germany, Italy, United Kingdom, Ireland)#

Power Station	WiFi 6 Station	Ultra Hub	Gigabox	Vox 3.0	H300S
vodafone_power_station	vodafone_wifi6_station	vodafone_ultra_hub	vodafone_gigabox	vodafone_vox	vodafone_h300s

Sagemcom F@st (by provider and country)#

The model number of the F@st gateway gives the provider, whose name, colour and links the card takes. An unknown F@st keeps the Sagemcom name with its own model number.

Provider	Country	Box	model	Picture
Telekom	Germany	Speedport Pro	telekom_speedport_pro
BT	United Kingdom	Smart Hub (F@st 5364)	bt_smart_hub
eir	Ireland	F3000 (F@st 5366SD)	eir_f3000
Salt	Switzerland	FibreBox X6 (F@st 5688T)	salt_fibrebox_x6
KPN	Netherlands	Experia Box 12 (F@st 5359)	kpn_experia_box_12
KPN	Netherlands	F@st 4360Air	kpn_fast_4360
DELTA Fiber / Zeelandnet	Netherlands	F@st 3890V3	delta_fast_3890
Proximus	Belgium	b-box 3 (F@st 3865b)	proximus_bbox3
MásMóvil	Spain	F@st 5655V2	masmovil_fast_5655
Telia	Sweden	F@st 5370e	telia_fast_5370
TDC	Denmark	F@st 5380	tdc_fast_5380
Bell	Canada	Home Hub 4000 (F@st 5689)	bell_home_hub_4000
Bell	Canada	Home Hub 3000 (F@st 5566)	bell_home_hub_3000
Optus	Australia	F@st 3864	optus_fast_3864
Other F@st	—	Its own model number	sagemcom_fast

Switzerland#

Swisscom Internet-Box#

The integration has no entity for the box, so its model is not known: the Internet-Box picture is always shown.

Internet-Box
internet_box

Netherlands#

KPN Box 12 (Livebox integration)#

KPN Box 12
kpn_box_12

The KPN Experia boxes are Sagemcom F@st gateways, see above.

Any country: 4G / 5G and satellite#

Huawei LTE	ZTE Hyperbox 5G Lite	Starlink
huawei_lte_router	zte_mc8810	starlink

How it works

The cards read the entity and device registries of Home Assistant and keep the entities of the supported box integrations (freebox, livebox, sfr_box, bbox (legacy or hass-bbox2) / custom_bbox, fritz, vodafone_station, swisscom, sagemcom_fast, huawei_lte, zte_hyperbox, starlink). Each box's sensors are recognized by their integration's own translation keys (for the Freebox: rate_down, rate_up, missed, wifi, partition_free_space, raid_degraded), so entity ids translated in another language (for example sensor.freebox_vitesse_de_telechargement) and renamed entities are supported. The legacy Bbox integration is a YAML platform without devices nor unique ids, so its sensors are not in the entity registry: they are found in the states by their entity-id suffix (_currently_used_download_bandwidth…). The Bouygues Bbox integration (hass-bbox2) shares the bbox domain and registers a device, but its sensors have no translation key: the box's own entities are matched by their entity-id suffix (_download_speed…). The box picture and the header logo, colour and links follow the detected operator, or the provider of the detected model (Sagemcom F@st and KPN boxes). A box with no rate sensor is found by its restart button (Sagemcom F@st); the Swisscom integration has only the trackers of the connected devices, so the integration itself is the box. On the ZTE Hyperbox, whose keys the card does not know, the rates are the data-rate sensors whose name says download / upload, and the connection and restart entities are found by their device class. A restart button with a translation key of its own is a reconnect button (FRITZ!Box, Vodafone), never taken for the reboot.

The box itself is the device of the download rate sensor (on a Livebox fibre line, which has no down_rate / up_rate sensor, the rates of the WAN_GPON, WAN_SFP or veip0 interface statistics sensors, never those of the Wi-Fi, Ethernet or DS-Lite interfaces; since the Livebox integration 3.0.0 they share the interface_rate_rx / interface_rate_tx key and the interface is read from the entity id). The Livebox missed calls are counted from the callmissed binary sensor's missed_calls list (its callers sensor counts every call, missed or not, and is only a fallback filtered on the missed ones). Temperature and fan sensors are recognized by their temperature device class and rpm unit, disk partitions by their parent device, and connected devices by the config entry they share with the box (with a single box, the connected devices trackers that have no device are counted too). The mark calls as read and reboot buttons are found by their translation key (the reboot button also by its restart device class). On a Freebox, the connection type, IP addresses and uptime come from the attributes of its device_tracker. The connection status comes from the integration's connectivity binary sensors when it has some (Livebox connectivity with its link_type attribute; SFR Box wan_status, else dsl_status / ftth_status, with the dsl_training, dsl_line_status and net_infra sensors), else from the box's device_tracker (Freebox). The Freebox integration gives the boot date without a time zone, in the system time zone of the Home Assistant process, and the card reads it in the time zone of Home Assistant (Settings → System → General). Both match on Home Assistant OS and Supervised; in a Docker container, start Home Assistant with TZ set to the same time zone (for example -e TZ=Europe/Paris), otherwise the uptime is off by the UTC offset. When the registry is not available, English Freebox entity ids (sensor.freebox_download_speed…) are used as a fallback.

Thresholds:

Temperatures are shown in the unit of their sensor (°F with the imperial unit system) and compared to these thresholds after conversion to °C.

Support

If you find this project useful, you can support its development:

Features

• Speed test button (#107): a button next to the last speed test runs a new one. With Speedtest.net or Fast.com, it refreshes their sensors (the integration runs a test); with another speed test, it uses the entity set in entities.speedtest.run (a button or an input_button pressed, a script run, an automation triggered), also in the visual editor. Its icon turns, and it can't be pressed again, until the new results come (3 minutes at most), on every card of the page showing that speed test; a failed call stops it at once. The README screenshots show the speed test.

Features

• show_title and show_subtitle options (also in the visual editor) hide the header's title and its subtitle, separately, for a card placed under a section heading of its own (asked in juju35/ha-vehicle-card#72).

Features

• Sensors of your choice (#100): entities sets the sensors of another speed test than Speedtest.net (speedtest: download, upload, ping, from LibreSpeed, Speedtest Tracker or a sensor of your own) and of the box's values (rate_down, rate_up, sync_down, sync_up, ip, boot, wifi, missed). The box rates and the speed test can be picked in the visual editor, under Sensors of your choice.
• Fast.com: its last test (download) shows when Speedtest.net is not set up.

Fixes

• Livebox on fibre not found with the Livebox integration 3.0.0 (#98): since that release every interface rate shares the translation key interface_rate_rx / interface_rate_tx instead of one built from the interface name, so the WAN_GPON / WAN_SFP rates were no longer recognised. The WAN interface (WAN_GPON, WAN_SFP, or veip0 on the boxes with a built-in ONT) is now also told by its name in the entity id, in any language; never a sub-interface nor the DS-Lite tunnel. The keys of the earlier releases still work.
• Livebox 5 by Sagemcom (SagemcomFast5656_OFR, "Livebox Fibre") detected and drawn as a Livebox 5, like the Arcadyan one.

Features

• Bbox: the "Bouygues Bbox" integration (hass-bbox2, custom, config flow) is supported. It shares the bbox domain with the legacy platform but registers a device whose sensors have no translation key, so the box was not found (#93). Its download / upload rates, link status, public IPv4 / IPv6, uptime, Wi-Fi switch, connected devices and restart button are recognised by their entity-id suffix.
• Bbox Wi-Fi 7 model (bbox_wifi7, Sagemcom F@st 5696b), detected from the hass-bbox2 device model, drawn with the generic router silhouette.

Features

• The header icon takes the colour of the internet link state, like the status pill: green online, orange while the DSL line syncs, red offline or on a line fault, grey when unavailable. It keeps the operator colour when the box exposes no link state. On both the full and the mini card.