buttplug 3.2.1 → 4.0.0

package/dist/main/src/core/Messages.d.ts

@@ -5,84 +5,35 @@
  *
  * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
  */
-import 'reflect-metadata';
 export declare const SYSTEM_MESSAGE_ID = 0;
 export declare const DEFAULT_MESSAGE_ID = 1;
 export declare const MAX_ID = 4294967295;
-export declare const MESSAGE_SPEC_VERSION = 3;
-export declare class MessageAttributes {
-    ScalarCmd?: Array<GenericDeviceMessageAttributes>;
-    RotateCmd?: Array<GenericDeviceMessageAttributes>;
-    LinearCmd?: Array<GenericDeviceMessageAttributes>;
-    RawReadCmd?: RawDeviceMessageAttributes;
-    RawWriteCmd?: RawDeviceMessageAttributes;
-    RawSubscribeCmd?: RawDeviceMessageAttributes;
-    SensorReadCmd?: Array<SensorDeviceMessageAttributes>;
-    SensorSubscribeCmd?: Array<SensorDeviceMessageAttributes>;
-    StopDeviceCmd: {};
-    constructor(data: Partial<MessageAttributes>);
-    update(): void;
-}
-export declare enum ActuatorType {
-    Unknown = "Unknown",
-    Vibrate = "Vibrate",
-    Rotate = "Rotate",
-    Oscillate = "Oscillate",
-    Constrict = "Constrict",
-    Inflate = "Inflate",
-    Position = "Position"
-}
-export declare enum SensorType {
-    Unknown = "Unknown",
-    Battery = "Battery",
-    RSSI = "RSSI",
-    Button = "Button",
-    Pressure = "Pressure"
-}
-export declare class GenericDeviceMessageAttributes {
-    FeatureDescriptor: string;
-    ActuatorType: ActuatorType;
-    StepCount: number;
-    Index: number;
-    constructor(data: Partial<GenericDeviceMessageAttributes>);
-}
-export declare class RawDeviceMessageAttributes {
-    Endpoints: Array<string>;
-    constructor(Endpoints: Array<string>);
-}
-export declare class SensorDeviceMessageAttributes {
-    FeatureDescriptor: string;
-    SensorType: SensorType;
-    StepRange: Array<number>;
-    Index: number;
-    constructor(data: Partial<GenericDeviceMessageAttributes>);
-}
-export declare abstract class ButtplugMessage {
-    Id: number;
-    constructor(Id: number);
-    get Type(): Function;
-    toJSON(): string;
-    toProtocolFormat(): object;
-    update(): void;
-}
-export declare abstract class ButtplugDeviceMessage extends ButtplugMessage {
-    DeviceIndex: number;
-    Id: number;
-    constructor(DeviceIndex: number, Id: number);
-}
-export declare abstract class ButtplugSystemMessage extends ButtplugMessage {
-    Id: number;
-    constructor(Id?: number);
-}
-export declare class Ok extends ButtplugSystemMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
-}
-export declare class Ping extends ButtplugMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
+export declare const MESSAGE_SPEC_VERSION_MAJOR = 4;
+export declare const MESSAGE_SPEC_VERSION_MINOR = 0;
+export interface ButtplugMessage {
+    Ok?: Ok;
+    Ping?: Ping;
+    Error?: Error;
+    RequestServerInfo?: RequestServerInfo;
+    ServerInfo?: ServerInfo;
+    RequestDeviceList?: RequestDeviceList;
+    StartScanning?: StartScanning;
+    StopScanning?: StopScanning;
+    StopAllDevices?: StopAllDevices;
+    ScanningFinished?: ScanningFinished;
+    StopDeviceCmd?: StopDeviceCmd;
+    InputCmd?: InputCmd;
+    InputReading?: InputReading;
+    OutputCmd?: OutputCmd;
+    DeviceList?: DeviceList;
+}
+export declare function msgId(msg: ButtplugMessage): number;
+export declare function setMsgId(msg: ButtplugMessage, id: number): void;
+export interface Ok {
+    Id: number | undefined;
+}
+export interface Ping {
+    Id: number | undefined;
 }
 export declare enum ErrorClass {
     ERROR_UNKNOWN = 0,
@@ -91,185 +42,124 @@ export declare enum ErrorClass {
     ERROR_MSG = 3,
     ERROR_DEVICE = 4
 }
-export declare class Error extends ButtplugMessage {
+export interface Error {
     ErrorMessage: string;
     ErrorCode: ErrorClass;
-    Id: number;
-    static Name: string;
-    constructor(ErrorMessage: string, ErrorCode?: ErrorClass, Id?: number);
-    get Schemversion(): number;
-}
-export declare class DeviceInfo {
-    DeviceIndex: number;
-    DeviceName: string;
-    DeviceMessages: MessageAttributes;
-    DeviceDisplayName?: string;
-    DeviceMessageTimingGap?: number;
-    constructor(data: Partial<DeviceInfo>);
-}
-export declare class DeviceList extends ButtplugMessage {
-    static Name: string;
-    Devices: DeviceInfo[];
-    Id: number;
-    constructor(devices: DeviceInfo[], id?: number);
-    update(): void;
-}
-export declare class DeviceAdded extends ButtplugSystemMessage {
-    static Name: string;
-    DeviceIndex: number;
-    DeviceName: string;
-    DeviceMessages: MessageAttributes;
-    DeviceDisplayName?: string;
-    DeviceMessageTimingGap?: number;
-    constructor(data: Partial<DeviceAdded>);
-    update(): void;
+    Id: number | undefined;
 }
-export declare class DeviceRemoved extends ButtplugSystemMessage {
-    DeviceIndex: number;
-    static Name: string;
-    constructor(DeviceIndex: number);
+export interface RequestDeviceList {
+    Id: number | undefined;
 }
-export declare class RequestDeviceList extends ButtplugMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
+export interface StartScanning {
+    Id: number | undefined;
 }
-export declare class StartScanning extends ButtplugMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
+export interface StopScanning {
+    Id: number | undefined;
 }
-export declare class StopScanning extends ButtplugMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
+export interface StopAllDevices {
+    Id: number | undefined;
 }
-export declare class ScanningFinished extends ButtplugSystemMessage {
-    static Name: string;
-    constructor();
+export interface ScanningFinished {
+    Id: number | undefined;
 }
-export declare class RequestServerInfo extends ButtplugMessage {
+export interface RequestServerInfo {
     ClientName: string;
-    MessageVersion: number;
-    Id: number;
-    static Name: string;
-    constructor(ClientName: string, MessageVersion?: number, Id?: number);
+    ProtocolVersionMajor: number;
+    ProtocolVersionMinor: number;
+    Id: number | undefined;
 }
-export declare class ServerInfo extends ButtplugSystemMessage {
-    MessageVersion: number;
+export interface ServerInfo {
     MaxPingTime: number;
     ServerName: string;
-    Id: number;
-    static Name: string;
-    constructor(MessageVersion: number, MaxPingTime: number, ServerName: string, Id?: number);
-}
-export declare class StopDeviceCmd extends ButtplugDeviceMessage {
-    DeviceIndex: number;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex?: number, Id?: number);
-}
-export declare class StopAllDevices extends ButtplugMessage {
-    Id: number;
-    static Name: string;
-    constructor(Id?: number);
+    ProtocolVersionMajor: number;
+    ProtocolVersionMinor: number;
+    Id: number | undefined;
 }
-export declare class GenericMessageSubcommand {
-    Index: number;
-    protected constructor(Index: number);
-}
-export declare class ScalarSubcommand extends GenericMessageSubcommand {
-    Scalar: number;
-    ActuatorType: ActuatorType;
-    constructor(Index: number, Scalar: number, ActuatorType: ActuatorType);
-}
-export declare class ScalarCmd extends ButtplugDeviceMessage {
-    Scalars: ScalarSubcommand[];
+export interface DeviceFeature {
+    FeatureDescriptor: string;
+    Output: {
+        [key: string]: DeviceFeatureOutput;
+    };
+    Input: {
+        [key: string]: DeviceFeatureInput;
+    };
+    FeatureIndex: number;
+}
+export interface DeviceInfo {
     DeviceIndex: number;
-    Id: number;
-    static Name: string;
-    constructor(Scalars: ScalarSubcommand[], DeviceIndex?: number, Id?: number);
+    DeviceName: string;
+    DeviceFeatures: {
+        [key: number]: DeviceFeature;
+    };
+    DeviceDisplayName?: string;
+    DeviceMessageTimingGap?: number;
 }
-export declare class RotateSubcommand extends GenericMessageSubcommand {
-    Speed: number;
-    Clockwise: boolean;
-    constructor(Index: number, Speed: number, Clockwise: boolean);
+export interface DeviceList {
+    Devices: {
+        [key: number]: DeviceInfo;
+    };
+    Id: number | undefined;
 }
-export declare class RotateCmd extends ButtplugDeviceMessage {
-    Rotations: RotateSubcommand[];
-    DeviceIndex: number;
-    Id: number;
-    static Name: string;
-    static Create(deviceIndex: number, commands: [number, boolean][]): RotateCmd;
-    constructor(Rotations: RotateSubcommand[], DeviceIndex?: number, Id?: number);
+export declare enum OutputType {
+    Unknown = "Unknown",
+    Vibrate = "Vibrate",
+    Rotate = "Rotate",
+    Oscillate = "Oscillate",
+    Constrict = "Constrict",
+    Inflate = "Inflate",
+    Position = "Position",
+    PositionWithDuration = "PositionWithDuration",
+    Temperature = "Temperature",
+    Spray = "Spray",
+    Led = "Led"
 }
-export declare class VectorSubcommand extends GenericMessageSubcommand {
-    Position: number;
-    Duration: number;
-    constructor(Index: number, Position: number, Duration: number);
+export declare enum InputType {
+    Unknown = "Unknown",
+    Battery = "Battery",
+    RSSI = "RSSI",
+    Button = "Button",
+    Pressure = "Pressure"
 }
-export declare class LinearCmd extends ButtplugDeviceMessage {
-    Vectors: VectorSubcommand[];
-    DeviceIndex: number;
-    Id: number;
-    static Name: string;
-    static Create(deviceIndex: number, commands: [number, number][]): LinearCmd;
-    constructor(Vectors: VectorSubcommand[], DeviceIndex?: number, Id?: number);
+export declare enum InputCommandType {
+    Read = "Read",
+    Subscribe = "Subscribe",
+    Unsubscribe = "Unsubscribe"
 }
-export declare class SensorReadCmd extends ButtplugDeviceMessage {
-    DeviceIndex: number;
-    SensorIndex: number;
-    SensorType: SensorType;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, SensorIndex: number, SensorType: SensorType, Id?: number);
+export interface DeviceFeatureInput {
+    Value: number[];
+    Command: InputCommandType[];
 }
-export declare class SensorReading extends ButtplugDeviceMessage {
-    DeviceIndex: number;
-    SensorIndex: number;
-    SensorType: SensorType;
-    Data: number[];
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, SensorIndex: number, SensorType: SensorType, Data: number[], Id?: number);
+export interface DeviceFeatureOutput {
+    Value: number;
+    Duration?: number;
 }
-export declare class RawReadCmd extends ButtplugDeviceMessage {
+export interface OutputCmd {
     DeviceIndex: number;
-    Endpoint: string;
-    ExpectedLength: number;
-    Timeout: number;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, Endpoint: string, ExpectedLength: number, Timeout: number, Id?: number);
+    FeatureIndex: number;
+    Command: {
+        [key: string]: DeviceFeatureOutput;
+    };
+    Id: number | undefined;
 }
-export declare class RawWriteCmd extends ButtplugDeviceMessage {
+export interface InputCmd {
     DeviceIndex: number;
-    Endpoint: string;
-    Data: Uint8Array;
-    WriteWithResponse: boolean;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, Endpoint: string, Data: Uint8Array, WriteWithResponse: boolean, Id?: number);
+    FeatureIndex: number;
+    Type: InputType;
+    Command: InputCommandType;
+    Id: number | undefined;
 }
-export declare class RawSubscribeCmd extends ButtplugDeviceMessage {
-    DeviceIndex: number;
-    Endpoint: string;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, Endpoint: string, Id?: number);
+export interface InputValue {
+    Value: number;
 }
-export declare class RawUnsubscribeCmd extends ButtplugDeviceMessage {
+export interface InputReading {
     DeviceIndex: number;
-    Endpoint: string;
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, Endpoint: string, Id?: number);
-}
-export declare class RawReading extends ButtplugDeviceMessage {
+    FeatureIndex: number;
+    Reading: {
+        [key: string]: InputValue;
+    };
+    Id: number | undefined;
+}
+export interface StopDeviceCmd {
+    Id: number | undefined;
     DeviceIndex: number;
-    Endpoint: string;
-    Data: number[];
-    Id: number;
-    static Name: string;
-    constructor(DeviceIndex: number, Endpoint: string, Data: number[], Id?: number);
 }