@hangtime/grip-connect 0.3.1 → 0.3.3

package/README.md

@@ -3,18 +3,31 @@
 **Force-Sensing Climbing Training**
 
 The objective of this project is to create a Web Bluetooth API client that can establish connections with various
-Force-Sensing Hangboards / Plates used by climbers for strength measurement. Examples of such hangboards include the
-[Griptonite Motherboard](https://griptonite.io/shop/motherboard/), [Climbro](https://climbro.com/),
-[mySmartBoard](https://www.smartboard-climbing.com/), [Entralpi](https://entralpi.com/),
-[Tindeq Progressor](https://tindeq.com/) or [MAT Muscle Meter](https://www.matassessment.com/musclemeter)
+Force-Sensing Hangboards / Plates / LED system boards used by climbers for strength measurement. Examples of such
+hangboards include the [Griptonite Motherboard](https://griptonite.io/shop/motherboard/),
+[Climbro](https://climbro.com/), [mySmartBoard](https://www.smartboard-climbing.com/),
+[Entralpi](https://entralpi.com/), [Tindeq Progressor](https://tindeq.com/) or
+[MAT Muscle Meter](https://www.matassessment.com/musclemeter)
+
+And LED system boards from [Aurora Climbing](https://auroraclimbing.com/) like the
+[Kilter Board](https://settercloset.com/pages/the-kilter-board),
+[Tension Board](https://tensionclimbing.com/product/tension-board-2/),
+[Grasshopper Board](https://grasshopperclimbing.com/products/),
+[Decoy Board](https://decoy-holds.com/pages/decoy-board), [Touchstone Board](https://touchstoneboardapp.com/) and
+[So iLL Board](https://apps.apple.com/us/app/so-ill-board/id1358056082).
 
 Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
 [Browser Support](https://caniuse.com/web-bluetooth)
 
+> [!CAUTION] This project is provided "as-is" without any express or implied warranties. By using this software, you
+> assume all risks associated with its use, including but not limited to hardware damage, data loss, or any other issues
+> that may arise. The developers and contributors are not responsible for any harm or loss incurred. Use this software
+> at your own discretion and responsibility.
+
 ## Try it out
 
 [Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/) -
-[Pong](https://grip-connect-pong.vercel.app/)
+[Kilter Board](https://grip-connect-kilter-board.vercel.app/)
 
 ## Install
 
@@ -77,7 +90,8 @@ available services with us.
 
 - ✅ Griptonite Motherboard
 - ✅ Tindeq Progressor
-- ☑️ Entralpi (not verified)
+- ⏳ Entralpi (not verified)
+- ⏳ Kilterboard (write only, see example)
 - ➡️ Climbro
 - ➡️ mySmartBoard
 - ➡️ MAT Muscle Meter
@@ -113,9 +127,13 @@ A special thank you to:
 - [@donaldharvey](https://github.com/donaldharvey) for a valuable example on connecting to the Motherboard.
 - [@ecstrema](https://github.com/ecstrema) for providing [examples](https://github.com/ecstrema/entralpi-games) on how
   to play games with the Entralpi.
-- [Tindeq](https://tindeq.com/) for providing an open [Progressor API](https://tindeq.com/progressor_api/)
+- [Tindeq](https://tindeq.com/) for providing an open [Progressor API](https://tindeq.com/progressor_api/).
 - [@StuartLittlefair](https://github.com/StuartLittlefair) for his
   [PyTindeq](https://github.com/StuartLittlefair/PyTindeq) implementation.
+- [@Phil9l](https://github.com/phil9l) for his research and providing a [blog](https://bazun.me/blog/kiterboard/) on how
+  to connect with the Kilter Board.
+- [@1-max-1](https://github.com/1-max-1/fake_kilter_board) for the docs on his Kilter Board
+  [https://github.com/1-max-1/fake_kilter_board](simulator).
 
 ## Disclaimer
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "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 Griptonite Motherboard, Climbro, SmartBoard, Entralpi or Tindeq Progressor",
   "main": "src/index.ts",
   "scripts": {

package/src/battery.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { read } from "./read"
 import { isConnected } from "./is-connected"
@@ -14,12 +14,12 @@ export const battery = async (board: Device): Promise<void> => {
   // Check if the device is connected
   if (isConnected(board)) {
     // If the device is connected and it is a Motherboard device
-    if (board.name === "Motherboard") {
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       // Read battery level information from the Motherboard
       await read(Motherboard, "battery", "level", 250)
     }
     // If the device is connected and its name starts with "Progressor"
-    if (board.name && board.name.startsWith("Progressor")) {
+    if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
       // Write command to get battery voltage information to the Progressor
       await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250)
     }

package/src/calibration.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { write } from "./write"
 import { Motherboard } from "./devices"
@@ -13,7 +13,7 @@ export const calibration = async (board: Device): Promise<void> => {
   // Check if the device is connected
   if (isConnected(board)) {
     // If the device is connected, and it is a Motherboard device
-    if (board.name === "Motherboard") {
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       // Write the command to get calibration data to the device
       await write(Motherboard, "uart", "tx", MotherboardCommands.GET_CALIBRATION, 2500)
     }

package/src/characteristic.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 
 /**
  * Retrieves the characteristic from the device's service.

package/src/commands/climbro.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/entralpi.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/motherboard.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/musclemeter.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/mysmartboard.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device

package/src/commands/progressor.ts

@@ -1,4 +1,4 @@
-import { Commands } from "../commands/types"
+import type { Commands } from "../types/commands"
 /**
  * Warning:
  * Using other commands can seriously harm your device
@@ -22,10 +22,10 @@ export const ProgressorCommands: Commands = {
  * The Progressor returns a Uint8Array.
  * The first item [0] is the type of response it returns
  */
-export const ProgressorResponses = {
-  COMMAND_RESPONSE: 0,
-  WEIGHT_MEASURE: 1,
-  PEAK_RFD_MEAS: 2,
-  PEAK_RFD_MEAS_SERIES: 3,
-  LOW_BATTERY_WARNING: 4,
+export enum ProgressorResponses {
+  COMMAND_RESPONSE,
+  WEIGHT_MEASURE,
+  PEAK_RFD_MEAS,
+  PEAK_RFD_MEAS_SERIES,
+  LOW_BATTERY_WARNING,
 }

package/src/connect.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { handleEntralpiData, handleMotherboardData, handleProgressorData } from "./data"
 
 let server: BluetoothRemoteGATTServer
@@ -24,7 +24,8 @@ const handleNotifications = (event: Event, board: Device): void => {
   const value: DataView | undefined = characteristic.value
 
   if (value) {
-    if (board.name === "Motherboard") {
+    // If the device is connected and it is a Motherboard device
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       for (let i: number = 0; i < value.byteLength; i++) {
         receiveBuffer.push(value.getUint8(i))
       }
@@ -37,14 +38,14 @@ const handleNotifications = (event: Event, board: Device): void => {
         const receivedData: string = decoder.decode(new Uint8Array(line))
         handleMotherboardData(receivedData)
       }
-    } else if (board.name === "ENTRALPI") {
+    } else if (board.filters.some((filter) => filter.name === "ENTRALPI")) {
       if (value.buffer) {
         const buffer: ArrayBuffer = value.buffer
         const rawData: DataView = new DataView(buffer)
         const receivedData: string = (rawData.getUint16(0) / 100).toFixed(1)
         handleEntralpiData(receivedData)
       }
-    } else if (board.name && board.name.startsWith("Progressor")) {
+    } else if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
       if (value.buffer) {
         const buffer: ArrayBuffer = value.buffer
         const rawData: DataView = new DataView(buffer)
@@ -90,7 +91,7 @@ const onConnected = async (board: Device, onSuccess: () => void): Promise<void>
               // notify
               if (element.id === "rx") {
                 matchingCharacteristic.startNotifications()
-                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event) =>
+                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event: Event) =>
                   handleNotifications(event, board),
                 )
               }
@@ -126,25 +127,8 @@ export const connect = async (board: Device, onSuccess: () => void): Promise<voi
     // Request device and set up connection
     const deviceServices = getAllServiceUUIDs(board)
 
-    // setup filter list
-    const filters = []
-
-    if (board.name) {
-      const filterName = board.name === "Progressor" ? { namePrefix: board.name } : { name: board.name }
-      filters.push(filterName)
-    }
-    if (board.companyId) {
-      filters.push({
-        manufacturerData: [
-          {
-            companyIdentifier: board.companyId,
-          },
-        ],
-      })
-    }
-
     const device = await navigator.bluetooth.requestDevice({
-      filters: filters,
+      filters: board.filters,
       optionalServices: deviceServices,
     })
 

package/src/data.ts

@@ -3,8 +3,9 @@ import { applyTare } from "./tare"
 import { ProgressorCommands, ProgressorResponses } from "./commands/progressor"
 import { MotherboardCommands } from "./commands"
 import { lastWrite } from "./write"
-import { DownloadPacket, DownloadPackets } from "./download"
 import struct from "./struct"
+import { DownloadPackets } from "./download"
+import type { DownloadPacket } from "./types/download"
 
 // Constants
 const PACKET_LENGTH: number = 32

package/src/devices/climbro.ts

@@ -1,10 +1,10 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Climbro device
  * TODO: Add services, do you own a Climbro? Help us!
  */
 export const Climbro: Device = {
-  name: "Climbro",
+  filters: [{ name: "Climbro" }],
   services: [],
 }

package/src/devices/entralpi.ts

@@ -1,10 +1,14 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Entralpi device
  */
 export const Entralpi: Device = {
-  name: "ENTRALPI",
+  filters: [
+    {
+      name: "ENTRALPI",
+    },
+  ],
   services: [
     {
       name: "Device Information",

package/src/devices/index.ts

@@ -2,6 +2,8 @@ export { Climbro } from "./climbro"
 
 export { Entralpi } from "./entralpi"
 
+export { KilterBoard } from "./kilterboard"
+
 export { Motherboard } from "./motherboard"
 
 export { mySmartBoard } from "./mysmartboard"

package/src/devices/kilterboard.ts

@@ -0,0 +1,32 @@
+import type { Device } from "../types/devices"
+
+/**
+ * Represents a Aurora Climbing device
+ * Kilter Board, Tension Board, Decoy Board, Touchstone Board, Grasshopper Board, Aurora Board, So iLL Board
+ */
+export const KilterBoard: Device = {
+  filters: [
+    {
+      services: ["4488b571-7806-4df6-bcff-a2897e4953ff"], // Aurora Climbing Advertising service
+    },
+  ],
+  services: [
+    {
+      name: "UART Nordic Service",
+      id: "uart",
+      uuid: "6e400001-b5a3-f393-e0a9-e50e24dcca9e",
+      characteristics: [
+        {
+          name: "TX",
+          id: "tx",
+          uuid: "6e400002-b5a3-f393-e0a9-e50e24dcca9e",
+        },
+        // {
+        //   name: "RX",
+        //   id: "rx",
+        //   uuid: "6e400003-b5a3-f393-e0a9-e50e24dcca9e",
+        // },
+      ],
+    },
+  ],
+}

package/src/devices/motherboard.ts

@@ -1,11 +1,10 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a Griptonite Motherboard device
  */
 export const Motherboard: Device = {
-  name: "Motherboard",
-  companyId: 0x2a29,
+  filters: [{ name: "Motherboard" }],
   services: [
     {
       name: "Device Information",

package/src/devices/musclemeter.ts

@@ -1,10 +1,10 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a MAT Muscle Meter device
  * TODO: Add services, do you own a MAT Muscle Meter? Help us!
  */
 export const MuscleMeter: Device = {
-  name: "MAT",
+  filters: [{ name: "MAT" }],
   services: [],
 }

package/src/devices/mysmartboard.ts

@@ -1,10 +1,10 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 
 /**
  * Represents a mySmartBoard device
  * TODO: Add services, do you own a mySmartBoard? Help us!
  */
 export const mySmartBoard: Device = {
-  name: "mySmartBoard",
+  filters: [{ name: "mySmartBoard" }],
   services: [],
 }

package/src/devices/progressor.ts

@@ -1,9 +1,9 @@
-import { Device } from "./types"
+import type { Device } from "../types/devices"
 /**
  * Represents a Tindeq Progressor device
  */
 export const Progressor: Device = {
-  name: "Progressor",
+  filters: [{ namePrefix: "Progressor" }],
   services: [
     {
       name: "Progressor Service",

package/src/disconnect.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 
 /**

package/src/download.ts

@@ -1,14 +1,4 @@
-/**
- * Represents a single data packet.
- */
-export interface DownloadPacket {
-  received: number // Timestamp of when the packet was received
-  sampleNum: number // Sample number
-  battRaw: number // Battery raw value
-  samples: number[] // Array of sample values
-  masses: number[] // Array of mass values
-}
-
+import type { DownloadPacket } from "./types/download"
 /**
  * Array of DownloadPacket entries.
  */

package/src/index.ts

@@ -1,5 +1,5 @@
 // Export device types
-export { Climbro, Entralpi, Motherboard, mySmartBoard, MuscleMeter, Progressor } from "./devices/index"
+export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, MuscleMeter, Progressor } from "./devices/index"
 
 // Export battery related functions
 export { battery } from "./battery"

package/src/info.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { read } from "./read"
 import { isConnected } from "./is-connected"
@@ -12,7 +12,7 @@ import { MotherboardCommands, ProgressorCommands } from "./commands"
  */
 export const info = async (board: Device): Promise<void> => {
   if (isConnected(board)) {
-    if (board.name === "Motherboard") {
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       // Read manufacturer information
       await read(Motherboard, "device", "manufacturer", 250)
       // Read hardware version
@@ -24,7 +24,7 @@ export const info = async (board: Device): Promise<void> => {
       // Get serial number from Motherboard
       await write(Motherboard, "uart", "tx", MotherboardCommands.GET_SERIAL, 250)
     }
-    if (board.name && board.name.startsWith("Progressor")) {
+    if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
       // Get firmware version from Progressor
       await write(Progressor, "progressor", "tx", ProgressorCommands.GET_FW_VERSION, 250)
     }

package/src/is-connected.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 
 /**
  * Checks if a Bluetooth device is connected.

package/src/notify.ts

@@ -1,13 +1,6 @@
-export interface massObject {
-  massTotal: string // The total mass.
-  massMax: string // The total maximum mass.
-  massAverage: string // The total average mass.
-  massLeft?: string // The mass on the left side (optional: Motherboard).
-  massCenter?: string // The mass at the center (optional: Motherboard).
-  massRight?: string // The mass on the right side (optional: Motherboard).
-}
-// Define the type for the callback function
-type NotifyCallback = (data: massObject) => void
+import type { massObject } from "./types/notify"
+/** Define the type for the callback function */
+export type NotifyCallback = (data: massObject) => void
 /**
  * Defines the type for the callback function.
  * @callback NotifyCallback

package/src/read.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { getCharacteristic } from "./characteristic"
 import { isConnected } from "./is-connected"
 

package/src/stop.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { write } from "./write"
 import { isConnected } from "./is-connected"
 import { Motherboard, Progressor } from "./devices"
@@ -11,11 +11,11 @@ import { MotherboardCommands, ProgressorCommands } from "./commands"
  */
 export const stop = async (board: Device): Promise<void> => {
   if (isConnected(board)) {
-    if (board.name === "Motherboard") {
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       // Stop stream on Motherboard
       await write(Motherboard, "uart", "tx", MotherboardCommands.STOP_WEIGHT_MEAS, 0)
     }
-    if (board.name && board.name.startsWith("Progressor")) {
+    if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
       // Stop stream on Progressor
       await write(Progressor, "progressor", "tx", ProgressorCommands.STOP_WEIGHT_MEAS, 0)
     }

package/src/stream.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { write } from "./write"
 import { stop } from "./stop"
@@ -19,7 +19,7 @@ export const stream = async (board: Device, duration: number = 0): Promise<void>
     // Reset download packets
     emptyDownloadPackets()
     // Device specific logic
-    if (board.name === "Motherboard") {
+    if (board.filters.some((filter) => filter.name === "Motherboard")) {
       // Read calibration data if not already available
       if (!CALIBRATION[0].length) {
         await calibration(Motherboard)
@@ -31,7 +31,7 @@ export const stream = async (board: Device, duration: number = 0): Promise<void>
         await stop(Motherboard)
       }
     }
-    if (board.name && board.name.startsWith("Progressor")) {
+    if (board.filters.some((filter) => filter.namePrefix === "Progressor")) {
       // Start streaming data
       await write(Progressor, "progressor", "tx", ProgressorCommands.START_WEIGHT_MEAS, duration)
       // Stop streaming if duration is set

package/src/types/devices.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents a characteristic of a Bluetooth service.
+ */
+interface Characteristic {
+  /** Name of the characteristic */
+  name: string
+  /** Identifier of the characteristic */
+  id: string
+  /** UUID of the characteristic */
+  uuid: string
+  /** Reference to the characteristic object */
+  characteristic?: BluetoothRemoteGATTCharacteristic
+}
+
+/**
+ * Represents a Bluetooth service.
+ */
+interface Service {
+  /**  Name of the service */
+  name: string
+  /** Identifier of the service */
+  id: string
+  /** UUID of the service */
+  uuid: string
+  /** Array of characteristics belonging to this service */
+  characteristics: Characteristic[]
+}
+
+/**
+ * Represents a Bluetooth device.
+ */
+export interface Device {
+  /** Filters to indentify the device */
+  filters: BluetoothLEScanFilter[]
+  /** Array of services provided by the device */
+  services: Service[]
+  /** Reference to the BluetoothDevice object representing this device */
+  device?: BluetoothDevice
+}

package/src/types/download.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents a single data packet.
+ */
+export interface DownloadPacket {
+  /** Timestamp of when the packet was received */
+  received: number
+  /** Sample number */
+  sampleNum: number //
+  /** Battery raw value */
+  battRaw: number
+  /** Array of sample values */
+  samples: number[]
+  /** Array of mass values */
+  masses: number[]
+}

package/src/types/notify.ts

@@ -0,0 +1,14 @@
+export interface massObject {
+  /** The total mass. */
+  massTotal: string
+  /**  The total maximum mass. */
+  massMax: string
+  /** The total average mass. */
+  massAverage: string
+  /** The mass on the left side (optional: Motherboard). */
+  massLeft?: string
+  /** The mass at the center (optional: Motherboard). */
+  massCenter?: string
+  /** The mass on the right side (optional: Motherboard). */
+  massRight?: string
+}

package/src/write.ts

@@ -1,4 +1,4 @@
-import { Device } from "./devices/types"
+import type { Device } from "./types/devices"
 import { isConnected } from "./is-connected"
 import { getCharacteristic } from "./characteristic"
 
@@ -55,9 +55,6 @@ export const write = (
         // Reject if characteristic is undefined
         reject(new Error("Characteristics is undefined"))
       }
-    } else {
-      // Reject if device is not connected
-      reject(new Error("Device is not connected"))
     }
   })
 }

package/src/battery.d.ts

@@ -1,7 +0,0 @@
-import { Device } from "./devices/types";
-/**
- * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
- */
-export declare const battery: (board: Device) => Promise<void>;

package/src/battery.js

@@ -1,25 +0,0 @@
-import { write } from "./write";
-import { read } from "./read";
-import { isConnected } from "./is-connected";
-import { Motherboard, Progressor } from "./devices";
-import { ProgressorCommands } from "./commands";
-/**
- * Retrieves battery or voltage information from the device.
- * @param {Device} board - The device.
- * @returns {Promise<void>} A Promise that resolves when the information is successfully retrieved.
- */
-export const battery = async (board) => {
-    // Check if the device is connected
-    if (isConnected(board)) {
-        // If the device is connected and it is a Motherboard device
-        if (board.name === "Motherboard") {
-            // Read battery level information from the Motherboard
-            await read(Motherboard, "battery", "level", 250);
-        }
-        // If the device is connected and its name starts with "Progressor"
-        if (board.name && board.name.startsWith("Progressor")) {
-            // Write command to get battery voltage information to the Progressor
-            await write(Progressor, "progressor", "tx", ProgressorCommands.GET_BATT_VLTG, 250);
-        }
-    }
-};