Amazfish

Rating: 
4.702705
Your rating: None Average: 4.7 (74 votes)

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.

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.
Screenshots: 
Application versions: 
AttachmentSizeDate
File harbour-amazfish-0.1-1.armv7hl.rpm112.29 KB17/04/2018 - 23:12
File harbour-amazfish-0.2-1.armv7hl.rpm119.54 KB28/04/2018 - 00:35
File harbour-amazfish-0.3-1.armv7hl.rpm131.01 KB07/05/2018 - 23:54
File harbour-amazfish-0.4-1.armv7hl.rpm137.54 KB18/05/2018 - 23:22
File harbour-amazfish-0.4.1-1.armv7hl.rpm137.63 KB20/05/2018 - 00:15
File harbour-amazfish-0.4.5-1.armv7hl.rpm148.71 KB22/05/2018 - 22:02
File harbour-amazfish-0.4.6-1.armv7hl.rpm149.08 KB22/05/2018 - 22:55
File harbour-amazfish-0.4.7-1.armv7hl.rpm149.42 KB24/05/2018 - 00:35
File harbour-amazfish-0.5.1-1.armv7hl.rpm158.56 KB30/05/2018 - 00:22
File harbour-amazfish-0.5.5-1.armv7hl.rpm164.27 KB02/06/2018 - 22:11
File harbour-amazfish-0.5.8-1.armv7hl.rpm168.1 KB04/06/2018 - 21:07
File harbour-amazfish-0.5.9-1.armv7hl.rpm170.27 KB05/06/2018 - 22:24
File harbour-amazfish-0.6.0-1.armv7hl.rpm171.68 KB06/06/2018 - 00:17
File harbour-amazfish-0.6.5-1.armv7hl.rpm179.96 KB23/06/2018 - 11:28
File harbour-amazfish-0.6.7-1.armv7hl.rpm185.47 KB26/06/2018 - 21:55
File harbour-amazfish-0.6.8-1.armv7hl.rpm186.04 KB28/06/2018 - 21:19
File harbour-amazfish-0.7.0-1.armv7hl.rpm238.07 KB15/07/2018 - 12:13
File harbour-amazfish-0.7.1-1.armv7hl.rpm237.48 KB19/07/2018 - 16:51
File harbour-amazfish-0.7.3-1.armv7hl.rpm239.17 KB23/07/2018 - 23:19
File harbour-amazfish-0.7.5-1.armv7hl.rpm673.84 KB26/08/2018 - 11:02
File harbour-amazfish-0.8.0-1.armv7hl.rpm673.94 KB25/11/2018 - 16:33
File harbour-amazfish-0.8.1-1.armv7hl.rpm674.27 KB29/11/2018 - 00:32
File harbour-amazfish-0.8.2-1.armv7hl.rpm674.21 KB01/12/2018 - 16:29
File harbour-amazfish-0.8.5-1.armv7hl.rpm679.46 KB12/01/2019 - 18:02
File harbour-amazfish-0.8.7-1.armv7hl.rpm681.18 KB23/01/2019 - 01:38
File harbour-amazfish-0.8.8-1.armv7hl.rpm681.32 KB04/04/2019 - 20:58
File harbour-amazfish-0.8.9-1.armv7hl.rpm682.44 KB05/04/2019 - 01:11
File harbour-amazfish-0.9.0-1.armv7hl.rpm703.9 KB18/05/2019 - 00:30
File harbour-amazfish-0.9.1-1.armv7hl.rpm702.06 KB21/05/2019 - 22:37
File harbour-amazfish-0.9.2-1.armv7hl.rpm703.2 KB12/06/2019 - 23:28
File harbour-amazfish-1.0.0-1.armv7hl.rpm703.32 KB05/01/2020 - 17:44
File harbour-amazfish-1.1.0-1.armv7hl.rpm1.8 MB06/02/2020 - 01:11
File harbour-amazfish-1.1.1-1.armv7hl.rpm1.48 MB07/02/2020 - 23:21
File harbour-amazfish-1.1.2-1.armv7hl.rpm1.49 MB16/02/2020 - 12:31
File harbour-amazfish-1.1.3-1.armv7hl.rpm1.6 MB29/02/2020 - 14:09
File harbour-amazfish-1.2.0-1.armv7hl.rpm1.6 MB01/03/2020 - 14:03
File harbour-amazfish-1.3.0-1.armv7hl.rpm1.6 MB04/03/2020 - 12:39
File harbour-amazfish-1.3.1-1.armv7hl.rpm1.6 MB04/03/2020 - 21:22
File harbour-amazfish-1.4.0-1.armv7hl.rpm1.62 MB12/04/2020 - 12:39
File harbour-amazfish-1.4.5-1.armv7hl.rpm1.62 MB13/04/2020 - 15:49
File harbour-amazfish-1.5.0-1.armv7hl.rpm1.61 MB22/04/2020 - 15:23
File harbour-amazfish-1.5.1-1.armv7hl.rpm1.61 MB26/04/2020 - 22:58
File harbour-amazfish-1.5.5-1.armv7hl.rpm2.45 MB15/05/2020 - 11:48
File harbour-amazfish-1.5.6-1.armv7hl.rpm2.45 MB16/06/2020 - 15:48
File harbour-amazfish-1.6.0-1.armv7hl.rpm3.17 MB28/06/2020 - 16:43
File harbour-amazfish-1.6.1-1.armv7hl.rpm3.17 MB30/06/2020 - 22:29
File harbour-amazfish-1.6.5-1.armv7hl.rpm3.18 MB08/07/2020 - 11:17
File harbour-amazfish-1.6.6-1.armv7hl.rpm3.18 MB17/07/2020 - 11:30
File harbour-amazfish-1.6.7-1.armv7hl.rpm3.18 MB22/09/2020 - 00:25
File harbour-amazfish-1.6.8-1.armv7hl.rpm3.18 MB22/09/2020 - 11:29
File harbour-amazfish-1.7.01.7.0.20201010190441.8409c73-1.5.1.jolla_.armv7hl.rpm3.25 MB10/10/2020 - 22:34
File harbour-amazfish-1.7.11.7.1.20201013113553.5d4533a-1.6.1.jolla_.armv7hl.rpm3.25 MB13/10/2020 - 15:03
File harbour-amazfish-1.8.1-1.10.1.jolla_.armv7hl.rpm3.35 MB17/12/2020 - 01:24
File harbour-amazfish-1.8.2-1.11.1.jolla_.armv7hl.rpm3.35 MB18/12/2020 - 23:28
File harbour-amazfish-1.8.5-1.12.1.jolla_.armv7hl.rpm3.38 MB07/01/2021 - 20:31
File harbour-amazfish-1.8.7-1.13.1.jolla_.armv7hl.rpm3.41 MB20/01/2021 - 00:00
File harbour-amazfish-1.9.0-1.14.1.jolla_.armv7hl.rpm3.45 MB21/01/2021 - 12:44
File harbour-amazfish-1.9.5-1.15.1.jolla_.armv7hl.rpm3.56 MB11/02/2021 - 01:40
File harbour-amazfish-1.9.6-1.16.1.jolla_.armv7hl.rpm3.56 MB13/02/2021 - 01:40
File harbour-amazfish-1.9.7-1.18.1.jolla_.armv7hl.rpm3.56 MB02/03/2021 - 19:30
File harbour-amazfish-1.9.8-1.19.1.jolla_.armv7hl.rpm3.56 MB06/03/2021 - 00:09
File harbour-amazfish-2.0.0master.20210510082230.b199678-1.3.armv7hl.rpm3.56 MB10/05/2021 - 11:55
File harbour-amazfish-2.0.2-1.30.1.jolla_.armv7hl.rpm3.57 MB11/07/2021 - 01:29
File harbour-amazfish-2.0.2-1.30.1.jolla_.aarch64.rpm3.58 MB11/07/2021 - 01:29
Changelog: 

