From 6c71ff38ebd523f62d1c7ab92bcf49017ab56e9c Mon Sep 17 00:00:00 2001
From: Sander Roosendaal <roosendaalsander@gmail.com>
Date: Mon, 16 Jan 2023 20:38:31 +0100
Subject: [PATCH] added help

---
 rowers/templates/developers.html | 84 ++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)

diff --git a/rowers/templates/developers.html b/rowers/templates/developers.html
index b6529e1a..3e5ed958 100644
--- a/rowers/templates/developers.html
+++ b/rowers/templates/developers.html
@@ -658,6 +658,90 @@
                   fails a test, its values are silently replaced by zeros.</p>
             </td>
           </tr>
+	  <tr>
+            <td>Stroke Data (v3)</td>
+            <td><a href="/rowers/api/v3/workouts/">/rowers/api/v3/workouts/</a>
+            </td>
+            <td>POST</td>
+            <td>
+              <pre>{
+    "totalDistance": 100,
+    "elapsedTime": 29000,
+    "title": "Test Workout (GO)",
+    "startdatetime": "2023-01-16 17:54:35.588838+00:00",
+    "workouttype": "water",
+    "boattype": "1x",
+    "notes": "some\nnotes",
+    "strokes": {
+	"data": [
+	{
+          "time": 3200.0000476837,
+          "pace": 155068.4885951763,
+          "hr": 85.7857142857,
+          "power": 84.6531131591,
+          "distance": 23,
+          "spm": 16.380952381
+	},
+	{
+	  "time": 6700.0000476837,
+          "pace" : 144402.6407586741,
+          "hr": 91.2142857143,
+          "power": 117.458827834,
+          "distance": 36,
+          "spm": 21.1666666667
+	},
+	{
+          "time": 10099.9999046326,
+          "pace": 138830.8712654931,
+          "hr": 95.7142857143,
+          "power": 141.31057207,
+          "distance": 48,
+          "spm": 19.8095238095
+	}
+	]
+     }
+}
+              </pre>
+	      With v3, you can post stroke data and workout metadata in one JSON object.
+                <br>
+                <p>For v3, mandatory data fields are:</p>
+                <p>
+                <ul class="contentli">
+                  <li><b>time</b>: Time (milliseconds since workout start)</li>
+                  <li><b>distance</b>: Distance (meters)</li>
+                  <li><b>pace</b>: Pace (milliseconds per 500m)</li>
+                  <li><b>spm</b> Stroke rate (strokes per minute)</li>
+                </ul>
+                </p>
+                <p>Optional data fiels are:</p>
+                <p>
+                <ul class="contentli">
+                  <li><b>power</b>: Power (Watt)</li>
+                  <li><b>latitude</b>: GPS position (latitude)</li>
+                  <li><b>longitude</b>: GPS position (longitude)</li>
+                  <li><b>drivelength</b>: Drive length (meters)</li>
+                  <li><b>dragfactor</b>: Drag factor</li>
+                  <li><b>drivetime</b>: Drive time (ms)</li>
+                  <li><b>strokerecoverytime</b>: Recovery time (ms)</li>
+                  <li><b>averagedriveforce</b>: Average handle force (lbs)</li>
+                  <li><b>peakdriveforce</b>: Peak handle force (lbs)</li>
+                  <li><b>lapidx</b>: Lap identifier</li>
+                  <li><b>hr</b>: Heart rate (beats per minute)</li>
+                  <li><b>wash</b>: Wash as defined per Empower oarlock (degrees)</li>
+                  <li><b>catch</b>: Catch angle per Empower oarlock (degrees)</li>
+                  <li><b>finish</b>: Finish angle per Empower oarlock (degrees)</li>
+                  <li><b>peakforceangle</b>: Peak Force Angle per Empower oarlock (degrees)</li>
+                  <li><b>slip</b>: Slip as defined per Empower oarlock (degrees)</li>
+
+                </ul>
+                </p>
+                <p>Also for this API version, consistency checks will be done and the stroke data will be
+                  refused if the mandatory data fields don't pass the checks.
+                  All mandatory data fields
+                  must have the same number of records. If an optional data field
+                  fails a test, its values are silently replaced by zeros.</p>
+            </td>
+          </tr>
         </tbody>
       </table>
     </p>