Search
Preparing search index...
The search index is not available
M5Stack.js
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"node_modules/obniz/dist/src/obniz/libs/wscommand/WSCommandDirective.d"
WSCommandDirective
Class WSCommandDirective
Hierarchy
WSCommand
WSCommandDirective
Index
Constructors
constructor
Properties
COMMAND_
FUNC_
ID_
ERROR
_
Command
Notify
_
Command
Pause
_
Command
Registrate
_
Command
Resume
_hw
available
Commands
io
Not
Used
module
Accessors
WSCommand
Not
Found
Error
Command
Classes
schema
Methods
_filter
Schema
change
State
envelop
Error
envelop
Warning
filter
get
Schema
init
is
ValidIO
notify
From
Binary
only
Type
Error
Message
parse
From
Json
send
Command
set
Hw
validate
validate
Command
Schema
add
Command
Class
compress
dequeue
One
framed
Constructors
constructor
new WSCommand
Directive
(
)
:
WSCommandDirective
Returns
WSCommandDirective
Properties
COMMAND_
FUNC_
ID_
ERROR
COMMAND_
FUNC_
ID_
ERROR
:
number
Protected
_
Command
Notify
_
Command
Notify
:
number
Protected
_
Command
Pause
_
Command
Pause
:
number
Protected
_
Command
Registrate
_
Command
Registrate
:
number
Protected
_
Command
Resume
_
Command
Resume
:
number
_hw
_hw
:
any
available
Commands
available
Commands
:
any
io
Not
Used
io
Not
Used
:
number
Protected
module
module
:
number
Accessors
WSCommand
Not
Found
Error
get
WSCommandNotFoundError
(
)
:
WSCommandNotFoundError
Returns
WSCommandNotFoundError
Static
Command
Classes
get
CommandClasses
(
)
:
any
Returns
any
Static
schema
get
schema
(
)
:
WSSchema.TV4
Returns
WSSchema.TV4
Methods
_filter
Schema
_filter
Schema
(
schema
:
any
, json
:
any
)
:
any
Parameters
schema:
any
json:
any
Returns
any
change
State
change
State
(
params
:
any
)
:
void
Parameters
params:
any
Returns
void
envelop
Error
envelop
Error
(
objToSend
:
any
, module_key
:
any
, obj
:
any
)
:
void
Parameters
objToSend:
any
module_key:
any
obj:
any
Returns
void
envelop
Warning
envelop
Warning
(
objToSend
:
any
, module_key
:
any
, obj
:
any
)
:
void
Parameters
objToSend:
any
module_key:
any
obj:
any
Returns
void
filter
filter
(
commandUri
:
any
, json
:
any
)
:
any
Parameters
commandUri:
any
json:
any
Returns
any
get
Schema
get
Schema
(
uri
:
any
)
:
WSSchema.JsonSchema
Parameters
uri:
any
Returns
WSSchema.JsonSchema
init
init
(
params
:
any
, originalParams
:
any
)
:
void
Parameters
params:
any
originalParams:
any
Returns
void
is
ValidIO
is
ValidIO
(
io
:
any
)
:
boolean
Parameters
io:
any
Returns
boolean
notify
From
Binary
notify
From
Binary
(
objToSend
:
any
, func
:
any
, payload
:
any
)
:
void
Parameters
objToSend:
any
func:
any
payload:
any
Returns
void
only
Type
Error
Message
only
Type
Error
Message
(
validateError
:
any
, rootPath
:
any
)
:
any
Parameters
validateError:
any
rootPath:
any
Returns
any
parse
From
Json
parse
From
Json
(
json
:
any
)
:
void
Parameters
json:
any
Returns
void
send
Command
send
Command
(
func
:
any
, payload
:
any
)
:
void
Parameters
func:
any
payload:
any
Returns
void
set
Hw
set
Hw
(
obj
:
any
)
:
void
Parameters
obj:
any
Returns
void
validate
validate
(
commandUri
:
any
, json
:
any
)
:
WSSchema.MultiResult
Parameters
commandUri:
any
json:
any
Returns
WSSchema.MultiResult
validate
Command
Schema
validate
Command
Schema
(
uriList
:
any
, json
:
any
, rootPath
:
any
, customArg
:
any
)
:
any
Parameters
uriList:
any
json:
any
rootPath:
any
customArg:
any
Returns
any
Static
add
Command
Class
add
Command
Class
(
name
:
any
, classObj
:
any
)
:
void
Parameters
name:
any
classObj:
any
Returns
void
Static
compress
compress
(
wscommands
:
any
, json
:
any
)
:
Uint8Array
|
null
Parameters
wscommands:
any
json:
any
Returns
Uint8Array
|
null
Static
dequeue
One
dequeue
One
(
buf
:
any
)
:
object
|
null
Parameters
buf:
any
Returns
object
|
null
Static
framed
framed
(
module
:
any
, func
:
any
, payload
:
any
)
:
Uint8Array
Parameters
module:
any
func:
any
payload:
any
Returns
Uint8Array
Globals
"node_
modules/obniz/dist/src/obniz/libs/wscommand/WSCommand
Directive.d"
WSCommand
Directive
constructor
COMMAND_
FUNC_
ID_
ERROR
_
Command
Notify
_
Command
Pause
_
Command
Registrate
_
Command
Resume
_hw
available
Commands
io
Not
Used
module
WSCommand
Not
Found
Error
Command
Classes
schema
_filter
Schema
change
State
envelop
Error
envelop
Warning
filter
get
Schema
init
is
ValidIO
notify
From
Binary
only
Type
Error
Message
parse
From
Json
send
Command
set
Hw
validate
validate
Command
Schema
add
Command
Class
compress
dequeue
One
framed
Generated using
TypeDoc