gd-ant-plus
Version:
A node module for ANT+ - forked from longhorn/ant-plus
181 lines • 7.62 kB
JavaScript
"use strict";
/*
* ANT+ profile: https://www.thisisant.com/developer/ant-plus/device-profiles/#523_tab
* Spec sheet: https://www.thisisant.com/resources/bicycle-speed-and-cadence/
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.SpeedScanner = exports.SpeedSensor = void 0;
const Ant = require("./ant");
const Messages = Ant.Messages;
const Constants = Ant.Constants;
class SpeedSensorState {
constructor(deviceID) {
this.DeviceID = deviceID;
}
}
class SpeedScanState extends SpeedSensorState {
}
class SpeedSensor extends Ant.AntPlusSensor {
constructor(stick) {
super(stick);
this.wheelCircumference = 2.118; //This is my 700c wheel, just using as default
this.decodeDataCbk = this.decodeData.bind(this);
}
setWheelCircumference(wheelCircumference) {
this.wheelCircumference = wheelCircumference;
}
attach(channel, deviceID) {
super.attach(channel, 'receive', deviceID, SpeedSensor.deviceType, 0, 255, 8086);
this.state = new SpeedSensorState(deviceID);
}
decodeData(data) {
if (data.readUInt8(Messages.BUFFER_INDEX_CHANNEL_NUM) !== this.channel) {
return;
}
switch (data.readUInt8(Messages.BUFFER_INDEX_MSG_TYPE)) {
case Constants.MESSAGE_CHANNEL_BROADCAST_DATA:
case Constants.MESSAGE_CHANNEL_ACKNOWLEDGED_DATA:
case Constants.MESSAGE_CHANNEL_BURST_DATA:
if (this.deviceID === 0) {
this.write(Messages.requestMessage(this.channel, Constants.MESSAGE_CHANNEL_ID));
}
updateState(this, this.state, data);
break;
case Constants.MESSAGE_CHANNEL_ID:
this.deviceID = data.readUInt16LE(Messages.BUFFER_INDEX_MSG_DATA);
this.transmissionType = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 3);
this.state.DeviceID = this.deviceID;
break;
default:
break;
}
}
}
exports.SpeedSensor = SpeedSensor;
SpeedSensor.deviceType = 0x7B;
class SpeedScanner extends Ant.AntPlusScanner {
constructor(stick) {
super(stick);
this.wheelCircumference = 2.118; //This is my 700c wheel, just using as default
this.states = {};
this.decodeDataCbk = this.decodeData.bind(this);
}
setWheelCircumference(wheelCircumference) {
this.wheelCircumference = wheelCircumference;
}
scan() {
super.scan('receive');
}
decodeData(data) {
if (data.length <= (Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 3) || !(data.readUInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN) & 0x80)) {
console.log('wrong message format');
return;
}
const deviceId = data.readUInt16LE(Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 1);
const deviceType = data.readUInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 3);
if (deviceType !== SpeedScanner.deviceType) {
return;
}
if (!this.states[deviceId]) {
this.states[deviceId] = new SpeedScanState(deviceId);
}
if (data.readUInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN) & 0x40) {
if (data.readUInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 5) === 0x20) {
this.states[deviceId].Rssi = data.readInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 6);
this.states[deviceId].Threshold = data.readInt8(Messages.BUFFER_INDEX_EXT_MSG_BEGIN + 7);
}
}
switch (data.readUInt8(Messages.BUFFER_INDEX_MSG_TYPE)) {
case Constants.MESSAGE_CHANNEL_BROADCAST_DATA:
case Constants.MESSAGE_CHANNEL_ACKNOWLEDGED_DATA:
case Constants.MESSAGE_CHANNEL_BURST_DATA:
updateState(this, this.states[deviceId], data);
break;
default:
break;
}
}
}
exports.SpeedScanner = SpeedScanner;
SpeedScanner.deviceType = 0x7B;
const TOGGLE_MASK = 0x80;
function updateState(sensor, state, data) {
const pageNum = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA);
switch (pageNum & ~TOGGLE_MASK) { //check the new pages and remove the toggle bit
case 1:
//decode the cumulative operating time
state.OperatingTime = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 1);
state.OperatingTime |= data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 2) << 8;
state.OperatingTime |= data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 3) << 16;
state.OperatingTime *= 2;
break;
case 2:
//decode the Manufacturer ID
state.ManId = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 1);
//decode the 4 byte serial number
state.SerialNumber = state.DeviceID;
state.SerialNumber |= data.readUInt16LE(Messages.BUFFER_INDEX_MSG_DATA + 2) << 16;
state.SerialNumber >>>= 0;
break;
case 3:
//decode HW version, SW version, and model number
state.HwVersion = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 1);
state.SwVersion = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 2);
state.ModelNum = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 3);
break;
case 4: {
const batteryFrac = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 2);
const batteryStatus = data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 3);
state.BatteryVoltage = (batteryStatus & 0x0F) + (batteryFrac / 256);
const batteryFlags = (batteryStatus & 0x70) >>> 4;
switch (batteryFlags) {
case 1:
state.BatteryStatus = 'New';
break;
case 2:
state.BatteryStatus = 'Good';
break;
case 3:
state.BatteryStatus = 'Ok';
break;
case 4:
state.BatteryStatus = 'Low';
break;
case 5:
state.BatteryStatus = 'Critical';
break;
default:
state.BatteryVoltage = undefined;
state.BatteryStatus = 'Invalid';
break;
}
break;
}
case 5:
state.Motion = (data.readUInt8(Messages.BUFFER_INDEX_MSG_DATA + 1) & 0x01) === 0x01;
break;
default:
break;
}
//get old state for calculating cumulative values
const oldSpeedTime = state.SpeedEventTime;
const oldSpeedCount = state.CumulativeSpeedRevolutionCount;
let speedEventTime = data.readUInt16LE(Messages.BUFFER_INDEX_MSG_DATA + 4);
const speedRevolutionCount = data.readUInt16LE(Messages.BUFFER_INDEX_MSG_DATA + 6);
if (speedEventTime !== oldSpeedTime) {
state.SpeedEventTime = speedEventTime;
state.CumulativeSpeedRevolutionCount = speedRevolutionCount;
if (oldSpeedTime > speedEventTime) { //Hit rollover value
speedEventTime += (1024 * 64);
}
const distance = sensor.wheelCircumference * (speedRevolutionCount - oldSpeedCount);
state.CalculatedDistance = distance;
//speed in m/sec
const speed = (distance * 1024) / (speedEventTime - oldSpeedTime);
if (!isNaN(speed)) {
state.CalculatedSpeed = speed;
sensor.emit('speedData', state);
}
}
}
//# sourceMappingURL=speed-sensors.js.map