跳转到主要内容

雷诺API

项目描述

PyPI Python Version License

Read the documentation at https://renault-api.readthedocs.io/ Tests Codecov

pre-commit Ruff

功能

此Python包用于管理与官方MyRenault应用程序使用的私有雷诺API的通信。

客户端能够读取各种车辆属性,例如

  • 里程

  • GPS位置

  • 燃油续航能力(适用于燃油车辆)

  • 电池续航能力(适用于电动汽车)

  • 与车辆关联的合同(保修和连接服务)

对于某些车辆,还可以管理

  • 车辆的HVAC/预调节

  • 充电计划

此包已开发用于与Home-Assistant一起使用,但也可以在其他环境中使用

需求

  • Python (>= 3.8)

API使用

您可以通过pipPyPI安装雷诺API

$ pip install renault-api
import aiohttp
import asyncio

from renault_api.renault_client import RenaultClient

async def main():
   async with aiohttp.ClientSession() as websession:
      client = RenaultClient(websession=websession, locale="fr_FR")
      await client.session.login('email', 'password')
      print(f"Accounts: {await client.get_person()}") # List available accounts, make a note of kamereon account id

      account_id = "Your Kamereon account id"
      account = await client.get_api_account(account_id)
      print(f"Vehicles: {await account.get_vehicles()}") # List available vehicles, make a note of vehicle VIN

      vin = "Your vehicle VIN"
      vehicle = await account.get_api_vehicle(vin)
      print(f"Cockpit information: {await vehicle.get_cockpit()}")
      print(f"Battery status information: {await vehicle.get_battery_status()}")

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

CLI使用

renault-api 也通过 CLI 提供支持,这需要额外的依赖项。对于添加的依赖项,您可以通过 pipPyPI 安装 Renault API

$ pip install renault-api[cli]

安装完成后,以下命令会提示输入凭据和设置,显示基本车辆状态信息,并生成跟踪信息

$ renault-api --log status
  • 凭据将自动存储在用户主目录 (~/.credentials/renault-api.json)

  • 日志将自动生成在 logs 子目录

有关详细信息,请参阅 命令行参考

贡献

我们非常欢迎贡献。要了解更多信息,请参阅 贡献指南

许可证

在 MIT 许可证的条款下分发,Renault API 是免费且开源的软件。

免责声明

本项目与雷诺没有关联,也没有获得其认可或支持。我不对使用此项目与雷诺的 API 交互产生的任何后果(无论是故意的还是意外的)承担任何责任。

问题

如果您遇到任何问题,请附上详细描述 提交问题

鸣谢

本项目基于 @cjolowiczHypermodern Python Cookiecutter 模板创建。本项目主要基于 @jamesremuscatPyZE Python 客户端,用于 Renault ZE API。

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源代码分发

renault_api-0.2.7.tar.gz (35.9 kB 查看哈希值)

上传时间 源代码

构建分发

renault_api-0.2.7-py3-none-any.whl (47.3 kB 查看哈希值)

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页