Sports Sync 同步程序使用文档

Feature

  • Garmin双向同步（国区->国际区）（国际区->国区）（国区->国区）（国际区->国际区）
  • Garmin同步时坚果云异地备份运动数据 （可支持不使用坚果云保存简化配置）
  • RQ RUN 签到
  • 各种消息推送（企业微信机器人，钉钉，Bark。。。。）目前只配置了企业微信机器人

配置参数

参数名 备注 是否必填
LOCAL_OR_WEBDAV 使用Github Action存储填False 使用坚果云保存填True 是
AESKEY AES KEY用于加密数据 是
QYWX_KEY 企业微信机器人KEY 否
RQ_EMAIL RQ帐号 是
RQ_PASSWORD RQ密码 是
SOURCE_GARMIN_AUTH_DOMAIN 主Garmin域（国区填cn 国际区填com) 是
SOURCE_GARMIN_EMAIL 主Garmin的Email 是
SOURCE_GARMIN_PASSWORD 主Garmin的Password 是
SYNC_GARMIN_AUTH_DOMAIN 同步Garmin域（国区填cn 国际区填com) 是
SYNC_GARMIN_EMAIL 同步Garmin的Email 是
SYNC_GARMIN_PASSWORD 同步Garmin的PASSWORD 是
WEBDAV_URL 坚果云服务器地址 是
WEBDAV_USERNAME 坚果云帐号 是
WEBDAV_PASSWORD 坚果云WEBDAV密钥 是

GitHub Action secrets配置

打开你的仓库点击Settings->Secrets and variables->New repository secret
GitHub Action
新增需要的参数Name填写参数名，参数如上表格：

点击New repository secret如下图填写参数：
新增步骤

存储选择

Github或者拉取本地电脑存储

选择本地存储以下三个参数不需要配置

参数名 备注
WEBDAV_URL 坚果云服务器地址
WEBDAV_USERNAME 坚果云帐号
WEBDAV_PASSWORD 坚果云WEBDAV密钥 
1
LOCAL_OR_WEBDAV 填 False

选择Github存储必需填写以下两个参数

1
2
GITHUB_NAME 填你的Github 名称
GITHUB_EMAIL 填你的Github登录邮箱

填写步骤图如下：


坚果云（WEBDAV）存储选择

选择坚果云（WEBDAV）以下三个参数必须要配置

参数名 备注
WEBDAV_URL 坚果云服务器地址
WEBDAV_USERNAME 坚果云帐号
WEBDAV_PASSWORD 坚果云WEBDAV密钥 
1
LOCAL_OR_WEBDAV 填 True

坚果云

开启坚果云WebDav

坚果云第三方应用授权WebDAV开启方法

获取WEBDAV_PASSWORD

获取图中的密钥，该密钥在Github Action中需要配置
坚果云WEBDAV密钥

1
WEBDAV_PASSWORD 上图获取的密钥
获取WEBDAV_URL

获取图中的服务器地址，该地址在Github Action中需要配置
坚果云WEBDAV地址

1
WEBDAV_URL 服务器地址

AESKEY配置（必填）

1
AESKEY 填写随机的字母符合数字长度不能超过32位

Garmin同步配置

主Garmin Github ACTION 参数配置

1
2
3
SOURCE_GARMIN_AUTH_DOMAIN 主Garmin域（国区填cn 国际区填com)
SOURCE_GARMIN_EMAIL 主Garmin的Email
SOURCE_GARMIN_PASSWORD 主Garmin的Password

需要同步Garmin Github ACTION 参数配置

1
2
3
SYNC_GARMIN_AUTH_DOMAIN 同步Garmin域（国区填cn 国际区填com)
SYNC_GARMIN_EMAIL 同步Garmin的Email
SYNC_GARMIN_PASSWORD 同步Garmin的Password

RQ跑力配置（只支持国区）

1
2
RQ_EMAIL 你的RQ跑力帐号
RQ_PASSWORD 你的RQ跑力密码

企业微信机器人Key

没有企业微信机器人不影响程序同步

获取企业微信Key

企业微信机器人
企业微信机器人的key只需要复制企业微信的url ?=key后面那部分字符串前面的不需要复制
例：

1
https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxx-2b51-xxx-9dc0-befbaa4d34ec

只需要复制这部分即可xxxx-2b51-xxx-9dc0-befbaa4d34ec

1
QYWX_KEY 企业微信机器人KEY如上xxxx-2b51-xxx-9dc0-befbaa4d34ec

启动Action

打开你的仓库点击Actions->左边的工作流（如garmin-sports-sync）->Run workflow执行测试是否能成功运行

停止RQ签到任务

可能有部分用户并不是RQ用户默认是开启这个脚本为了防止出错异常推送消息可以点击Actions->左边的rq-sigin-sync->最右边…打开点击Disable workflow