@hangtime/grip-connect 0.1.0 → 0.1.1

package/README.md

@@ -63,7 +63,7 @@ Simply importing the utilities you need from `@hangtime/grip-connect`. Devices t
 ```
 
 ```js
-import { Motherboard, calibrate, connect, disconnect, notify, read, stream } from "@hangtime/grip-connect"
+import { Motherboard, calibration, connect, disconnect, notify, read, stream } from "@hangtime/grip-connect"
 
 const motherboardButton = document.querySelector("#motherboard")
 
@@ -74,19 +74,22 @@ motherboardButton.addEventListener("click", () => {
       console.log(data)
     })
 
-    // read battery + device info
+    // Read battery + device info
     await read(Motherboard, "battery", "level", 250)
     await read(Motherboard, "device", "manufacturer", 250)
     await read(Motherboard, "device", "hardware", 250)
     await read(Motherboard, "device", "firmware", 250)
 
-    // read calibration (required before reading data)
-    await calibrate(Motherboard)
+    // Read calibration (required before reading data)
+    await calibration(Motherboard)
 
-    // start streaming for a minute
+    // Start streaming (for a minute) remove parameter for a continues stream
     await stream(Motherboard, 60000)
 
-    // disconnect from device after we are done
+    // Manually call stop method if stream is continues
+    // await stop(Motherboard)
+
+    // Disconnect from device after we are done
     disconnect(Motherboard)
   })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A client that can establish connections with various Force-Sensing Hangboards/Plates used by climbers for strength measurement. Examples of such hangboards include the Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {

package/src/calibration.d.ts

@@ -0,0 +1,6 @@
+import { Device } from "./devices/types";
+/**
+ * write command to get calibration
+ * @param board
+ */
+export declare const calibration: (board: Device) => Promise<void>;

package/src/{calibrate.js → calibration.js}

@@ -1,15 +1,16 @@
 import { Motherboard } from "./devices";
+import { MotherboardCommands } from "./commands";
 import { write } from "./write";
 /**
- * read calibration
+ * write command to get calibration
  * @param board
  */
-export const calibrate = async (board) => {
+export const calibration = async (board) => {
     if (!board.device)
         return;
     if (board.device.gatt?.connected) {
         if (board.name === "Motherboard") {
-            await write(Motherboard, "uart", "tx", "C", 2500);
+            await write(Motherboard, "uart", "tx", String(MotherboardCommands.GET_CALIBRATION), 2500);
         }
     }
 };

package/src/{calibrate.ts → calibration.ts}

@@ -1,16 +1,17 @@
 import { Device } from "./devices/types"
 import { Motherboard } from "./devices"
+import { MotherboardCommands } from "./commands"
 import { write } from "./write"
 
 /**
- * read calibration
+ * write command to get calibration
  * @param board
  */
-export const calibrate = async (board: Device): Promise<void> => {
+export const calibration = async (board: Device): Promise<void> => {
   if (!board.device) return
   if (board.device.gatt?.connected) {
     if (board.name === "Motherboard") {
-      await write(Motherboard, "uart", "tx", "C", 2500)
+      await write(Motherboard, "uart", "tx", String(MotherboardCommands.GET_CALIBRATION), 2500)
     }
   }
 }

package/src/commands/climbro.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const ClimbroCommands: Commands;

package/src/commands/climbro.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const ClimbroCommands = {};

package/src/commands/climbro.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types"
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const ClimbroCommands: Commands = {}

package/src/commands/entralpi.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const EntralpiCommands: Commands;

package/src/commands/entralpi.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const EntralpiCommands = {};

package/src/commands/entralpi.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types"
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const EntralpiCommands: Commands = {}

package/src/commands/index.d.ts

@@ -0,0 +1,5 @@
+export { ClimbroCommands } from "./climbro";
+export { EntralpiCommands } from "./entralpi";
+export { MotherboardCommands } from "./motherboard";
+export { SmartBoardCommands } from "./smartboard";
+export { TindeqCommands } from "./tindeq";

package/src/commands/index.js

@@ -0,0 +1,5 @@
+export { ClimbroCommands } from "./climbro";
+export { EntralpiCommands } from "./entralpi";
+export { MotherboardCommands } from "./motherboard";
+export { SmartBoardCommands } from "./smartboard";
+export { TindeqCommands } from "./tindeq";

package/src/commands/index.ts

@@ -0,0 +1,9 @@
+export { ClimbroCommands } from "./climbro"
+
+export { EntralpiCommands } from "./entralpi"
+
+export { MotherboardCommands } from "./motherboard"
+
+export { SmartBoardCommands } from "./smartboard"
+
+export { TindeqCommands } from "./tindeq"

package/src/commands/motherboard.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const MotherboardCommands: Commands;

package/src/commands/motherboard.js

@@ -0,0 +1,13 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const MotherboardCommands = {
+    GET_SERIAL: "#",
+    START_WEIGHT_MEAS: "S30",
+    STOP_WEIGHT_MEAS: "", // All commands will stop the data stream.
+    GET_CALIBRATION: "C",
+    SLEEP: 0,
+    GET_TEXT: "T",
+    DEBUG_STREAM: "D",
+};

package/src/commands/motherboard.ts

@@ -0,0 +1,14 @@
+import { Commands } from "../commands/types"
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const MotherboardCommands: Commands = {
+  GET_SERIAL: "#",
+  START_WEIGHT_MEAS: "S30",
+  STOP_WEIGHT_MEAS: "", // All commands will stop the data stream.
+  GET_CALIBRATION: "C",
+  SLEEP: 0,
+  GET_TEXT: "T",
+  DEBUG_STREAM: "D",
+}

package/src/commands/smartboard.d.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const SmartBoardCommands: Commands;

package/src/commands/smartboard.js

@@ -0,0 +1,5 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const SmartBoardCommands = {};

package/src/commands/smartboard.ts

@@ -0,0 +1,6 @@
+import { Commands } from "../commands/types"
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const SmartBoardCommands: Commands = {}

package/src/commands/tindeq.d.ts

@@ -0,0 +1,11 @@
+import { Commands } from "../commands/types";
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export declare const TindeqCommands: Commands;
+export declare const NotificationTypes: {
+    COMMAND_RESPONSE: number;
+    WEIGHT_MEASURE: number;
+    LOW_BATTERY_WARNING: number;
+};

package/src/commands/tindeq.js

@@ -0,0 +1,23 @@
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const TindeqCommands = {
+    TARE_SCALE: 'd', // 0x64,
+    START_WEIGHT_MEAS: 'e', // 0x65,
+    STOP_WEIGHT_MEAS: 'f', // 0x66,
+    START_PEAK_RFD_MEAS: 'g', //  0x67,
+    START_PEAK_RFD_MEAS_SERIES: 'h', //  0x68,
+    ADD_CALIB_POINT: 'i', //  0x69,
+    SAVE_CALIB: 'j', //  0x6a,
+    GET_APP_VERSION: 'k', //  0x6b,
+    GET_ERR_INFO: 'l', //  0x6c,
+    CLR_ERR_INFO: 'm', //  0x6d,
+    SLEEP: 'n', // 0x6e,
+    GET_BATT_VLTG: 'o' //  0x6f,
+};
+export const NotificationTypes = {
+    COMMAND_RESPONSE: 0,
+    WEIGHT_MEASURE: 1,
+    LOW_BATTERY_WARNING: 2,
+};

package/src/commands/tindeq.ts

@@ -0,0 +1,25 @@
+import { Commands } from "../commands/types"
+/**
+ * Warning:
+ * Using other commands can seriously harm your device
+ */
+export const TindeqCommands: Commands = {
+  TARE_SCALE: "d", // 0x64,
+  START_WEIGHT_MEAS: "e", // 0x65,
+  STOP_WEIGHT_MEAS: "f", // 0x66,
+  START_PEAK_RFD_MEAS: "g", //  0x67,
+  START_PEAK_RFD_MEAS_SERIES: "h", //  0x68,
+  ADD_CALIB_POINT: "i", //  0x69,
+  SAVE_CALIB: "j", //  0x6a,
+  GET_APP_VERSION: "k", //  0x6b,
+  GET_ERR_INFO: "l", //  0x6c,
+  CLR_ERR_INFO: "m", //  0x6d,
+  SLEEP: "n", // 0x6e,
+  GET_BATT_VLTG: "o", //  0x6f,
+}
+
+export const NotificationTypes = {
+  COMMAND_RESPONSE: 0,
+  WEIGHT_MEASURE: 1,
+  LOW_BATTERY_WARNING: 2,
+}

package/src/commands/types.d.ts

@@ -0,0 +1,18 @@
+export interface Commands {
+    START_WEIGHT_MEAS?: string;
+    STOP_WEIGHT_MEAS?: string;
+    SLEEP?: number | string;
+    GET_TEXT?: string;
+    GET_SERIAL?: string;
+    DEBUG_STREAM?: string;
+    GET_CALIBRATION?: string;
+    TARE_SCALE?: string;
+    START_PEAK_RFD_MEAS?: string;
+    START_PEAK_RFD_MEAS_SERIES?: string;
+    ADD_CALIB_POINT?: string;
+    SAVE_CALIB?: string;
+    GET_APP_VERSION?: string;
+    GET_ERR_INFO?: string;
+    CLR_ERR_INFO?: string;
+    GET_BATT_VLTG?: string;
+}

package/src/commands/types.js

@@ -0,0 +1 @@
+export {};

package/src/commands/types.ts

@@ -0,0 +1,21 @@
+export interface Commands {
+  // Motherboard, Tindeq
+  START_WEIGHT_MEAS?: string
+  STOP_WEIGHT_MEAS?: string
+  SLEEP?: number | string
+  // Motherboard
+  GET_TEXT?: string
+  GET_SERIAL?: string
+  DEBUG_STREAM?: string
+  GET_CALIBRATION?: string
+  // Tindeq
+  TARE_SCALE?: string
+  START_PEAK_RFD_MEAS?: string
+  START_PEAK_RFD_MEAS_SERIES?: string
+  ADD_CALIB_POINT?: string
+  SAVE_CALIB?: string
+  GET_APP_VERSION?: string
+  GET_ERR_INFO?: string
+  CLR_ERR_INFO?: string
+  GET_BATT_VLTG?: string
+}

package/src/connect.js

@@ -1,5 +1,5 @@
 import { notifyCallback } from "./notify";
-import { handleMotherboardData } from "./devices/moterboard";
+import { handleMotherboardData } from "./devices/motherboard";
 import { handleEntralpiData } from "./devices/entralpi";
 let server;
 const receiveBuffer = [];

package/src/connect.ts

@@ -1,6 +1,6 @@
 import { Device } from "./devices/types"
 import { notifyCallback } from "./notify"
-import { handleMotherboardData } from "./devices/moterboard"
+import { handleMotherboardData } from "./devices/motherboard"
 import { handleEntralpiData } from "./devices/entralpi"
 
 let server: BluetoothRemoteGATTServer

package/src/devices/index.d.ts

@@ -1,5 +1,5 @@
 export { Climbro } from "./climbro";
 export { Entralpi } from "./entralpi";
-export { Motherboard } from "./moterboard";
+export { Motherboard } from "./motherboard";
 export { SmartBoard } from "./smartboard";
 export { Tindeq } from "./tindeq";

package/src/devices/index.js

@@ -1,5 +1,5 @@
 export { Climbro } from "./climbro";
 export { Entralpi } from "./entralpi";
-export { Motherboard } from "./moterboard";
+export { Motherboard } from "./motherboard";
 export { SmartBoard } from "./smartboard";
 export { Tindeq } from "./tindeq";

package/src/devices/index.ts

@@ -2,7 +2,7 @@ export { Climbro } from "./climbro"
 
 export { Entralpi } from "./entralpi"
 
-export { Motherboard } from "./moterboard"
+export { Motherboard } from "./motherboard"
 
 export { SmartBoard } from "./smartboard"
 

package/src/devices/tindeq.d.ts

@@ -1,17 +1,2 @@
 import { Device } from "./types";
 export declare const Tindeq: Device;
-export declare const Commands: {
-    TARE_SCALE: number;
-    START_MEASURING: number;
-    STOP_MEASURING: number;
-    GET_APP_VERSION: number;
-    GET_ERROR_INFO: number;
-    CLEAR_ERR_INFO: number;
-    GET_BATTERY_LEVEL: number;
-    SLEEP: number;
-};
-export declare const NotificationTypes: {
-    COMMAND_RESPONSE: number;
-    WEIGHT_MEASURE: number;
-    LOW_BATTERY_WARNING: number;
-};

package/src/devices/tindeq.js

@@ -20,18 +20,3 @@ export const Tindeq = {
         },
     ],
 };
-export const Commands = {
-    TARE_SCALE: 0x64,
-    START_MEASURING: 0x65,
-    STOP_MEASURING: 0x66,
-    GET_APP_VERSION: 0x6b,
-    GET_ERROR_INFO: 0x6c,
-    CLEAR_ERR_INFO: 0x6d,
-    GET_BATTERY_LEVEL: 0x6f,
-    SLEEP: 0x6e,
-};
-export const NotificationTypes = {
-    COMMAND_RESPONSE: 0,
-    WEIGHT_MEASURE: 1,
-    LOW_BATTERY_WARNING: 2,
-};

package/src/devices/tindeq.ts

@@ -22,20 +22,3 @@ export const Tindeq: Device = {
     },
   ],
 }
