Python library for interacting with the PowUnity BikeTrax GPS tracker.
Project description
aiobiketrax
Python library for interacting with the PowUnity BikeTrax GPS tracker.
Introduction
This library is mainly written to work with a custom component for Home Assistant. You can find this custom component here.
The PowUnity BikeTrax is a GPS tracker for electric bicycles. It provides real-time updates every when the bike is in motion, using a 2G modem. It works in Europe, and requires a subscription after a trial period of one year.
Features
- Multi-device support.
- Traccar and admin API support.
- Live updates using websocket.
Not implemented:
- Geofencing.
- Global configuration, such as webhooks.
Known issues
The schemas of the models haven been reversed-engineerd by observing responses for a small number of devices. It is likely that responses of other devices do not map onto the current models. For example, some properties are not set if they have never been configured from the app.
Please open an issue, and provide some responses so that the schemas can be improved. Be sure to redact sensitive information, such as locations, unique identifiers and personal details.
Debugging
In case of issues, it is possible to enable logging in your application for the following loggers:
aiobiketrax.api
- API logging.aiobiketrax.api.responses
- Additional API response logging.aiobiketrax.api.client
- Client interaction logging.
Usage
In code
from aiobiketrax import Account
import aiohttp
async with aiohttp.ClientSession() as session:
account = Account(
username="someone@example.org",
password="secret",
session=session)
await account.update_devices()
for device in account.devices:
print(device.name)
CLI
For demonstration and testing purposes, one can use the CLI as well. If you
have the package installed, use biketrax --help
command to get started.
Mock server
For development, a mock server is included in contrib/mock/
. Simply run
server.py
and adapt aiobiketrax/consts.py
to use other endpoints.
API_TRACCAR_ENDPOINT = "http://localhost:5555/traccar/api"
API_ADMIN_ENDPOINT = "http://localhost:5555/admin/api"
Do note that authentication is not mocked.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file aiobiketrax-1.3.1.tar.gz
.
File metadata
- Download URL: aiobiketrax-1.3.1.tar.gz
- Upload date:
- Size: 18.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.4 Darwin/23.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e1f615cc14563c4ec6ae4fc92f367556120a151bae9c835548abf6a1e57c732 |
|
MD5 | e0031a6d22fdc9c006ca2e05961cbba9 |
|
BLAKE2b-256 | 9f26e6af31cf25df7f1e19125c442933de5112abb489cd331bbffb9456298cfd |
File details
Details for the file aiobiketrax-1.3.1-py3-none-any.whl
.
File metadata
- Download URL: aiobiketrax-1.3.1-py3-none-any.whl
- Upload date:
- Size: 19.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.4 Darwin/23.6.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f988a12299c71da70f3e3e82993f9cdb2b9b47a426958a06b0c108c4caf1a64 |
|
MD5 | 38a6b77fcda193786f283862cd380fa5 |
|
BLAKE2b-256 | e9a6f95164b657abd06389efbb91a3e8e720aef5c0618bd83c5d1e74ee0efeca |