2.0.2 - Now for 4.1

  • Minor fixes
  • OBS build fixes

2.0.0 (incl unreleased 1.9.9)

  • Check if service is running on open, and start if nescessary
  • Remove start service button from UI
  • Much improved date/TX handlng.  Fixes all known issues regarding missing or duplicate activity/step data
  • Dont display useless weather condition string message
  • Possibly fix missing BipS menu items
  • Aarch64 fixes
  • Code cleanups
     

1.9.8

  • Add the new button handling function to GTS (see docs)

1.9.7

  • Bip users get customisable button actions
  • Infintime call handling and fixes

1.9.6

  • Fix daemon crash when sending buffered notifications
  • Better BipS support

1.9.5 (includes unreleased changes for otehr distros)

  • Initial support fo Bangle.JS
    • Music, Notification, Call, Weather, Status
  • Some app icon fixes for newer Sailfish applications
  • Support a new deviceEvent dbus message
  • Translation updates
  • Support Infinitime music service on fw > 11
  • Service updates for non-sailfish

1.9.0

  • Added strava upload support
  • Allow activities to be deleted from database
  • Fix dbus interface
  • Fix navigation in kirigami

1.8.7

  • Code refactor to make adding more huami devices easier
  • Fixed setting display items / order for Bip
  • Fixed horrible display items screen
  • Fixed alarms page
  • Fixed call notification

