@kuriousdesign/machine-sdk
Version:
Shared data types and helpers for machine-related repositories
37 lines (28 loc) • 1.13 kB
Markdown
/machine-sdk
A shared SDK for data types and helper functions used in machine-related repositories.
Installation
npm install /machine-sdk
Usage
import { Machine, formatTimestamp, isMachineActive } from '@kuriousdesign/machine-sdk';
// Example: Machine data
const machine: Machine = {
id: 'M001',
name: 'Conveyor',
status: 'running',
lastUpdated: new Date()
};
// Format timestamp
console.log(formatTimestamp(machine.lastUpdated)); // e.g., "2025-08-15T22:23:00.000Z"
// Check if machine is active
console.log(isMachineActive(machine)); // true
API
Data Types
Machine: Represents a machine with id, name, status, and lastUpdated.
SensorData: Represents sensor readings with machineId, temperature, pressure, and timestamp.
Helper Functions
formatTimestamp(date: Date): string: Formats a Date to ISO string.
isMachineActive(machine: Machine): boolean: Checks if a machine is running.
calculateAverageTemperature(data: SensorData[]): number: Computes average temperature.
validateMachineId(id: string): boolean: Validates a machine ID format.
License
MIT