PSA Car Controller 项目安装与使用教程

PSA Car Controller 项目安装与使用教程

psa_car_controller Control psa car with connected_car v4 API. 项目地址: https://gitcode.com/gh_mirrors/ps/psa_car_controller

1. 项目目录结构及介绍

psa_car_controller/
├── README.md
├── requirements.txt
├── setup.py
├── psa_car_controller/
│   ├── __init__.py
│   ├── api.py
│   ├── car_controller.py
│   ├── config.py
│   ├── utils.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_api.py
│   ├── test_car_controller.py
│   └── ...
└── docs/
    ├── index.md
    ├── installation.md
    ├── usage.md
    └── ...

目录结构说明

• README.md: 项目介绍文件，包含项目的基本信息、安装步骤和使用说明。
• requirements.txt: 项目依赖文件，列出了项目运行所需的Python包。
• setup.py: 项目安装脚本，用于安装项目及其依赖。
• psa_car_controller/: 项目主目录，包含项目的核心代码。
  • init.py: 初始化文件，使该目录成为一个Python包。
  • api.py: 与PSA汽车API交互的核心模块。
  • car_controller.py: 控制汽车的主要逻辑模块。
  • config.py: 配置文件处理模块。
  • utils.py: 工具函数模块。
• tests/: 测试目录，包含项目的单元测试代码。
• docs/: 文档目录，包含项目的详细文档。

2. 项目启动文件介绍

项目的启动文件是 psa_car_controller/car_controller.py。该文件包含了控制PSA汽车的主要逻辑，包括与API的交互、状态获取、充电控制、空调控制等功能。

启动文件主要功能

• 初始化配置: 从配置文件中读取API密钥、车辆信息等。
• API交互: 通过PSA汽车的Connected Car v4 API与汽车进行通信。
• 状态获取: 获取汽车的当前状态，如电池电量、位置等。
• 控制功能: 提供充电控制、空调控制、车门锁定/解锁等功能。

3. 项目配置文件介绍

项目的配置文件通常位于 psa_car_controller/config.py 中。该文件包含了项目的所有配置项，如API密钥、车辆信息、充电设置等。

配置文件主要内容

• API密钥: 用于与PSA汽车API进行身份验证的密钥。
• 车辆信息: 包含车辆的型号、VIN码等信息。
• 充电设置: 设置充电阈值、充电停止时间等。
• 空调设置: 设置空调的温度、模式等。
• 其他设置: 如日志级别、数据存储路径等。

配置文件示例

# config.py

API_KEY = 'your_api_key_here'
VEHICLE_VIN = 'your_vehicle_vin_here'

CHARGE_THRESHOLD = 80  # 充电阈值，百分比
STOP_CHARGE_HOUR = 22  # 停止充电时间，24小时制

AC_TEMPERATURE = 22  # 空调温度，摄氏度
AC_MODE = 'COOL'  # 空调模式，如COOL, HEAT

LOG_LEVEL = 'INFO'  # 日志级别，如DEBUG, INFO, WARNING, ERROR
DATA_STORAGE_PATH = '/path/to/storage'  # 数据存储路径

通过以上配置文件，用户可以根据自己的需求调整项目的各项设置，以实现对PSA汽车的个性化控制。

psa_car_controller Control psa car with connected_car v4 API. 项目地址: https://gitcode.com/gh_mirrors/ps/psa_car_controller