/ha-bouncie

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

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

bouncie

CI - Main GitHub Release License hacs Discord Buy Me A Coffee

🤟 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. It will help me continue supporting this product. 🙏

Component to integrate with [bouncie][bouncie].

This component will set up the following platforms.

Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) download bouncie.zip from latest release.
  4. Unzip bouncie.zip file in custom_components folder.
  5. Restart Home Assistant
  6. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "bouncie"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/bouncie/translations/en.json
custom_components/bouncie/__init__.py
custom_components/bouncie/coordinator.py
custom_components/bouncie/config_flow.py
custom_components/bouncie/const.py
custom_components/bouncie/manifest.json
custom_components/bouncie/sensor.py
custom_components/bouncie/strings.json

Configuration is done in the UI

The bouncie integration uses the Bouncie web service as a source for monitoring your car(s).

Setup

To generate an Bouncie application credentials -

  1. Go to the Bouncie Developer Page 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. Visit https://auth.bouncie.com/dialog/authorize?response_type=code&<client_id>=&redirect_uri=<redirect_url> in a browser.
  9. Follow the prompts to provide your application access to your account
  10. Copy the alphanumeric string after <redirect URL provided above>?code=... - this is your authorization_code
  11. Note down following values to enter in Home Assistant
    1. Client ID
    2. Client Secret
    3. Redirect URL
    4. Authorization code
This integration currently uses REST API only with polling.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines