Skip to main content

A Python package for interacting with Bluetooth Low Energy (BLE) compatible bike trainers and power meters

Project description

pycycling

A Python package for interacting with Bluetooth Low Energy (BLE) compatible bike trainers and power meters.

The package uses Bleak (Bluetooth Low Energy platform Agnostic Klient) behind the scenes to connect and communicate with bike trainers. Bleak is cross-platform with support for Windows, MacOS, and Linux. Please refer to the Bleak repository for more information about supported platforms.

Disclaimer

I take no responsibility if the use of this package breaks your turbo trainer or stationary bike. Use at your own risk!

I have tested it with (tested protocols in brackets):

  • a Tacx NEO trainer (ANT+ FE-C over BLE, CPS, CSCS)
  • a Tacx NEO 2T trainer (ANT+ FE-C over BLE, CPS, CSCS)
  • an Elite Sterzo Smart steering plate (STERZO)
  • a pair of Garmin Vector 3 power meter pedals (CPS)
  • a Garmin RVR315 rear view radar (RDR)
  • a Magene S3+ Speed/Cadence sensor (CSCS)
  • a Elite Suito-T smart trainer (CPS, CSCS, FTMS)

Please let me know if you have used it with another device, and I will add it to the list.

Supported protocols

Protocol name Fully supported Partially supported
Battery Service (BAS)
Cycling Speed and Cadence Service (CSCS)
Cycling Power Service (CPS)
Elite Sterzo Steering Service (STERZO)
FiTness Machine Service (FTMS)
Heart Rate Service (HRS)
Tacx Trainer Control (ANT+ FE-C over BLE)
Rear View Radar (RDR)

Installation

Clone this repo and then run the following command from the root directory

python setup.py develop

Documentation

Please refer to the documentation and the examples folder for basic usage of the package.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/zacharyedwardbull/pycycling. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

In terms of contributing code, pull requests increasing the features supported in each protocol are especially welcome. If you would like to add support for another cycling related protocol, that would also be appreciated!

Useful documentation

Projects using pycycling

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycycling-0.3.0.tar.gz (156.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pycycling-0.3.0-py3-none-any.whl (158.8 kB view details)

Uploaded Python 3

File details

Details for the file pycycling-0.3.0.tar.gz.

File metadata

  • Download URL: pycycling-0.3.0.tar.gz
  • Upload date:
  • Size: 156.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pycycling-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0318e52683b6e50b6c7f473ea1765deb5ddf44d5cd707ba0f143ee85cd343171
MD5 6c8a0e97c2a300f584da605e1ed7fdc0
BLAKE2b-256 3fa3cef02ed480de2701e85f1f9b9a050ff454a7bb005cf98203564d96e319ae

See more details on using hashes here.

File details

Details for the file pycycling-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: pycycling-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 158.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pycycling-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70fb98db11fa1ed82b9006c4db4fdffc64e37935a49444a40cb1bb853800f306
MD5 8e7bffdb80034e98608cc617d5f05240
BLAKE2b-256 09b17f61242a606b2120303d0f38860cf6471efb748dfa56c725c2a19a229bd1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page