Giter Site home page Giter Site logo

andreasbrett / homeassistant-biketrax Goto Github PK

View Code? Open in Web Editor NEW

This project forked from basilfx/homeassistant-biketrax

0.0 1.0 0.0 641 KB

Custom component for the PowUnity BikeTrax integration for Home Assistant.

License: MIT License

Python 100.00%

homeassistant-biketrax's Introduction

Home Assistant BikeTrax

Custom component for the PowUnity BikeTrax integration for Home Assistant.

Introduction

This custom components adds support for the PowUnity BikeTrax GPS tracker.

Overview screenshot.

Features

  • Multi-device support
  • Live updates
  • Ability to control alarm, tracking and stolen-state.

Installation

HACS

This is the preferred method of installation.

  • Search for this integration and install it.
  • Restart Home Assistant.

Manual

  • Download the contents of this repository.
  • Copy the custom_components folder to your configuration folder. If you already have one, then merge its contents.
  • Restart Home Assistant.

Configuration

Add a new integration using the web interface, and follow the configuration steps.

You can also click the button below to get started.

Open your Home Assistant instance and start setting up a new integration.

Debug logging

Additional logging can be enabled from the Home Assistant integrations page. Simply enable debug logging to see additional logging of this integration.

If you ever need to share your logs, be sure to remove sensitive data such as email addresses, identifiers and serial numbers.

Known issues

Read-only mode

When read-only mode is enabled, the switches and alarm do not reflect this mode properly. For example, if you try to toggle device tracking, it will eventually restore to its previous state.

I do not really know how to handle this properly, without changing the entity type.

Alarm control panel

The current alarm control panel component in Home Assistant does not reflect the supported features properly. In addition, 'arm home' and 'arm away' have an odd meaning for a device alarm. Because of this 'bug', both modes for arming the alarm are implemented.

See nielsfaber/alarmo#384 for more information.

Stolen mode

When this integration was first introduced, there was a toggle in the PowUnity app to mark your bike as stolen. In the background, this toggled an attribute.

This functionality seems to be removed from the PowUnity app, or but behind a an additional subscription. However, the entity is still provided by this integration, because it is unknonw if it is a removed feature, or only available with an additional subscription.

References

This custom component builds on top of aiobiketrax.

Development version

If you ever need to use a newer version of aiobiketrax with this integration, you can edit custom_components/biketrax/manifest.json and adapt the requirements section to point to a newer version:

"requirements": [
  "aiobiketrax @ git+https://github.com/basilfx/aiobiketrax.git@master"
]

Shut-down Home Assistant, remove the old dependency and then restart Home Assistant. The latest version will be fetched from GitHub directly.

Removing a dependency depends on your installation. In a supervised installation, you can try the following:

docker exec -it homeassistant bash
pip uninstall aiobiketrax

Contributing

See the CONTRIBUTING.md file.

License

See the LICENSE.md file (MIT license).

Disclaimer

Use this library at your own risk. I cannot be held responsible for any damages.

This page and its content is not affiliated with PowUnity.

homeassistant-biketrax's People

Contributors

basilfx avatar dependabot[bot] avatar vlebourl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.