1.8.6 (not release for sailfish)

  • Build fixes for other platforms

1.8.5

  • Support for flashing the PInetime Infinitime firmware
  • Support for setting and re-arranging GTS menu items
  • Activities are now saved as TCX, aswell as GPX.  This allows indoor activities to be saved.
  • XML is no longer stored in the database, instead the filename/path is saved.

1.8.2

  • Fix file selection in download page
  • Translation updates
  • Some contributed build fixes

1.8.1 - Includes 1.8.0 which was skipped

  • Reqrite the entire application to use rinigus QML components, enabling cross platform
  • Expermental navigation instructions from Pure Maps
    • On GTS instructions come through the music app
    • On other, instructions are by notifications (may be spammy!)
    • Fix GTS GPS data with duplicate sime stamps
    • Lots of code cleanups

1.7.1

  • Implement AGPS download for Bip/Lite/GTS (See description)
  • Translation updates

1.7.0

  • Added parsing for sport summary data and record data in database
  • Added new sport info page with all activity data and map of route
  • Fixed buttonPressed dbus-signal (contribution from jgibbon)
  • Added untested basic bip-s support

1.6.8

  • Fix application notifications not shown in UI

1.6.7

  • Add support for the activity data format in later GTS firmware
  • Pinetime-JF renamed InfiniTime
  • Add music control for InfiniTime
  • Fix sending goal to watch

1.6.6.

  • Fix uI crash when daemon not running
  • Minor backend fixes

1.6.5

  • Fixed GTS/GTR auth with new firmware (please feedback if still issues)
  • Major re-write, mostly non user visible, moving the following to libwatchfish
    • Calendar
    • Notification
    • Calls

1.6.1

  • Fixed repeating alarms

1.6.0

  • Basic GTR support
  • GTS/GTS music app inplemented
  • Moved button based mucis control to daemon
  • Only send connect notification if there are no buffered messages
  • Start using libwatchish where applicable

1.5.6

  • Fix daemon crash when pairing

1.5.5

  • Fixed sending weather to GTS
  • Refactored weather code
  • Initial support for Pinetime-JF

1.5.1

  • Be more stringent about allowing firmwares to be downloaded
  • Fix timestamps in GPX files

1.5.0

  • Fixed file transfers (watchface/fw) to the Bip
  • Watchface transfer to Bip Lite confirmed working
  • Added file transfer support for the GTS
    • Watchface confirmed working on XA2/Mido
    • FW confirmed working on Mido

 