-
-export const Commands = {
-  TARE_SCALE: 0x64,
-  START_MEASURING: 0x65,
-  STOP_MEASURING: 0x66,
-  GET_APP_VERSION: 0x6b,
-  GET_ERROR_INFO: 0x6c,
-  CLEAR_ERR_INFO: 0x6d,
-  GET_BATTERY_LEVEL: 0x6f,
-  SLEEP: 0x6e,
-}
-
-export const NotificationTypes = {
-  COMMAND_RESPONSE: 0,
-  WEIGHT_MEASURE: 1,
-  LOW_BATTERY_WARNING: 2,
-}

package/src/index.d.ts

@@ -1,7 +1,8 @@
 export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index";
-export { calibrate } from "./calibrate";
+export { calibration } from "./calibration";
 export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { notify } from "./notify";
 export { read } from "./read";
+export { stop } from "./stop";
 export { stream } from "./stream";

package/src/index.js

@@ -1,9 +1,8 @@
 export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index";
-export { calibrate } from "./calibrate";
+export { calibration } from "./calibration";
 export { connect } from "./connect";
 export { disconnect } from "./disconnect";
 export { notify } from "./notify";
 export { read } from "./read";
+export { stop } from "./stop";
 export { stream } from "./stream";
-// WARNING: Writing to device can seriously damage the device
-// export { write } from "./write"

