Amazfish

Donations: https://paypal.me/piggz

Companion application for Huami Devices (such as Amazfit Bip, Cor, MiBand2/3 and GTS and GTS), Pinetime Infinitime and Bangle.js.

This release is for SFOS 4.1 only.  For older SFOS versions see OBS.

Updated Installation Instructions (Aug 2021)

This application requires several supporting packages.  Until Aug 2021, these were available on openrepos for the latest SailfishOS release.  Updating these libs is a big pain, so they have now moved to SailfishOS::Chum.  If you dont know what that is, read this https://build.merproject.org/project/show/sailfishos:chum:testing

To install Amazfish, first install the "chum" repository from the link above and "pkcon refresh" then install Amazfish.

I apologise about thie extra step, but it makes updates much easier.  Pacakges in chum are automatically built for each SailfishOS release and instantly available.  In the future, Amazfish may also be distributed this way, but for now, it can still be installed from here, for the current SailfishOS release.

If you already have Amazfish installed, and need to update, you will also need chum, but you may have to drop to a command line and "zypper dup" and accept and changes to the package vendor.

Supported Devices

There are 3 tiers of supported devices:

Gold

These are devices I have, have tested and will try not to break any functioanlity for an include:
* Amazfit Bip
* Amazfit GTS
* Pinetime Infinitme
* Bangle.js

Silver

These are devices which are properly implemented in the application, but I do not have and are tested by the commuity, and include:
* Amazfit BipS
* Amazfit Bip Lite
I do not promise not to break funcaionality in these, but will fix where I can

Bronze

These are devices which use a protocol that is close to another suppored device, and so is treated like that device.  Your mileage may vary with these devices.
* MiBand 2/3/4
* AMzfit Cor
* Amazfit GTR

***BUILT FOR 3.4 PLEASE READ OLDER USERS***

Amazfish needs to be built on OBS against a defined set of libraries.  Becuase there is a delay between a Sailfish release and that release being available on OBS, there will be a delay to supporting the latest versions.

For releases of the current version built against other Sailfish releases, use the repositories at :

https://build.merproject.org/project/show/home:piggz:harbour-amazfish and
https://build.merproject.org/project/show/home:piggz:kf5

***PLEASE READ for 1.7.0 Update***

The new sport display feature requires the MapBox component.  The easiest way to get this is by installing PureMaps from rinigus repository.

Powered by KEXI

As of version 0.5.1, actiivity data is retrieved into an sqlite database.  Becuase I think it is important to allow individuals to be in control of their own data, and that they should have the ability to analyse it themsleves, I have chosen to store data in a KEXI compatible database.  This will allow you to copy the database from the phone, and open it up inside KEXI on Linux/Windows/Mac and perform queries and reports on it.  This added ability means i link to a couple of KDE libraries, which should be installed automatically.

Firmware Download - READ FIRST - I am not liable if you brick your watch ;)

Read this for info about which files to flash https://github.com/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Bip-Firmware...

App has been tested using an amazfit bip and GTS, downloading the latest (0.1.1.45) official firmware.

The firmware is split into multiple files on these devices.  With the official MiFit app, all are downloaded at once, and everything works fine.  With this app, you have to send each file individually.  The firmwares are available by extracting the MiFit apk, and looking in the assets/ folder for files named Mili_chaohu.*.  When you select a file, its type and version will be determined, and you will be prevented from sending invalid files.

The firmware (.fw) requires a matching fotn (.ft) and resource (.res).  Send the firmware first, the app will send a reboot command at the end of the transfer, and the watch will boot up into a mode where it needs the matching font and resource sent.  Just wait for the app to connect again, then send the font and resource. 

The following types of file exist:

firmware, resource, a-gps data, fonts

So, to re-iterate, the firmware flashing order is:

• .fw
• .ft
• .res

Server Side Pairing Code

The newer devices (GTS, BipS etc) requires a server-side pairing key which requires inital pairing with an android device.  To get the key, follow the instructions here and enter into Amzafish when prompted, WITHOUT 0x at the beginning.

See https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-GTS

AGPS Download/Transfer

The official amazfit app can download and transfer the AGPS files to the watch automatically.  The amazfit web site limits download of the files to those with accounts.  A python script has been developped that can download the AGPS files, these can then be transferred to your phone, and downloaded to the watch using the normal "Download File" option.

• Obtain the script from https://github.com/argrento/huami-token
• Download the AGPS files using the -g paramter, this will download 2 .zip file.  The only one required is cep_alm_pak.zip
• Extract the zip and transfer the 2 .bin files to the phone
• Send the files gps_alm.bin and cep_pak.bin to the watch.

Pairing Issues

Pairing works for myself, sometimes I have to try twice.  If pairing doesnt work at all, then try:

• keep the app open, and pair again in the BT settings page of sailfish
• in the sailfish BT settings page, delete all entries and try again
• turn off/on BT on the phone
• factory reset the watch

Check if after all this, pairing works from the sailfish BT settings page.  It should pair and connect just fine from there.  f that doesnt work, my app wont either.

Not all features currently implemented

***May not work on all devices***

Uses Bluetooth Low Energy to communicate with the watch, this is known to be problematic on some devices.  it is known to work on the Xiaomi Mido.  Probably also works on the FP2.  Official devices unknown.

Implemented

• Pairing
• Notifications
• Calls
• Some settings
• Retrieving activities
• Heartrate Chart
• Alarms
• Watchface download
• Firmware upload
• Activity Sync

Todo

• More Settings
• Support other devices (maybe eg MiBand2, as it is similar)

Tip:
On your device, create a symlink in /home/nemo to /home/nemo/.local/share/harbour-amazfish
This way, you can easilty copy the database off the phone using MTP.

Button Actions

Bip and GTS notify when the watch button is pressed. This is captured by amazfish which allows running actions on theses presses. An action can be ran on 2,3 or 4 presses. To confiure the actions, goto Settings > Application > Button Actions.

A custom script can be used, the script must be called harbour-amazfish-script.sh and be in the home folder. Example which sends a OTP code to the watch as a message:

#!/bin/sh
if [ "$1" == "4" ]; then
    CODE=`python3 -c 'import pyotp;totp = pyotp.TOTP("XXXX Authenticator code here XXXX");print(totp.now())'`
    dbus-send --session --print-reply --dest=uk.co.piggz.amazfish /application uk.co.piggz.amazfish.sendAlert string:'' string:'Google OTP' string:$CODE boolean:true
fi;

Source: https://github.com/piggz/harbour-amazfish

Credits to:

• The gadgetbridge devs, which gave me a lot of hints and inspiration from their device code.