mirror of
https://codeberg.org/Freeyourgadget/Gadgetbridge
synced 2024-12-28 19:45:50 +01:00
139 lines
7.0 KiB
Markdown
139 lines
7.0 KiB
Markdown
**IF YOU WANT TO EDIT THE WIKI**, do so on [codeberg.org](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki)
|
|
The wiki on github.com is a read-only mirror, as is the git repo itself. Issues and PRs will move to codeberg summer 2019, if you want your issue/PR comments migrated properly, please create a codeberg acount before we will migrate.
|
|
|
|
Gadgetbridge
|
|
============
|
|
|
|
Gadgetbridge is an Android (4.4+) application which will allow you to use your
|
|
Pebble, Mi Band, Amazfit Bip and HPlus device (and more) without the vendor's closed source application
|
|
and without the need to create an account and transmit any of your data to the
|
|
vendor's servers.
|
|
|
|
|
|
[Homepage](https://gadgetbridge.org)
|
|
|
|
[Blog](https://blog.freeyourgadget.org)
|
|
|
|
[](https://liberapay.com/Gadgetbridge/donate)
|
|
|
|
|
|
[](https://travis-ci.org/Freeyourgadget/Gadgetbridge)
|
|
[](https://lgtm.com/projects/g/Freeyourgadget/Gadgetbridge/context:java)
|
|
[](https://lgtm.com/projects/g/Freeyourgadget/Gadgetbridge/alerts)
|
|
[](https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge)
|
|
|
|
## Download
|
|
|
|
[<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/app/nodomain.freeyourgadget.gadgetbridge)
|
|
|
|
[List of changes](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/master/CHANGELOG.md)
|
|
|
|
## Supported Devices
|
|
* Amazfit Bip [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Bip)
|
|
* Amazfit Cor [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Cor)
|
|
* Amazfit Cor 2 [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Cor-2)
|
|
* BFH-16
|
|
* Casio GB-6900B (WIP)
|
|
* HPlus Devices (e.g. ZeBand) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/HPlus)
|
|
* ID115 (WIP)
|
|
* Lenovo Watch 9 (WIP)
|
|
* Liveview (WIP)
|
|
* Mi Band, Mi Band 1A, Mi Band 1S [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band)
|
|
* Mi Band 2 [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band-2)
|
|
* Mi Band 3 [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band-3)
|
|
* Mi Band 4 (WIP, NOT RECOMMENDED, NEEDS MI FIT WITH ACCOUNT AND ROOT ONCE) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band-4)
|
|
* Mi Scale 2 (currently only displays a toast after stepping on the scale)
|
|
* NO.1 F1 (WIP)
|
|
* Pebble, Pebble Steel, Pebble Time, Pebble Time Steel, Pebble Time Round [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Pebble)
|
|
* Pebble 2 [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Pebble)
|
|
* Teclast H10, H30 (WIP)
|
|
* XWatch (Affordable Chinese Casio-like smartwatches)
|
|
* Vibratissimo (experimental)
|
|
* ZeTime (WIP) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/MyKronoz-ZeTime)
|
|
|
|
|
|
## Features
|
|
|
|
Please see [FEATURES.md](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/master/FEATURES.md)
|
|
|
|
## Getting Started (Pebble)
|
|
|
|
Please [this wiki article](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Pebble-Getting-Started)
|
|
|
|
## How to use (Mi Band 1+2)
|
|
|
|
* Invoke the discovery activity manually via the "+" button. It will ask you for some personal info that appears
|
|
to be needed for proper steps calculation on the band. If you do not provide these,
|
|
some hardcoded default "dummy" values will be used instead.
|
|
|
|
When your Mi Band starts to vibrate and blink during the pairing process,
|
|
tap it quickly a few times in a row to confirm the pairing with the band.
|
|
|
|
1. Configure other notifications as desired
|
|
2. Go back to the "Gadgetbridge" activity
|
|
3. Tap the Mi Band item to connect if you're not connected yet
|
|
4. To test, chose "Debug" from the menu and play around
|
|
|
|
**Known Issues:**
|
|
|
|
* The initial connection to a Mi Band sometimes takes a little patience. Try to connect a few times, wait,
|
|
and try connecting again. This only happens until you have "bonded" with the Mi Band, i.e. until it
|
|
knows your MAC address. This behavior may also only occur with older firmware versions.
|
|
* If you use other apps like Mi Fit, and "bonding" with Gadgetbridge does not work, please
|
|
try to unpair the band in the other app and try again with Gadgetbridge.
|
|
* While all Mi Band devices are supported, some firmware versions might work better than others.
|
|
You can consult the [projects wiki pages](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band)
|
|
to check if your firmware version is fully supported or if an upgrade/downgrade might be beneficial.
|
|
* In order to display text notifications on the Mi Band 2, you have to [install a font on the band](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Mi-Band-2).
|
|
|
|
## Features (Liveview)
|
|
|
|
* set time (automatically upon connection)
|
|
* display notifications and vibrate
|
|
|
|
## Authors
|
|
### Core Team (in order of first code contribution)
|
|
|
|
* Andreas Shimokawa
|
|
* Carsten Pfeiffer
|
|
* Daniele Gobbetti
|
|
|
|
### Additional device support
|
|
* João Paulo Barraca (HPlus)
|
|
* Vitaly Svyastyn (NO.1 F1)
|
|
* Sami Alaoui (Teclast H30)
|
|
* "ladbsoft" (XWatch)
|
|
* Sebastian Kranz (ZeTime)
|
|
* Vadim Kaushan (ID115)
|
|
* "maxirnilian" (Lenovo Watch 9)
|
|
* Andreas Böhler (Casio GB-6900B)
|
|
* Jean-François Greffier (Mi Scale 2)
|
|
* Johannes Schmitt (BFH-16)
|
|
|
|
## Contribute
|
|
|
|
Contributions are welcome, be it feedback, bug reports, documentation, translation, research or code. Feel free to work
|
|
on any of the open [issues](https://github.com/Freeyourgadget/Gadgetbridge/issues?q=is%3Aopen+is%3Aissue);
|
|
just leave a comment that you're working on one to avoid duplicated work.
|
|
|
|
Translations can be contributed via https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge/
|
|
|
|
## Do you have further questions or feedback?
|
|
|
|
Feel free to open an issue on our issue tracker, but please:
|
|
- do not use the issue tracker as a forum, do not ask for ETAs and read the issue conversation before posting
|
|
- use the search functionality to ensure that your question wasn't already answered. Don't forget to check the **closed** issues as well!
|
|
- remember that this is a community project, people are contributing in their free time because they like doing so: don't take the fun away! Be kind and constructive.
|
|
- Do not ask for help regarding your own projects, unless they are Gadgetbridge related
|
|
|
|
## Having problems?
|
|
|
|
0. Phone crashing during device discovery? Disable Privacy Guard (or similarly named functionality) during discovery.
|
|
1. Open Gadgetbridge's settings and check the option to write log files
|
|
2. Reproduce the problem you encountered
|
|
3. Check the logfile at /sdcard/Android/data/nodomain.freeyourgadget.gadgetbridge/files/gadgetbridge.log
|
|
4. File an issue at https://github.com/Freeyourgadget/Gadgetbridge/issues/new and possibly provide the logfile
|
|
|
|
Alternatively you may use the standard logcat functionality to access the log.
|
|
|