Skip to content

Commit

Permalink
Add: README document
Browse files Browse the repository at this point in the history
  • Loading branch information
ziqin committed Aug 18, 2018
1 parent 8a23a13 commit a8494f4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Fitness Recorder

An Android application for reading heart rates from MI Band 2.

## Current Features

- Read realtime heart rate data from MI Band 2
- Store and export data (Exported database file can be opened by SQLite clients like [SQLite Browser](https://sqlitebrowser.org/), [DataGrip](https://www.jetbrains.com/datagrip/), etc.)

Please forgive the shortcomings in this project, which are probably caused by my lack of Android development knowledge and experience currently. Suggestions and contribution for improvements are certainly welcome.

## Remark

- For longtime measurement, __DO ALLOW__ the app to run in background. (You may need to enable this permission manually, especially for highly customized Android OS like Flyme and MIUI, otherwise the background service may be killed by the system without any notification.)
- It is suggested to "stop measurement" before exporting data.

## Acknowledgement

- Leo Soares, [Mi Band 2, Part 1: Authentication](https://leojrfs.github.io/writing/miband2-part1-auth/)
- Volodymyr Shymanskyy, [Mi Band 2 python test](Mi Band 2 python test)
- Andrey Nikishaev, [How I hacked my Xiaomi MiBand 2 fitness tracker—a step-by-step Linux guide](https://medium.com/@a.nikishaev/how-i-hacked-xiaomi-miband-2-to-control-it-from-linux-a5bd2f36d3ad)
- 陈利健, [Android BLE开发详解和FastBle源码解析](https://www.jianshu.com/p/795bb0a08beb)
4 changes: 1 addition & 3 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,13 @@ android {
}

dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:28.0.0-rc01'
implementation 'com.android.support.constraint:constraint-layout:1.1.2'
implementation 'com.android.support:recyclerview-v7:28.0.0-rc01'

implementation 'com.annimon:stream:1.2.0'
implementation 'com.clj.fastble:FastBleLib:2.3.2'
implementation 'commons-io:commons-io:2.6'

testImplementation 'junit:junit:4.12'
androidTestImplementation 'com.android.support.test:runner:1.0.2'
androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
Expand Down

0 comments on commit a8494f4

Please sign in to comment.