1.4.5

  • Added heartrate analysis page
  • Moved raw graphs to mene

1.4.0

  • Large contribution from Petr Tsymbarovich
    • Reworked pairing
    • Updated first page
    • Updated config storage
    • Updated device selection
    • Use nemo notifications
  • Add indoor cycling activity type
  • Fix syncing data when in DST(hopefully!)

1.3.1

  • Darker paercentage circle
  • Fixed service Stop button
  • Load steps on startup for quicker display
  • Translation updates

1.3.0

  • UI improvements thanks to @AlphaX2
  • Note added to sleep page

1.2.0

  • Hopefully fix reading calendar
  • Translation update
  • Start using the supported-features system to hide some UI components when not applicable

1.1.3

  • Improve coverpage information and actions
  • Fix labels on graphs
  • Fix auth with bip lite / band
  • Fix bug for time format selection
  • Add support for sending calendar events to supprorted devices
  • Request alarm info from watch on init
  • Fix display of steps showing x10 sometimes

1.1.2

  • Fix initial pairing with Bip, Miband 3 and maybe others

1.1.1

  • Add support for Bip Lite
  • Allow connection of MiBand3 and Cor (untested, uses the Bip backend)
  • Translation updates

1.1.0

  • Fix alarms being overwritten
  • Initial (beta) support for Amazfit GTS
  • New pairing page and improved pairing

1.0.0

  • Added support for flashing newer firmwares
  • Added disconnect notification option
  • Fix buffered notifications when the watch is not connected (they never worked)
  • Added workaround for data not syncing when in DST
  • Added low battery notification

0.9.2
Stop notification when call answered
Fix sending weather on interval
Add more languages for watch (only works if supported by FW)

0.9.1
Fixed crash for new users
Weather UI fixes
Whitelisted some more firmware
Translation updates
Bugfixes for daemon/ui split

0.9.0
***ONLY FOR SAILFISHOS >= 3.0.3***
Daemon/UI split
Reworked some pages to streamline them

0.8.9
Add buffer for 10 notifications when watch disconnected

0.8.8
Added deep sleep value to page
Save GPX files in data location not cache location
May install on SFOS 3.0.3 when available

0.8.7
New UI layout
Sleep statistics

0.8.5
Added step summary chart showing steps over previous 20 days from the selected day
Added auto-sync of activity data which occurs each hour

0.8.2
Fixed applying settings from the UI

0.8.1
Hopefully fixed crash introduced in 0.8.0

0.8.0
Major code restructure to better allow support for other devices (devs needed!)
Whitelist new Bip frmwares
Hopefully fixed GPS issue with new firmwares

 

0.7.5
Implemented sending weather
Fixed app displaying correct status when watch disconnects
Use correct icon for depecher
Fix layout of HR button

 

0.7.3
Updated translations
Fixed user profile settings page not opening

Comments

elkiaer's picture

There is some connection to the miband, the "Test Call" under "Debug Info" is working.
Data download is not possible.

elkiaer's picture

I had to do:
Pkcon install zypper
Then the zypper is installed.
Here after I did run the 2 zypper command.
The miband did then connect BUT after the steps have been downloaded and the Bluetooth icon was viewable for about 5 seconds the icon disappeared and it is not possible to download data.
This zypper fix do not solve the issue totally .

elkiaer's picture

First I will mention that I did reset my OS on this 3.4.0.22 update.

Second, I get an error:
bash: zypper: command not found

piggz's picture

You can probably achieve the same using pkcon refresh and pkcon update, or, use pkcon to install zypper.

apozaf's picture

thx a lot, I had not installed zypper before so it had no result. I just donated 20 bucks to your paypal account for your fantastic work.

apozaf's picture

Sorry for being stupid: devel-su zypper ref harbour-amazfish?

piggz's picture

devel-su zypepr ref

devel-su zypper dup

