Home Assistant custom integration for BYD vehicles, powered by pyBYD.
Note
The integration and pyBYD are nearing feature complete. A small number of API values still need final mapping/validation. Follow ongoing mapping work in pyBYD issue #20: jkaberg/pyBYD#20
- Open HACS → Integrations.
- Open the menu (⋮) → Custom repositories.
- Add
https://github.com/jkaberg/hass-byd-vehicleas Integration. - Install BYD Vehicle.
- Restart Home Assistant.
- Add BYD Vehicle from Settings → Devices & Services.
- Open your Home Assistant config directory.
- Create
custom_components/if needed. - Copy
custom_components/byd_vehicle/from this repository into your HA config. - Restart Home Assistant.
- Add BYD Vehicle from Settings → Devices & Services.
Configuration is UI-only via Home Assistant config flow.
Tip
Use an dedicated BYD account for the integration, that way you won't be logged out from the BYD app on your main account - see here for instructions.
Important
If you intend to control the car via the integration (turn on/off A/C, lock the car etc.), it's crucial that you set up an operation/control PIN in the BYD app prior to setting up this integration. This also applies if you use an dedicated account for the integration, which means the dedicated account must also set an control PIN.
| Field | Required | Default | Description |
|---|---|---|---|
| Username | Yes | — | BYD account username (email/phone). |
| Password | Yes | — | BYD account password. |
| Country | Yes | United Kingdom | Country used for country code and language. |
| Control PIN | No | — | Optional PIN used for remote commands. |
| Climate duration | No | 10 | Climate run time in minutes. |
| Debug dump API responses | No | Off | Writes API request/response traces for troubleshooting. |
Tip
If you get invalid authentication, verify credentials first, then verify selected country.
Entity updates are cloud-polled, poll intervals are exposed as entities and can be tuned using automations.
- Troubleshooting: docs/TROUBLESHOOTING.md
- Contributing: docs/CONTRIBUTING.md