Class UnknownDevice

Represents an unknown device.

Hierarchy (View Summary)

Device<string, Record<string, any>>
- UnknownDevice

Index

Constructors

constructor

new UnknownDevice(restClient: RestClient, serialNumber: string): UnknownDevice
Parameters
- restClient: RestClient
- serialNumber: string
Returns UnknownDevice
Inherited from Device.constructor
- Defined in rest-client/src/lib/devices/Device.ts:10

Properties

`Protected`restClient

restClient: RestClient

`Readonly`sn

sn: string

Methods

getProperties

getProperties(): Promise<Record<string, any>>
Retrieves the properties of the device asynchronously.

Returns Promise<Record<string, any>>
Inherited from Device.getProperties
- Defined in rest-client/src/lib/devices/Device.ts:32

getProperty

getProperty<K extends string>(property: K): Promise<any>
Retrieves the specified property of a device, if present.
Type Parameters
- K extends string
Parameters
- property: K
Returns Promise<any>
Inherited from Device.getProperty
- Defined in rest-client/src/lib/devices/Device.ts:40

`Protected`parseProperties

parseProperties(data: any): any
Simply return the data as is as we don't know the device hence the properties as well.
Parameters
- data: any
Returns any
Overrides Device.parseProperties
- Defined in rest-client/src/lib/devices/UnknownDevice.ts:10

`Protected`sendCommand

sendCommand(
    payload: any,
    schema: ZodTypeAny,
): Promise<
    | {
        code: "0";
        eagleEyeTraceId: string;
        message: "Success";
        tid: string;
    }
    | { code: string; eagleEyeTraceId: string; message: string; tid: string },
>
Sends a command with the given payload.
Parameters
- payload: any
- schema: ZodTypeAny
Returns Promise<
    | {
        code: "0";
        eagleEyeTraceId: string;
        message: "Success";
        tid: string;
    }
    | { code: string; eagleEyeTraceId: string; message: string; tid: string },
>
Inherited from Device.sendCommand
- Defined in rest-client/src/lib/devices/Device.ts:25

Class UnknownDevice

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UnknownDevice

Properties

`Protected`restClient

`Readonly`sn

Methods

getProperties

Returns Promise<Record<string, any>>

getProperty

Type Parameters

Parameters

Returns Promise<any>

`Protected`parseProperties

Parameters

Returns any

`Protected`sendCommand

Parameters

Returns Promise<
    | {
        code: "0";
        eagleEyeTraceId: string;
        message: "Success";
        tid: string;
    }
    | { code: string; eagleEyeTraceId: string; message: string; tid: string },
>

Settings

On This Page

Class UnknownDevice

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UnknownDevice

Properties

ProtectedrestClient

Readonlysn

Methods

getProperties

Returns Promise<Record<string, any>>

getProperty

Type Parameters

Parameters

Returns Promise<any>

ProtectedparseProperties

Parameters

Returns any

ProtectedsendCommand

Parameters

Returns Promise< | { code: "0"; eagleEyeTraceId: string; message: "Success"; tid: string; } | { code: string; eagleEyeTraceId: string; message: string; tid: string },>

Settings

On This Page

`Protected`restClient

`Readonly`sn

`Protected`parseProperties

`Protected`sendCommand

Returns Promise<
| {
code: "0";
eagleEyeTraceId: string;
message: "Success";
tid: string;
}
| { code: string; eagleEyeTraceId: string; message: string; tid: string },
>