Java script ergometer driver for concept 2 performance monitor with BLE. (The PM5) Works on all major platforms using cordova and node/electron",
I hope this project will become a shared effort to make it easier to write next generation ergometer software.
Tijmen Tijmen@vangulik
#change log
-
0.0.1 First version
-
0.0.2 New features:
- csafe framework
- power curve event and csafe command
- some simple csafe commands
-
0.0.3
- easy ble is replaced by bleat (still uses the evothings ble drivers) Easy ble is replaced by bleat. With some small changes in bleat api my ergometer api is still backwards compatible.
You only need to change the javascript included file
<script src="libs/evothings/easyble/easyble.js"></script>
to
<script src="libs/bleat.js"></script>
-
bleat (https://github.com/thegecko/bleat) will allow multiple platforms
- Android/iOS/Windows (using Evothings/Cordova/PhoneGap) https://github.com/evothings/cordova-ble/blob/master/ble.js
- Mac/Linux/Windows (using noble on Node.js) https://github.com/sandeepmistry/noble
- ChromeOS https://developer.chrome.com/apps/bluetoothLowEnergy
-
0.0.4
- Electron demo for desktop apps
- separated the demo code from the platform code
- Refactored error handling
- Renamed project from MobileErgometer to ErgometerJS
-
0.0.5
- Improved npm build script and typescript config files
- Send now returns a Promise. Changed the demo for this. I plan to make more use of promises to clean up some internal error handling code.
-
0.0.6
- Refactored all internal error handling to make use of Promises
- Made internal driver layer based on Promises which gives some more protection and will make recording easier in the future.
-
0.0.7
- More commands
- Skipp some strange return values which look like corrupted or undocumented return values
- Short hand notation for some simple get and set commands
- Program command , the value now a correct type and the property program is now named value
-
0.0.8
- Record and replay events. This is use full for:
- Writing code without the constant need of an ergometer
- You can test code in an phone emulator (emulators do not have access to bluetooth hardware)
- Writing unit tests
- Record issues and send them to some one else to fix.
- added a demo project for record and replay
- Record and replay events. This is use full for:
-
0.0.9
- Upgraded bleat 0.1.0
- The bleat bug fixes are not needed any more.
- Still use the bleat classic interface
- The ergometer api is not changed but you will need to include other bleat javascript libraries in your html/javascript. See the demo's for the details
- Upgraded to typescript 1.8.2
- Made a start with implementing Web-bluetooth. In the future this allows you to run the app from a normal browser. This is still work in progress
- Upgraded bleat 0.1.0
-
0.0.10
- ionic 2 example
- moved readme's
-
0.0.11
- added web bluetooth support
-
0.0.12
- Web bluetooth Fix: web blue tooth messages stop after some time.
-
The project is open source and and it is based on open source project. (appache 2 license)
-
Uses low power bluetooth (BLE) connection.
-
Written in typescript which is compiled to javascript. You can use the driver without typescript.
-
Platform independent (mobile / desktop / web ) I have not yet been able to test all platforms but it should work on:
- Mobile using cordova: iOS,android, Windows
- Mobile react native: iOS,android
- Desktop using Electron MacOS X, Windows, Linux
- Server using Node MacOS X, Windows, Linux (inc Raspberry PI)
- Web: chrome canary (still beta)
Basically ErgometerJS needs javascript and a blue tooth driver which can be (noble,cordova-plugin-ble or web bluetooth)
-
API definitions can be found in a separate typescript definition file (ergometer.d.ts).
http://www.concept2.com/files/pdf/us/monitors/PM5_BluetoothSmartInterfaceDefinition.pdf
Components
- The project : Apache license 2.
- Bleat : Mit license
- Electron: Mit license
- Write a demo of an app which can really be used.
- Add more commands
- There are problems in the PM5 BLE firmware. Some csafe commands give back invalid responses. I hope they fix it soon. See
http://www.c2forum.com/viewtopic.php?f=15&t=93321
- ES6-Promises The library uses ES6-Promises. I assume that the library is uses in modern browsers. If this is not the case you need to include a poly fill javascript library:
https://github.com/lahmatiy/es6-promise-polyfill
-
React native: the used blue tooth library does not (yet?) support direct reading and writing to characteristics. due to this the csafe commands and the power curve do not work.
-
Web bluetooth is not yet supported by all browsers
To make it work you need:
- An concept2 ergometer with PM5
- An android or iphone with BLE capability.
- npm which can be downloaded from https://www.npmjs.com
Do a download or checkout from github (https://github.com/tijmenvangulik/ErgometerJS)
open a command prompt on the downloaded directory and type
npm install
to build the driver and the demo from the original typescript source. (not required they are already build)
npm run build
after the build the driver will be located in
driver\lib\ergometer.js
the description of the interface can be viewed as type script definition file. (this is generated from the source)
driver\lib\ergometer.d.ts
To use the library you need all the files in the lib directory and include it in your cordova phone gab app
<script src="libs/ergometer.js"></script>
<script src="libs/jquery/jquery.js"></script>
#Usage
Create this class to acCess the performance data
var performanceMonitor= new ergometer.PerformanceMonitor();
After this connect to the events to get data
performanceMonitor.rowingGeneralStatusEvent.sub(this,this.onRowingGeneralStatus);
On some android phones you can connect to a limited number of events. Use the multiplex property to overcome
this problem. When the multi plex mode is switched on the data send to the device can be a a bit different, see
the documentation in the properties You must set the multiplex property before connecting
performanceMonitor.multiplex=true;
to start the connection first start scanning for a device,
you should call when the cordova deviceready event is called (or later)
performanceMonitor.startScan((device : ergometer.DeviceInfo) : boolean => {
//return true when you want to connect to the device
return device.name=='My device name';
});
to connect at at a later time
performanceMonitor.connectToDevice('my device name');
the devices which where found during the scan are collected in
performanceMonitor.devices
when you connect to a device the scan is stopped, when you want to stop the scan earlier you need to call
performanceMonitor.stopScan
More information can be found in the typescript definitions:
https://github.com/tijmenvangulik/MobileErgometer/blob/master/api/lib/ergometer.d.ts
##CSafe
CSafe is used to send and receive commands. I have implemented an jquery like api which is:
- chainable (not required)
- Extensible (you add your own commands to the buffer object. A command can consist out of multiple commands)
- type safe
- multiple commands can be send in one requests to reduce the load
An example of a
when the connection state is ready for communcation you can start with csafe commands
protected onConnectionStateChanged(oldState : ergometer.MonitorConnectionState, newState : ergometer.MonitorConnectionState) {
if (newState==ergometer.MonitorConnectionState.readyForCommunication) {
The csafeBuffer property is used to prepare one or multiple commands. Before adding commands you have to clear the buffer. At then end call send to call the buffer. The next command can only be send after that the first command is send. Use the optional success and error parameters of the send function to start with the next command. You can also send the next command when data is received.
this.performanceMonitor.csafeBuffer
.clear()
.getStrokeState({
received: (strokeState : ergometer.StrokeState) =>{
this.showData(`stroke state: ${strokeState}`);
}
})
.getVersion({
received: (version : ergometer.csafe.IVersion)=> {
this.showData(`Version hardware ${version.HardwareVersion} software:${version.FirmwareVersion}`);
}
})
.setProgram({program:2})
.send();
It is not required to chain the commands. You can also write code the classic way:
var buffer=this.performanceMonitor.csafeBuffer;
buffer.clear();
buffer.setProgram({program:2});
buffer.send();
It is possible to add new commands to the command buffer. for this you have to call commandManager.register to register your new command. You have to pass on a function because the actual declaration is deferred to a later state.
There is one required command property where you define the main command. Some long commands like the configuration command have a second detail command. You can specify this in the detailCommand property. You do not have to set the start,stop,crc check,length bytes in the cdafe commands these values are automaticly calculated. (except when there is an additional length in the data of a command, like the power curve)
export interface ICommandStrokeState {
received : (state : StrokeState )=>void;
onError? : ErrorHandler;
}
export interface IBuffer {
getStrokeState(params : ICommandStrokeState) : IBuffer;
}
commandManager.register( (buffer : IBuffer,monitor : PerformanceMonitor) =>{
buffer.getStrokeState= function (params : ICommandStrokeState) : IBuffer {
buffer.addRawCommand({
waitForResponse:true,
command : csafe.defs.LONG_CFG_CMDS.SETUSERCFG1_CMD,
detailCommand: csafe.defs.PM_SHORT_PULL_DATA_CMDS.PM_GET_STROKESTATE,
onDataReceived : (data : DataView)=>{
if (params.received) params.received(data.getUint8(0))
},
onError:params.onError
});
return buffer;
}
})
There are many commands, I have not yet found time to add all the commands. If you added new ones please commit them to github. When you not care about writing a user friendly command wrapper you can allways send raw commands. For example
this.performanceMonitor.csafeBuffer.clear()
.addRawCommand({
waitForResponse:true,
command : csafe.defs.LONG_CFG_CMDS.SETUSERCFG1_CMD,
detailCommand: csafe.defs.PM_SHORT_PULL_DATA_CMDS.PM_GET_STROKESTATE,
onDataReceived : (data : DataView)=>{
alert(data.getUint8(0));
}
})
.send();
.then(()=>{ //send returns a promise
console.log("send done, you can send th next")
});
Use cordova when you want to write a mobile app using html5.
Use this when you want tow write a desktop app using html 5
Record and replay the bluetooth communication. Handy for debuging without having to row on an ergometer. This demo is written using electron, this makes it ideal for debugging the communication because you can do not need to place it on a phone to make it worrk.
Popular GUI frame work for writing hml5 apps for mobile apps. Since it is html 5 the app is re-usable in web or electron.
Write mobile apps using native components in react using javascript.
Know problem: the used blue tooth library does not (yet?) support direct reading and writing to characteristics. due to this the csafe commands and the power curve do not work.
This is for web application. Directy access the ergometer from the webbrowser. This feature is at the point of writing only works in the latest chrome on a mac and linux.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent