node-poweredup 8.0.5 → 10.0.0

package/dist/node/hub.d.ts

@@ -0,0 +1,291 @@
+/**
+ * Hub - Main hub class for LEGO Powered UP hubs
+ *
+ * Follows the event-driven pattern from node-coral/node-wedo/node-controllab.
+ * Hubs emit device attach/detach events when peripherals are connected/disconnected.
+ */
+import { EventEmitter } from "events";
+import { HubType, DeviceType, Color, HubEventMap, HubProperties, BrakingStyle, DeviceInfo } from "./types";
+import { LWP3Connection, WeDo2Connection, BLEPeripheral } from "./connection";
+import { Device } from "./devices";
+/**
+ * Base class for all LEGO Powered UP hubs
+ */
+export declare abstract class BaseHub extends EventEmitter {
+    protected _connection: LWP3Connection | WeDo2Connection;
+    protected _peripheral: BLEPeripheral;
+    protected _properties: HubProperties;
+    protected _ports: Map<number, DeviceInfo>;
+    protected _devices: Map<number, Device>;
+    protected _isConnected: boolean;
+    readonly hubType: HubType;
+    constructor(peripheral: BLEPeripheral, hubType: HubType);
+    /**
+     * Connect to the hub
+     */
+    abstract connect(): Promise<void>;
+    /**
+     * Disconnect from the hub
+     */
+    abstract disconnect(): Promise<void>;
+    /**
+     * Shutdown the hub (power off)
+     */
+    abstract shutdown(): Promise<void>;
+    /**
+     * Get hub name
+     */
+    get name(): string;
+    /**
+     * Set hub name
+     */
+    abstract setName(name: string): Promise<void>;
+    /**
+     * Get firmware version
+     */
+    get firmwareVersion(): string;
+    /**
+     * Get hardware version
+     */
+    get hardwareVersion(): string;
+    /**
+     * Get battery level (0-100)
+     */
+    get batteryLevel(): number;
+    /**
+     * Get RSSI signal strength
+     */
+    get rssi(): number;
+    /**
+     * Check if hub is connected
+     */
+    get isConnected(): boolean;
+    /**
+     * Get attached ports
+     */
+    get ports(): Map<number, DeviceInfo>;
+    /**
+     * Get port info by port ID
+     */
+    getPort(portId: number): DeviceInfo | undefined;
+    /**
+     * Get ports by device type
+     */
+    getPortsByType(deviceType: DeviceType): DeviceInfo[];
+    /**
+     * Wait for a device of a specific type to be attached
+     * @param deviceType The device type to wait for
+     * @param timeout Timeout in milliseconds (default: 10000)
+     * @returns Promise that resolves to the Device
+     */
+    waitForDeviceByType(deviceType: DeviceType, timeout?: number): Promise<Device>;
+    /**
+     * Wait for a device at a specific port
+     * @param portName The port name (e.g., "A", "B", "LEFT", "RIGHT")
+     * @param timeout Timeout in milliseconds (default: 10000)
+     * @returns Promise that resolves to the Device
+     */
+    waitForDeviceAtPort(portName: string, timeout?: number): Promise<Device>;
+    /**
+     * Get existing device or create and register a new one
+     */
+    protected _getOrCreateDevice(portId: number, portInfo: DeviceInfo): Device;
+    /**
+     * Convert port name to port ID
+     */
+    protected _portNameToId(portName: string): number;
+    /**
+     * Sleep for a specified time
+     * @param ms Time to sleep in milliseconds
+     */
+    sleep(ms: number): Promise<void>;
+    on<K extends keyof HubEventMap>(event: K, listener: HubEventMap[K]): this;
+    once<K extends keyof HubEventMap>(event: K, listener: HubEventMap[K]): this;
+    emit<K extends keyof HubEventMap>(event: K, ...args: Parameters<HubEventMap[K]>): boolean;
+}
+/**
+ * Hub class for LWP3-based hubs (Powered UP, Boost Move Hub, Technic, etc.)
+ */
+export declare class LWP3Hub extends BaseHub {
+    protected _connection: LWP3Connection;
+    constructor(peripheral: BLEPeripheral, hubType: HubType);
+    /**
+     * Connect to the hub and initialize
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the hub
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Shutdown the hub (power off)
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Set the hub name
+     */
+    setName(name: string): Promise<void>;
+    /**
+     * Set the hub LED color
+     */
+    setLEDColor(color: Color): Promise<void>;
+    /**
+     * Set the hub LED to RGB color
+     */
+    setLEDRGB(red: number, green: number, blue: number): Promise<void>;
+    /**
+     * Run a motor at a given power level (-100 to 100)
+     */
+    motorPower(portId: number, power: number): Promise<void>;
+    /**
+     * Run a motor at a given speed (-100 to 100) with power regulation
+     */
+    motorSpeed(portId: number, speed: number, maxPower?: number): Promise<void>;
+    /**
+     * Run a motor for a specified time
+     */
+    motorRunForTime(portId: number, time: number, speed: number, maxPower?: number, endState?: BrakingStyle): Promise<void>;
+    /**
+     * Run a motor for a specified number of degrees
+     */
+    motorRunForDegrees(portId: number, degrees: number, speed: number, maxPower?: number, endState?: BrakingStyle): Promise<void>;
+    /**
+     * Move motor to absolute position
+     */
+    motorGotoPosition(portId: number, position: number, speed: number, maxPower?: number, endState?: BrakingStyle): Promise<void>;
+    /**
+     * Stop a motor
+     */
+    motorStop(portId: number): Promise<void>;
+    /**
+     * Brake a motor
+     */
+    motorBrake(portId: number): Promise<void>;
+    /**
+     * Subscribe to sensor updates on a port
+     */
+    subscribe(portId: number, mode?: number, deltaInterval?: number): Promise<void>;
+    /**
+     * Unsubscribe from sensor updates on a port
+     */
+    unsubscribe(portId: number, mode?: number): Promise<void>;
+    /**
+     * Send raw command to the hub
+     */
+    sendRaw(data: Buffer): Promise<void>;
+    private _requestHubProperties;
+    private _enableButtonNotifications;
+    private _handleMessage;
+    private _handleHubProperty;
+    private _handleAttachedIO;
+    private _handlePortValue;
+    private _handleCommandFeedback;
+    private _handleAlert;
+    private _handleError;
+    private _handleDisconnect;
+    private _findPortByDeviceType;
+    private _parseVersion;
+}
+/**
+ * Hub class for WeDo 2.0 Smart Hub
+ */
+export declare class WeDo2Hub extends BaseHub {
+    protected _connection: WeDo2Connection;
+    constructor(peripheral: BLEPeripheral);
+    /**
+     * Connect to the hub and initialize
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the hub
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Shutdown the hub (WeDo 2.0 doesn't support remote shutdown)
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Set the hub name
+     */
+    setName(name: string): Promise<void>;
+    /**
+     * Set the hub LED color
+     */
+    setLEDColor(color: Color): Promise<void>;
+    /**
+     * Set the hub LED to RGB color
+     */
+    setLEDRGB(red: number, green: number, blue: number): Promise<void>;
+    /**
+     * Run a motor at a given power level (-100 to 100)
+     */
+    motorPower(portId: number, power: number): Promise<void>;
+    /**
+     * Stop a motor
+     */
+    motorStop(portId: number): Promise<void>;
+    /**
+     * Play a tone
+     */
+    playTone(frequency: number, duration: number): Promise<void>;
+    /**
+     * Stop tone playback
+     */
+    stopTone(): Promise<void>;
+    /**
+     * Set sensor mode
+     */
+    setSensorMode(portId: number, mode: number): Promise<void>;
+    /**
+     * Send raw command
+     */
+    sendRaw(characteristicUUID: string, data: Buffer): Promise<void>;
+    private _handleMessage;
+    private _handlePortInfo;
+    private _handleSensorValue;
+    private _handleButton;
+    private _handleBattery;
+    private _handleDisconnect;
+}
+/**
+ * Create a hub instance based on the hub type
+ */
+export declare function createHub(peripheral: BLEPeripheral, hubType: HubType): BaseHub;
+/**
+ * Move Hub (Boost) with built-in tilt sensor and motors
+ */
+export declare class MoveHub extends LWP3Hub {
+    constructor(peripheral: BLEPeripheral);
+    get motorAPort(): number;
+    get motorBPort(): number;
+    get tiltSensorPort(): number;
+    get colorSensorPort(): number;
+}
+/**
+ * Technic Medium Hub with gyro and accelerometer
+ */
+export declare class TechnicMediumHub extends LWP3Hub {
+    constructor(peripheral: BLEPeripheral);
+    get gyroPort(): number;
+    get accelerometerPort(): number;
+    get tiltSensorPort(): number;
+}
+/**
+ * Remote Control
+ */
+export declare class RemoteControl extends LWP3Hub {
+    constructor(peripheral: BLEPeripheral);
+    get leftButtonPort(): number;
+    get rightButtonPort(): number;
+}
+/**
+ * Duplo Train Base
+ */
+export declare class DuploTrainBase extends LWP3Hub {
+    constructor(peripheral: BLEPeripheral);
+    get motorPort(): number;
+    get colorSensorPort(): number;
+    get speedometerPort(): number;
+    get speakerPort(): number;
+    playSound(sound: number): Promise<void>;
+}