@hangtime/grip-connect 0.3.8 → 0.3.9

package/README.md

@@ -28,7 +28,7 @@ Learn more: [Docs](https://stevie-ray.github.io/hangtime-grip-connect/) -
 ## Try it out
 
 [Chart](https://grip-connect.vercel.app/) - [Flappy Bird](https://grip-connect-flappy-bird.vercel.app/) -
-[Kilter Board](https://grip-connect-kilter-board.vercel.app/)
+[Kilter Board](https://grip-connect-kilter-board.vercel.app/?route=p1083r15p1117r15p1164r12p1185r12p1233r13p1282r13p1303r13p1372r13p1392r14p1505r15)
 
 ## Install
 
@@ -80,8 +80,8 @@ motherboardButton.addEventListener("click", () => {
     // Manually call stop method if stream is continues
     // await stop(Motherboard)
 
-    // Download data to CSV: format => timestamp, frame, battery, samples, masses
-    // download()
+    // Download data as CSV, JSON, or XML (default: CSV) format => timestamp, frame, battery, samples, masses
+    // download('json')
 
     // Disconnect from device after we are done
     disconnect(Motherboard)
@@ -117,7 +117,7 @@ available services with us.
 - ✅ Check if device is being used
 - ✅ Peak / Average load
 - ✅️ Tare / unladen weight
-- ✅️ Download data to CVS
+- ✅️ Download data (CSV, JSON, XML)
 - ➡️ Endurance
 - ➡️ Rate of Force Development: RFD
 - ➡️ Critical Force
@@ -146,7 +146,7 @@ A special thank you to:
 - [@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) 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.
+- [@sebws](https://github.com/sebw) for a [code sample](https://github.com/sebws/Crane) of the Weiheng WH-C06 App.
 
 ## Disclaimer
 

package/dist/commands/kilterboard.d.ts

@@ -21,3 +21,15 @@ export declare enum KilterBoardPacket {
     /** 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 = 84
 }
+/**
+ * Extracted from placement_roles database table.
+ */
+export declare const KilterBoardPlacementRoles: {
+    id: number;
+    product_id: number;
+    position: number;
+    name: string;
+    full_name: string;
+    led_color: string;
+    screen_color: string;
+}[];

package/dist/commands/kilterboard.js

@@ -22,3 +22,44 @@ export var KilterBoardPacket;
     /** 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. */
     KilterBoardPacket[KilterBoardPacket["V3_ONLY"] = 84] = "V3_ONLY";
 })(KilterBoardPacket || (KilterBoardPacket = {}));
+/**
+ * Extracted from placement_roles database table.
+ */
+export const KilterBoardPlacementRoles = [
+    {
+        id: 12,
+        product_id: 1,
+        position: 1,
+        name: "start",
+        full_name: "Start",
+        led_color: "00FF00",
+        screen_color: "00DD00",
+    },
+    {
+        id: 13,
+        product_id: 1,
+        position: 2,
+        name: "middle",
+        full_name: "Middle",
+        led_color: "00FFFF",
+        screen_color: "00FFFF",
+    },
+    {
+        id: 14,
+        product_id: 1,
+        position: 3,
+        name: "finish",
+        full_name: "Finish",
+        led_color: "FF00FF",
+        screen_color: "FF00FF",
+    },
+    {
+        id: 15,
+        product_id: 1,
+        position: 4,
+        name: "foot",
+        full_name: "Foot Only",
+        led_color: "FFA500",
+        screen_color: "FFA500",
+    },
+];

package/dist/download.d.ts

@@ -5,6 +5,12 @@ import type { DownloadPacket } from "./types/download";
 export declare const DownloadPackets: DownloadPacket[];
 export declare const emptyDownloadPackets: () => void;
 /**
- * Exports the data as a CSV file.
+ * Exports the data in the specified format (CSV, JSON, XML) with a filename format:
+ * 'data-export-YYYY-MM-DD-HH-MM-SS.{format}'.
+ *
+ * @param {('csv' | 'json' | 'xml')} [format='csv'] - The format in which to download the data.
+ * Defaults to 'csv'. Accepted values are 'csv', 'json', and 'xml'.
+ *
+ * @returns {void} Initiates a download of the data in the specified format.
  */
-export declare const download: () => void;
+export declare const download: (format?: "csv" | "json" | "xml") => void;

package/dist/download.js

@@ -26,20 +26,76 @@ const packetsToCSV = (data) => {
         .join("\r\n");
 };
 /**
- * Exports the data as a CSV file.
+ * Converts an array of DownloadPacket objects to a JSON string.
+ * @param data - Array of DownloadPacket objects.
+ * @returns JSON string representation of the data.
+ */
+const packetsToJSON = (data) => {
+    return JSON.stringify(data, null, 2); // Pretty print JSON with 2-space indentation
+};
+/**
+ * Converts an array of DownloadPacket objects to an XML string.
+ * @param data - Array of DownloadPacket objects.
+ * @returns XML string representation of the data.
+ */
+const packetsToXML = (data) => {
+    const xmlPackets = data
+        .map((packet) => {
+        const samples = packet.samples.map((sample) => `<sample>${sample}</sample>`).join("");
+        const masses = packet.masses.map((mass) => `<mass>${mass}</mass>`).join("");
+        return `
+        <packet>
+          <received>${packet.received}</received>
+          <sampleNum>${packet.sampleNum}</sampleNum>
+          <battRaw>${packet.battRaw}</battRaw>
+          <samples>${samples}</samples>
+          <masses>${masses}</masses>
+        </packet>
+      `;
+    })
+        .join("");
+    return `<DownloadPackets>${xmlPackets}</DownloadPackets>`;
+};
+/**
+ * Exports the data in the specified format (CSV, JSON, XML) with a filename format:
+ * 'data-export-YYYY-MM-DD-HH-MM-SS.{format}'.
+ *
+ * @param {('csv' | 'json' | 'xml')} [format='csv'] - The format in which to download the data.
+ * Defaults to 'csv'. Accepted values are 'csv', 'json', and 'xml'.
+ *
+ * @returns {void} Initiates a download of the data in the specified format.
  */
-export const download = () => {
-    // Generate CSV string from DownloadPackets array
-    const csvContent = packetsToCSV(DownloadPackets);
-    // Create a Blob object containing the CSV data
-    const blob = new Blob([csvContent], { type: "text/csv" });
+export const download = (format = "csv") => {
+    let content = "";
+    let mimeType = "";
+    let fileName = "";
+    if (format === "csv") {
+        content = packetsToCSV(DownloadPackets);
+        mimeType = "text/csv";
+    }
+    else if (format === "json") {
+        content = packetsToJSON(DownloadPackets);
+        mimeType = "application/json";
+    }
+    else if (format === "xml") {
+        content = packetsToXML(DownloadPackets);
+        mimeType = "application/xml";
+    }
+    const now = new Date();
+    // YYYY-MM-DD
+    const date = now.toISOString().split("T")[0];
+    // HH-MM-SS
+    const time = now.toTimeString().split(" ")[0].replace(/:/g, "-");
+    fileName = `data-export-${date}-${time}.${format}`;
+    // Create a Blob object containing the data
+    const blob = new Blob([content], { type: mimeType });
     // Create a URL for the Blob
     const url = window.URL.createObjectURL(blob);
     // Create a link element
     const link = document.createElement("a");
     // Set link attributes
     link.href = url;
-    link.setAttribute("download", "data.csv");
+    link.setAttribute("download", fileName);
     // Append link to document body
     document.body.appendChild(link);
     // Programmatically click the link to trigger the download

package/dist/led.d.ts

@@ -1,8 +1,8 @@
 import type { Device } from "./types/devices";
 declare class ClimbPlacement {
     position: number;
-    role_id: string;
-    constructor(position: number, role_id: string);
+    role_id: number;
+    constructor(position: number, role_id: number);
 }
 /**
  * Prepares byte arrays for transmission based on a list of climb placements.

package/dist/led.js

@@ -1,7 +1,7 @@
 import { write } from "./write";
 import { isConnected } from "./is-connected";
 import { KilterBoard, Motherboard } from "./devices";
-import { KilterBoardPacket } from "./commands/kilterboard";
+import { KilterBoardPacket, KilterBoardPlacementRoles } from "./commands/kilterboard";
 /**
  * Maximum length of the message body for byte wrapping.
  */
@@ -102,8 +102,11 @@ export function prepBytesV3(climbPlacementList) {
             resultArray.push(tempArray);
             tempArray = [KilterBoardPacket.V3_MIDDLE];
         }
-        const ledColor = climbPlacement.role_id;
-        const encodedPlacement = encodePlacement(climbPlacement.position, ledColor);
+        const role = KilterBoardPlacementRoles.find((placement) => placement.id === climbPlacement.role_id);
+        if (!role) {
+            throw new Error(`Role with id ${climbPlacement.role_id} not found in placement_roles`);
+        }
+        const encodedPlacement = encodePlacement(climbPlacement.position, role.led_color);
         tempArray.push(...encodedPlacement);
     }
     resultArray.push(tempArray);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hangtime/grip-connect",
-  "version": "0.3.8",
+  "version": "0.3.9",
   "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": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,9 @@
     "motherboard",
     "tindeq",
     "progressor",
-    "entralpi"
+    "entralpi",
+    "wh-c06",
+    "kilterboard"
   ],
   "bugs": {
     "url": "https://github.com/Stevie-Ray/hangtime-grip-connect/issues"

package/src/commands/kilterboard.ts

@@ -21,3 +21,44 @@ export enum KilterBoardPacket {
   /** 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,
 }
+/**
+ * Extracted from placement_roles database table.
+ */
+export const KilterBoardPlacementRoles = [
+  {
+    id: 12,
+    product_id: 1,
+    position: 1,
+    name: "start",
+    full_name: "Start",
+    led_color: "00FF00",
+    screen_color: "00DD00",
+  },
+  {
+    id: 13,
+    product_id: 1,
+    position: 2,
+    name: "middle",
+    full_name: "Middle",
+    led_color: "00FFFF",
+    screen_color: "00FFFF",
+  },
+  {
+    id: 14,
+    product_id: 1,
+    position: 3,
+    name: "finish",
+    full_name: "Finish",
+    led_color: "FF00FF",
+    screen_color: "FF00FF",
+  },
+  {
+    id: 15,
+    product_id: 1,
+    position: 4,
+    name: "foot",
+    full_name: "Foot Only",
+    led_color: "FFA500",
+    screen_color: "FFA500",
+  },
+]

package/src/download.ts

@@ -32,14 +32,74 @@ const packetsToCSV = (data: DownloadPacket[]): string => {
 }
 
 /**
- * Exports the data as a CSV file.
+ * Converts an array of DownloadPacket objects to a JSON string.
+ * @param data - Array of DownloadPacket objects.
+ * @returns JSON string representation of the data.
+ */
+const packetsToJSON = (data: DownloadPacket[]): string => {
+  return JSON.stringify(data, null, 2) // Pretty print JSON with 2-space indentation
+}
+
+/**
+ * Converts an array of DownloadPacket objects to an XML string.
+ * @param data - Array of DownloadPacket objects.
+ * @returns XML string representation of the data.
+ */
+const packetsToXML = (data: DownloadPacket[]): string => {
+  const xmlPackets = data
+    .map((packet) => {
+      const samples = packet.samples.map((sample) => `<sample>${sample}</sample>`).join("")
+      const masses = packet.masses.map((mass) => `<mass>${mass}</mass>`).join("")
+      return `
+        <packet>
+          <received>${packet.received}</received>
+          <sampleNum>${packet.sampleNum}</sampleNum>
+          <battRaw>${packet.battRaw}</battRaw>
+          <samples>${samples}</samples>
+          <masses>${masses}</masses>
+        </packet>
+      `
+    })
+    .join("")
+
+  return `<DownloadPackets>${xmlPackets}</DownloadPackets>`
+}
+
+/**
+ * Exports the data in the specified format (CSV, JSON, XML) with a filename format:
+ * 'data-export-YYYY-MM-DD-HH-MM-SS.{format}'.
+ *
+ * @param {('csv' | 'json' | 'xml')} [format='csv'] - The format in which to download the data.
+ * Defaults to 'csv'. Accepted values are 'csv', 'json', and 'xml'.
+ *
+ * @returns {void} Initiates a download of the data in the specified format.
  */
-export const download = (): void => {
-  // Generate CSV string from DownloadPackets array
-  const csvContent: string = packetsToCSV(DownloadPackets)
+export const download = (format: "csv" | "json" | "xml" = "csv"): void => {
+  let content = ""
+  let mimeType = ""
+  let fileName = ""
+
+  if (format === "csv") {
+    content = packetsToCSV(DownloadPackets)
+    mimeType = "text/csv"
+  } else if (format === "json") {
+    content = packetsToJSON(DownloadPackets)
+    mimeType = "application/json"
+  } else if (format === "xml") {
+    content = packetsToXML(DownloadPackets)
+    mimeType = "application/xml"
+  }
+
+  const now = new Date()
+  // YYYY-MM-DD
+  const date = now.toISOString().split("T")[0]
+  // HH-MM-SS
+  const time = now.toTimeString().split(" ")[0].replace(/:/g, "-")
+
+  fileName = `data-export-${date}-${time}.${format}`
 
-  // Create a Blob object containing the CSV data
-  const blob = new Blob([csvContent], { type: "text/csv" })
+  // Create a Blob object containing the data
+  const blob = new Blob([content], { type: mimeType })
 
   // Create a URL for the Blob
   const url = window.URL.createObjectURL(blob)
@@ -49,7 +109,7 @@ export const download = (): void => {
 
   // Set link attributes
   link.href = url
-  link.setAttribute("download", "data.csv")
+  link.setAttribute("download", fileName)
 
   // Append link to document body
   document.body.appendChild(link)

package/src/led.ts

@@ -2,7 +2,8 @@ import type { Device } from "./types/devices"
 import { write } from "./write"
 import { isConnected } from "./is-connected"
 import { KilterBoard, Motherboard } from "./devices"
-import { KilterBoardPacket } from "./commands/kilterboard"
+import { KilterBoardPacket, KilterBoardPlacementRoles } from "./commands/kilterboard"
+
 /**
  * Maximum length of the message body for byte wrapping.
  */
@@ -46,9 +47,9 @@ function wrapBytes(data: number[]) {
 }
 class ClimbPlacement {
   position: number
-  role_id: string
+  role_id: number
 
-  constructor(position: number, role_id: string) {
+  constructor(position: number, role_id: number) {
     this.position = position
     this.role_id = role_id
   }
@@ -109,10 +110,11 @@ export function prepBytesV3(climbPlacementList: ClimbPlacement[]) {
       resultArray.push(tempArray)
       tempArray = [KilterBoardPacket.V3_MIDDLE]
     }
-
-    const ledColor = climbPlacement.role_id
-
-    const encodedPlacement = encodePlacement(climbPlacement.position, ledColor)
+    const role = KilterBoardPlacementRoles.find((placement) => placement.id === climbPlacement.role_id)
+    if (!role) {
+      throw new Error(`Role with id ${climbPlacement.role_id} not found in placement_roles`)
+    }
+    const encodedPlacement = encodePlacement(climbPlacement.position, role.led_color)
     tempArray.push(...encodedPlacement)
   }