@hangtime/grip-connect 0.3.4 → 0.3.5

package/README.md

@@ -3,11 +3,12 @@
 **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 / 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)
+Force-Sensing Hangboards / Dynamometers / Plates / LED system boards used by climbers. Examples of such tools 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
+[Weiheng WH-C06](https://weihengmanufacturer.com/products/wh-c06-bluetooth-300kg-hanging-scale/) also sold as
+[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),
@@ -91,10 +92,11 @@ available services with us.
 - ✅ Griptonite Motherboard
 - ✅ Tindeq Progressor
 - ⏳ Entralpi (not verified)
-- ⏳ Kilterboard (write only, see example)
+- ⏳ Kilterboard (see example)
+- ⏳ Weiheng WH-C06 / MAT Muscle Meter
+  - Enable: `chrome://flags#enable-experimental-web-platform-features`
 - ➡️ Climbro
 - ➡️ mySmartBoard
-- ➡️ MAT Muscle Meter
 
 ### Features
 
@@ -133,7 +135,9 @@ A special thank you to:
 - [@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) for the docs on his Kilter Board
-  [simulator](https://github.com/1-max-1/fake_kilter_board).
+  [simulator](https://github.com/1-max-1/fake_kilter_board) that I coverted to
+  [hangtime-arduino-kilterboard](https://github.com/Stevie-Ray/hangtime-arduino-kilterboard).
+- [sebws](https://github.com/sebw) for a [code sample](https://github.com/sebws/Crane) of the Weiheng WH-C06 App.
 
 ## Disclaimer
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "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/commands/index.ts

@@ -4,7 +4,7 @@ export { EntralpiCommands } from "./entralpi"
 
 export { MotherboardCommands } from "./motherboard"
 
-export { MuscleMeterCommands } from "./musclemeter"
+export { WHC06Commands } from "./wh-c06"
 
 export { ProgressorCommands } from "./progressor"
 

package/src/commands/kilterboard.ts

@@ -0,0 +1,23 @@
+/**
+ * For API level 2 and API level 3.
+ * The first byte in the data is dependent on where the packet is in the message as a whole.
+ * More details: https://github.com/1-max-1/fake_kilter_board
+ */
+export enum KilterBoardPacket {
+  /** If this packet is in the middle, the byte gets set to 77 (M). */
+  V2_MIDDLE = 77,
+  /** If this packet is the first packet in the message, then this byte gets set to 78 (N). */
+  V2_FIRST,
+  /** If this is the last packet in the message, this byte gets set to 79 (0). */
+  V2_LAST,
+  /** If this packet is the only packet in the message, the byte gets set to 80 (P). Note that this takes priority over the other conditions. */
+  V2_ONLY,
+  /** If this packet is in the middle, the byte gets set to 81 (Q). */
+  V3_MIDDLE,
+  /** If this packet is the first packet in the message, then this byte gets set to 82 (R). */
+  V3_FIRST,
+  /** If this is the last packet in the message, this byte gets set to 83 (S). */
+  V3_LAST,
+  /** If this packet is the only packet in the message, the byte gets set to 84 (T). Note that this takes priority over the other conditions. */
+  V3_ONLY,
+}

package/src/commands/{musclemeter.ts → wh-c06.ts}

@@ -3,4 +3,4 @@ import type { Commands } from "../types/commands"
  * Warning:
  * Using other commands can seriously harm your device
  */
-export const MuscleMeterCommands: Commands = {}
+export const WHC06Commands: Commands = {}

package/src/connect.ts

@@ -1,5 +1,8 @@
 import type { Device } from "./types/devices"
-import { handleEntralpiData, handleMotherboardData, handleProgressorData } from "./data"
+import { handleEntralpiData } from "./data/entralpi"
+import { handleMotherboardData } from "./data/motherboard"
+import { handleProgressorData } from "./data/progressor"
+import { handleWHC06Data } from "./data/wh-c06"
 
 let server: BluetoothRemoteGATTServer
 const receiveBuffer: number[] = []
@@ -26,7 +29,7 @@ const handleNotifications = (event: Event, board: Device): void => {
   if (value) {
     // 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++) {
+      for (let i = 0; i < value.byteLength; i++) {
         receiveBuffer.push(value.getUint8(i))
       }
 
@@ -64,7 +67,7 @@ const handleNotifications = (event: Event, board: Device): void => {
 const onConnected = async (board: Device, onSuccess: () => void): Promise<void> => {
   try {
     // Connect to GATT server and set up characteristics
-    const services: BluetoothRemoteGATTService[] = await server?.getPrimaryServices()
+    const services: BluetoothRemoteGATTService[] = await server.getPrimaryServices()
 
     if (!services || services.length === 0) {
       console.error("No services found")
@@ -91,9 +94,9 @@ const onConnected = async (board: Device, onSuccess: () => void): Promise<void>
               // notify
               if (element.id === "rx") {
                 matchingCharacteristic.startNotifications()
-                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event: Event) =>
-                  handleNotifications(event, board),
-                )
+                matchingCharacteristic.addEventListener("characteristicvaluechanged", (event: Event) => {
+                  handleNotifications(event, board)
+                })
               }
             }
           } else {
@@ -127,9 +130,15 @@ export const connect = async (board: Device, onSuccess: () => void): Promise<voi
     // Request device and set up connection
     const deviceServices = getAllServiceUUIDs(board)
 
+    // Only data matching the optionalManufacturerData parameter to requestDevice is included in the advertisement event: https://github.com/WebBluetoothCG/web-bluetooth/issues/598
+    const optionalManufacturerData = board.filters.flatMap(
+      (filter) => filter.manufacturerData?.map((data) => data.companyIdentifier) || [],
+    )
+
     const device = await navigator.bluetooth.requestDevice({
       filters: board.filters,
       optionalServices: deviceServices,
+      optionalManufacturerData,
     })
 
     board.device = device
@@ -139,9 +148,28 @@ export const connect = async (board: Device, onSuccess: () => void): Promise<voi
       return
     }
 
-    server = await board.device?.gatt?.connect()
+    board.device.addEventListener("gattserverdisconnected", (event) => {
+      onDisconnected(event, board)
+    })
+
+    // WH-C06
+    const MANUFACTURER_ID = 256 // 0x0100
+
+    board.device.addEventListener("advertisementreceived", (event) => {
+      const manufacturerData = event.manufacturerData.get(MANUFACTURER_ID)
+      if (manufacturerData) {
+        // Device has no services / characteristics
+        onSuccess()
+        // Handle recieved data
+        handleWHC06Data(manufacturerData)
+      }
+    })
+
+    if (optionalManufacturerData.length) {
+      await board.device.watchAdvertisements()
+    }
 
-    board.device.addEventListener("gattserverdisconnected", (event) => onDisconnected(event, board))
+    server = await board.device.gatt.connect()
 
     if (server.connected) {
       await onConnected(board, onSuccess)

package/src/data/entralpi.ts

@@ -0,0 +1,37 @@
+import { notifyCallback } from "./../notify"
+import { applyTare } from "./../tare"
+
+// Constants
+let MASS_MAX = "0"
+let MASS_AVERAGE = "0"
+let MASS_TOTAL_SUM = 0
+let DATAPOINT_COUNT = 0
+
+/**
+ * Handles data received from the Entralpi device.
+ * @param {string} receivedData - The received data string.
+ */
+export const handleEntralpiData = (receivedData: string): void => {
+  let numericData = Number(receivedData)
+
+  // Tare correction
+  numericData -= applyTare(numericData)
+
+  // Update MASS_MAX
+  MASS_MAX = Math.max(Number(MASS_MAX), numericData).toFixed(1)
+
+  // Update running sum and count
+  const currentMassTotal = Math.max(-1000, numericData)
+  MASS_TOTAL_SUM += currentMassTotal
+  DATAPOINT_COUNT++
+
+  // Calculate the average dynamically
+  MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+
+  // Notify with weight data
+  notifyCallback({
+    massMax: MASS_MAX,
+    massAverage: MASS_AVERAGE,
+    massTotal: Math.max(-1000, numericData).toFixed(1),
+  })
+}

package/src/{data.ts → data/motherboard.ts}

@@ -1,19 +1,17 @@
-import { notifyCallback } from "./notify"
-import { applyTare } from "./tare"
-import { ProgressorCommands, ProgressorResponses } from "./commands/progressor"
-import { MotherboardCommands } from "./commands"
-import { lastWrite } from "./write"
-import struct from "./struct"
-import { DownloadPackets } from "./download"
-import type { DownloadPacket } from "./types/download"
+import { notifyCallback } from "./../notify"
+import { applyTare } from "./../tare"
+import { MotherboardCommands } from "./../commands"
+import { lastWrite } from "./../write"
+import { DownloadPackets } from "./../download"
+import type { DownloadPacket } from "./../types/download"
 
 // Constants
-const PACKET_LENGTH: number = 32
-const NUM_SAMPLES: number = 3
-let MASS_MAX: string = "0"
-let MASS_AVERAGE: string = "0"
-let MASS_TOTAL_SUM: number = 0
-let DATAPOINT_COUNT: number = 0
+const PACKET_LENGTH = 32
+const NUM_SAMPLES = 3
+let MASS_MAX = "0"
+let MASS_AVERAGE = "0"
+let MASS_TOTAL_SUM = 0
+let DATAPOINT_COUNT = 0
 export const CALIBRATION = [[], [], [], []]
 
 /**
@@ -26,9 +24,9 @@ const applyCalibration = (sample: number, calibration: number[][]): number => {
   // Extract the calibrated value for the zero point
   const zeroCalibration: number = calibration[0][2]
   // Initialize sign as positive
-  let sign: number = 1
+  let sign = 1
   // Initialize the final calibrated value
-  let final: number = 0
+  let final = 0
 
   // If the sample value is less than the zero calibration point
   if (sample < zeroCalibration) {
@@ -154,92 +152,3 @@ export const handleMotherboardData = (receivedData: string): void => {
     console.log(receivedData)
   }
 }
-
-/**
- * Handles data received from the Progressor device.
- * @param {DataView} data - The received data.
- */
-export const handleProgressorData = (data: DataView): void => {
-  const receivedTime: number = Date.now()
-  const [kind] = struct("<bb").unpack(data.buffer.slice(0, 2))
-  if (kind === ProgressorResponses.WEIGHT_MEASURE) {
-    const iterable: IterableIterator<unknown[]> = struct("<fi").iter_unpack(data.buffer.slice(2))
-    console.log(iterable)
-    // eslint-disable-next-line prefer-const
-    for (let [weight, seconds] of iterable) {
-      if (typeof weight === "number" && !isNaN(weight) && typeof seconds === "number" && !isNaN(seconds)) {
-        // Add data to downloadable Array: sample and mass are the same
-        DownloadPackets.push({
-          received: receivedTime,
-          sampleNum: seconds,
-          battRaw: 0,
-          samples: [weight],
-          masses: [weight],
-        })
-        // Tare correction
-        weight -= applyTare(weight)
-        // Check for max weight
-        MASS_MAX = Math.max(Number(MASS_MAX), Number(weight)).toFixed(1)
-        // Update running sum and count
-        const currentMassTotal = Math.max(-1000, Number(weight))
-        MASS_TOTAL_SUM += currentMassTotal
-        DATAPOINT_COUNT++
-
-        // Calculate the average dynamically
-        MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
-
-        notifyCallback({
-          massMax: MASS_MAX,
-          massAverage: MASS_AVERAGE,
-          massTotal: Math.max(-1000, weight).toFixed(1),
-        })
-      }
-    }
-  } else if (kind === ProgressorResponses.COMMAND_RESPONSE) {
-    if (!lastWrite) return
-
-    let value: string = ""
-
-    if (lastWrite === ProgressorCommands.GET_BATT_VLTG) {
-      const vdd = new DataView(data.buffer, 2).getUint32(0, true)
-      value = `ℹ️ Battery level: ${vdd} mV`
-    } else if (lastWrite === ProgressorCommands.GET_FW_VERSION) {
-      value = new TextDecoder().decode(data.buffer.slice(2))
-    } else if (lastWrite === ProgressorCommands.GET_ERR_INFO) {
-      value = new TextDecoder().decode(data.buffer.slice(2))
-    }
-    console.log(value)
-  } else if (kind === ProgressorResponses.LOW_BATTERY_WARNING) {
-    console.warn("⚠️ Low power detected. Please consider connecting to a power source.")
-  } else {
-    console.error(`❌ Error: Unknown message kind detected: ${kind}`)
-  }
-}
-/**
- * Handles data received from the Entralpi device.
- * @param {string} receivedData - The received data string.
- */
-export const handleEntralpiData = (receivedData: string): void => {
-  let numericData = Number(receivedData)
-
-  // Tare correction
-  numericData -= applyTare(numericData)
-
-  // Update MASS_MAX
-  MASS_MAX = Math.max(Number(MASS_MAX), numericData).toFixed(1)
-
-  // Update running sum and count
-  const currentMassTotal = Math.max(-1000, numericData)
-  MASS_TOTAL_SUM += currentMassTotal
-  DATAPOINT_COUNT++
-
-  // Calculate the average dynamically
-  MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
-
-  // Notify with weight data
-  notifyCallback({
-    massMax: MASS_MAX,
-    massAverage: MASS_AVERAGE,
-    massTotal: Math.max(-1000, numericData).toFixed(1),
-  })
-}

package/src/data/progressor.ts

@@ -0,0 +1,72 @@
+import { notifyCallback } from "./../notify"
+import { applyTare } from "./../tare"
+import { ProgressorCommands, ProgressorResponses } from "./../commands/progressor"
+import { lastWrite } from "./../write"
+import struct from "./../struct"
+import { DownloadPackets } from "./../download"
+
+// Constants
+let MASS_MAX = "0"
+let MASS_AVERAGE = "0"
+let MASS_TOTAL_SUM = 0
+let DATAPOINT_COUNT = 0
+
+/**
+ * Handles data received from the Progressor device.
+ * @param {DataView} data - The received data.
+ */
+export const handleProgressorData = (data: DataView): void => {
+  const receivedTime: number = Date.now()
+  const [kind] = struct("<bb").unpack(data.buffer.slice(0, 2))
+  if (kind === ProgressorResponses.WEIGHT_MEASURE) {
+    const iterable: IterableIterator<unknown[]> = struct("<fi").iter_unpack(data.buffer.slice(2))
+    // eslint-disable-next-line prefer-const
+    for (let [weight, seconds] of iterable) {
+      if (typeof weight === "number" && !isNaN(weight) && typeof seconds === "number" && !isNaN(seconds)) {
+        // Add data to downloadable Array: sample and mass are the same
+        DownloadPackets.push({
+          received: receivedTime,
+          sampleNum: seconds,
+          battRaw: 0,
+          samples: [weight],
+          masses: [weight],
+        })
+        // Tare correction
+        weight -= applyTare(weight)
+        // Check for max weight
+        MASS_MAX = Math.max(Number(MASS_MAX), Number(weight)).toFixed(1)
+        // Update running sum and count
+        const currentMassTotal = Math.max(-1000, Number(weight))
+        MASS_TOTAL_SUM += currentMassTotal
+        DATAPOINT_COUNT++
+
+        // Calculate the average dynamically
+        MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+
+        notifyCallback({
+          massMax: MASS_MAX,
+          massAverage: MASS_AVERAGE,
+          massTotal: Math.max(-1000, weight).toFixed(1),
+        })
+      }
+    }
+  } else if (kind === ProgressorResponses.COMMAND_RESPONSE) {
+    if (!lastWrite) return
+
+    let value = ""
+
+    if (lastWrite === ProgressorCommands.GET_BATT_VLTG) {
+      const vdd = new DataView(data.buffer, 2).getUint32(0, true)
+      value = `ℹ️ Battery level: ${vdd} mV`
+    } else if (lastWrite === ProgressorCommands.GET_FW_VERSION) {
+      value = new TextDecoder().decode(data.buffer.slice(2))
+    } else if (lastWrite === ProgressorCommands.GET_ERR_INFO) {
+      value = new TextDecoder().decode(data.buffer.slice(2))
+    }
+    console.log(value)
+  } else if (kind === ProgressorResponses.LOW_BATTERY_WARNING) {
+    console.warn("⚠️ Low power detected. Please consider connecting to a power source.")
+  } else {
+    console.error(`❌ Error: Unknown message kind detected: ${kind}`)
+  }
+}

package/src/data/wh-c06.ts

@@ -0,0 +1,43 @@
+import { notifyCallback } from "./../notify"
+import { applyTare } from "./../tare"
+
+// Constants
+let MASS_MAX = "0"
+let MASS_AVERAGE = "0"
+let MASS_TOTAL_SUM = 0
+let DATAPOINT_COUNT = 0
+const WEIGHT_OFFSET = 10
+// const STABLE_OFFSET = 14
+
+/**
+ * Handles data received from the WH-C06 device.
+ * @param {DataView} data - The received data.
+ */
+export const handleWHC06Data = (data: DataView): void => {
+  const weight = (data.getUint8(WEIGHT_OFFSET) << 8) | data.getUint8(WEIGHT_OFFSET + 1)
+  // const stable = (data.getUint8(STABLE_OFFSET) & 0xf0) >> 4
+  // const unit = data.getUint8(STABLE_OFFSET) & 0x0f
+
+  let numericData = weight / 100
+
+  // Tare correction
+  numericData -= applyTare(numericData)
+
+  // Update MASS_MAX
+  MASS_MAX = Math.max(Number(MASS_MAX), numericData).toFixed(1)
+
+  // Update running sum and count
+  const currentMassTotal = Math.max(-1000, numericData)
+  MASS_TOTAL_SUM += currentMassTotal
+  DATAPOINT_COUNT++
+
+  // Calculate the average dynamically
+  MASS_AVERAGE = (MASS_TOTAL_SUM / DATAPOINT_COUNT).toFixed(1)
+
+  // Notify with weight data
+  notifyCallback({
+    massMax: MASS_MAX,
+    massAverage: MASS_AVERAGE,
+    massTotal: Math.max(-1000, numericData).toFixed(1),
+  })
+}

package/src/devices/index.ts

@@ -8,6 +8,6 @@ export { Motherboard } from "./motherboard"
 
 export { mySmartBoard } from "./mysmartboard"
 
-export { MuscleMeter } from "./musclemeter"
+export { WHC06 } from "./wh-c06"
 
 export { Progressor } from "./progressor"

package/src/devices/wh-c06.ts

@@ -0,0 +1,19 @@
+import type { Device } from "../types/devices"
+
+/**
+ * Represents a  Weiheng - WH-C06 (or MAT Muscle Meter) device
+ * Enable 'Experimental Web Platform features' Chrome Flags.
+ */
+export const WHC06: Device = {
+  filters: [
+    {
+      // namePrefix: "IF_B7",
+      manufacturerData: [
+        {
+          companyIdentifier: 0x0100, // 256
+        },
+      ],
+    },
+  ],
+  services: [],
+}

package/src/index.ts

@@ -1,5 +1,5 @@
 // Export device types
-export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, MuscleMeter, Progressor } from "./devices/index"
+export { Climbro, Entralpi, KilterBoard, Motherboard, mySmartBoard, WHC06, Progressor } from "./devices/index"
 
 // Export battery related functions
 export { battery } from "./battery"
@@ -18,6 +18,9 @@ export { isConnected } from "./is-connected"
 // Export information retrieval function
 export { info } from "./info"
 
+// Export led retrieval function
+export { led } from "./led"
+
 // Export notification related function
 export { notify } from "./notify"
 

package/src/led.ts

@@ -0,0 +1,187 @@
+import type { Device } from "./types/devices"
+import { write } from "./write"
+import { isConnected } from "./is-connected"
+import { KilterBoard } from "./devices"
+import { KilterBoardPacket } from "./commands/kilterboard"
+/**
+ * Maximum length of the message body for byte wrapping.
+ */
+const MESSAGE_BODY_MAX_LENGTH = 255
+/**
+ * Maximum length of the the bluetooth chunk.
+ */
+const MAX_BLUETOOTH_MESSAGE_SIZE = 20
+/**
+ * Calculates the checksum for a byte array by summing up all bytes ot hre packet in a single-byte variable.
+ * @param data - The array of bytes to calculate the checksum for.
+ * @returns The calculated checksum value.
+ */
+function checksum(data: number[]) {
+  let i = 0
+  for (const value of data) {
+    i = (i + value) & 255
+  }
+  return ~i & 255
+}
+/**
+ * Wraps a byte array with header and footer bytes for transmission.
+ * @param data - The array of bytes to wrap.
+ * @returns The wrapped byte array.
+ */
+function wrapBytes(data: number[]) {
+  if (data.length > MESSAGE_BODY_MAX_LENGTH) {
+    return []
+  }
+  /**
+  - 0x1
+  - len(packets)
+  - checksum(packets)
+  - 0x2
+  - *packets
+  - 0x3
+  
+  First byte is always 1, the second is a number of packets, then checksum, then 2, packets themselves, and finally 3.
+   */
+  return [1, data.length, checksum(data), 2, ...data, 3]
+}
+class ClimbPlacement {
+  position: number
+  role_id: string
+
+  constructor(position: number, role_id: string) {
+    this.position = position
+    this.role_id = role_id
+  }
+}
+/**
+ * Encodes a position into a byte array.
+ * The lowest 8 bits of the position get put in the first byte of the group.
+ * The highest 8 bits of the position get put in the second byte of the group.
+ * @param position - The position to encode.
+ * @returns The encoded byte array representing the position.
+ */
+function encodePosition(position: number) {
+  const position1 = position & 255
+  const position2 = (position & 65280) >> 8
+
+  return [position1, position2]
+}
+/**
+ * Encodes a color string into a numeric representation.
+ * The rgb color, 3 bits for the R and G components, 2 bits for the B component, with the 3 R bits occupying the high end of the byte and the 2 B bits in the low end (hence 3 G bits in the middle).
+ * @param color - The color string in hexadecimal format (e.g., 'FFFFFF').
+ * @returns The encoded /compressed color value.
+ */
+function encodeColor(color: string) {
+  const substring = color.substring(0, 2)
+  const substring2 = color.substring(2, 4)
+
+  const parsedSubstring = parseInt(substring, 16) / 32
+  const parsedSubstring2 = parseInt(substring2, 16) / 32
+  const parsedResult = (parsedSubstring << 5) | (parsedSubstring2 << 2)
+
+  const substring3 = color.substring(4, 6)
+  const parsedSubstring3 = parseInt(substring3, 16) / 64
+  const finalParsedResult = parsedResult | parsedSubstring3
+
+  return finalParsedResult
+}
+/**
+ * Encodes a placement (requires a 16-bit position and a 24-bit rgb color. ) into a byte array.
+ * @param position - The position to encode.
+ * @param ledColor - The color of the LED in hexadecimal format (e.g., 'FFFFFF').
+ * @returns The encoded byte array representing the placement.
+ */
+function encodePlacement(position: number, ledColor: string) {
+  return [...encodePosition(position), encodeColor(ledColor)]
+}
+/**
+ * Prepares byte arrays for transmission based on a list of climb placements.
+ * @param climbPlacementList - The list of climb placements containing position and role ID.
+ * @returns The final byte array ready for transmission.
+ */
+export function prepBytesV3(climbPlacementList: ClimbPlacement[]) {
+  const resultArray: number[][] = []
+  let tempArray: number[] = [KilterBoardPacket.V3_MIDDLE]
+
+  for (const climbPlacement of climbPlacementList) {
+    if (tempArray.length + 3 > MESSAGE_BODY_MAX_LENGTH) {
+      resultArray.push(tempArray)
+      tempArray = [KilterBoardPacket.V3_MIDDLE]
+    }
+
+    const ledColor = climbPlacement.role_id
+
+    const encodedPlacement = encodePlacement(climbPlacement.position, ledColor)
+    tempArray.push(...encodedPlacement)
+  }
+
+  resultArray.push(tempArray)
+
+  if (resultArray.length === 1) {
+    resultArray[0][0] = KilterBoardPacket.V3_ONLY
+  } else if (resultArray.length > 1) {
+    resultArray[0][0] = KilterBoardPacket.V3_FIRST
+    resultArray[resultArray.length - 1][0] = KilterBoardPacket.V3_LAST
+  }
+
+  const finalResultArray: number[] = []
+  for (const currentArray of resultArray) {
+    finalResultArray.push(...wrapBytes(currentArray))
+  }
+
+  return finalResultArray
+}
+/**
+ * Splits a collection into slices of the specified length.
+ * https://github.com/ramda/ramda/blob/master/source/splitEvery.js
+ * @param {Number} n
+ * @param {Array} list
+ * @return {Array}
+ */
+function splitEvery(n: number, list: number[]) {
+  if (n <= 0) {
+    throw new Error("First argument to splitEvery must be a positive integer")
+  }
+  const result = []
+  let idx = 0
+  while (idx < list.length) {
+    result.push(list.slice(idx, (idx += n)))
+  }
+  return result
+}
+/**
+ * The kilter board only supports messages of 20 bytes
+ * at a time. This method splits a full message into parts
+ * of 20 bytes
+ *
+ * @param buffer
+ */
+const splitMessages = (buffer: number[]) =>
+  splitEvery(MAX_BLUETOOTH_MESSAGE_SIZE, buffer).map((arr) => new Uint8Array(arr))
+/**
+ * Sends a series of messages to a device.
+ */
+async function writeMessageSeries(messages: Uint8Array[]) {
+  for (const message of messages) {
+    await write(KilterBoard, "uart", "tx", message)
+  }
+}
+/**
+ * Set device leds.
+ * @param {Device} board - The device to retrieve information from.
+ * @returns {Promise<void>} A promise that resolves when the information retrieval is completed.
+ */
+export const led = async (board: Device, placement: ClimbPlacement[]): Promise<number[] | undefined> => {
+  // Check if the filter contains the Aurora Climbing Advertising service
+  const AuroraUUID = "4488b571-7806-4df6-bcff-a2897e4953ff"
+  if (board.filters.some((filter) => filter.services?.includes(AuroraUUID))) {
+    // Prepares byte arrays for transmission based on a list of climb placements.
+    const payload = prepBytesV3(placement)
+    // Sends the payload to the device by splitting it into messages and writing each message.
+    if (isConnected(board)) {
+      writeMessageSeries(splitMessages(payload))
+    }
+    return payload
+  }
+}

package/src/notify.ts

@@ -1,6 +1,6 @@
 import type { massObject } from "./types/notify"
 /** Define the type for the callback function */
-export type NotifyCallback = (data: massObject) => void
+type NotifyCallback = (data: massObject) => void
 /**
  * Defines the type for the callback function.
  * @callback NotifyCallback

package/src/read.ts

@@ -10,12 +10,7 @@ import { isConnected } from "./is-connected"
  * @param {number} [duration=0] - The duration to wait before resolving the promise, in milliseconds.
  * @returns {Promise<void>} A promise that resolves when the read operation is completed.
  */
-export const read = (
-  board: Device,
-  serviceId: string,
-  characteristicId: string,
-  duration: number = 0,
-): Promise<void> => {
+export const read = (board: Device, serviceId: string, characteristicId: string, duration = 0): Promise<void> => {
   return new Promise((resolve, reject) => {
     if (isConnected(board)) {
       const characteristic = getCharacteristic(board, serviceId, characteristicId)

package/src/stream.ts

@@ -5,7 +5,7 @@ import { stop } from "./stop"
 import { Motherboard, Progressor } from "./devices"
 import { MotherboardCommands, ProgressorCommands } from "./commands"
 import { emptyDownloadPackets } from "./download"
-import { CALIBRATION } from "./data"
+import { CALIBRATION } from "./data/motherboard"
 import { calibration } from "./calibration"
 
 /**
@@ -14,7 +14,7 @@ import { calibration } from "./calibration"
  * @param {number} [duration=0] - The duration of the stream in milliseconds. If set to 0, stream will continue indefinitely.
  * @returns {Promise<void>} A promise that resolves when the streaming operation is completed.
  */
-export const stream = async (board: Device, duration: number = 0): Promise<void> => {
+export const stream = async (board: Device, duration = 0): Promise<void> => {
   if (isConnected(board)) {
     // Reset download packets
     emptyDownloadPackets()

package/src/struct/index.ts

@@ -1,11 +1,12 @@
-const rechk: RegExp = /^([<>])?(([1-9]\d*)?([xcbB?hHiIfdsp]))*$/
-const refmt: RegExp = /([1-9]\d*)?([xcbB?hHiIfdsp])/g
+const rechk = /^([<>])?(([1-9]\d*)?([xcbB?hHiIfdsp]))*$/
+const refmt = /([1-9]\d*)?([xcbB?hHiIfdsp])/g
 
 const str = (v: DataView, o: number, c: number): string =>
   String.fromCharCode(...Array.from(new Uint8Array(v.buffer, v.byteOffset + o, c)))
 
-const rts = (v: DataView, o: number, c: number, s: string): void =>
+const rts = (v: DataView, o: number, c: number, s: string): void => {
   new Uint8Array(v.buffer, v.byteOffset + o, c).set(s.split("").map((str) => str.charCodeAt(0)))
+}
 
 const pst = (v: DataView, o: number, c: number): string => str(v, o + 1, Math.min(v.getUint8(o), c - 1))
 
@@ -19,9 +20,7 @@ interface FormatFn {
   p: (v: DataView, value: unknown) => void
 }
 
-interface LUT {
-  [key: string]: (c: number) => [number, number, (o: number) => FormatFn]
-}
+type LUT = Record<string, (c: number) => [number, number, (o: number) => FormatFn]>
 
 const lut = (le: boolean): LUT => ({
   x: (c: number) =>
@@ -39,7 +38,9 @@ const lut = (le: boolean): LUT => ({
       1,
       (o: number) => ({
         u: (v: DataView) => str(v, o, 1),
-        p: (v: DataView, s: string) => rts(v, o, 1, s),
+        p: (v: DataView, s: string) => {
+          rts(v, o, 1, s)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   "?": (c: number) =>
@@ -48,7 +49,9 @@ const lut = (le: boolean): LUT => ({
       1,
       (o: number) => ({
         u: (v: DataView) => Boolean(v.getUint8(o)),
-        p: (v: DataView, B: boolean) => v.setUint8(o, B ? 1 : 0),
+        p: (v: DataView, B: boolean) => {
+          v.setUint8(o, B ? 1 : 0)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   b: (c: number) =>
@@ -57,7 +60,9 @@ const lut = (le: boolean): LUT => ({
       1,
       (o: number) => ({
         u: (v: DataView) => v.getInt8(o),
-        p: (v: DataView, b: number) => v.setInt8(o, b),
+        p: (v: DataView, b: number) => {
+          v.setInt8(o, b)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   B: (c: number) =>
@@ -66,7 +71,9 @@ const lut = (le: boolean): LUT => ({
       1,
       (o: number) => ({
         u: (v: DataView) => v.getUint8(o),
-        p: (v: DataView, B: number) => v.setUint8(o, B),
+        p: (v: DataView, B: number) => {
+          v.setUint8(o, B)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   h: (c: number) =>
@@ -75,7 +82,9 @@ const lut = (le: boolean): LUT => ({
       2,
       (o: number) => ({
         u: (v: DataView) => v.getInt16(o, le),
-        p: (v: DataView, h: number) => v.setInt16(o, h, le),
+        p: (v: DataView, h: number) => {
+          v.setInt16(o, h, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   H: (c: number) =>
@@ -84,7 +93,9 @@ const lut = (le: boolean): LUT => ({
       2,
       (o: number) => ({
         u: (v: DataView) => v.getUint16(o, le),
-        p: (v: DataView, H: number) => v.setUint16(o, H, le),
+        p: (v: DataView, H: number) => {
+          v.setUint16(o, H, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   i: (c: number) =>
@@ -93,7 +104,9 @@ const lut = (le: boolean): LUT => ({
       4,
       (o: number) => ({
         u: (v: DataView) => v.getInt32(o, le),
-        p: (v: DataView, i: number) => v.setInt32(o, i, le),
+        p: (v: DataView, i: number) => {
+          v.setInt32(o, i, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   I: (c: number) =>
@@ -102,7 +115,9 @@ const lut = (le: boolean): LUT => ({
       4,
       (o: number) => ({
         u: (v: DataView) => v.getUint32(o, le),
-        p: (v: DataView, I: number) => v.setUint32(o, I, le),
+        p: (v: DataView, I: number) => {
+          v.setUint32(o, I, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   f: (c: number) =>
@@ -111,7 +126,9 @@ const lut = (le: boolean): LUT => ({
       4,
       (o: number) => ({
         u: (v: DataView) => v.getFloat32(o, le),
-        p: (v: DataView, f: number) => v.setFloat32(o, f, le),
+        p: (v: DataView, f: number) => {
+          v.setFloat32(o, f, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   d: (c: number) =>
@@ -120,7 +137,9 @@ const lut = (le: boolean): LUT => ({
       8,
       (o: number) => ({
         u: (v: DataView) => v.getFloat64(o, le),
-        p: (v: DataView, d: number) => v.setFloat64(o, d, le),
+        p: (v: DataView, d: number) => {
+          v.setFloat64(o, d, le)
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   s: (c: number) =>
@@ -129,7 +148,9 @@ const lut = (le: boolean): LUT => ({
       c,
       (o: number) => ({
         u: (v: DataView) => str(v, o, c),
-        p: (v: DataView, s: string) => rts(v, o, c, s.slice(0, c)),
+        p: (v: DataView, s: string) => {
+          rts(v, o, c, s.slice(0, c))
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
   p: (c: number) =>
@@ -138,7 +159,9 @@ const lut = (le: boolean): LUT => ({
       c,
       (o: number) => ({
         u: (v: DataView) => pst(v, o, c),
-        p: (v: DataView, s: string) => tsp(v, o, c, s.slice(0, c - 1)),
+        p: (v: DataView, s: string) => {
+          tsp(v, o, c, s.slice(0, c - 1))
+        },
       }),
     ] as [number, number, (o: number) => FormatFn],
 })
@@ -148,7 +171,7 @@ const errval: RangeError = new RangeError("Not enough values for structure")
 
 export default function struct(format: string) {
   const fns: FormatFn[] = []
-  let size: number = 0
+  let size = 0
   let m: RegExpExecArray | null = rechk.exec(format)
 
   if (!m) {
@@ -159,7 +182,6 @@ export default function struct(format: string) {
   const lu = (n: string, c: string): [number, number, (o: number) => FormatFn] => t[c](n ? parseInt(n, 10) : 1)
 
   while ((m = refmt.exec(format))) {
-    // eslint-disable-next-line no-extra-semi
     ;((r: number, s: number, f: (o: number) => FormatFn) => {
       for (let i = 0; i < r; ++i, size += s) {
         if (f) {
@@ -186,7 +208,9 @@ export default function struct(format: string) {
     }
     const v = new DataView(arrb, offs)
     new Uint8Array(arrb, offs, size).fill(0)
-    fns.forEach((f, i) => f.p(v, values[i]))
+    fns.forEach((f, i) => {
+      f.p(v, values[i])
+    })
   }
 
   const pack = (...values: unknown[]): ArrayBuffer => {

package/src/tare.ts

@@ -2,7 +2,7 @@
  * Represents the current tare value for calibration.
  * @type {number}
  */
-let currentTare: number = 0
+let currentTare = 0
 
 /**
  * Represents the state of tare calibration.
@@ -23,20 +23,20 @@ let tareSamples: number[] = []
  * Array holding the sum of samples collected during tare calibration.
  * @type {number}
  */
-let newTares: number = 0
+let newTares = 0
 
 /**
  * Duration time for tare calibration process.
  * @type {number}
  */
-let timeTare: number = 5000
+let timeTare = 5000
 
 /**
  * Initiates the tare calibration process.
  * @param {number} time - The duration time for tare calibration process.
- * @returns {Promise<void>} A Promise that resolves when tare calibration is initiated.
+ * @returns {void} A Promise that resolves when tare calibration is initiated.
  */
-export const tare = async (time: number = 5000): Promise<void> => {
+export const tare = (time = 5000): void => {
   runTare = true
   timeTare = time
   tareSamples = []
@@ -50,7 +50,7 @@ export const tare = async (time: number = 5000): Promise<void> => {
 export const applyTare = (sample: number): number => {
   if (runTare) {
     // If taring process is initiated
-    if (typeof runTare === "boolean" && runTare === true) {
+    if (typeof runTare === "boolean" && runTare) {
       // If tare flag is true (first time), set it to the current date
       runTare = new Date()
       // Initialize the sum of new tare values
@@ -59,10 +59,10 @@ export const applyTare = (sample: number): number => {
     // Push current sample to tareSamples array
     tareSamples.push(sample)
     // Check if taring process duration has passed (defaults to 5 seconds)
-    if (typeof runTare !== "boolean" && new Date().getTime() - (runTare as Date).getTime() > timeTare) {
+    if (typeof runTare !== "boolean" && new Date().getTime() - runTare.getTime() > timeTare) {
       // Calculate the sum of tare samples
-      for (let i = 0; i < tareSamples.length; ++i) {
-        newTares += tareSamples[i]
+      for (const tareSample of tareSamples) {
+        newTares += tareSample
       }
       // Calculate the average by dividing the sum by the number of samples and update the tare value with the calculated average
       currentTare = newTares / tareSamples.length

package/src/write.ts

@@ -4,16 +4,16 @@ import { getCharacteristic } from "./characteristic"
 
 /**
  * The last message written to the device.
- * @type {string | null}
+ * @type {string | Uint8Array | null}
  */
-export let lastWrite: string | null = null
+export let lastWrite: string | Uint8Array | null = null
 
 /**
  * Writes a message to the specified characteristic of the device.
  * @param {Device} board - The device board to write to.
  * @param {string} serviceId - The service ID where the characteristic belongs.
  * @param {string} characteristicId - The characteristic ID to write to.
- * @param {string | undefined} message - The message to write.
+ * @param {string | Uint8Array | undefined} message - The message to write.
  * @param {number} [duration=0] - The duration to wait before resolving the promise, in milliseconds.
  * @returns {Promise<void>} A promise that resolves when the write operation is completed.
  */
@@ -21,8 +21,8 @@ export const write = (
   board: Device,
   serviceId: string,
   characteristicId: string,
-  message: string | undefined,
-  duration: number = 0,
+  message: string | Uint8Array | undefined,
+  duration = 0,
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
     if (isConnected(board)) {
@@ -31,24 +31,28 @@ export const write = (
         // If not provided, return without performing write operation
         return
       }
-      // Get the characteristic
+      // Get the characteristic from the device using serviceId and characteristicId
       const characteristic = getCharacteristic(board, serviceId, characteristicId)
       if (characteristic) {
-        // Encode the message
-        const encoder = new TextEncoder()
+        // Convert the message to Uint8Array if it's a string
+        const valueToWrite: Uint8Array = typeof message === "string" ? new TextEncoder().encode(message) : message
+        // Write the value to the characteristic
         characteristic
-          .writeValue(encoder.encode(message))
+          .writeValue(valueToWrite)
           .then(() => {
             // Update the last written message
             lastWrite = message
-            // Handle timeout
-            if (duration !== 0) {
+            // If a duration is specified, resolve the promise after the duration
+            if (duration > 0) {
               setTimeout(() => {
                 resolve()
               }, duration)
+            } else {
+              // Otherwise, resolve the promise immediately
+              resolve()
             }
           })
-          .catch((error) => {
+          .catch((error: unknown) => {
             reject(error)
           })
       } else {

package/src/devices/musclemeter.ts

@@ -1,10 +0,0 @@
-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 = {
-  filters: [{ name: "MAT" }],
-  services: [],
-}