incyclist-devices 2.4.14 → 3.0.0

package/.eslintrc.json

@@ -0,0 +1,23 @@
+{
+    "env": {
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    },
+    "ignorePatterns": [ "lib/"]
+}

package/.github/workflows/PR.yml

@@ -0,0 +1,48 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Commit and PR
+
+on:
+  push: 
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+    paths-ignore:
+      - 'README.MD'
+      - '.github/**'
+
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'README.MD'
+      - '.github/**'
+
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    
+    strategy:
+      matrix:
+        node-version: [ 20.x, 21.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: test ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    #- run: npm run lint
+    - run: npm run test:ci
+      env:
+        CI: true 
+
+

package/.github/workflows/tag.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push: 
+    tags:
+      - '**'
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: test 
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - run: echo "Setting up a new release"
+      

package/package.json

@@ -1,70 +1,59 @@
 {
-  "name": "incyclist-devices",
-  "version": "2.4.14",
-  "dependencies": {
-    "@protobuf-ts/runtime": "^2.11.1",
-    "@serialport/bindings-interface": "^1.2.2",
-    "@serialport/parser-byte-length": "^9.0.1",
-    "@serialport/parser-delimiter": "^9.0.1",
-    "@serialport/parser-readline": "^10.5.0",
-    "@serialport/stream": "^10.5.0",
-    "incyclist-ant-plus": "^0.3.5",
-    "win32filetime": "^1.0.2"
-  },
-  "peerDependencies": {
-    "gd-eventlog": "^0.1.27"
-  },
-  "devDependencies": {
-    "@protobuf-ts/plugin": "^2.11.1",
-    "@serialport/binding-mock": "^10.2.2",
-    "@serialport/bindings-cpp": "^10.8.0",
-    "@stoprocent/noble": "^2.3.5",
-    "@types/jest": "^30.0.0",
-    "@types/node": "^24.3.1",
-    "@typescript-eslint/eslint-plugin": "^8.43.0",
-    "@typescript-eslint/parser": "^8.43.0",
-    "bonjour-service": "^1.3.0",
-    "eslint": "^9.35.0",
-    "jest": "^30.1.3",
-    "npm": "^11.6.4",
-    "protoc": "^32.1.0",
-    "ts-jest": "^29.4.1",
-    "typescript": "^5.9.2"
-  },
-  "scripts": {
-    "lint": "eslint . --ext .ts",
-    "build": "tsc",
-    "test:unit": "npx jest --coverage",
-    "test:ci": "npx jest --coverage --forceExit",
-    "dev": "tsc --watch",
-    "postversion": "git push && git push --tags",
-    "protogen": "protoc --ts_out src/proto --proto_path protos protos/*.proto "
-  },
-  "files": [
-    "lib/"
-  ],
-  "main": "lib/index.js",
-  "directories": {
-    "example": "./sample",
-    "lib": "./src"
-  },
-  "eslintConfig": {
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "ecmaVersion": "latest",
-      "sourceType": "module"
+    "name": "incyclist-devices",
+    "version": "3.0.0",
+    "scripts": {
+        "lint": "eslint . --ext .ts",
+        "build": "npm run build:esm && npm run build:cjs",
+        "build:esm": "tsc -p tsconfig.esm.json",
+        "build:cjs": "tsc -p tsconfig.cjs.json",
+        "test": "vitest run",
+        "test:unit": "vitest run --coverage",
+        "test:ci": "vitest run--coverage --forceExit",
+        "dev": "tsc -p tsconfig.esm.json --watch",
+        "postversion": "git push && git push --tags",
+        "protogen": "protoc --ts_out src/proto --proto_path protos protos/*.proto "
     },
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "rules": {
-      "jsx-a11y/anchor-is-valid": [
-        "off"
-      ]
+    "dependencies": {
+        "@protobuf-ts/runtime": "^2.11.1",
+        "@serialport/bindings-interface": "^1.2.2",
+        "@serialport/parser-byte-length": "^13.0.0",
+        "@serialport/parser-delimiter": "^13.0.0",
+        "@serialport/parser-readline": "^13.0.0",
+        "@serialport/stream": "^13.0.0",
+        "incyclist-ant-plus": "^0.3.6",
+        "win32filetime": "^1.0.2"
+    },
+    "peerDependencies": {
+        "gd-eventlog": "^0.1.27"
+    },
+    "devDependencies": {
+        "@protobuf-ts/plugin": "^2.11.1",
+        "@serialport/binding-mock": "^10.2.2",
+        "@serialport/bindings-cpp": "^13.0.1",
+        "@stoprocent/noble": "^2.3.10",
+        "@types/node": "^25.0.10",
+        "@typescript-eslint/eslint-plugin": "^8.54.0",
+        "@typescript-eslint/parser": "^8.54.0",
+        "@vitest/coverage-v8": "^4.0.18",
+        "bonjour-service": "^1.3.0",
+        "eslint": "^9.39.2",
+        "protoc": "^33.4.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.9.2",
+        "vitest": "^4.0.18"
+    },
+    "module": "./lib/esm/index.js",
+    "main": "./lib/cjs/index.js",
+    "types": "./lib/types/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./lib/types/index.d.ts",
+            "import": "./lib/esm/index.js",
+            "require": "./lib/cjs/index.js"
+        }
+    },
+    "directories": {
+        "example": "./sample",
+        "lib": "./src"
     }
-  }
 }

