openant icon indicating copy to clipboard operation
openant copied to clipboard

ANT and ANT-FS Python Library

openant

Build Status Coverage Status Code style: black

A python library to download and upload files from ANT-FS compliant devices (Garmin products).

Features

  • ANT
  • ANT-FS (with command pipe, file listings, downloading, uploading, etc)
  • Three libs (ant.base basic ANT library, ant.easy blocking version using ant.base, ant.fs ANT-FS library)

Requirements

  • Python >= 3.6
  • PyUSB >= 1.1.0
  • Root access (for installation only)

Automatic install

  • Install setuptools:

      apt-get install python-setuptools
    

or

    wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python
  • Run the following command:

      sudo python setup.py install
    

This will install everything required on your active python installation.

Manual install

These should only be necessary to install manually, if you don't want to use the Automatic installation script.

  • Install PyUSB.

      pip install pyusb
    

    (Or alternatively from sources available on GitHub)

  • Install udev rules (Only required to avoid running the program as root).

      sudo python setup.py udev_rules
    

Windows install

Windows does not use udev_rules and therefore does not need to be installed. The installation of udev_rules is bypassed for Windows. libusb is supported by Windows. Follow libusb's driver installation instructions for Windows.

Supported devices

ANT USB Sticks

ANT-FS Devices

Any compliant ANT-FS device should in theory work, but those specific devices have been reported as working:

  • Garmin Forerunner 60
  • Garmin Forerunner 405CX
  • Garmin Forerunner 310XT
  • Garmin Forerunner 610
  • Garmin Forerunner 910XT
  • Garmin FR70
  • Garmin Swim
  • Garmin vívoactive HR

Please let me know if you have any success with devices that are not listed here.