Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #2874

Merged
merged 1 commit into from
Jul 14, 2023
Merged

Update README.md #2874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions apps/runplus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Run App

This app allows you to display the status of your run, it
shows distance, time, steps, cadence, pace and more.
Displays distance, time, steps, cadence, pace and heart rate for runners. Based on the Run app, but extended with additional screen for heart rate based training, based on the Karvonnen calculation method.
It requires the input of your minimum and maximum heart rate in the settings for the app to work. You can come back back to the initial run screen anytime by swimping left.
To use it, start the app and press the middle button so that the red STOP in the bottom right turns to a green `RUN`.

To use it, start the app and press the middle button so that
the red `STOP` in the bottom right turns to a green `RUN`.

## Display
## Display 1st screen

* `DIST` - the distance travelled based on the GPS (if you have a GPS lock).
* NOTE: this is based on the GPS coordinates which are not 100% accurate, especially initially. As
Expand All @@ -23,6 +21,11 @@ so if you have no GPS lock you just need to wait.
* The current time is displayed right at the bottom of the screen
* `RUN/STOP` - whether the distance for your run is being displayed or not

## Display 2nd screen

Unlock the screen and navigate between displays by swiping left or right.
The upper number is the limit before next heart rate zone. The lower number is the limit before previous heart rate zone. The number in the middle is the heart rate. The Z1 to Z5 number indicates the heart rate zone where you are. The circle provides a quick visualisation of the hr zone in which you are.

## Recording Tracks

When the `Recorder` app is installed, `Run` will automatically start and stop tracks
Expand Down Expand Up @@ -55,10 +58,12 @@ your distance, steps, or time repeatedly pass your configured thresholds
* `Dist Pattern`: The vibration pattern to use to notify you about meeting your distance threshold
* `Step Pattern`: The vibration pattern to use to notify you about meeting your step threshold
* `Time Pattern`: The vibration pattern to use to notify you about meeting your time threshold
* `min hr`: Input your minimum heart rate (measure it as you wake up, prior to any movement)
* `max hr`: Input your maximum heart rate

## TODO

* Keep a log of each run's stats (distance/steps/etc)
* Keep a log of each run's stats (distance/steps/time in each hr zone/etc)

## Development

Expand Down