search

jampez77 / DVLA-Vehicle-Enquiry-Service

A custom component for connecting to the DVLAs Vehicle Enquiry Service API.
MIT License
27 stars 5 forks source link
hacs hacs-integration homeassistant homeautomation

readme

Logo DVLA Vehicle Enquiry Service for Home Assistant

This component provides vehicle details of a specified vehicle into and adds a sensor to Home Assistant which can be used in your own automations.

GitHub Release License hacs_badge Project Maintenance

Enjoying this? Help me out with a :beers: or :coffee:!

coffee

Installation through HACS

You can install the DVLA Vehicle Enquiry Service integration by searching for it there in HA instance.

Manual Installation

Use this route only if you do not want to use HACS and love the pain of manually installing regular updates.

Usage

Before you can configure this sensor, you must register and obtain and API key at VES API Registration.

The API is ratelimited, this is predefined when filling in the registration form under Estimated monthly enquiry volumes input. The default scan interval is every 6 hours (21600 seconds), this translates to about 62 for Estimated monthly enquiry volumes.

You can change this value at any time by configuring the scan interval for an instance. You should take the rate limiting into account when setting the scan interval and vice versa.

Also make sure to select no for Testing otherwise you won't have access to any live data.

Contributing

Contirbutions are welcome from everyone! By contributing to this project, you help improve it and make it more useful for the community. Here's how you can get involved:

How to Contribute

  1. Report Bugs: If you encounter a bug, please open an issue with details about the problem and how to reproduce it.
  2. Suggest Features: Have an idea for a new feature? I'd love to hear about it! Please open an issue to discuss it.
  3. Submit Pull Requests: If you'd like to contribute code:
    • Fork the repository and create your branch from main.
    • Make your changes in the new branch.
    • Open a pull request with a clear description of what you’ve done.

Data

The following attributes can be expose as attributes in HA. It's also worth mentioning that some data won't be returned if it doesn't apply to the specific vehicle.