@hangtime/grip-connect 0.3.1 → 0.3.2

package/src/tare.js

@@ -1,70 +0,0 @@
-/**
- * Represents the current tare value for calibration.
- * @type {number}
- */
-let currentTare = 0;
-/**
- * Represents the state of tare calibration.
- * - If `false`, tare calibration is not active.
- * - If `true`, tare calibration process is initiated.
- * - If `Date` object, tare calibration process is ongoing and started at this date.
- * @type {boolean | Date}
- */
-let runTare = false;
-/**
- * Array holding the samples collected during tare calibration.
- * @type {number[]}
- */
-let tareSamples = [];
-/**
- * Array holding the sum of samples collected during tare calibration.
- * @type {number}
- */
-let newTares = 0;
-/**
- * Duration time for tare calibration process.
- * @type {number}
- */
-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.
- */
-export const tare = async (time = 5000) => {
-    runTare = true;
-    timeTare = time;
-    tareSamples = [];
-};
-/**
- * Apply tare calibration to the provided sample.
- * @param {number} sample - The sample to calibrate.
- * @returns {number} The calibrated tare value.
- */
-export const applyTare = (sample) => {
-    if (runTare) {
-        // If taring process is initiated
-        if (typeof runTare === "boolean" && runTare === true) {
-            // If tare flag is true (first time), set it to the current date
-            runTare = new Date();
-            // Initialize the sum of new tare values
-            newTares = 0;
-        }
-        // 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.getTime() > timeTare) {
-            // Calculate the sum of tare samples
-            for (let i = 0; i < tareSamples.length; ++i) {
-                newTares += tareSamples[i];
-            }
-            // 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;
-            // Reset tare related variables
-            runTare = false;
-            tareSamples = [];
-        }
-    }
-    // Apply tare correction to the sample and return the calibrated value
-    return currentTare;
-};

package/src/write.d.ts

@@ -1,16 +0,0 @@
-import { Device } from "./devices/types";
-/**
- * The last message written to the device.
- * @type {string | null}
- */
-export declare let lastWrite: string | 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 {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.
- */
-export declare const write: (board: Device, serviceId: string, characteristicId: string, message: string | undefined, duration?: number) => Promise<void>;

package/src/write.js

@@ -1,56 +0,0 @@
-import { isConnected } from "./is-connected";
-import { getCharacteristic } from "./characteristic";
-/**
- * The last message written to the device.
- * @type {string | null}
- */
-export let lastWrite = 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 {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.
- */
-export const write = (board, serviceId, characteristicId, message, duration = 0) => {
-    return new Promise((resolve, reject) => {
-        if (isConnected(board)) {
-            // Check if message is provided
-            if (message === undefined) {
-                // If not provided, return without performing write operation
-                return;
-            }
-            // Get the characteristic
-            const characteristic = getCharacteristic(board, serviceId, characteristicId);
-            if (characteristic) {
-                // Encode the message
-                const encoder = new TextEncoder();
-                characteristic
-                    .writeValue(encoder.encode(message))
-                    .then(() => {
-                    // Update the last written message
-                    lastWrite = message;
-                    // Handle timeout
-                    if (duration !== 0) {
-                        setTimeout(() => {
-                            resolve();
-                        }, duration);
-                    }
-                })
-                    .catch((error) => {
-                    reject(error);
-                });
-            }
-            else {
-                // 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"));
-        }
-    });
-};