Polestar API 开源项目安装与使用指南
1. 项目目录结构及介绍
Polestar API 是一个与家居自动化平台 Home Assistant 集成的组件,旨在帮助用户通过其Polestar账户管理车辆。以下是该仓库的基本目录结构及其简介:
- github/workflows # GitHub Actions 工作流配置文件
- custom_components # 自定义Home Assistant组件存放位置,含polestar_api组件
└── polestar_api # 主要组件代码
- .gitignore # 忽略版本控制的文件列表
- LICENSE # 许可证文件,采用MIT License
- README.md # 项目的主要读我文件,包含安装和基本使用说明
- hacs.json # 用于HACS(Home Assistant Community Store)的元数据配置文件
- info.md # 可能包含额外的信息或说明
2. 项目的启动文件介绍
本项目的核心在于 custom_components/polestar_api
目录下的Python脚本,这些脚本共同构成了在Home Assistant中运行的自定义组件。虽然没有明确指出单个“启动”文件,但通常组件的激活是通过Home Assistant加载custom_components/polestar_api/__init__.py
文件来实现的。用户无需直接操作这个部分;集成过程更多地依赖于Home Assistant的配置添加指定的组件。
3. 项目的配置文件介绍
Home Assistant配置
为了使用此组件,您需在Home Assistant的配置文件中添加以下信息到相应的板块,通常是configuration.yaml
:
# 示例配置
polestar_api:
email: "您的邮箱地址"
password: "您的密码"
# VIN: "车辆识别号 (从1.2.0版本开始不再需要)"
请注意,从1.2.0版本起,VIN号码不再是必需项,除非您的特定情况或较旧版本需要它。
此外,对于首次安装,您需要将整个Polestar API组件添加到Home Assistant的自定义组件目录,并且可以通过HACS(Home Assistant Community Store)进行便捷安装。具体步骤包括添加仓库URL(https://github.com/leeyuentuen/polestar_api),搜索并启用组件,随后按照上述配置段落进行设置。
确保替换示例中的占位符以匹配您的个人凭据,并且在修改配置后重启Home Assistant以应用更改。
以上便是基于提供的GitHub仓库链接生成的Polestar API项目的简要安装与配置指南。遵循这些步骤应该能使您顺利地在Home Assistant环境下集成并使用Polestar API功能。