1
0
mirror of https://codeberg.org/Freeyourgadget/Gadgetbridge synced 2024-11-16 06:59:29 +01:00
Gadgetbridge/README.md

111 lines
5.5 KiB
Markdown
Raw Normal View History

2019-12-10 19:35:35 +01:00
Gadgetbridge is now hosted on [codeberg.org](https://codeberg.org/Freeyourgadget/Gadgetbridge/)
2015-01-06 00:19:03 +01:00
Gadgetbridge
============
2015-01-07 14:00:18 +01:00
Gadgetbridge is an Android (4.4+) application which will allow you to use your
2018-07-22 16:39:37 +02:00
Pebble, Mi Band, Amazfit Bip and HPlus device (and more) without the vendor's closed source application
2017-08-19 21:03:21 +02:00
and without the need to create an account and transmit any of your data to the
2017-06-30 21:28:20 +02:00
vendor's servers.
2015-01-07 14:00:18 +01:00
2017-08-29 23:56:55 +02:00
[Homepage](https://gadgetbridge.org)
2018-06-07 13:27:32 +02:00
[Blog](https://blog.freeyourgadget.org)
2017-08-29 23:56:55 +02:00
[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/Gadgetbridge/donate)
[![Build](https://travis-ci.org/Freeyourgadget/Gadgetbridge.svg?branch=master)](https://travis-ci.org/Freeyourgadget/Gadgetbridge)
2018-09-14 12:26:10 +02:00
[![Code Quality: Java](https://img.shields.io/lgtm/grade/java/g/Freeyourgadget/Gadgetbridge.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Freeyourgadget/Gadgetbridge/context:java)
[![Total Alerts](https://img.shields.io/lgtm/alerts/g/Freeyourgadget/Gadgetbridge.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Freeyourgadget/Gadgetbridge/alerts)
2019-07-30 09:31:38 +02:00
[![Translate](https://hosted.weblate.org/widgets/freeyourgadget/-/gadgetbridge/svg-badge.svg)](https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge)
2015-08-15 23:21:42 +02:00
## 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)
2019-01-19 15:26:51 +01:00
[List of changes](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/master/CHANGELOG.md)
2015-08-23 01:04:40 +02:00
2019-10-12 20:41:27 +02:00
## Supported Devices (Some of them WIP and some of them without maintainer)
2019-01-19 15:05:12 +01:00
* Amazfit Bip [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Bip)
2019-11-24 22:35:23 +01:00
* Amazfit Bip Lite (NOT RECOMMENDED, NEEDS MI FIT WITH ACCOUNT ONCE) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Bip-Lite)
2019-01-19 15:05:12 +01:00
* Amazfit Cor [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Cor)
2019-07-28 15:36:50 +02:00
* Amazfit Cor 2 [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-Cor-2)
2019-12-10 21:17:57 +01:00
* Amazfit GTR (NOT RECOMMENDED, NEEDS MI FIT WITH ACCOUNT ONCE) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-GTR)
* Amazfit GTS (NOT RECOMMENDED, NEEDS MI FIT WITH ACCOUNT ONCE) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/Amazfit-GTS)
2019-05-09 13:05:37 +02:00
* BFH-16
2019-10-12 20:41:27 +02:00
* Casio GB-6900B
2019-12-05 22:34:48 +01:00
* Fossil Q Hybrid
2019-01-19 15:05:12 +01:00
* HPlus Devices (e.g. ZeBand) [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/HPlus)
2019-10-12 20:41:27 +02:00
* ID115
* Lenovo Watch 9
* Liveview
* Makibes HR3
2019-01-19 15:05:12 +01:00
* 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)
2019-10-12 20:41:27 +02:00
* Mi Band 4 (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)
2019-10-12 20:41:27 +02:00
* NO.1 F1
2019-01-19 15:05:12 +01:00
* 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)
2019-10-12 20:41:27 +02:00
* Teclast H10, H30
* XWatch (Affordable Chinese Casio-like smartwatches)
2018-08-12 09:40:13 +02:00
* Vibratissimo (experimental)
2019-10-12 20:41:27 +02:00
* ZeTime [Wiki](https://codeberg.org/Freeyourgadget/Gadgetbridge/wiki/MyKronoz-ZeTime)
2016-03-01 12:26:56 +01:00
2019-01-07 09:44:28 +01:00
## Features
2019-01-19 15:26:51 +01:00
Please see [FEATURES.md](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/master/FEATURES.md)
## Authors
### Core Team (in order of first code contribution)
2015-07-05 00:52:12 +02:00
* Andreas Shimokawa
* Carsten Pfeiffer
* Daniele Gobbetti
2015-07-05 00:52:12 +02:00
### Additional device support
* João Paulo Barraca (HPlus)
2017-09-05 22:48:03 +02:00
* Vitaly Svyastyn (NO.1 F1)
* Sami Alaoui (Teclast H30)
2018-07-16 14:49:58 +02:00
* "ladbsoft" (XWatch)
* Sebastian Kranz (ZeTime)
2018-08-12 09:40:13 +02:00
* Vadim Kaushan (ID115)
* "maxirnilian" (Lenovo Watch 9)
2019-01-07 09:44:28 +01:00
* Andreas Böhler (Casio GB-6900B)
* Jean-François Greffier (Mi Scale 2)
2019-05-09 13:05:37 +02:00
* Johannes Schmitt (BFH-16)
* Lukas Schwichtenberg (Makibes HR3)
2019-12-05 22:34:48 +01:00
* Daniel Dakhno (Fossil Q Hybrid)
* Gordon Williams (Bangle.js)
2015-04-27 23:08:31 +02:00
## Contribute
2018-03-30 15:38:29 +02:00
Contributions are welcome, be it feedback, bug reports, documentation, translation, research or code. Feel free to work
2019-12-10 19:35:35 +01:00
on any of the open [issues](https://codeberg.org/Freeyourgadget/Gadgetbridge/issues);
2015-04-27 23:08:31 +02:00
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/
2016-03-22 13:21:24 +01:00
## 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.
2019-05-09 13:05:37 +02:00
- 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
2019-12-10 19:35:35 +01:00
4. File an issue at https://codeberg.org/Freeyourgadget/Gadgetbridge/issues/new and possibly provide the logfile
Alternatively you may use the standard logcat functionality to access the log.
2015-04-27 23:08:31 +02:00