package/src/index.ts

@@ -1,6 +1,6 @@
 export { Climbro, Entralpi, Motherboard, SmartBoard, Tindeq } from "./devices/index"
 
-export { calibrate } from "./calibrate"
+export { calibration } from "./calibration"
 
 export { connect } from "./connect"
 
@@ -10,7 +10,6 @@ export { notify } from "./notify"
 
 export { read } from "./read"
 
-export { stream } from "./stream"
+export { stop } from "./stop"
 
-// WARNING: Writing to device can seriously damage the device
-// export { write } from "./write"
+export { stream } from "./stream"

package/src/{calibrate.d.ts → stop.d.ts}

@@ -3,4 +3,4 @@ import { Device } from "./devices/types";
  * read calibration
  * @param board
  */
-export declare const calibrate: (board: Device) => Promise<void>;
+export declare const stop: (board: Device) => Promise<void>;

package/src/stop.js

@@ -0,0 +1,19 @@
+import { Motherboard, Tindeq } from "./devices";
+import { MotherboardCommands, TindeqCommands } from "./commands";
+import { write } from "./write";
+/**
+ * read calibration
+ * @param board
+ */
+export const stop = async (board) => {
+    if (!board.device)
+        return;
+    if (board.device.gatt?.connected) {
+        if (board.name === "Motherboard") {
+            await write(Motherboard, "uart", "tx", String(MotherboardCommands.STOP_WEIGHT_MEAS), 0);
+        }
+        if (board.name === "Tindeq") {
+            await write(Tindeq, "progressor", "tx", String(TindeqCommands.STOP_WEIGHT_MEAS), 0);
+        }
+    }
+};

