Introduction of the Calories workout type, various improvements

app/client/index.html

@@ -5,7 +5,7 @@
   <meta charset="UTF-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="description" content="A rowing monitor for rowing exercise machines">
-  <meta name="author" content="Lars Berning">
+  <meta name="author" content="Jaap van Ekris">
   <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, viewport-fit=cover">
   <meta name="apple-mobile-web-app-status-bar-style" content="black" />
   <meta name="apple-mobile-web-app-capable" content="yes">

app/client/manifest.json

@@ -1,7 +1,7 @@
 {
-  "short_name": "Rowing Monitor",
-  "name": "Open Rowing Monitor",
-  "description": "A rowing monitor for rowing exercise machines",
+  "short_name": "ORM",
+  "name": "OpenRowingMonitor",
+  "description": "A rowing monitor for indoor rowing machines",
   "icons": [
     {
     "src": "icon.png",

app/client/store/dashboardMetrics.js

@@ -48,13 +48,13 @@ export const DASHBOARD_METRICS = {
     </dashboard-metric>`
   },
 
-  totalStk: { displayName: 'Total strokes', size: 1, template: (metrics, config) => simpleMetricFactory(metrics?.totalNumberOfStrokes, 'stk', config?.guiConfigs?.showIcons ? iconPaddle : '') },
+  totalStk: { displayName: 'Total strokes', size: 1, template: (metrics, config) => simpleMetricFactory(metrics?.interval?.numberOfStrokes, 'stk', config?.guiConfigs?.showIcons ? iconPaddle : '') },
 
   calories: {
     displayName: 'Calories',
     size: 1,
     template: (metrics, config) => {
-      const calories = metrics?.interval?.type === 'Calories' ? Math.max(metrics?.interval?.TargetCalories - metrics?.interval?.Calories, 0) : metrics?.totalCalories
+      const calories = metrics?.interval?.type === 'calories' ? Math.max(metrics?.interval?.calories?.toEnd, 0) : Math.max(metrics?.interval?.calories?.sinceStart, 0)
 
       return simpleMetricFactory(formatNumber(calories ?? 0), 'kcal', config?.guiConfigs?.showIcons ? iconFire : '')
     }

app/engine/Rower.js

@@ -1,15 +1,16 @@
 'use strict'
 /*
   Open Rowing Monitor, https://github.com/JaapvanEkris/openrowingmonitor
-
-  The Rowing Engine models the physics of a real rowing boat.
-  It takes impulses from the flywheel of a rowing machine and estimates
-  parameters such as energy, stroke rates and movement.
-
-  This implementation uses concepts that are described here:
-  Physics of Rowing by Anu Dudhia: http://eodg.atm.ox.ac.uk/user/dudhia/rowing/physics
-  Also Dave Vernooy has some good explanations here: https://dvernooy.github.io/projects/ergware
 */
+/**
+ * @file The Rowing Engine models the physics of a real rowing boat. It takes impulses from the flywheel of a rowing machine
+ * and calculates parameters such as work, stroke rates and linear movement.
+ *
+ * This implementation uses concepts that are described here:
+ * - @see {@link https://github.com/JaapvanEkris/openrowingmonitor/blob/main/docs/physics_openrowingmonitor.md#relevant-linear-metrics|the description of our underlying physics model}
+ * - @see {@link https://eodg.atm.ox.ac.uk/user/dudhia/rowing/physics/ergometer.html|Physics of Ergometers by Anu Dudhia}
+ * - @see {@link https://dvernooy.github.io/projects/ergware|Dave Vernooy's good explanation of the physics involved}
+ */
 /* eslint-disable max-lines -- There is a lot of state machine dependent math going on here. Hard to keep short while maintaining readability */
 import loglevel from 'loglevel'
 import { createFlywheel } from './Flywheel.js'
@@ -29,6 +30,8 @@ export function createRower (rowerSettings) {
   let _recoveryDuration
   let drivePhaseStartTime = 0.0
   let _driveDuration
+  let drivePhaseStartFlywheelWork = 0.0
+  let _driveFlywheelWork = 0.0
   let drivePhaseStartAngularPosition = 0.0
   let drivePhaseAngularDisplacement = 0.0
   let _driveLinearDistance = 0.0
@@ -157,6 +160,8 @@ export function createRower (rowerSettings) {
     // Here, we conclude the Drive Phase
     // The FSM guarantees that we have a credible driveDuration and cycletime in normal operation, but NOT at the start
     _driveDuration = flywheel.spinningTime() - drivePhaseStartTime
+    _driveFlywheelWork = flywheel.totalWork() - drivePhaseStartFlywheelWork
+    drivePhaseStartFlywheelWork = flywheel.totalWork()
     drivePhaseAngularDisplacement = flywheel.angularPosition() - drivePhaseStartAngularPosition
     _driveLength = drivePhaseAngularDisplacement * sprocketRadius
     _driveLinearDistance = calculateLinearDistance(drivePhaseAngularDisplacement, _driveDuration)
@@ -253,6 +258,10 @@ export function createRower (rowerSettings) {
     return flywheel.spinningTime()
   }
 
+  function totalFlywheelWorkSinceStart () {
+    return flywheel.totalWork()
+  }
+
   function driveLastStartTime () {
     return drivePhaseStartTime
   }
@@ -316,6 +325,14 @@ export function createRower (rowerSettings) {
     }
   }
 
+  function driveFlywheelWork () {
+    if (_driveDuration >= rowerSettings.minimumDriveTime) {
+      return _driveFlywheelWork
+    } else {
+      return undefined
+    }
+  }
+
   function driveAverageHandleForce () {
     if (_driveDuration >= rowerSettings.minimumDriveTime) {
       return driveHandleForce.average()
@@ -410,6 +427,8 @@ export function createRower (rowerSettings) {
     drivePhaseStartTime = 0.0
     drivePhaseStartAngularPosition = 0.0
     _driveDuration = 0.0
+    drivePhaseStartFlywheelWork = 0.0
+    _driveFlywheelWork = 0.0
     drivePhaseAngularDisplacement = 0.0
     _driveLinearDistance = 0.0
     recoveryPhaseStartTime = 0.0
@@ -435,13 +454,15 @@ export function createRower (rowerSettings) {
     driveLastStartTime,
     totalMovingTimeSinceStart,
     totalLinearDistanceSinceStart,
+    totalFlywheelWorkSinceStart,
     cycleDuration,
     cycleLinearDistance,
     cycleLinearVelocity,
     cyclePower,
     driveDuration,
     driveLinearDistance,
     driveLength,
+    driveFlywheelWork,
     driveAverageHandleForce,
     drivePeakHandleForce,
     driveHandleForceCurve,