hass-byd-vehicle - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #llm #go #golang #android #machine-learning #linux #nodejs #macos #awesome-list #security #pytorch #open-source

hass-byd-vehicle

(★ 282)

Custom HASS integration for BYD vehicles.

파일 탐색기

최종 버전 다운로드 (.zip)

- - 01-bug-report.yml
  - config.yml
  - feature_request.yml
- - check-logs.yaml
  - feature-request-comment.yaml
  - hacs.yaml
  - hassfest.yaml
  - lint.yaml
  - pr-comment.yaml
  - release.yaml
- dependabot.yml
- pull_request_template.md
- - __init__.py
  - binary_sensor.py
  - button.py
  - climate.py
  - config_flow.py
  - const.py
  - coordinator.py
  - device_fingerprint.py
  - device_pool.json
  - device_tracker.py
  - entity.py
  - lock.py
  - manifest.json
  - number.py
  - select.py
  - sensor.py
  - services.yaml
  - strings.json
  - switch.py
  - time.py
- CONTRIBUTING.md
- TROUBLESHOOTING.md
- - start-ha-dev.sh
.gitignore
.pylintrc
hacs.json
LICENSE
pyproject.toml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/jkaberg/hass-byd-vehicle

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd hass-byd-vehicle

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Python

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

pip install .

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BYD Vehicle Integration for Home Assistant

Home Assistant custom integration for BYD vehicles, powered by [pyBYD](https://github.com/jkaberg/pyBYD).

[![Matrix](https://img.shields.io/matrix/hass-byd-vehicle%3Akaberg.me?server_fqdn=matrix.kaberg.me&fetchMode=summary)](https://matrix.to/#/#hass-byd-vehicle:kaberg.me)

> [!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: https://github.com/jkaberg/pyBYD/issues/20

## Installation

### Option 1: HACS (Custom Repository)

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=jkaberg&repository=hass-byd-vehicle&category=Integration)

1. Open HACS → **Integrations**.
2. Open the menu (**⋮**) → **Custom repositories**.
3. Add `https://github.com/jkaberg/hass-byd-vehicle` as **Integration**.
4. Install **BYD Vehicle**.
5. Restart Home Assistant.
6. Add **BYD Vehicle** from **Settings → Devices & Services**.

### Option 2: Manual

1. Open your Home Assistant config directory.
2. Create `custom_components/` if needed.
3. Copy `custom_components/byd_vehicle/` from this repository into your HA config.
4. Restart Home Assistant.
5. Add **BYD Vehicle** from **Settings → Devices & Services**.

## Initial setup

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](https://www.youtube.com/watch?v=DRzsjYHjlqQ) 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.

## After setup

Entity updates are cloud-polled, poll intervals are exposed as entities and can be tuned using automations.

> [!TIP]
> Frequent polling can cause noticeable battery drain. Adjust the polling interval to find your ideal balance between real-time updates and battery drain.

## Documentation

- Troubleshooting: [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)
- Contributing: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)