@xkeys-lib/core/dist/api.d.ts

NPM package to interact with the X-keys panels

export declare type ButtonStates = Map<number, boolean>;
export interface AnalogStates {
    /** -127 to 127 */
    jog: number[];
    /** -127 to 127 */
    shuttle: number[];
    joystick: JoystickValue[];
    /** 0 to 255 */
    tbar: number[];
    /** 0 to 255 */
    rotary: number[];
    trackball: TrackballValue[];
}
export interface JoystickValue {
    /** Joystick X (horizontal movement). -127 to 127 */
    x: number;
    /** Joystick Y (vertical movement), positive value is "up". -127 to 127 */
    y: number;
    /**
     * Joystick Z (twist of joystick) is a continuous value that rolls over to 0 after 255.
     * Note: Use .deltaZ instead
     */
    z: number;
}
export interface TrackballValue {
    /**  X (delta horizontal movement). 2 byte */
    x: number;
    /**  Y (delta vertical movement), positive value is "up". 2 byte */
    y: number;
}
export interface JoystickValueEmit extends JoystickValue {
    /** Joystick delta Z, a delta value that behaves properly when Z rolls over 255 to 0 */
    deltaZ: number;
}
export declare type Color = {
    r: number;
    g: number;
    b: number;
};
export interface EventMetadata {
    /**
     * Timestamp of the event. Measured in milliseconds from when the device was last powered on.
     * The timestamp can be used as a more trustworthy source of time than the computer clock, as it's not affected by delays in the USB data handling.
     */
    timestamp: number | undefined;
}
export interface ButtonEventMetadata extends EventMetadata {
    /** Row of the button location*/
    row: number;
    /** Column of the button location */
    col: number;
}
export interface XKeysEvents {
    down: (keyIndex: number, metadata: ButtonEventMetadata) => void;
    up: (keyIndex: number, metadata: ButtonEventMetadata) => void;
    jog: (index: number, value: number, eventMetadata: EventMetadata) => void;
    shuttle: (index: number, value: number, eventMetadata: EventMetadata) => void;
    joystick: (index: number, value: JoystickValueEmit, eventMetadata: EventMetadata) => void;
    tbar: (index: number, value: number, eventMetadata: EventMetadata) => void;
    trackball: (index: number, value: TrackballValue, eventMetadata: EventMetadata) => void;
    rotary: (index: number, value: number, eventMetadata: EventMetadata) => void;
    disconnected: () => void;
    reconnected: () => void;
    error: (err: any) => void;
}
export interface XKeysInfo {
    /** Name of the device */
    name: string;
    /** Vendor id of the HID device */
    vendorId: number;
    /** Product id of the HID device */
    productId: number;
    /** Interface number of the HID device */
    interface: number;
    /** Unit id ("UID") of the device, is used to uniquely identify a certain panel, or panel type.
     * From factory it's set to 0, but it can be changed using xkeys.setUnitId()
     */
    unitId: number;
    /** firmware version of the device	 */
    firmwareVersion: number;
    /** The number of physical columns */
    colCount: number;
    /** The number of physical rows */
    rowCount: number;
    /**
     * Physical layout of the product. To be used to draw a visual representation of the X-keys
     * Note: Layout is a work-in-progress and it might/will change in the future.
     */
    layout: {
        /** Name of the region */
        name: string;
        /** Index of the region */
        index: number;
        /** First row of the region (1-indexed) */
        startRow: number;
        /** First column of the region (1-indexed) */
        startCol: number;
        /** Last row of the region (1-indexed) */
        endRow: number;
        /** Last column of the region (1-indexed) */
        endCol: number;
    }[];
    /** If the X-keys panel emits timestamps (if not, timestamp will be undefined) */
    emitsTimestamp: boolean;
    /** If the product has the Program Switch button, this is a special switch not in the normal switch matrix. If exists, only one per X-keys. */
    hasPS: boolean;
    /** The number of joysticks available on the device */
    hasJoystick: number;
    /** The number of trackballs available on the device */
    hasTrackball: number;
    /** The number of jog wheels available on the device */
    hasJog: number;
    /** The number of shuttles available on the device */
    hasShuttle: number;
    /** The number of T-bars available on the device */
    hasTbar: number;
    /** The number of rotary knobs available on the device */
    hasRotary: number;
    /** The number of extra buttons available on the device */
    hasExtraButtons: number;
    /** If the device has an LCD display */
    hasLCD: boolean;
    /** If the device has GPIO support */
    hasGPIO: boolean;
    /** If the device has serial-data support  */
    hasSerialData: boolean;
    /** If the device has DMX support */
    hasDMX: boolean;
}
//# sourceMappingURL=api.d.ts.map