Skip to main content

iGPSPORT

python-igps-ble

CI PyPI Python License: MIT

Talk to an iGPSPORT iGS10S cycling computer over Bluetooth LE from Python — battery, internal sensors, ride status, stored activities, last GPS position and the rider/bike profile, through iGPSPORT's proprietary protobuf-over-Nordic-UART protocol (reverse engineered from the official app, no pairing or login needed).

This library powers the iGPSPORT iGS10S Home Assistant integration, but works standalone in any async Python project (or straight from the command line).

Protocol notes: ha-igps-ble/docs/PROTOCOL.md.

Features

  • 🔌 Async BLE control built on bleak — works on Linux, macOS, and Windows.
  • 🔍 Discovery helper — discover_devices() finds nearby iGPSPORT devices (presence + RSSI).
  • 🏷️ Device info — manufacturer, hardware revision, firmware, serial and protocol version.
  • 🔋 Battery — level (%) and voltage.
  • 🌡️ Sensors — internal temperature, free memory, device clock.
  • 🚴 Ride status — idle / recording / paused, live ride fields while recording, last GPS position.
  • 🗂️ Activities — list of rides stored on the device (start time, size).
  • 💾 .fit download — download_activity(session, id, size) with per-chunk CRC and size checks.
  • 🧹 Maintenance — delete one/all activities, factory_control() (format, factory reset, settings reset, lock, logs, test mode), unbind, DFU mode.
  • 🛰️ GPS — gps_control(), set_gnss(), set_gps_dynamic(), set_gps_position().
  • 🧪 Raw — command(session, service, op, fields) for anything else.
  • ⚙️ Profile — write rider weight/height/age/sex, wheel circumference, bike weight and time zone (set_profile).
  • 🖥️ CLI — igps-ble scan / info for quick testing.

Requirements

  • Python 3.11 or newer.
  • A Bluetooth LE adapter (built-in or USB).
  • An iGPSPORT iGS10S (other iGPSPORT models exposing the same standard services may also work).

Installation

pip install python-igps-ble

CLI usage

igps-ble scan                      # find nearby iGPSPORT devices
igps-ble info AA:BB:CC:DD:EE:FF     # connect and read everything

Library usage

import asyncio
from igps_ble import IGPSDeviceState
from igps_ble.scanner import discover_devices
from igps_ble.client import IGPSClient


async def main():
    for dev in await discover_devices(timeout=10):
        state: IGPSDeviceState = await IGPSClient(
            dev.address, dev.name
        ).async_read_state()
        print(state.manufacturer, state.model, state.firmware, state.battery_level)


asyncio.run(main())

IGPSClient accepts a bleak BLEDevice (preferred — e.g. from Home Assistant's shared scanner or a Bluetooth proxy) or a string MAC/UUID address.

API

Symbol Description
discover_devices(timeout=10.0) List nearby iGPSPORT devices as IGPSDeviceState (presence + RSSI; does not connect).
is_igps_device(local_name) True if an advertisement name matches a known iGPSPORT prefix.
IGPSClient(address, name="iGS10S", rssi=None) Async client; await client.async_read_state() connects and returns an IGPSDeviceState.
read_state(client, address, name, rssi, session=None) Read everything over an already-connected BleakClient.
IGPSSession(client) Request/response over the NUS channels; await session.start() once per connection.
set_profile(session, UserProfile(...)) Write the whole rider/bike profile (the device does not report it back).
IGPSDeviceState Frozen dataclass with everything read (battery, sensors, ride status, GPS, activities…).
igps_ble.protocol Framing (20-byte header, CRC-8/MAXIM) and a tiny protobuf codec.
parse_battery_level(data) / decode_device_string(data) Pure parsers for the standard Bluetooth SIG characteristics.

Scope

Data Supported Source
Presence ✅ BLE advertisement
Manufacturer / hardware / firmware ✅ Device Information Service 0x180A
Battery % / voltage ✅ FACTORY service (protobuf)
Serial, memory, temperature, clock ✅ FACTORY service
Ride status, last GPS fix, live ride fields ✅ DEV_STATUS service (live field units unconfirmed)
Stored activity list ✅ CYCLING_DATA service
Rider/bike profile, time zone ✅ write-only USER_CONFIG service
.fit download ✅ CYCLING_DATA FILE_GET
Delete activities, format, factory reset, GPS/factory settings, unbind, DFU ✅ not live-tested FACTORY / CYCLING_DATA / BLE / FIRMWARE
Display/page settings, time sync ❌ unsupported by the iGS10S firmware

Development

python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest

Credits

Built to back the ha-igps-ble Home Assistant integration. Author @hudsonbrendon.

License

MIT — see LICENSE.

Metadata

Release files for python-igps-ble 0.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-igps-ble 0.3.4
File Size Uploaded Provenance Actions
python_igps_ble-0.3.4.tar.gz 21.8 kB Without provenance Details for python_igps_ble-0.3.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for python-igps-ble 0.3.4
File Interpreter ABI Platform Actions
python_igps_ble-0.3.4-py3-none-any.whl Python 3 none any Details for python_igps_ble-0.3.4-py3-none-any.whl

Total release size: 40.1 kB

Release files / python_igps_ble-0.3.4.tar.gz

Download URL python_igps_ble-0.3.4.tar.gz
Size 21.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e69b91f34cd23a29eb947aa7fc80a3d2a24f0eaf3dc72ffb91b2494f1d8042d6
BLAKE2b-256 checksum
How to use checksums
dea48ed76fad45cb516ab2356ed21d846c097c6f09d142188ca465a3bec123cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Release files / python_igps_ble-0.3.4-py3-none-any.whl

Download URL python_igps_ble-0.3.4-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e2f499818ae4b99d6a1492162872e45267852d1cf94fea3d917241ed205f6a35
BLAKE2b-256 checksum
How to use checksums
64fb9007de68de376be20afd45928aa384f8e91ee62d216334dc3b4d3610f8b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.5

Security for python-igps-ble 0.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page