@robdobsn/raftjs 1.8.5 → 1.11.5

package/src/RaftDeviceMgrIF.ts

@@ -0,0 +1,37 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftDeviceMgrIF.ts
+// Interface to devices state
+//
+// Rob Dobson (C) 2024
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+import { DeviceTypeAction } from "./RaftDeviceInfo";
+import { DeviceAttributeState, DevicesState, DeviceState, DeviceStats } from "./RaftDeviceStates";
+
+export default interface RaftDeviceMgrIF {
+
+    // Get state of devices
+    getDevicesState(): DevicesState;
+    getDeviceState(deviceKey: string): DeviceState;
+    getDeviceStats(deviceKey: string): DeviceStats;
+    resetDeviceStats(deviceKey: string): void;
+
+    // Settings
+    setMaxDataPointsToStore(maxDataPointsToStore: number): void;
+
+    // Callbacks
+    addNewDeviceCallback(callback: (deviceKey: string, state: DeviceState) => void): void;
+    removeNewDeviceCallback(callback: (deviceKey: string, state: DeviceState) => void): void;
+    addNewAttributeCallback(callback: (deviceKey: string, attrState: DeviceAttributeState) => void): void;
+    removeNewAttributeCallback(callback: (deviceKey: string, attrState: DeviceAttributeState) => void): void;
+    addAttributeDataCallback(callback: (deviceKey: string, attrState: DeviceAttributeState) => void): void;
+    removeAttributeDataCallback(callback: (deviceKey: string, attrState: DeviceAttributeState) => void): void;
+    addDeviceRemovedCallback(callback: (deviceKey: string, state: DeviceState) => void): void;
+    removeDeviceRemovedCallback(callback: (deviceKey: string, state: DeviceState) => void): void;
+
+    // Send action to device
+    sendAction(deviceKey: string, action: DeviceTypeAction, data: number[]): void;
+    sendCompoundAction(deviceKey: string, action: DeviceTypeAction, data: number[][]): void;
+}

package/src/RaftDeviceMsg.ts

@@ -0,0 +1,20 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftDeviceMsg
+// Device message for Raft devices
+//
+// Rob Dobson (C) 2024
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export interface DeviceMsgJsonElem {
+    [attrGroupName: string]: string | number | boolean; // Attribute group name and value
+}
+
+export interface DeviceMsgJsonBus {
+    [devAddr: string]: DeviceMsgJsonElem;
+}
+  
+export interface DeviceMsgJson {
+    [busName: string]: DeviceMsgJsonBus;
+}

package/src/RaftDeviceStates.ts

@@ -0,0 +1,122 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftDeviceStates
+// Device states for Raft devices
+//
+// Rob Dobson (C) 2024
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+import { DeviceTypeInfo } from "./RaftDeviceInfo";
+
+export function deviceAttrGetLatestFormatted(attrState: DeviceAttributeState): string {
+
+    if (attrState.values.length === 0) {
+        return 'N/A';
+    }
+    if (attrState.format.length === 0) {
+        return attrState.values[attrState.values.length - 1].toString();
+    }
+    const value = attrState.values[attrState.values.length - 1];
+    let format = attrState.format;
+    if (format.startsWith("%")) {
+        format = format.slice(1);
+    }
+    if (format.endsWith('f')) {
+        // Floating point number formatting
+        const parts = format.split('.');
+        let decimalPlaces = 0;
+        if (parts.length === 2) {
+            decimalPlaces = parseInt(parts[1], 10);
+        }
+        const formattedNumber = value.toFixed(decimalPlaces);
+        const fieldWidth = parseInt(parts[0], 10);
+        return fieldWidth ? formattedNumber.padStart(fieldWidth, ' ') : formattedNumber;
+    } else if (format.endsWith('x')) {
+        // Hexadecimal formatting
+        const totalLength = parseInt(format.slice(0, -1), 10);
+        return Math.floor(value).toString(16).padStart(totalLength, format.startsWith('0') ? '0' : ' ');
+    } else if (format.endsWith('d')) {
+        // Decimal integer formatting
+        const totalLength = parseInt(format.slice(0, -1), 10);
+        return Math.floor(value).toString(10).padStart(totalLength, format.startsWith('0') ? '0' : ' ');
+    } else if (format.endsWith('b')) {
+        // Binary formatting
+        return Math.floor(value) === 0 ? 'no' : 'yes';
+    }
+    return value.toString();
+}
+
+export interface DeviceAttributeState {
+    name: string;
+    newAttribute: boolean;
+    newData: boolean;
+    numNewValues: number;
+    values: number[];
+    units: string;
+    range: number[];
+    format: string;
+    visibleSeries: boolean;
+    visibleForm: boolean;
+}
+
+export interface DeviceAttributesState {
+    [attributeName: string]: DeviceAttributeState;
+}
+
+export interface DeviceTimeline {
+    timestampsUs: number[];
+    lastReportTimestampUs: number;
+    reportTimestampOffsetUs: number;
+}
+
+export interface DeviceStats {
+    totalSamples: number;
+    windowMs: number;
+    windowSamples: number;
+    sampleRateHz: number;
+    lastSampleTimeMs: number | null;
+    lastUpdateTimeMs: number | null;
+}
+
+export enum DeviceOnlineState {
+    Offline = 0,
+    Online = 1,
+    PendingDeletion = 2,
+}
+
+export interface DeviceState {
+    deviceTypeInfo: DeviceTypeInfo | undefined;
+    deviceTimeline: DeviceTimeline;
+    deviceAttributes: DeviceAttributesState;
+    deviceIsNew: boolean;
+    stateChanged: boolean;
+    onlineState: DeviceOnlineState;
+    deviceAddress: string;
+    deviceType: string;
+    busName: string;
+}
+
+export class DevicesState {
+    [deviceKey: string]: DeviceState;
+}
+
+// Format a numeric device address as canonical hex string:
+// lowercase, no "0x" prefix, no leading zeros
+export function formatDeviceAddrHex(addr: number): string {
+    return addr.toString(16);
+}
+
+// Generate a composite device key from bus number and hex address
+export function getDeviceKey(busNumberAsString: string, devAddrHexStr: string): string {
+    return `${busNumberAsString}_${devAddrHexStr}`;
+}
+
+// Parse a device key into its bus and address components
+export function parseDeviceKey(deviceKey: string): { bus: string; addr: string } {
+    const sep = deviceKey.indexOf('_');
+    if (sep < 0) {
+        return { bus: deviceKey, addr: '' };
+    }
+    return { bus: deviceKey.substring(0, sep), addr: deviceKey.substring(sep + 1) };
+}