package/protos/zwift_hub.proto

@@ -0,0 +1,194 @@
+syntax = "proto2";
+package org.cagnulen.qdomyoszwift;
+
+//-------------- Zwift Hub messages
+// The command code prepending this message is 0x00
+// This message is sent always following the change of the gear ratio probably to verify it was received properly
+message HubRequest {
+	optional uint32 DataId = 1;				// Value observed 520 and 0, 0 requests general info, 1-7 are the fields# in DeviceInformationContent, 520 requests the gear ratio
+											// 512 to 534 responds unidentifiable data
+}
+
+// The command code prepending this message is 0x03
+message HubRidingData {
+	optional uint32 Power = 1;
+	optional uint32 Cadence = 2;
+	optional uint32 SpeedX100 = 3;
+	optional uint32 HR = 4;
+	optional uint32 Unknown1 = 5;				// Values observed 0 when stopped, 2864, 4060, 4636, 6803
+	optional uint32 Unknown2 = 6;				// Values observed 25714, 30091 (constant during session)
+}
+
+message SimulationParam {
+	optional sint32 Windx100 = 1;					// Wind in m/s * 100. In zwift there is no wind (0). Negative is backwind
+	optional sint32 InclineX100 = 2;			// Incline value * 100  
+	optional uint32 CWax10000 = 3;					// Wind coefficient CW * a * 10000. In zwift this is constant 0.51 (5100) 
+	optional uint32 Crrx100000 = 4;					// Rolling resistance Crr * 100000. In zwift this is constant 0.004 (400)
+}
+
+message PhysicalParam {
+	optional uint32 GearRatioX10000 = 2;
+	optional uint32 BikeWeightx100 = 4;
+	optional uint32 RiderWeightx100 = 5;
+}
+
+// The command code prepending this message is 0x04
+message HubCommand {
+	optional uint32 PowerTarget = 3;
+	optional SimulationParam Simulation = 4;
+	optional PhysicalParam Physical = 5;
+}
+
+//---------------- Zwift Play messages
+
+enum PlayButtonStatus {
+	ON = 0;
+	OFF = 1;
+}
+// The command code prepending this message is 0x07
+message PlayKeyPadStatus {
+	optional PlayButtonStatus RightPad = 1;
+	optional PlayButtonStatus Button_Y_Up = 2;
+	optional PlayButtonStatus Button_Z_Left = 3;
+	optional PlayButtonStatus Button_A_Right = 4;
+	optional PlayButtonStatus Button_B_Down = 5;
+	optional PlayButtonStatus Button_On = 6;
+	optional PlayButtonStatus Button_Shift = 7;
+	optional sint32 Analog_LR = 8;
+	optional sint32 Analog_UD = 9;
+}
+
+
+message PlayCommandParameters {
+	optional uint32 param1 = 1;
+	optional uint32 param2 = 2;
+	optional uint32 HapticPattern = 3;
+}
+
+message PlayCommandContents {
+	optional PlayCommandParameters CommandParameters = 1;
+}
+
+// The command code prepending this message is 0x12
+// This is sent to the control point to configure and make the controller vibrate 
+message PlayCommand {
+	optional PlayCommandContents CommandContents = 2;
+}
+
+// The command code prepending this message is 0x19
+// This is sent periodically when there are no button presses
+message Idle {
+	optional uint32 Unknown2 = 2;
+}
+
+//----------------- Zwift Ride messages
+enum RideButtonMask {
+	LEFT_BTN      = 0x00001;
+	UP_BTN        = 0x00002;
+	RIGHT_BTN     = 0x00004;
+	DOWN_BTN      = 0x00008;
+	A_BTN         = 0x00010;
+	B_BTN         = 0x00020;
+	Y_BTN         = 0x00040;
+
+	Z_BTN         = 0x00100;
+	SHFT_UP_L_BTN = 0x00200;
+	SHFT_DN_L_BTN = 0x00400;
+	POWERUP_L_BTN = 0x00800;
+	ONOFF_L_BTN   = 0x01000;
+	SHFT_UP_R_BTN = 0x02000;
+	SHFT_DN_R_BTN = 0x04000;
+
+	POWERUP_R_BTN = 0x10000;
+	ONOFF_R_BTN   = 0x20000;
+}
+
+enum RideAnalogLocation {
+	LEFT = 0;
+	RIGHT = 1;
+	UP = 2;
+	DOWN = 3;
+}
+
+message RideAnalogKeyPress {
+	optional RideAnalogLocation Location = 1;
+	optional sint32 AnalogValue = 2;
+}
+
+message RideAnalogKeyGroup {
+	repeated RideAnalogKeyPress GroupStatus = 1;
+}
+
+// The command code prepending this message is 0x23
+message RideKeyPadStatus {
+	optional uint32 ButtonMap = 1;
+	optional RideAnalogKeyGroup AnalogButtons = 2;
+}
+
+
+//------------------ Zwift Hub message after sending rideOn
+// The command code prepending this message is 0x2a
+message TrainerResponse {
+	optional uint32 Unknown = 1;
+	optional TrainerResponseContent Content = 2;
+}
+
+message TrainerResponseContent  {
+	optional string Text = 4;
+}
+
+
+//------------------ Zwift Click messages
+// The command code prepending this message is 0x37
+message ClickKeyPadStatus {
+	optional PlayButtonStatus Button_Plus = 1;
+	optional PlayButtonStatus Button_Minus = 2;
+}
+
+//------------------ Device Information requested after connection
+// The command code prepending this message is 0x3c
+message DeviceInformationContent {
+	optional uint32 Unknown1 = 1;
+	repeated uint32 SoftwareVersion = 2;
+	optional string DeviceName = 3;
+	optional uint32 Unknown4 = 4;
+	optional uint32 Unknown5 =5;
+	optional string SerialNumber = 6;
+	optional string HardwareVersion = 7;
+	repeated uint32 ReplyData = 8;
+	optional uint32 Unknown9 = 9;
+	optional uint32 Unknown10 = 10;
+	optional uint32 Unknown13 = 13;
+}
+
+message SubContent {
+	optional DeviceInformationContent Content = 1;
+	optional uint32 Unknown2 = 2;
+	optional uint32 Unknown4 = 4;	
+	optional uint32 Unknown5 = 5;
+	optional uint32 Unknown6 = 6;
+}
+
+message DeviceInformation {
+	optional uint32 InformationId = 1;
+	optional SubContent DeviceInformationContent = 2;
+}
+
+message DeviceSettings {
+	optional DeviceSettingsSubContent SubContent = 1;
+}
+
+message DeviceSettingsSubContent {
+	optional sint32 Windx100 = 5;					// Wind in m/s * 100. In zwift there is no wind (0). Negative is backwind
+	optional sint32 InclineX100 = 6;			// Incline value * 100  
+  	optional uint32 GearRatiox10000 = 8;
+  	optional uint32 BikeWeightx100  = 11;
+  	optional uint32 RiderWeightx100 = 12;
+	optional uint32 Crrx100000 = 13;					// Rolling resistance Crr * 100000. In zwift this is constant 0.004 (400)
+
+}
+
+message DeviceDataEnvelope {
+  optional uint32 message_type = 1;
+  optional bytes  payload      = 2; // raw inner bytes
+}

