nkellenicki/node-poweredup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Replace magic numbers with constants

Browse Source 
This replaces several magic numbers in the lpf2hub implementation with constants that were already present in src/consts.ts. This should enhance readability and maintainability. Comments that were made redundant by including the constant names have been removed.

There are still quite a few magic numbers in here that could be replaced, particularly in the byte arrays used to build messages, but I didn't attempt to clean those up.
This commit is contained in:
Jon Craton 2020-10-16 15:05:01 -04:00
parent 7852fa5823
commit 7bc9603952
1 changed files with 33 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
src/hubs/lpf2hub.ts
View File

@ -25,12 +25,12 @@ export class LPF2Hub extends BaseHub {
await super.connect(); await super.connect();
await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.LPF2_HUB); await this._bleDevice.discoverCharacteristicsForService(Consts.BLEService.LPF2_HUB);
this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, this._parseMessage.bind(this)); this._bleDevice.subscribeToCharacteristic(Consts.BLECharacteristic.LPF2_ALL, this._parseMessage.bind(this));
await this._requestHubPropertyReports(0x02); // Activate button reports await this._requestHubPropertyReports(Consts.HubPropertyPayload.BUTTON_STATE);
await this._requestHubPropertyValue(0x03); // Request firmware version await this._requestHubPropertyValue(Consts.HubPropertyPayload.FW_VERSION);
await this._requestHubPropertyValue(0x04); // Request hardware version await this._requestHubPropertyValue(Consts.HubPropertyPayload.HW_VERSION);
await this._requestHubPropertyReports(0x05); // Activate RSSI updates await this._requestHubPropertyReports(Consts.HubPropertyPayload.RSSI);
await this._requestHubPropertyReports(0x06); // Activate battery level reports await this._requestHubPropertyReports(Consts.HubPropertyPayload.BATTERY_VOLTAGE);
await this._requestHubPropertyValue(0x0d); // Request primary MAC address await this._requestHubPropertyValue(Consts.HubPropertyPayload.PRIMARY_MAC_ADDRESS);
this.emit("connect"); this.emit("connect");
debug("LPF2Hub connected"); debug("LPF2Hub connected");
} }
@ -132,7 +132,7 @@ export class LPF2Hub extends BaseHub {
debug("Received Message (LPF2_ALL)", message); debug("Received Message (LPF2_ALL)", message);
switch (message[2]) { switch (message[2]) {
case 0x01: { case Consts.MessageType.HUB_PROPERTIES: {
const property = message[3]; const property = message[3];
const callback = this._propertyRequestCallbacks[property]; const callback = this._propertyRequestCallbacks[property];
if (callback) { if (callback) {
@ -143,23 +143,23 @@ export class LPF2Hub extends BaseHub {
delete this._propertyRequestCallbacks[property]; delete this._propertyRequestCallbacks[property];
break; break;
} }
case 0x04: { case Consts.MessageType.HUB_ATTACHED_IO: {
this._parsePortMessage(message); this._parsePortMessage(message);
break; break;
} }
case 0x43: { case Consts.MessageType.PORT_INFORMATION: {
this._parsePortInformationResponse(message); this._parsePortInformationResponse(message);
break; break;
} }
case 0x44: { case Consts.MessageType.PORT_MODE_INFORMATION: {
this._parseModeInformationResponse(message); this._parseModeInformationResponse(message);
break; break;
} }
case 0x45: { case Consts.MessageType.PORT_VALUE_SINGLE: {
this._parseSensorMessage(message); this._parseSensorMessage(message);
break; break;
} }
case 0x82: { case Consts.MessageType.HUB_ACTIONS: {
this._parsePortAction(message); this._parsePortAction(message);
break; break;
} }
@ -190,9 +190,7 @@ export class LPF2Hub extends BaseHub {
private _parseHubPropertyResponse (message: Buffer) { private _parseHubPropertyResponse (message: Buffer) {
if (message[3] === Consts.HubPropertyPayload.BUTTON_STATE) {
// Button press reports
if (message[3] === 0x02) {
if (message[5] === 1) { if (message[5] === 1) {
/** /**
* Emits when a button is pressed. * Emits when a button is pressed.
@ -207,29 +205,24 @@ export class LPF2Hub extends BaseHub {
return; return;
} }
// Firmware version } else if (message[3] === Consts.HubPropertyPayload.FW_VERSION) {
} else if (message[3] === 0x03) {
this._firmwareVersion = decodeVersion(message.readInt32LE(5)); this._firmwareVersion = decodeVersion(message.readInt32LE(5));
this._checkFirmware(this._firmwareVersion); this._checkFirmware(this._firmwareVersion);
// Hardware version } else if (message[3] === Consts.HubPropertyPayload.HW_VERSION) {
} else if (message[3] === 0x04) {
this._hardwareVersion = decodeVersion(message.readInt32LE(5)); this._hardwareVersion = decodeVersion(message.readInt32LE(5));
// RSSI update } else if (message[3] === Consts.HubPropertyPayload.RSSI) {
} else if (message[3] === 0x05) {
const rssi = message.readInt8(5); const rssi = message.readInt8(5);
if (rssi !== 0) { if (rssi !== 0) {
this._rssi = rssi; this._rssi = rssi;
this.emit("rssi", { rssi: this._rssi }); this.emit("rssi", { rssi: this._rssi });
} }
// primary MAC Address } else if (message[3] === Consts.HubPropertyPayload.PRIMARY_MAC_ADDRESS) {
} else if (message[3] === 0x0d) {
this._primaryMACAddress = decodeMACAddress(message.slice(5)); this._primaryMACAddress = decodeMACAddress(message.slice(5));
// Battery level reports } else if (message[3] === Consts.HubPropertyPayload.BATTERY_VOLTAGE) {
} else if (message[3] === 0x06) {
const batteryLevel = message[5]; const batteryLevel = message[5];
if (batteryLevel !== this._batteryLevel) { if (batteryLevel !== this._batteryLevel) {
this._batteryLevel = batteryLevel; this._batteryLevel = batteryLevel;
@ -245,8 +238,7 @@ export class LPF2Hub extends BaseHub {
const event = message[4]; const event = message[4];
const deviceType = event ? message.readUInt16LE(5) : 0; const deviceType = event ? message.readUInt16LE(5) : 0;
// Handle device attachments if (event === Consts.AlertPayload.ATTACHED_IO) {
if (event === 0x01) {
if (modeInfoDebug.enabled) { if (modeInfoDebug.enabled) {
const deviceTypeName = Consts.DeviceTypeNames[message[5]] || "Unknown"; const deviceTypeName = Consts.DeviceTypeNames[message[5]] || "Unknown";
@ -260,8 +252,7 @@ export class LPF2Hub extends BaseHub {
const device = this._createDevice(deviceType, portId); const device = this._createDevice(deviceType, portId);
this._attachDevice(device); this._attachDevice(device);
// Handle device detachments } else if (event === Consts.AlertPayload.DETACHED_IO) {
} else if (event === 0x00) {
const device = this._getDeviceByPortId(portId); const device = this._getDeviceByPortId(portId);
if (device) { if (device) {
this._detachDevice(device); this._detachDevice(device);
@ -274,8 +265,7 @@ export class LPF2Hub extends BaseHub {
} }
} }
// Handle virtual port creation } else if (event === Consts.AlertPayload.ATTACHED_VIRTUAL_IO) {
} else if (event === 0x02) {
const firstPortName = this.getPortNameForPortId(message[7]); const firstPortName = this.getPortNameForPortId(message[7]);
const secondPortName = this.getPortNameForPortId(message[8]); const secondPortName = this.getPortNameForPortId(message[8]);
// @ts-ignore NK These should never be undefined // @ts-ignore NK These should never be undefined
@ -312,12 +302,12 @@ export class LPF2Hub extends BaseHub {
modeInfoDebug(`Port ${toHex(port)}, total modes ${count}, input modes ${input}, output modes ${output}`); modeInfoDebug(`Port ${toHex(port)}, total modes ${count}, input modes ${input}, output modes ${output}`);
for (let i = 0; i < count; i++) { for (let i = 0; i < count; i++) {
await this._sendModeInformationRequest(port, i, 0x00); // Mode Name await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.NAME);
await this._sendModeInformationRequest(port, i, 0x01); // RAW Range await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.RAW);
await this._sendModeInformationRequest(port, i, 0x02); // PCT Range await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.PCT);
await this._sendModeInformationRequest(port, i, 0x03); // SI Range await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.SI);
await this._sendModeInformationRequest(port, i, 0x04); // SI Symbol await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.SYMBOL);
await this._sendModeInformationRequest(port, i, 0x80); // Value Format await this._sendModeInformationRequest(port, i, Consts.ModeInformationType.VALUE_FORMAT);
} }
} }
@ -332,22 +322,22 @@ export class LPF2Hub extends BaseHub {
const mode = message[4]; const mode = message[4];
const type = message[5]; const type = message[5];
switch (type) { switch (type) {
case 0x00: // Mode Name case Consts.ModeInformationType.NAME:
modeInfoDebug(`Port ${port}, mode ${mode}, name ${message.slice(6, message.length).toString()}`); modeInfoDebug(`Port ${port}, mode ${mode}, name ${message.slice(6, message.length).toString()}`);
break; break;
case 0x01: // RAW Range case Consts.ModeInformationType.RAW:
modeInfoDebug(`Port ${port}, mode ${mode}, RAW min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`); modeInfoDebug(`Port ${port}, mode ${mode}, RAW min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break; break;
case 0x02: // PCT Range case Consts.ModeInformationType.PCT:
modeInfoDebug(`Port ${port}, mode ${mode}, PCT min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`); modeInfoDebug(`Port ${port}, mode ${mode}, PCT min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break; break;
case 0x03: // SI Range case Consts.ModeInformationType.SI:
modeInfoDebug(`Port ${port}, mode ${mode}, SI min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`); modeInfoDebug(`Port ${port}, mode ${mode}, SI min ${message.readFloatLE(6)}, max ${message.readFloatLE(10)}`);
break; break;
case 0x04: // SI Symbol case Consts.ModeInformationType.SYMBOL:
modeInfoDebug(`Port ${port}, mode ${mode}, SI symbol ${message.slice(6, message.length).toString()}`); modeInfoDebug(`Port ${port}, mode ${mode}, SI symbol ${message.slice(6, message.length).toString()}`);
break; break;
case 0x80: // Value Format case Consts.ModeInformationType.VALUE_FORMAT:
const numValues = message[6]; const numValues = message[6];
const dataType = ["8bit", "16bit", "32bit", "float"][message[7]]; const dataType = ["8bit", "16bit", "32bit", "float"][message[7]];
const totalFigures = message[8]; const totalFigures = message[8];