Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mandarons/ha-bouncie

Home Assistant custom integration for Bouncie.com - track your car stuff in Home Assistant
https://github.com/mandarons/ha-bouncie

car car-metrics home-assistant home-assistant-custom-component

Last synced: about 1 month ago
JSON representation

Home Assistant custom integration for Bouncie.com - track your car stuff in Home Assistant

Awesome Lists containing this project

README

        

# bouncie

[![CI - Main][build-shield]][build]
[![Tests](https://mandarons.github.io/ha-bouncie/badges/tests.svg)](https://mandarons.github.io/ha-bouncie/test-results/)
[![Coverage](https://mandarons.github.io/ha-bouncie/badges/coverage.svg)](https://mandarons.github.io/ha-bouncie/test-coverage/index.html)
[![GitHub Release][releases-shield]][releases]
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
[![Discord][discord-badge]][discord]
Buy Me A Coffee

:love_you_gesture: Please star this repository if you end up using this integration. If it improved your life in any way, consider donating for my effort using 'Buy Me a Coffee' button above or sponsoring this project using GitHub Sponsors. It will help me continue supporting this product. :pray:

## Installation

1. Upgrade HACS to 1.31.0+ version
2. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "bouncie"
3. Configuration is done in the UI

The `bouncie` integration uses the [Bouncie](https://www.bouncie.dev/) web service as a source for monitoring your car(s).

## Setup

To generate an Bouncie application credentials -

1. Go to the [Bouncie Developer Page](https://bouncie.dev/) page
2. Login with your `bouncie.com` credentials
3. Click on `+ ADD APPLICATION`
4. Provide a `name` for application e.g. Home Assistant Integration
5. Provide a unique `client_id` e.g. alphanumeric random string
6. Provide redirect URL to be your Home Assistant URL
7. Click on `SAVE`
8. Click on the "Users & Devices" tab at the top of the page.
9. Click on the "Authorize My Devices" blue button.
10. Choose 'Yes' when prompted to authorize devices to your application.
11. You should now see your account listed in the "Users & Devices" list.
12. Next to your listed account, click the "Expand" arrow to see your "Auhtorization Code"
13. Copy the alphanumeric listed under "Authorization Code" - this is your `authorization_code`
14. Note down following values to enter in Home Assistant
1. Client ID
2. Client Secret
3. Redirect URL
4. Authorization Code

> **Note**
> This integration currently uses REST API only with polling. `scan_interval` (default is 10 seconds) can be set to a custom value in integration configuration setting.

## Contributions are welcome!

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

---

[build]: https://github.com/mandarons/bounciepy/actions/workflows/ci-main-test-coverage.yml
[build-shield]: https://github.com/mandarons/bounciepy/actions/workflows/ci-main-test-coverage.yml/badge.svg
[hacs]: https://github.com/hacs/integration
[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg
[license-shield]: https://img.shields.io/github/license/mandarons/ha-bouncie.svg
[releases-shield]: https://img.shields.io/github/v/release/mandarons/ha-bouncie
[releases]: https://github.com/mandarons/ha-bouncie/releases
[discord]: https://discord.gg/rPaGYqZW
[discord-badge]: https://img.shields.io/discord/871555550444408883
[github-sponsors]: https://github.com/sponsors/mandarons
[github-sponsors-badge]: https://img.shields.io/github/sponsors/mandarons