package/samples/DaumClassic/index.js

@@ -0,0 +1,118 @@
+const {EventLogger,ConsoleAdapter} = require( 'gd-eventlog');
+const { autoDetect } = require('@serialport/bindings-cpp')
+const { AdapterFactory, InterfaceFactory} = require('incyclist-devices');
+const { DaumClassicMock, DaumClassicSimulator, DaumClassicMockImpl } = require('incyclist-devices');
+
+EventLogger.registerAdapter(new ConsoleAdapter()) 
+
+const logger = new EventLogger('DaumClassicSample');
+
+function start(device) {
+
+    return new Promise( async (resolve,reject)=>{
+        try {
+            await device.start();
+            resolve(true);
+        } catch (e) {
+            logger.logEvent( {message:'error',error:e.message,device:device.getName()})        
+            setTimeout(async ()=>{
+                try {
+                    await device.start();
+                    resolve(true)
+                } catch (e1) {
+                    logger.logEvent( {message:'error',error:e.message,device:device.getName()})        
+                    reject();
+                }
+    
+            },30000);
+        }
+    
+    });
+
+}
+
+function runDevice(device) {
+    logger.logEvent( {message:'starting device',device:device.getName()})        
+    
+    device.onData( (data)=> { logger.logEvent( {message:'onData',data}) })
+
+    return new Promise( resolve => {
+        start(device)
+        .then(()=>{
+            let slope =0
+            // setting power to 200W every 1s
+            const iv = setInterval( async ()=>{
+                //logger.logEvent( {message:'setting Power',power:200,device:device.getName()})        
+                await device.sendUpdate( {slope});
+                slope+=0.1
+        
+            }, 1000)
+    
+            // stopping device after 10s
+            setTimeout( async ()=>{
+                logger.logEvent( {message:'stopping device',device:device.getName()})        
+                await device.stop();    
+                clearInterval(iv)
+                logger.log('stopped')
+                resolve(true);
+            }, 10000)
+        })
+        .catch((err)=>{resolve(false)})
+    })
+}
+
+
+async function run() {
+
+
+    const serial = InterfaceFactory.create('serial',{protocol:'Daum Classic'})
+
+    if (process.env.MOCK) {
+        logger.log('using MockBinding for ports',process.env.MOCK )
+
+        const mockPorts = process.env.MOCK.split(',')
+
+        DaumClassicMockImpl.reset();        
+        const simulator = new DaumClassicSimulator();
+
+        serial.setBinding(DaumClassicMock)
+
+        mockPorts.forEach( port => {
+            DaumClassicMock.createPort(port)
+            DaumClassicMockImpl.getInstance().setSimulator(port,simulator)           
+        })
+        
+    }
+    else {
+        serial.setBinding(autoDetect())
+    }
+    await serial.connect()
+  
+
+    var args = process.argv.slice(2);
+    if (args.length<1) {
+        logger.logEvent({message:'Scanning for devices ...'})
+
+        serial.on('device',(args)=> logger.logEvent({message:'Device Detected',...args}))
+    
+        const devices = await serial.scan( { timeout: 10000,protocol:'Daum Classic'})
+        logger.logEvent({message:'devices found', devices})
+    
+        if (devices.length>0) {
+            const device = AdapterFactory.create(devices[0])
+            await runDevice(device)           
+        }
+    }
+    else {        
+        const device = AdapterFactory.create({interface:serial, protocol:'Daum Classic',port:args[0], name:'Test'})       
+        await runDevice(device)      
+    }
+}
+
+process.on('SIGINT', () => process.exit() );  // CTRL+C
+process.on('SIGQUIT', () => process.exit() ); // Keyboard quit
+process.on('SIGTERM', () => process.exit() ); // `kill` command 
+
+
+run();
+