New BLE Api, new PM5 emulator, revamped recorders and added uploaders

.github/workflows/node.js.yml

@@ -19,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x]
+        node-version: [22.x]
 
     steps:
       - name: Checkout repository

.markdownlint.json

@@ -1,5 +1,6 @@
 {
   "default": true,
   "MD013": false,
-  "MD049": { "style": "asterisk" }
+  "MD049": { "style": "asterisk" },
+  "MD059": false
 }

app/WebServer.js

@@ -1,10 +1,10 @@
 'use strict'
 /*
   Open Rowing Monitor, https://github.com/JaapvanEkris/openrowingmonitor
-
-  Creates the WebServer which serves the static assets and communicates with the clients
-  via WebSockets
 */
+/**
+ * Creates the WebServer which serves the static assets and communicates with the clients via WebSockets
+ */
 import { WebSocket, WebSocketServer } from 'ws'
 import finalhandler from 'finalhandler'
 import http from 'http'
@@ -17,27 +17,17 @@ export function createWebServer (config) {
   const port = process.env.PORT || 80
   const serve = serveStatic('./build', { index: ['index.html'] })
   let timer = setTimeout(timeBasedPresenter, config.webUpdateInterval)
-  let lastKnownMetrics = {
-    strokeState: 'WaitingForDrive',
-    sessionStatus: 'WaitingForStart',
-    totalMovingTime: 0,
-    totalNumberOfStrokes: 0,
-    totalLinearDistance: 0,
-    cyclePace: Infinity,
-    cyclePower: 0,
-    driveLength: 0,
-    driveDistance: 0,
-    dragFactor: undefined
-  }
+  let lastKnownMetrics
   let heartRate
   let heartRateBatteryLevel
+  resetLastKnownMetrics()
 
   const server = http.createServer((req, res) => {
     serve(req, res, finalhandler(req, res))
   })
 
   server.listen(port, (err) => {
-    if (err) throw err
+    if (err) { throw err }
     log.info(`webserver running on port ${port}`)
   })
 
@@ -46,27 +36,29 @@ export function createWebServer (config) {
   wss.on('connection', function connection (client) {
     log.debug('websocket client connected')
     notifyClient(client, 'config', getConfig())
+    notifyClient(client, 'metrics', lastKnownMetrics)
     client.on('message', function incoming (data) {
       try {
         const message = JSON.parse(data)
         if (message) {
-          emitter.emit('messageReceived', message, client)
+          emitter.emit('messageReceived', message)
         } else {
           log.warn(`invalid message received: ${data}`)
         }
       } catch (err) {
         log.error(err)
       }
     })
-    client.on('close', function () {
+    client.on('close', function close () {
       log.debug('websocket client disconnected')
     })
   })
 
   // This function handles all incomming commands. As all commands are broadasted to all application parts,
   // we need to filter here what the webserver will react to and what it will ignore
   // The start...reset commands are handled by the RowingEngine and the result will be reported by the metrics update, so we ignore them here
-  function handleCommand (commandName, data, client) {
+  /* eslint-disable-next-line no-unused-vars -- this is part of the standardised handleCommand interface */
+  function handleCommand (commandName, data) {
     switch (commandName) {
       case ('updateIntervalSettings'):
         break
@@ -78,9 +70,9 @@ export function createWebServer (config) {
         break
       case ('stop'):
         break
-      case ('requestControl'):
-        break
       case ('reset'):
+        resetLastKnownMetrics()
+        notifyClients('metrics', lastKnownMetrics)
         break
       case 'switchBlePeripheralMode':
         break
@@ -91,12 +83,7 @@ export function createWebServer (config) {
       case 'refreshPeripheralConfig':
         notifyClients('config', getConfig())
         break
-      case 'authorizeStrava':
-        notifyClient(client, 'authorizeStrava', data)
-        break
-      case 'uploadTraining':
-        break
-      case 'stravaAuthorizationCode':
+      case 'upload':
         break
       case 'shutdown':
         break
@@ -106,15 +93,15 @@ export function createWebServer (config) {
   }
 
   function presentRowingMetrics (metrics) {
-    if (metrics.metricsContext === undefined) return
+    if (metrics.metricsContext === undefined) { return }
     switch (true) {
       case (metrics.metricsContext.isSessionStart):
         notifyClients('metrics', metrics)
         break
       case (metrics.metricsContext.isSessionStop):
         notifyClients('metrics', metrics)
         break
-      case (metrics.metricsContext.isIntervalStart):
+      case (metrics.metricsContext.isIntervalEnd):
         notifyClients('metrics', metrics)
         break
       case (metrics.metricsContext.isPauseStart):
@@ -129,6 +116,7 @@ export function createWebServer (config) {
       case (metrics.metricsContext.isRecoveryStart):
         notifyClients('metrics', metrics)
         break
+      // no default
     }
     lastKnownMetrics = metrics
   }
@@ -144,6 +132,9 @@ export function createWebServer (config) {
     notifyClients('metrics', lastKnownMetrics)
   }
 
+  /**
+   * @param {Metrics} metrics
+   */
   function addHeartRateToMetrics (metrics) {
     if (heartRate !== undefined) {
       metrics.heartrate = heartRate
@@ -185,13 +176,43 @@ export function createWebServer (config) {
       blePeripheralMode: config.bluetoothMode,
       antPeripheralMode: config.antPlusMode,
       hrmPeripheralMode: config.heartRateMode,
-      stravaUploadEnabled: !!config.stravaClientId && !!config.stravaClientSecret,
+      uploadEnabled: ((config.userSettings.strava.allowUpload && !config.userSettings.strava.autoUpload) || (config.userSettings.intervals.allowUpload && !config.userSettings.intervals.autoUpload) || (config.userSettings.rowsAndAll.allowUpload && !config.userSettings.rowsAndAll.autoUpload)),
       shutdownEnabled: !!config.shutdownCommand
     }
   }
 
+  function resetLastKnownMetrics () {
+    lastKnownMetrics = {
+      strokeState: 'WaitingForDrive',
+      sessionState: 'WaitingForStart',
+      totalMovingTime: 0,
+      pauseCountdownTime: 0,
+      totalNumberOfStrokes: 0,
+      totalLinearDistance: 0,
+      cyclePace: Infinity,
+      cyclePower: 0,
+      cycleStrokeRate: 0,
+      driveLength: 0,
+      driveDuration: 0,
+      driveHandleForceCurve: [],
+      driveDistance: 0,
+      recoveryDuration: 0,
+      dragFactor: undefined,
+      interval: {
+        type: 'justrow',
+        movingTime: {
+          sinceStart: 0,
+          toEnd: 0
+        },
+        distance: {
+          fromStart: 0,
+          toEnd: 0
+        }
+      }
+    }
+  }
+
   return Object.assign(emitter, {
-    notifyClient,
     presentRowingMetrics,
     presentHeartRate,
     handleCommand

app/client/components/AppDialog.js

@@ -4,7 +4,6 @@
 
   Component that renders a html dialog
 */
-
 import { AppElement, html, css } from './AppElement.js'
 import { customElement, property } from 'lit/decorators.js'
 import { ref, createRef } from 'lit/directives/ref.js'

app/client/components/DashboardActions.js

@@ -7,7 +7,7 @@
 
 import { AppElement, html, css } from './AppElement.js'
 import { customElement, property, state } from 'lit/decorators.js'
-import { icon_undo, icon_expand, icon_compress, icon_poweroff, icon_bluetooth, icon_upload, icon_heartbeat, icon_antplus } from '../lib/icons.js'
+import { iconUndo, iconExpand, iconCompress, iconPoweroff, iconBluetooth, iconUpload, iconHeartbeat, iconAntplus } from '../lib/icons.js'
 import './AppDialog.js'
 
 @customElement('dashboard-actions')
@@ -86,19 +86,19 @@ export class DashboardActions extends AppElement {
   render () {
     return html`
     <div class="top-button-group">
-      <button @click=${this.reset}>${icon_undo}</button>
+      <button @click=${this.reset}>${iconUndo}</button>
       ${this.renderOptionalButtons()}
       <button @click=${this.switchHrmPeripheralMode}>
-        ${icon_heartbeat}
+        ${iconHeartbeat}
         <div class="text">${this.config?.hrmPeripheralMode}</div>
       </button>
       <button @click=${this.switchAntPeripheralMode}>
-        ${icon_antplus}
+        ${iconAntplus}
         <div class="text">${this.config?.antPeripheralMode}</div>
       </button>
     </div>
       <div class="text-button">
-      <button @click=${this.switchBlePeripheralMode}>${icon_bluetooth}</button>
+      <button @click=${this.switchBlePeripheralMode}>${iconBluetooth}</button>
         <div class="peripheral-mode">${this.blePeripheralMode()}</div>
     </div>
     ${this._dialog ? this._dialog : ''}
@@ -126,8 +126,8 @@ export class DashboardActions extends AppElement {
     if (this._appMode === 'BROWSER' && document.documentElement.requestFullscreen) {
       buttons.push(html`
       <button @click=${this.toggleFullscreen}>
-        <div id="fullscreen-icon">${icon_expand}</div>
-        <div id="windowed-icon">${icon_compress}</div>
+        <div id="fullscreen-icon">${iconExpand}</div>
+        <div id="windowed-icon">${iconCompress}</div>
       </button>
     `)
     }
@@ -136,13 +136,13 @@ export class DashboardActions extends AppElement {
     // (might also make sence to enable this for all clients but then we would need visual feedback)
     if (this._appMode === 'KIOSK' && this.config?.shutdownEnabled) {
       buttons.push(html`
-      <button @click=${this.shutdown}>${icon_poweroff}</button>
+      <button @click=${this.shutdown}>${iconPoweroff}</button>
     `)
     }
 
-    if (this.config?.stravaUploadEnabled) {
+    if (this.config?.uploadEnabled) {
       buttons.push(html`
-      <button @click=${this.uploadTraining}>${icon_upload}</button>
+      <button @click=${this.uploadTraining}>${iconUpload}</button>
     `)
     }
     return buttons
@@ -196,22 +196,22 @@ export class DashboardActions extends AppElement {
   uploadTraining () {
     this._dialog = html`
       <app-dialog @close=${dialogClosed}>
-        <legend>${icon_upload}<br/>Upload to Strava?</legend>
-        <p>Do you want to finish your workout and upload it to Strava?</p>
+        <legend>${iconUpload}<br/>Upload training?</legend>
+        <p>Do you want to finish your workout and upload it to webservices (Strava, Intervals.icu and RowsAndAll)?</p>
       </app-dialog>
     `
     function dialogClosed (event) {
       this._dialog = undefined
       if (event.detail === 'confirm') {
-        this.sendEvent('triggerAction', { command: 'uploadTraining' })
+        this.sendEvent('triggerAction', { command: 'upload' })
       }
     }
   }
 
   shutdown () {
     this._dialog = html`
       <app-dialog @close=${dialogClosed}>
-        <legend>${icon_poweroff}<br/>Shutdown Open Rowing Monitor?</legend>
+        <legend>${iconPoweroff}<br/>Shutdown Open Rowing Monitor?</legend>
         <p>Do you want to shutdown the device?</p>
       </app-dialog>
     `

app/client/components/DashboardMetric.js

@@ -45,7 +45,9 @@ export class DashboardMetric extends AppElement {
 
   render () {
     return html`
-      <div class="label"><div class="icon">${this.icon}</div></div>
+      <div class="${this.icon === '' ? '' : 'label'}">
+        <div class=${this.icon === '' ? '' : 'icon'}>${this.icon}</div>
+      </div>
       <div class="content">
         <span class="metric-value" style="${this.icon === '' ? 'font-size: 200%;' : ''}">${this.value !== undefined ? this.value : '--'}</span>
         <span class="metric-unit">${this.unit}</span>

app/client/components/PerformanceDashboard.js

@@ -8,7 +8,7 @@
 import { AppElement, html, css } from './AppElement.js'
 import { customElement, property, state } from 'lit/decorators.js'
 import './SettingsDialog.js'
-import { icon_settings } from '../lib/icons.js'
+import { iconSettings } from '../lib/icons.js'
 import { DASHBOARD_METRICS } from '../store/dashboardMetrics.js'
 
 @customElement('performance-dashboard')
@@ -90,7 +90,7 @@ export class PerformanceDashboard extends AppElement {
         }
       </style>
       <div class="settings" @click=${this.openSettings}>
-        ${icon_settings}
+        ${iconSettings}
         ${this._dialog ? this._dialog : ''}
       </div>
 
@@ -101,6 +101,7 @@ export class PerformanceDashboard extends AppElement {
   openSettings () {
     this._dialog = html`<settings-dialog .config=${this.appState.config.guiConfigs} @close=${dialogClosed}></settings-dialog>`
 
+    /* eslint-disable-next-line no-unused-vars -- Standard construct?? */
     function dialogClosed (event) {
       this._dialog = undefined
     }