1
0
mirror of https://codeberg.org/Freeyourgadget/Gadgetbridge synced 2024-12-26 18:45:49 +01:00
Gadgetbridge/README.md

120 lines
5.0 KiB
Markdown
Raw Normal View History

2015-01-06 00:19:03 +01:00
Gadgetbridge
============
2015-01-07 14:00:18 +01:00
2015-04-25 23:59:24 +02:00
Gadgetbridge is an Android (4.4+) Application which will allow you to use your
Pebble or Mi Band without the vendor's closed source application and without the
2015-04-25 23:59:24 +02:00
need to create an account and transmit any of your data to the vendor's servers.
2015-01-07 14:00:18 +01:00
2015-08-15 23:21:42 +02:00
[![Build](https://travis-ci.org/Freeyourgadget/Gadgetbridge.svg?branch=master)](https://travis-ci.org/Freeyourgadget/Gadgetbridge)
## Download
[![Gadgetbridge on F-Droid](/Get_it_on_F-Droid.svg.png?raw=true "Download from F-Droid")](https://f-droid.org/repository/browse/?fdid=nodomain.freeyourgadget.gadgetbridge)
2015-08-23 01:04:40 +02:00
[List of changes](CHANGELOG.md)
2016-03-01 12:26:56 +01:00
## Supported Devices
* Pebble, Pebble Steel, Pebble Time, Pebble Time Steel, Pebble Time Round
* Mi Band, Mi Band 1A, Mi Band 1S (experimental)
## Features (Pebble)
2015-02-01 00:43:31 +01:00
2015-12-31 00:40:22 +01:00
* Incoming calls notification and display
* Outgoing call display
* Reject/hangup calls
* SMS notification
2015-12-31 00:40:22 +01:00
* K-9 Mail notification support
2015-06-15 20:33:32 +02:00
* Support for generic notifications (above filtered out)
* Support for up to 16 predefined replies for SMS and Android Wear compatible notifications (experimental, tested with Signal)
2015-12-31 00:40:22 +01:00
* Dismiss individial notifications, mute or open corresponding app on phone from the action menu (generic notifications)
2015-09-05 22:20:22 +02:00
* Dismiss all notifications from the action menu (non-generic notifications)
2015-09-17 23:22:15 +02:00
* Music playback info (artist, album, track)
2015-04-13 22:31:00 +02:00
* Music control: play/pause, next track, previous track, volume up, volume down
* List and remove installed apps/watchfaces
* Install watchfaces and watchapps (.pbw)
* Install firwmare files (.pbz) [READ THE WIKI](https://github.com/Freeyourgadget/Gadgetbridge/wiki/Pebble-Firmware-updates)
2015-12-08 12:11:26 +01:00
* Install language files (.pbl)
2015-07-05 00:52:12 +02:00
* Take and share screenshots from the Pebble's screen
* PebbleKit support for 3rd Party Android Apps (experimental)
* Fetch activity data from Pebble Health, Misfit and Morpheuz (experimental)
2016-03-22 13:21:24 +01:00
* Configure watchfaces / apps (limited compatibility, experimental)
2015-02-01 00:43:31 +01:00
## Notes about Firmware 3.x (Pebble Time, updated OG)
2015-08-29 22:47:33 +02:00
2015-12-08 12:11:26 +01:00
* Listing installed watchfaces will simply display previously installed watchapps, no matter if they are still installed or not.
2016-03-22 13:21:24 +01:00
## Getting Started (Pebble)
2015-02-01 00:43:31 +01:00
2016-03-22 13:21:24 +01:00
1. Pair your Pebble through the Android's Bluetooth Settings
2. Start Gadgetbridge, tap on the device you want to connect to
3. To test, choose "Debug" from the menu and play around
2015-01-07 14:00:18 +01:00
2016-03-22 13:21:24 +01:00
For more information read [this wiki article](https://github.com/Freeyourgadget/Gadgetbridge/wiki/Getting-Started-(Pebble))
## Features (Mi Band)
* Mi Band notifications (LEDs + vibration) for
2015-05-08 00:10:54 +02:00
* Discovery and pairing
2015-04-26 14:34:06 +02:00
* Incoming calls
* SMS received
* K-9 mails received
* Generic Android notifications
* Synchronize the time to the Mi Band
2015-05-05 23:44:45 +02:00
* Display firmware version and battery state
2015-07-05 01:43:45 +02:00
* Synchronize activity data
2015-08-03 01:36:54 +02:00
* Display sleep data (alpha)
* Display sports data (step count) (alpha)
2015-10-25 00:08:49 +02:00
* Display live activity data (alpha)
2015-07-05 01:43:45 +02:00
* Set alarms on the Mi Band
## How to use (Mi Band)
2015-05-08 00:10:54 +02:00
* When starting Gadgetbridge and no device is visible, it will automatically
attempt to discover and pair your Mi Band. Alternatively you can invoke this
manually via the menu 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 with all three LEDs during the pairing process,
tap it quickly a few times in a row to confirm the pairing with the band.
2015-04-25 23:59:24 +02:00
1. Configure other notifications as desired
2. Go back to the "Gadgetbridge" Activity
2015-05-08 00:10:54 +02:00
3. Tap the "MI" item to connect if you're not connected yet.
2015-04-25 23:59:24 +02:00
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,
2015-05-08 00:10:54 +02:00
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.
2015-07-05 01:43:45 +02:00
## Authors (in order of first code contribution)
2015-07-05 00:52:12 +02:00
2015-07-05 01:43:45 +02:00
* Andreas Shimokawa
* Carsten Pfeiffer
* Daniele Gobbetti
2015-07-05 00:52:12 +02:00
2015-04-27 23:08:31 +02:00
## Contribute
Contributions are welcome, be it feedback, bugreports, documentation, translation, research or code. Feel free to work
2015-04-27 23:08:31 +02:00
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.
2016-03-22 13:21:24 +01:00
Please do not use the issue tracker as a forum, do not ask for ETAs and read the issue conversation before posting.
Translations can be contributed via https://www.transifex.com/projects/p/gadgetbridge/resource/strings/ or
manually.
2016-03-22 13:21:24 +01:00
## Having problems?
1. Open Gadgetbridge's settings and check the option to write log files
2. Quit Gadgetbridge and restart it
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://github.com/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