Permalink
Browse files

Documentation tweaks

  • Loading branch information...
reefab committed Jan 11, 2013
1 parent e170b2e commit 84b5a642c7b49140356a183e06cd39adbd6ca446
Showing with 15 additions and 17 deletions.
  1. +15 −17 README.md
  2. BIN images/BikeProjectRunkeeper.png
View
@@ -2,35 +2,34 @@
## Description
-This project provides an [Arduino](http://arduino.cc/) sketch that can power an Arduino + Ethernet Shield (or Arduino with built-in ethernet) to make a stationary bike computer that can upload Cycling workout sessions results to [Runkeeper](http://runkeeper.com/)'s [Healthgraph API](http://developer.runkeeper.com/healthgraph), where it get added to the user's activities feed.
-The activity can then be posted to Twitter or Facebook automatically by Runkeeper.
+This project provides an [Arduino](http://arduino.cc/) sketch that can power an Arduino + Ethernet Shield (or Arduino with built-in ethernet)
+to make a stationary bike computer that can upload Cycling workout sessions results to [Runkeeper](http://runkeeper.com/)'s [Healthgraph API](http://developer.runkeeper.com/healthgraph).
+This activity get added to the user's activities feed and could then be posted to Twitter or Facebook automatically by Runkeeper.
-It doesn't need to be connected to a computer for that purpose, only a wired ethernet connection + DHCP is required.
+It doesn't need to be connected to a computer for that purpose, only a wired ethernet connection is required.
-It'll also display either current speed and total distance or average speed and elapsed time during normal use via a LCD.
+It'll also display the current speed and either the total distance or average speed or elapsed time during normal use via a LCD.
The sensor used is the [reed switch](http://en.wikipedia.org/wiki/Reed_switch) that was already present in my stationary bike connected to the Arduino with a pulldown resistor.
-The elapsed time only counts 15 seconds chunks when there was some activity, otherwise it'll pause.
+The elapsed time only counts 15 seconds chunks when there was some activity, otherwise it'll pause automatically.
-If the pause last more than 5 minutes, it'll upload to Runkeeper the:
+If the pause last more than 2 minutes, it'll upload to Runkeeper the:
* Starting Time
* Total Distance
* Elapsed Time
-for the current session. From this, Runkeeper computes the average speed, pace and
-total calories burned.
+for the current session. From this, Runkeeper computes the average speed, pace and total calories burned.
## Usage
Plug the ethernet cable and the USB/Power cable in.
-The Arduino will beep once it has obtained the current time and is ready for
-use.
+The Arduino will beep once it has obtained the current time and is ready for use.
Pedal away and it'll display the current speed while cycling between the total distance. average speed and elapsed time.
-Stop pedaling for ~ 15 seconds and the pause screen will come up. 60 seconds, the lcd's backlight will be switched off. 5 minutes and it'll end the session and upload the result or discard the session if the "valid activity" threshold hasn't been reached.
+Stop pedaling for ~ 15 seconds and the pause screen will come up. 60 seconds, the lcd's backlight will be switched off. 2 minutes and it'll end the session and upload the result or discard the session if the "valid activity" threshold hasn't been reached.
It'll beep every 5km by default.
@@ -41,10 +40,9 @@ To start a new session, just use the bike again, it'll start over.
### Device
![Device in clear enclosure](https://github.com/reefab/CyclingPusher/raw/master/images/finishedVersion.jpg)
[Prototype during testing](https://github.com/reefab/CyclingPusher/raw/master/images/prototype.jpg)
-### Runkeeper's screenshot
+[Stationary bike's reed switch and magnetic brake](https://github.com/reefab/CyclingPusher/raw/master/images/bike.jpg)
+### Runkeeper screenshot
![Runkeeper screenshot](https://github.com/reefab/CyclingPusher/raw/master/images/BikeProjectRunkeeper.png)
-### Reed Switch (at the top of the picture)
-![Stationary bike's reed switch and magnetic brake](https://github.com/reefab/CyclingPusher/raw/master/images/bike.jpg)
## Setup
@@ -70,9 +68,9 @@ Here is the breadboard view:
You'll need to modify/provide the MAC address and Healthgraph's access token in the config.h (that you'll copy from config.h-dist) file.
You might want to change the number of meters per reed switch activation too.
-### How to get access token
+### How to get the access token
-First, once you have your Runkeeper account got to:
+First, once you have your Runkeeper account go to:
http://runkeeper.com/partner/applications/registerForm
@@ -95,4 +93,4 @@ Now, in a shell:
Please note that the 'redirect_uri' needs to the be exact same one as before.
-It'll then give you the access token you can use in your Arduino's code.
+It'll then give you the access token you can use in your Arduino code.
Binary file not shown.

0 comments on commit 84b5a64

Please sign in to comment.