1
0
mirror of https://codeberg.org/Freeyourgadget/Gadgetbridge synced 2024-06-26 15:00:13 +02:00
Gadgetbridge/README.md
gfwilliams 2cb5844020 Bangle.js build flavor (#2621)
This PR adds build flavors to `build.gradle`. The default is called `main`, but we also add `banglejs` which allows the building of an app called `Bangle.js Gadgetbridge`.

This will have internet connectivity, allowing Bangle.js watches to request data directly from the internet - and it's named so as hopefully not to be confused with the normal offline Gadgetbridge, while still giving credit.

Eventually the plan is to put this on the Google Play store, and to have additions in it which are good for Bangle.js users but would otherwise negatively impact normal Gadgetbridge users (a build flavor is used so we can keep the same codebase and not fork).

About naming - I'd mentioned `Gadgetbridge for Bangle` to @ashimokawa but thinking about how it would appear in the app store and Android apps list, it probably makes sense to call it `Bangle.js Gadgetbridge` so it's listed under `B...`. Happy to change or use something else if you have strong opinions though.

**Note:** adding build flavors seems to add the flavor name to existing builds. As a result, *all other builds will now have `main` in the name*. Unfortunately I didn't see another way around this, but hopefully it won't break anything.

Co-authored-by: Gordon Williams <gw@pur3.co.uk>
Reviewed-on: https://codeberg.org/Freeyourgadget/Gadgetbridge/pulls/2621
Co-authored-by: gfwilliams <gfwilliams@noreply.codeberg.org>
Co-committed-by: gfwilliams <gfwilliams@noreply.codeberg.org>
2022-03-31 11:36:26 +02:00

9.2 KiB

Gadgetbridge is now hosted on codeberg.org.

Get it on Codeberg

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 - Blog - Wiki - Mastodon

Donate

Code Quality: Java Total Alerts Translate

Download

Get it on F-Droid

List of changes

Supported Devices

(WARNING: Some of them WIP and some of them without maintainer)

Special Pairing Procedures

Some Huami / Amazfit / Mi / Zepp devices can only be paired with Gadgetbridge using a secret key that has to be obtained once using the proprietary app with an account. Detailed instructions in the wiki: Huami Server Pairing

The Fossil Hybrid HR also requires using the proprietary app, but with a more complicated procedure. Details in the wiki: Hybrid HR.

Features

Please see FEATURES.md

Authors

Core Team (in order of first code contribution)

  • Andreas Shimokawa
  • Carsten Pfeiffer
  • Daniele Gobbetti
  • Petr Vaněk

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)
  • "ksiwczynski", "mkusnierz", "mamutcho" (Lenovo Watch X Plus)
  • Andreas Böhler (Casio)
  • Jean-François Greffier (Mi Scale 2)
  • Johannes Schmitt (BFH-16)
  • Lukas Schwichtenberg (Makibes HR3)
  • Daniel Dakhno (Fossil Q Hybrid, Fossil Hybrid HR)
  • Gordon Williams (Bangle.js)
  • Pavel Elagin (JYou Y5)
  • Taavi Eomäe (iTag)
  • Erik Bloß (TLW64)
  • Yukai Li (Lefun)

Contribute

Contributions are welcome, be it feedback, bug reports, documentation, translation, research or code. Feel free to work on any of the open issues; just leave a comment that you're working on one to avoid duplicated work.

Developer documentation - Support for a new Device - New Device Tutorial

Translations can be contributed via https://hosted.weblate.org/projects/freeyourgadget/gadgetbridge/

Community

If you would like to get in touch with other Gadgetbridge users and developers outside of Codeberg, you can do so via:

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?

  1. Phone crashing during device discovery? Disable Privacy Guard (or similarly named functionality) during discovery.
  2. Open Gadgetbridge's settings and check the option to write log files
  3. Reproduce the problem you encountered
  4. Check the logfile at /sdcard/Android/data/nodomain.freeyourgadget.gadgetbridge/files/gadgetbridge.log
  5. File an issue at https://codeberg.org/Freeyourgadget/Gadgetbridge/issues/new/choose and possibly provide the logfile

Alternatively you may use the standard logcat functionality to access the log.