Class WSCommandSystem

Hierarchy

WSCommand
- WSCommandSystem

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new WSCommandSystem(): WSCommandSystem

Overrides WSCommand.constructor
- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:17
Returns WSCommandSystem

Properties

COMMAND_FUNC_ID_ERROR

COMMAND_FUNC_ID_ERROR: number

WSCommandNotFoundError

WSCommandNotFoundError: any

_CommandPingPong

_CommandPingPong: any

_CommandReboot

_CommandReboot: any

_CommandReset

_CommandReset: any

_CommandResetOnDisconnect

_CommandResetOnDisconnect: any

_CommandSelfCheck

_CommandSelfCheck: any

_CommandSleepIoTrigger

_CommandSleepIoTrigger: any

_CommandSleepMinute

_CommandSleepMinute: any

_CommandSleepSeconds

_CommandSleepSeconds: any

_CommandVCC

_CommandVCC: any

_CommandWait

_CommandWait: any

_hw

_hw: any

envelopWarning

envelopWarning: any

ioNotUsed

ioNotUsed: number

module

module: any

sendCommand

sendCommand: any

validateCommandSchema

validateCommandSchema: any

Accessors

Static CommandClasses

get CommandClasses(): any

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

Static schema

get schema(): WSSchema.TV4

Inherited from WSCommand.schema
- 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

Inherited from WSCommand._filterSchema
- 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

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

filter

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

Inherited from WSCommand.filter
- 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

Inherited from WSCommand.getSchema
- 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

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

keepWorkingAtOffline

keepWorkingAtOffline(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:23
Parameters
- params: any
Returns void

notifyFromBinary

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

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

onlyTypeErrorMessage

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

Inherited from WSCommand.onlyTypeErrorMessage
- 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

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

ping

ping(params: any): void

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

pong

pong(objToSend: any, payload: any): void

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

reboot

reboot(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:19
Parameters
- params: any
Returns void

reset

reset(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:20
Parameters
- params: any
Returns void

resetOnDisconnect

resetOnDisconnect(mustReset: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:25
Parameters
- mustReset: any
Returns void

selfCheck

selfCheck(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:21
Parameters
- params: any
Returns void

setHw

setHw(obj: any): void

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

sleepIoTrigger

sleepIoTrigger(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:31
Parameters
- params: any
Returns void

sleepMinute

sleepMinute(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:30
Parameters
- params: any
Returns void

sleepSeconds

sleepSeconds(params: any): void

- Defined in node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandSystem.d.ts:29
Parameters
- params: any
Returns void

validate

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

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

wait

wait(params: any): void

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

Static addCommandClass

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

Inherited from WSCommand.addCommandClass
- 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

Inherited from WSCommand.compress
- 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

Inherited from WSCommand.dequeueOne
- 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

Inherited from WSCommand.framed
- 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