Look at the proposed changes, and make sure they look sane, ie, not going to remove anything unexpected.

piggz's picture

Yes I know its not working in 3.4 ... just needs the updated kdelibs from my repo, will publish soon

elkiaer's picture

Same here

piggz's picture

Try zypper ref and zypper dup, and it _should_ work

apozaf's picture

Can't connect on 3.4

piggz's picture

Try zypper ref and zypper dup, and it _should_ work

erdzas's picture

Hi, It seems that amasfish don't work with SFOS 3.4.

Service don't start.

piggz's picture

Try zypper ref and zypper dup, and it _should_ work

erdzas's picture

Thank you, It work great!!!

gerstavros's picture

Will it support Pace?

hensip's picture

Dear piggz,

Is it possible to add support for the Amazfit bip S watch?

Thank's for this amazing work.

vige's picture

Thank you for moving the music player controls to the daemon! It's really great that I no longer have to remember to start the app before going jogging, which is pretty much the only situation where I need that functionality.

axolotl's picture

Thx for the great app. Using it with a Mi Band 4. Everything works fine except phone finder and music controller.
The graphs look a bit strange as it seems that all bars are evenly distributed along the x-axis without respect to missing measurements (e.g. when watch and phone were out of range). For example, I have a heartrate chart starting at 0:16 and ending at 23:50, but the middle of x-axis shows 7:30. I think it would be better to always show the whole 24h range and a stem plot with respect to the exact time along the x-axis. Similarly, the steps chart should be fixed to 7 days, no matter if there were measurements or not. On the other hand, the steps are hardcapped at 20k, where I think they should be capped at the alltime maximum. When doing it with the kexi/sqlite3 data on a PC one can clearly see the many time gaps.
Keep up the good work, will definetly donate a good tasty beer :)

martinbook85's picture

I cannot get my Mi Band 4 to work properly on my Sailfish XA2 Ultra. I found the Auth Key (I think) but it just keeps saying unexpected error when I click on the device in the pair device window. Any suggestions? Thanks!
EDIT:
I thought of tapping the button "start services" and tried pairing again. Now it works fine. So far so good.
What I get so far:
Step count
Heart rate
Set alarm clock
Notifications
I will soon go by bike to work, we'll see how well it registers that. Sleep tracking is supposed to be updating at noon (why?) so we'll see how well that works.
EDIT II
Bicycle tracking is not available for me. Is there any way to get that? It really is the only exercise I do.

Malakay's picture

Hi, i was testing last days and still drops connection quite often. SFOS 3.3.0.16 Rokua, fw 1.1.5.16. Main problem is that some time it reconnects back in a few minutes, but after few hours it disconnects and doesn t reconnect back even after few hours :( i can provide log.can someone help?

chris7chris's picture

After the last update wheather data is not shown anymore. Only a cloud with a question mark in it. All other stuff is working fine.
Amazfit Bip
Update: Ah, today it's working again with a nice weather forecast.

mklick's picture

Tried the new version now one week. Connection and real-time data (cover) are fine. Weather was also fine after some time. Data in data base are still wrong as shown in the screenshots on github. Please let me know when you need data or logs.

Malakay's picture

where can I find amazfish logs?

piggz's picture

In the journal ... devel-su, journalctl | grep amaz

 

Malakay's picture

Thanks, I´ve got still connection problems, still dropping, so I want to try to debug. But I have it connected via ssh and got command ready and today it is working flawlessly few hours. Now I disconnected ssh, so I´ll see.

mklick's picture

After restarting the watch and re-coupling it works also for me now. Thanx, fast and a great work.

armorica's picture

After updating to 1.6.5 the connection issue with the GTR is gone. Great job!

ahjolinna's picture

for me rebooting solved the connection/auth issue (with GTS, on Xperia 10)

 

btw. is it possible to get the "Find Mobile" feature, as I kinda misplace my phone way too often

mklick's picture

PS: Rebooting SF does not help, manual BT coupling works.

Pages