An open API service indexing awesome lists of open source software.

https://github.com/andrew-codechimp/ha-andrews-arnold-quota

A Home Assistant integration to retrieve quota details of an Andrews & Arnold Broadband account
https://github.com/andrew-codechimp/ha-andrews-arnold-quota

hacs hacs-integration homeassistant

Last synced: 6 days ago
JSON representation

A Home Assistant integration to retrieve quota details of an Andrews & Arnold Broadband account

Awesome Lists containing this project

README

        

# Home Assistant Andrews & Arnold Quota Integration

[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![Downloads][download-latest-shield]](Downloads)
[![License][license-shield]](LICENSE)

[![hacs][hacsbadge]][hacs]
[![Community Forum][forum-shield]][forum]

_Integration to get broadband quota from [Andrews & Arnold](https://www.aa.net.uk)._

As there are [no quotas](https://www.aa.net.uk/etc/news/update-to-monthly-usage-quotas/) on the non-lite packages I am no longer able to test or maintain this integration, leaving it for those on lite packages.

![Andrews & Arnold Device Info](https://github.com/andrew-codechimp/HA-Andrews-Arnold-Quota/blob/main/images/screenshot.png "Andrews & Arnold Device Info")

**This integration will set up the following platforms.**

| Platform | Description |
|----------|--------------------------------------------|
| `sensor` | Show info from Andrews & Arnold Quota API. |

## Sensors

| Sensor | Description |
|:----------------------------------------|-----------------|
| `sensor.andrews_arnold_XXXXX_monthly_quota` | Monthly Quota, XXXXX is your line id to support multiple lines |
| `sensor.andrews_arnold_XXXXX_quota_remaining` | Quota Remaining, XXXXX is your line id to support multiple lines |

*Please :star: this repo if you find it useful*
*If you want to show your support please*

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)

## Installation

### HACS

This integration can be installed directly via HACS

[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=andrew-codechimp&repository=HA-Andrews-Arnold-Quota&category=Integration)

Or
Search for `Andrews & Arnold Quota` in HACS and install it under the "Integrations" category.
Restart Home Assistant
In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Andrews & Arnold Quota"

### Manual Installation

Show detailed instructions

Installation via HACS is recommended, but a manual setup is supported.

* You should take the latest [published release](https://github.com/andrew-codechimp/ha-andrews-arnold-quota/releases).
* To install, place the contents of `custom_components` into the `/custom_components` folder of your Home Assistant installation.
* Restart Home Assistant.
* In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Andrews & Arnold Quota"

## Configuration

Enter your control account details to connect to the Andrews & Arnold API.

Data is refreshed every 30 minutes.

## Contributions are welcome!

If you want to contribute to this repository, please read the [Contribution guidelines](CONTRIBUTING.md)

## Disclaimer

This integration is in no way approved, endorsed or supported by Andrews & Arnold Ltd.

***

[andrews_arnold_quota]: https://github.com/andrew-codechimp/HA-Andrews-Arnold-Quota
[commits-shield]: https://img.shields.io/github/commit-activity/y/andrew-codechimp/HA-Andrews-Arnold-Quota.svg?style=for-the-badge
[commits]: https://github.com/andrew-codechimp/HA-Andrews-Arnold-Quota/commits/main
[hacs]: https://github.com/hacs/integration
[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge
[exampleimg]: example.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/t/custom-component-andrews-arnold-uk-broadband-quota/595491
[license-shield]: https://img.shields.io/github/license/andrew-codechimp/HA-Andrews-Arnold-Quota.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/andrew-codechimp/HA-Andrews-Arnold-Quota.svg?style=for-the-badge
[releases]: https://github.com/andrew-codechimp/HA-Andrews-Arnold-Quota/releases
[download-latest-shield]: https://img.shields.io/github/downloads/andrew-codechimp/HA-Andrews-Arnold-Quota/latest/total?style=for-the-badge