https://github.com/jampez77/dvla-vehicle-enquiry-service

A custom component for connecting to the DVLAs Vehicle Enquiry Service API.
https://github.com/jampez77/dvla-vehicle-enquiry-service

hacs hacs-integration homeassistant homeautomation

Last synced: 3 months ago
JSON representation

A custom component for connecting to the DVLAs Vehicle Enquiry Service API.

• Host: GitHub
• URL: https://github.com/jampez77/dvla-vehicle-enquiry-service
• Owner: jampez77
• License: mit
• Created: 2023-01-26T16:28:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-28T08:42:44.000Z (11 months ago)
• Last Synced: 2025-04-02T02:37:54.998Z (7 months ago)
• Topics: hacs, hacs-integration, homeassistant, homeautomation
• Language: Python
• Homepage:
• Size: 73.2 KB
• Stars: 28
• Watchers: 2
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ![Logo](https://github.com/jampez77/DVLA-Vehicle-Enquiry-Service/blob/main/logo.png "DVLA 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](https://www.home-assistant.io/) which can be used in your own automations.

---

[![GitHub Release][releases-shield]][releases]

[![License][license-shield]](LICENSE.md)

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)

![Project Maintenance][maintenance-shield]

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

[![coffee](https://www.buymeacoffee.com/assets/img/custom_images/black_img.png)](https://www.buymeacoffee.com/whenitworks)

## Installation through [HACS](https://hacs.xyz/)

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](https://hacs.xyz/) and love the pain of manually installing regular updates.

* Add the `dvla` folder in your `custom_components` folder

## Usage

Before you can configure this sensor, you must register and obtain and API key at [VES API Registration](https://register-for-ves.driver-vehicle-licensing.api.gov.uk/).

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.

- registrationNumber

- taxStatus

- taxDueDate

- motStatus

- make

- yearOfManufacture

- engineCapacity

- co2Emissions

- fuelType

- markedForExport

- colour

- typeApproval

- dateOfLastV5CIssued

- motExpiryDate

- wheelplan

- monthOfFirstRegistration

- artEndDate

- revenueWeight

- euroStatus

- realDrivingEmissions

---

[commits-shield]: https://img.shields.io/github/commit-activity/y/jampez77/DVLA-Vehicle-Enquiry-Services.svg?style=for-the-badge

[commits]: https://github.com/jampez77/DVLA-Vehicle-Enquiry-Service/commits/main

[license-shield]: https://img.shields.io/github/license/jampez77/DVLA-Vehicle-Enquiry-Service.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/Maintainer-Jamie%20Nandhra--Pezone-blue

[releases-shield]: https://img.shields.io/github/v/release/jampez77/DVLA-Vehicle-Enquiry-Service.svg?style=for-the-badge

[releases]: https://github.com/jampez77/DVLA-Vehicle-Enquiry-Service/releases