Class WSCommand

Hierarchy

WSCommand

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WSCommand(): WSCommand

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:20
Returns WSCommand

Properties

COMMAND_FUNC_ID_ERROR

COMMAND_FUNC_ID_ERROR: number

_hw

_hw: any

ioNotUsed

ioNotUsed: number

Protected Abstract module

module: number

Private Optional parsed

parsed: any

Accessors

WSCommandNotFoundError

get WSCommandNotFoundError(): WSCommandNotFoundError

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:6
Returns WSCommandNotFoundError

Static CommandClasses

get CommandClasses(): any

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:5
Returns any

Static schema

get schema(): WSSchema.TV4

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:4
Returns WSSchema.TV4

Methods

_filterSchema

_filterSchema(schema: any, json: any): any

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:34
Parameters
- schema: any
- json: any
Returns any

envelopError

envelopError(objToSend: any, module_key: any, obj: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:27
Parameters
- objToSend: any
- module_key: any
- obj: any
Returns void

envelopWarning

envelopWarning(objToSend: any, module_key: any, obj: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:26
Parameters
- objToSend: any
- module_key: any
- obj: any
Returns void

filter

filter(commandUri: any, json: any): any

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:33
Parameters
- commandUri: any
- json: any
Returns any

getSchema

getSchema(uri: any): WSSchema.JsonSchema

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:29
Parameters
- uri: any
Returns WSSchema.JsonSchema

isValidIO

isValidIO(io: any): boolean

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:28
Parameters
- io: any
Returns boolean

notifyFromBinary

notifyFromBinary(objToSend: any, func: any, payload: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:25
Parameters
- objToSend: any
- func: any
- payload: any
Returns void

onlyTypeErrorMessage

onlyTypeErrorMessage(validateError: any, rootPath: any): any

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:32
Parameters
- validateError: any
- rootPath: any
Returns any

parseFromJson

parseFromJson(json: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:24
Parameters
- json: any
Returns void

sendCommand

sendCommand(func: any, payload: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:23
Parameters
- func: any
- payload: any
Returns void

setHw

setHw(obj: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:22
Parameters
- obj: any
Returns void

validate

validate(commandUri: any, json: any): WSSchema.MultiResult

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:31
Parameters
- commandUri: any
- json: any
Returns WSSchema.MultiResult

validateCommandSchema

validateCommandSchema(uriList: any, json: any, rootPath: any, customArg: any): any

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:30
Parameters
- uriList: any
- json: any
- rootPath: any
- customArg: any
Returns any

Static addCommandClass

addCommandClass(name: any, classObj: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:7
Parameters
- name: any
- classObj: any
Returns void

Static compress

compress(wscommands: any, json: any): Uint8Array | null

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:15
Parameters
- wscommands: any
- json: any
Returns Uint8Array | null

Static dequeueOne

dequeueOne(buf: any): object | null

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:9
Parameters
- buf: any
Returns object | null

Static framed

framed(module: any, func: any, payload: any): Uint8Array

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommand.d.ts:8
Parameters
- module: any
- func: any
- payload: any
Returns Uint8Array

Generated using TypeDoc