Advanced Home Assistant Lovelace card for BYD vehicles with a 3D-style UI, multi-language support, vehicle profiles, and category-based controls.
This card requires the BYD integration below.
Without it, the BYD entities do not exist, and the card cannot show data or control the vehicle:
Recommended order:
- Install
hass-byd-vehicle. - Verify BYD entities are available in Home Assistant.
- Install and use
BYD 3D Card.
- 3D hero layout for vehicle image and battery status
- Vehicle profiles:
ATTO 3,SEAL,DOLPHIN,SEALION 7,ATTO 2,SEAL 5,DOLPHIN SURF,TANG - Auto entity mapping via
entity_prefix - Category tabs (radio style):
SummaryClimateVehicleTiresLocationQuick actions
- Drag & drop category order in UI editor
- Last selected category is remembered after refresh
- Languages: Hebrew, English, Russian, French, Catalan
- Local profile images from
pic/ - External actions: choose multiple entities from Home Assistant and trigger them from a hero popup
- Trunk control: hero icon color reflects open/closed state, with a Yes/No confirmation popup before opening or closing (opt-in via editor toggle)
- Vehicle shutdown control: hero icon with a Yes/No confirmation popup before shutting down the vehicle (opt-in via editor toggle)
- Optional unlock PIN protection with numeric keypad popup (
Enterto confirm) - Charging cost popup with configurable
cost per kWh - Charging consumption mode selector:
monthly(internal monthly tracking)sensor(direct current sensor value)
- Hybrid profile support (
SEAL 5,TANG):- Hero top strip:
- Hybrid:
fuel %+battery %+range km - Non-hybrid:
battery %+range km(no fuel shown)
- Hybrid:
- Summary fuel panel with progress bar (same style structure as battery bar)
- Uses BYD integration sensor naming (
elec_percent,oil_percent,oil_endurance)
- Hero top strip:
- Install from HACS as a
Dashboardrepository. - Add Lovelace resource (if not added automatically):
/hacsfiles/<repository-name>/byd-3d-card-hacs.js- Type:
module
- Hard refresh the browser/app.
Important:
- This repository ships
dist/with a flat file layout (no nested folders). - HACS downloads dashboard files from
dist/, and nested directories are not reliably copied for this type. - Images and language files are shipped as root files in
dist/to ensure they are copied.
- Copy
dist/contents to:/config/www/byd-card/
- Add Lovelace resource:
- URL:
/local/byd-card/byd-3d-card.js - Type:
module
- URL:
- Hard refresh the browser/app.
Check these quickly:
- Resource URL must be exactly:
- Manual install:
/local/byd-card/byd-3d-card.js - HACS install:
/hacsfiles/<repository-name>/byd-3d-card-hacs.js
- Manual install:
- Resource type must be:
module
- File must exist on HA host:
- Manual install:
/config/www/byd-card/byd-3d-card.js - HACS install:
/config/www/community/<repository-name>/byd-3d-card-hacs.js
- Manual install:
- If browser/app cache is stale, add a version query:
/hacsfiles/<repository-name>/byd-3d-card-hacs.js?v=1.0.20
- Then hard refresh the browser/app again.
type: custom:byd-3d-card
vehicle_profile: atto3
title: Moshiko BYD ATTO 3
title_font_size: 35
entity_prefix: byd_atto_3
image_url: ""
show_tires: true
show_actions: true
show_climate: true
show_vehicle: true
show_location: true
show_charging_cost: true
charging_cost_per_kwh: 0.63
charging_cost_mode: monthly
show_trunk_button: true
show_shutdown_button: true
require_unlock_pin: false
unlock_pin_code: ""
tire_pressure_unit: psi
refresh_interval_seconds: 25
language: he
category_order:
- summary
- climate
- vehicle
- tires
- location
- actions
custom_entities:
- script.open_parking_gate
- light.garden
entities: {}
tire_pressure_unit options:
psikpa
require_unlock_pin and unlock_pin_code:
- Set
require_unlock_pin: trueto require PIN verification before unlock action. - PIN must be 4-8 digits.
- When PIN is enabled, unlock confirmation uses a numeric keypad popup (
0-9,Clear,Enter). - Security note: the PIN is saved in Lovelace card config, so treat dashboard edit access as sensitive.
custom_entities:
- Any entity IDs from any domain.
- A script icon appears on the hero image (left-bottom, aligned with lock badge).
- Tap it to open a 3-column popup grid with buttons for selected entities.
- In card editor, each selected entity can get a custom icon (for example
mdi:gate-open).
Charging cost options:
show_charging_cost: shows/hides money icon on hero image and the charging cost popup.charging_cost_per_kwh: numeric price used for cost calculation.charging_cost_mode:monthly: tracks monthly consumed charging energy internally and resets at a new month.sensor: uses current charging-energy sensor value directly.
Trunk & vehicle shutdown options:
show_trunk_button: shows/hides the trunk icon on the hero image. Requiresbutton.<prefix>_open_trunkand/orbutton.<prefix>_close_trunk, plus a binary sensor for trunk state (auto-detected asbinary_sensor.<prefix>_trunkorbinary_sensor.<prefix>_trunk_lid) to color the icon and pick the correct confirmation text. If the state entity is missing, the icon does not appear. Icon is red when the trunk is closed, green when open.show_shutdown_button: shows/hides the vehicle shutdown icon on the hero image. Requiresbutton.<prefix>_shutdown_vehicle. Icon color reflects whether the vehicle looks active (climate/AC on, or speed > 0): green when active, red when idle.- Both icons open a Yes/No confirmation popup before sending the command (same pattern as unlock).
- The lock icon uses the same red/green convention: red when locked, green when unlocked.
- The external actions ("scenarios") and charging cost icons are always a fixed, subtle blue — they are shortcuts, not state indicators.
- Some BYD integration versions ship these entities disabled by default (
entity_registry_enabled_default: False). If an icon does not show up even with the toggle on, check Home Assistant → Settings → Devices & services → Entities → filter by "Disabled" and enable the relevant entity. - If your entities use a different suffix, override manually in YAML:
entities:
trunk_lid: binary_sensor.byd_atto_3_trunk
open_trunk: button.byd_atto_3_open_trunk
close_trunk: button.byd_atto_3_close_trunk
shutdown_vehicle: button.byd_atto_3_shutdown_vehicleHybrid behavior:
- Hybrid fuel in top strip and summary panel is shown only for hybrid profiles (
seal5,tang). - Non-hybrid profiles keep top strip with battery/range only.
- The card prefers sensor mapping used by
jkaberg/hass-byd-vehicle:- battery:
sensor.<prefix>_elec_percent - fuel:
sensor.<prefix>_oil_percent - fuel range fallback:
sensor.<prefix>_oil_endurance
- battery:
- If your entities differ, you can override manually in YAML:
entities:
battery: sensor.byd_seal_5_elec_percent
fuel: sensor.byd_seal_5_oil_percent
fuel_range: sensor.byd_seal_5_oil_endurance- Open dashboard edit mode and click card
Edit. - In
Categories, enableRequire PIN before unlock. - In
Vehicle unlock PIN, enter 4-8 digits. - Click
Save. - Test by tapping
Unlock:- The popup asks confirmation.
- Numeric keypad is shown.
- Enter PIN and press
Enter.
YAML equivalent:
require_unlock_pin: true
unlock_pin_code: "1234"- Open card
Edit. - In
External actions, enableEnable external actions. - Click
Open settings. - Search and add entities to the selected list.
- Optional: set custom label and icon for each selected entity.
- Click
Save. - In the card hero area, tap the external actions icon to open the popup and run actions.
dist/byd-3d-card.js- main custom card file for HACS/manual runtimedist/byd-3d-card-hacs.js- HACS-specific entry filedist/*.json- language files shipped with the carddist/*.png- profile images shipped with the card
pic/bydatoo3.png- BYD ATTO 3 profile imagepic/byd_dolphin.png- BYD DOLPHIN profile imagepic/seal.png- BYD SEAL source profile imagepic/sealion.png- BYD SEALION 7 source profile imagepic/byd_seal.png- resized SEAL variant (450x273)pic/byd_seal.png- SEAL / SEAL 5 profile imagepic/byd_sealion7.png- resized SEALION 7 variant (450x273)pic/ATTO2.png- BYD ATTO 2 profile imagepic/dolphin_surf.png- BYD DOLPHIN SURF profile imagepic/TANG.png- BYD TANG profile image
| ATTO 3 | DOLPHIN |
|---|---|
![]() |
![]() |
| SEAL | SEALION 7 |
|---|---|
![]() |
![]() |
What it shows:
- Hero image + battery status badge
- Alert ribbon (single issue example)
- 6 category tabs
- Summary panel with power, range, battery bar and key metrics
What it shows:
- Climate metrics (A/C, battery heat, cabin/exterior temperatures)
- Climate controls grid (
on/off, temp up/down, preset modes) - Seat heating controls with level buttons
- Active service icons in hero area
What it shows:
- Vehicle status cards:
- Doors
- Windows
- Lock
- Online
- Speed
- Odometer
What it shows:
- Quick control buttons:
- Lock / Unlock
- A/C On / A/C Off
- Battery heat
- Flash lights
- Find car
- Close windows
- Active button highlighting and visual feedback
Use this flow to protect unlock action with PIN:
- Enable
Require PIN before unlockin editor - Enter 4-8 digit PIN in
Vehicle unlock PIN - Unlock action opens numeric keypad popup
- Press
Enterafter typing the PIN
What it shows:
- Tire pressure per wheel in PSI
- Color-based status:
- Green = normal
- Orange = warning
- Red = critical
What it shows:
- Vehicle profile selection with preview images
- Card title + title font size control
- Entity prefix
- Language picker with flags
- Live preview on the right
In editor you can configure:
- External actions toggle and selected entities
- Unlock PIN requirement and PIN code field
What it shows:
- The hero popup opened from the external actions icon
- Selected entities shown as quick action tiles
- Live state text under each action
What it shows:
- Image paths and i18n path configuration
- Refresh interval setting
- Category visibility toggles
- Category order drag & drop
What it shows:
- Full English editor labels
- Same category visibility + ordering workflow
- Live preview in English
What it shows:
- Catalan (
Català) language support in the editor - New vehicle profiles in selection grid:
ATTO 2,DOLPHIN SURF,TANG - Live preview with the new
TANGprofile
What it shows:
- Top strip behavior for hybrid profiles (
fuel %,battery %,range km) - Fuel panel in summary with progress bar style aligned to battery bar structure
What it shows:
- Dedicated charging cost popup from hero money icon
- Monthly period display (
MM/YYYY) - Consumption (
kWh), price perkWh, and estimated total cost
What it shows:
- Price per
kWhinput field - Consumption mode dropdown:
Internal monthlyCurrent sensor value
What it shows:
- Money icon positioned in hero area between external actions and lock icons
- Quick access to charging cost popup from the main dashboard view
entity_prefixexample:- For
sensor.byd_atto_3_battery_level, usebyd_atto_3.
- For
- Language files are loaded from:
i18n_base_path/<language>.json
- By default,
image_base_pathandi18n_base_pathare auto-detected from the loaded card URL, so HACS/manual installs work without extra path config. - If local profile image is missing, the card falls back to built-in SVG.





















