updates documentation

README.md

@@ -1,7 +1,7 @@
 # Open Rowing Monitor
 
 <!-- markdownlint-disable-next-line no-inline-html -->
-<img width="200" height="200" align="left" src="doc/img/openrowingmonitor_icon.png">
+<img width="200" height="200" align="left" src="docs/img/openrowingmonitor_icon.png">
 
 An open source rowing monitor for rowing exercise machines. It upgrades a rowing machine into a real smart trainer that can be used with training applications and games.
 
@@ -12,7 +12,7 @@ I suspect it works well with DIY rowing machines like the [Openergo](https://ope
 
 ## Features
 
-Currently the feature set is pretty basic, I'll add more features in the future, check the [Development Roadmap](doc/backlog.md) if you are curious.
+Currently the feature set is pretty basic, I'll add more features in the future, check the [Development Roadmap](docs/backlog.md) if you are curious.
 
 ### Rowing Metrics
 
@@ -31,7 +31,7 @@ Open Rowing Monitor implements a physics model to simulate the typical metrics o
 The web interface visualizes the rowing metrics on any device that can run a browser (i.e. a smartphone that you attach to your rowing machine while training). It uses web sockets to show the rowing status in Realtime. Besides that it does not do much (yet).
 
 <!-- markdownlint-disable-next-line no-inline-html -->
-<img src="doc/img/openrowingmonitor_frontend.png" width="700"><br clear="left">
+<img src="docs/img/openrowingmonitor_frontend.png" width="700"><br clear="left">
 
 ### Bluetooth Low Energy (BLE)
 
@@ -53,7 +53,7 @@ You will need a Raspberry Pi 3 or 4 with a fresh installation of Raspberry Pi OS
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/laberning/openrowingmonitor/HEAD/install/install.sh)"
 ```
 
-Also have a look at the [Detailed Installation Instructions](doc/installation.md) for more information on the software installation and for instructions on how to connect the rowing machine.
+Also have a look at the [Detailed Installation Instructions](docs/installation.md) for more information on the software installation and for instructions on how to connect the rowing machine.
 
 ## How it all started
 
@@ -67,6 +67,6 @@ This project is already in a very usable stage, but some things are still a bit
 
 Feel free to leave a message in the [GitHub Discussions](https://github.com/laberning/openrowingmonitor/discussions) if you have any questions or ideas related to this project.
 
-I plan to add more features, here is the [Development Roadmap](doc/backlog.md).
+I plan to add more features, here is the [Development Roadmap](docs/backlog.md).
 
-This project uses some great work by others, see the [Attribution here](doc/attribution.md).
+This project uses some great work by others, see the [Attribution here](docs/attribution.md).

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leader [Lars Berning](https://www.linkedin.com/in/larsberning).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

docs/backlog.md

@@ -4,24 +4,26 @@ This is the very minimalistic Backlog for further development of this project.
 
 ## Soon
 
-* investigate: occasionally stroke rate is too high - seems to happen after rowing pause
-* figure out where to set the Service Advertising Data (FTMS.pdf p 15)
-* set up a Raspberry Pi with the installation instructions to see if they are correct
+* monitor battery level of heart rate monitor and show hint if battery is low
+* deliver strokes per minute in the simulated FTMS bike as Cadence
+* add an update script to simplify the migration to new versions
+* validate FTMS with more training applications and harden implementation (i.e. Holofit and Coxswain)
 * record a longer rowing session and analyze two encountered problems: 1) rarely the stroke rate doubles for a short duration (might be a problem with stroke detection when measurements are imprecise), 2) in one occasion the measured power jumped to a very high value after a break (40000 watts)
+* add support for ANT+ heart rate monitors with USB dongles
+* presets for rowing machine specific config parameters
+* add an option to automatically feed the measured damping constant back into the rowing engine
 
 ## Later
 
+* figure out where to set the Service Advertising Data (FTMS.pdf p 15)
 * add some attributes to BLE DeviceInformationService
-* presets for rowing machine specific config parameters
-* improve the physics model for waterrowers
-* validate FTMS with more training applications and harden implementation
+* improve the physics model for water rowers
 * make Web UI a proper Web Application (tooling and SPA framework)
 * record the workout and show a visual graph of metrics
 * export the workout
 
 ## Ideas
 
-* add support for BLE Heart Rate Sensor and show pulse
 * add video playback in background of Web UI
 * implement or integrate some rowing games
 * add possibility to define workouts (i.e. training intervals with goals)

package-lock.json

@@ -5,15 +5,15 @@
   "requires": true,
   "dependencies": {
     "@abandonware/bleno": {
-      "version": "0.5.1-3",
-      "resolved": "https://registry.npmjs.org/@abandonware/bleno/-/bleno-0.5.1-3.tgz",
-      "integrity": "sha512-QDhWz57s0qS21MH8xoHmHHp3bu3Z5c9z2koMXt5newnBVFNJaGcmOileQBpP9JTrxWVFvhJcweFD3UMxSuVQ/Q==",
+      "version": "0.5.1-4",
+      "resolved": "https://registry.npmjs.org/@abandonware/bleno/-/bleno-0.5.1-4.tgz",
+      "integrity": "sha512-2K/gbDxh4l4TV8xT/XUCwCT3e5aGDGmYad8gxt19CEvBMCs0+JScZ7roNyX0Jzice5rrR5RETcsMwIjJSzbeCQ==",
       "requires": {
-        "@abandonware/bluetooth-hci-socket": "^0.5.3-6",
-        "bplist-parser": "0.2.0",
-        "debug": "^4.2.0",
+        "@abandonware/bluetooth-hci-socket": "^0.5.3-7",
+        "bplist-parser": "0.3.0",
+        "debug": "^4.3.1",
         "napi-thread-safe-callback": "0.0.6",
-        "node-addon-api": "^3.0.2",
+        "node-addon-api": "^3.1.0",
         "xpc-connect": "^2.0.0"
       }
     },
@@ -455,12 +455,12 @@
       }
     },
     "bplist-parser": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/bplist-parser/-/bplist-parser-0.2.0.tgz",
-      "integrity": "sha512-z0M+byMThzQmD9NILRniCUXYsYpjwnlO8N5uCFaCqIOpqRsJCrQL9NK3JsD67CN5a08nF5oIL2bD6loTdHOuKw==",
+      "version": "0.3.0",
+      "resolved": "https://registry.npmjs.org/bplist-parser/-/bplist-parser-0.3.0.tgz",
+      "integrity": "sha512-zgmaRvT6AN1JpPPV+S0a1/FAtoxSreYDccZGIqEMSvZl9DMe70mJ7MFzpxa1X+gHVdkToE2haRUHHMiW1OdejA==",
       "optional": true,
       "requires": {
-        "big-integer": "^1.6.44"
+        "big-integer": "1.6.x"
       }
     },
     "brace-expansion": {

package.json

@@ -24,7 +24,7 @@
     "test:watch": "uvu --watch"
   },
   "dependencies": {
-    "@abandonware/bleno": "^0.5.1-3",
+    "@abandonware/bleno": "^0.5.1-4",
     "@abandonware/noble": "^1.9.2-13",
     "finalhandler": "^1.1.2",
     "http": "0.0.1-security",