package/src/stop.ts

@@ -0,0 +1,20 @@
+import { Device } from "./devices/types"
+import { Motherboard, Tindeq } from "./devices"
+import { MotherboardCommands, TindeqCommands } from "./commands"
+import { write } from "./write"
+
+/**
+ * read calibration
+ * @param board
+ */
+export const stop = async (board: Device): Promise<void> => {
+  if (!board.device) return
+  if (board.device.gatt?.connected) {
+    if (board.name === "Motherboard") {
+      await write(Motherboard, "uart", "tx", String(MotherboardCommands.STOP_WEIGHT_MEAS), 0)
+    }
+    if (board.name === "Tindeq") {
+      await write(Tindeq, "progressor", "tx", String(TindeqCommands.STOP_WEIGHT_MEAS), 0)
+    }
+  }
+}

package/src/stream.js

@@ -1,5 +1,7 @@
 import { Motherboard, Tindeq } from "./devices";
+import { MotherboardCommands, TindeqCommands } from "./commands";
 import { write } from "./write";
+import { stop } from "./stop";
 /**
  * stream output
  * @param board
@@ -11,15 +13,19 @@ export const stream = async (board, duration = 0) => {
         if (board.name === "Motherboard") {
             // TODO: add check if device is recalibrated
             // start stream
-            await write(Motherboard, "uart", "tx", "S30", duration);
+            await write(Motherboard, "uart", "tx", String(MotherboardCommands.START_WEIGHT_MEAS), duration);
             // end stream
-            await write(Motherboard, "uart", "tx", "", 0);
+            if (duration !== 0) {
+                await stop(Motherboard);
+            }
         }
         if (board.name === "Tindeq") {
             // start stream
-            await write(Tindeq, "progressor", "tx", "e", duration);
+            await write(Tindeq, "progressor", "tx", String(TindeqCommands.START_WEIGHT_MEAS), duration);
             // end stream
-            await write(Tindeq, "progressor", "tx", "f", 0);
+            if (duration !== 0) {
+                await stop(Tindeq);
+            }
         }
     }
 };

package/src/stream.ts

@@ -1,6 +1,8 @@
 import { Device } from "./devices/types"
 import { Motherboard, Tindeq } from "./devices"
+import { MotherboardCommands, TindeqCommands } from "./commands"
 import { write } from "./write"
+import { stop } from "./stop"
 
 /**
  * stream output
@@ -12,15 +14,19 @@ export const stream = async (board: Device, duration: number = 0): Promise<void>
     if (board.name === "Motherboard") {
       // TODO: add check if device is recalibrated
       // start stream
-      await write(Motherboard, "uart", "tx", "S30", duration)
+      await write(Motherboard, "uart", "tx", String(MotherboardCommands.START_WEIGHT_MEAS), duration)
       // end stream
-      await write(Motherboard, "uart", "tx", "", 0)
+      if (duration !== 0) {
+        await stop(Motherboard)
+      }
     }
     if (board.name === "Tindeq") {
       // start stream
-      await write(Tindeq, "progressor", "tx", "e", duration)
+      await write(Tindeq, "progressor", "tx", String(TindeqCommands.START_WEIGHT_MEAS), duration)
       // end stream
-      await write(Tindeq, "progressor", "tx", "f", 0)
+      if (duration !== 0) {
+        await stop(Tindeq)
+      }
     }
   }
 }