首页
/ Python Ant Downloader 技术文档

Python Ant Downloader 技术文档

2024-12-26 05:08:40作者:咎竹峻Karen

以下为Python Ant Downloader项目的详细技术文档,包含安装指南、使用说明以及API使用文档。

1. 安装指南

简单安装(稳定版)

确保您的系统已安装python、pip以及libusb-1.0:

  • Debian/Ubuntu:
    sudo apt-get install python-pip libusb-1.0-0
    
  • Fedora:
    yum install python-pip libusb
    

您可能还需要安装python-lxml。如果跳过此步骤,pip将需要从源代码构建(这需要libxml2 libxslt1 dev软件包):

  • Debian/Ubuntu:
    sudo apt-get install python-lxml
    
  • Fedora:
    sudo yum install python-lxml
    

安装完依赖项后,您可以从PyPi安装python-ant-downloader:

sudo pip install python-ant-downloader

手动安装(稳定版/不稳定版)

您可以选择以下方式之一:

  • 克隆git项目:
    git clone git://github.com/braiden/python-ant-downloader.git
    
  • 从PyPi或Github tags下载稳定版构建。

依赖项

  • Python 2.6+
  • pyusb 1.0 - 建议从github下载最新版本。0.4版本将无法工作。
  • requests - 如果您启用了上传到Garmin Connect功能。
  • argparse - 如果Python版本小于2.7。
  • lxml
  • setuptools
  • pyserial(针对较老版本的USB ANT Stick硬件)

在Ubuntu上,大多数依赖项可以通过以下命令满足:

apt-get install python python-lxml python-pkg-resources python-requests python-serial

但是,您仍然需要从github或PyPi下载pyusb。

Fedora:

sudo yum install python python-lxml pyusb
sudo easy_install poster

2. 使用说明

运行以下命令查看帮助信息:

$ ant-downloader --help
用法:ant-downloader [-h] [--config f] [--daemon] [--verbose]
可选参数:
  -h, --help        显示此帮助信息并退出
  --config f, -c f  使用提供的配置文件,默认为 ~/.antd/antd.cfg,
  --daemon, -d      以持续搜索模式运行,从任何可用设备下载数据,不会与新设备配对
  --verbose, -v     启用所有调试输出,NOISY:查看配置文件以选择性启用记录器

首次使用

确保您有权限访问USB设备。在/etc/udev/rules.d/99-garmin.rules中添加以下内容之一:

  • Ubuntu 10.04(或其他较老版本):
    SUBSYSTEM=="usb", SYSFS{idVendor}=="0fcf", SYSFS{idProduct}=="1008", MODE:="666"
    
  • Ubuntu 12.04,Fedora 19(或其他较新版本):
    SUBSYSTEM=="usb", ATTR{idVendor}=="0fcf", ATTR{idProduct}=="1008", MODE:="666"
    

首次运行程序时,需要与GPS设备配对。确保GPS设备处于唤醒状态(按下一个按钮),并确保已启用配对。然后运行ant-downloader。当提示您在GPS设备上接受配对请求时,接受即可。一旦请求被接受,将保存一个密钥,下次无需再次配对。

您还可以选择在设备上启用“强制下载”功能。这将导致所有旧数据被下载。警告,它还会上传所有数据到Garmin Connect。

此外,设备不能被usbserial内核模块占用。如果出现错误并且dmesg显示:

usb 3-1.2: usbfs: interface 0 claimed by usbserial_generic while 'ant-downloader' sets config #1

尝试卸载'usbserial'内核模块。

配置

有关配置选项,包括文件保存位置和Garmin Connect登录详细信息,请查看antd.cfg。文件将在您首次运行程序时在~/.antd目录中创建。

3. 项目API使用文档

本项目API使用文档暂不提供,请参考项目源代码及配置文件进行API使用。

以上为Python Ant Downloader项目的详细技术文档,希望能帮助用户更好地使用和理解该项目。

登录后查看全文
热门项目推荐