ObnizComponents | M5Stack.js

Hierarchy

ObnizParts
- ObnizComponents
  - ObnizSystemMethods

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ObnizComponents(id: any, options?: any): ObnizComponents

Overrides ObnizParts.constructor
- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:59
Parameters
- id: any
- Optional options: any
Returns ObnizComponents

Properties

_allComponentKeys

_allComponentKeys: any

_connectionRetryCount

_connectionRetryCount: number

_sendQueue

_sendQueue: any

_sendQueueTimer

_sendQueueTimer: any

_waitForLocalConnectReadyTimer

_waitForLocalConnectReadyTimer: any

bufferdAmoundWarnBytes

bufferdAmoundWarnBytes: number

connectionState

connectionState: "closed" | "connecting" | "connected" | "closing"

debugprint

debugprint: boolean

debugprintBinary

debugprintBinary: boolean

debugs

debugs: any

Optional display

display: Display

emitter

emitter: any

firmware_ver

firmware_ver: any

hw

hw: any

Optional i2c0

i2c0: PeripheralI2C

id

id: any

io

io: PeripheralDirective

Optional io0

io0: PeripheralIO

Optional io1

io1: PeripheralIO

Optional io10

io10: PeripheralIO

Optional io11

io11: PeripheralIO

Optional io2

io2: PeripheralIO

Optional io3

io3: PeripheralIO

Optional io4

io4: PeripheralIO

Optional io5

io5: PeripheralIO

Optional io6

io6: PeripheralIO

Optional io7

io7: PeripheralIO

Optional io8

io8: PeripheralIO

Optional io9

io9: PeripheralIO

isNode

isNode: boolean

Optional logicAnalyzer

logicAnalyzer: LogicAnalyzer

Optional measure

measure: ObnizMeasure

onConnectCalled

onConnectCalled: boolean

onclose

onclose: any

onconnect

onconnect: any

onopen

onopen: any

options

options: any

pongObservers

pongObservers: any

Optional pwm0

pwm0: PeripheralPWM

Optional pwm1

pwm1: PeripheralPWM

Optional pwm2

pwm2: PeripheralPWM

Optional pwm3

pwm3: PeripheralPWM

Optional pwm4

pwm4: PeripheralPWM

Optional pwm5

pwm5: PeripheralPWM

sendPool

sendPool: any

socket

socket: any

socket_local

socket_local: any

Optional spi0

spi0: PeripheralSPI

Optional spi1

spi1: PeripheralSPI

Optional switch

switch: ObnizSwitch

Optional uart0

uart0: PeripheralUART

Optional uart1

uart1: PeripheralUART

wscommand

wscommand: any

wscommands

wscommands: any

Accessors

Static WSCommand

get WSCommand(): WSCommand

Inherited from ObnizConnection.WSCommand
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:52
Returns WSCommand

Static version

get version(): any

Inherited from ObnizConnection.version
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:29
Returns any

Methods

_callOnConnect

_callOnConnect(): void

Overrides ObnizConnection._callOnConnect
- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:62
Returns void

_canConnectToInsecure

_canConnectToInsecure(): boolean

Inherited from ObnizConnection._canConnectToInsecure
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:49
Returns boolean

_connectLocal

_connectLocal(host: any): void

Inherited from ObnizConnection._connectLocal
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:38
Parameters
- host: any
Returns void

_disconnectLocal

_disconnectLocal(): void

Inherited from ObnizConnection._disconnectLocal
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:39
Returns void

_drainQueued

_drainQueued(): void

Inherited from ObnizConnection._drainQueued
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:47
Returns void

_getFreePeripheralUnit

_getFreePeripheralUnit(peripheral: any): any

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:72
Parameters
- peripheral: any
Returns any

_prepareComponents

_prepareComponents(): void

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:63
Returns void

_reconnect

_reconnect(): void

Inherited from ObnizConnection._reconnect
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:34
Returns void

_resetComponents

_resetComponents(): void

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:64
Returns void

_sendRouted

_sendRouted(data: any): void

Inherited from ObnizConnection._sendRouted
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:46
Parameters
- data: any
Returns void

addPongObserver

addPongObserver(callback: any): void

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:67
Parameters
- callback: any
Returns void

binary2Json

binary2Json(binary: any): any

Inherited from ObnizConnection.binary2Json
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:53
Parameters
- binary: any
Returns any

clearSocket

clearSocket(socket: any): void

Inherited from ObnizConnection.clearSocket
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:40
Parameters
- socket: any
Returns void

close

close(): void

Overrides ObnizConnection.close
- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:61
Returns void

connect

connect(): void

Inherited from ObnizConnection.connect
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:41
Returns void

connectWait

connectWait(option: any): Promise<unknown>

Inherited from ObnizConnection.connectWait
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:33
Parameters
- option: any
Returns Promise<unknown>

error

error(msg: any): void

Inherited from ObnizConnection.error
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:55
Parameters
- msg: any
Returns void

getAD

getAD(io: number): PeripheralAD

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:71
Parameters
- io: number
Returns PeripheralAD

getFreeI2C

getFreeI2C(): PeripheralI2C

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:74
Returns PeripheralI2C

getFreePwm

getFreePwm(): PeripheralPWM

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:73
Returns PeripheralPWM

getFreeSpi

getFreeSpi(): PeripheralSPI

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:76
Returns PeripheralSPI

getFreeTcp

getFreeTcp(): any

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:79
Returns any

getFreeUart

getFreeUart(): PeripheralUART

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:78
Returns PeripheralUART

getI2CWithConfig

getI2CWithConfig(config: any): PeripheralI2C

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:75
Parameters
- config: any
Returns PeripheralI2C

getIO

getIO(io: number): PeripheralIO

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:70
Parameters
- io: number
Returns PeripheralIO

getSpiWithConfig

getSpiWithConfig(config: any): PeripheralSPI

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:77
Parameters
- config: any
Returns PeripheralSPI

handleSystemCommand

handleSystemCommand(wsObj: any): void

Overrides ObnizConnection.handleSystemCommand
- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:66
Parameters
- wsObj: any
Returns void

handleWSCommand

handleWSCommand(wsObj: any): void

Inherited from ObnizConnection.handleWSCommand
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:50
Parameters
- wsObj: any
Returns void

isValidIO

isValidIO(io: any): boolean

Inherited from ObnizParts.isValidIO
- Defined in node_modules/obniz/dist/src/obniz/ObnizParts.d.ts:8
Parameters
- io: any
Returns boolean

notifyToModule

notifyToModule(obj: any): void

Overrides ObnizConnection.notifyToModule
- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:65
Parameters
- obj: any
Returns void

print_debug

print_debug(str: any): void

Inherited from ObnizConnection.print_debug
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:44
Parameters
- str: any
Returns void

prompt

prompt(filled: any, callback: any): void

Inherited from ObnizConnection.prompt
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:28
Parameters
- filled: any
- callback: any
Returns void

removePongObserver

removePongObserver(callback: any): void

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:68
Parameters
- callback: any
Returns void

send

send(obj: any, options?: any): void

Inherited from ObnizConnection.send
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:45
Parameters
- obj: any
- Optional options: any
Returns void

setVccGnd

setVccGnd(vcc: number | null, gnd: number | null, drive: DriveType): void

- Defined in node_modules/obniz/dist/src/obniz/ObnizComponents.d.ts:69
Parameters
- vcc: number | null
- gnd: number | null
- drive: DriveType
Returns void

warning

warning(msg: any): void

Inherited from ObnizConnection.warning
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:54
Parameters
- msg: any
Returns void

wired

wired<K>(partsname: K, options?: undefined | WiredNameOptionsMap[K]): WiredNameMap[K]

Inherited from ObnizParts.wired
- Defined in node_modules/obniz/dist/src/obniz/ObnizParts.d.ts:9
Type parameters
- K: keyof WiredNameMap
Parameters
- partsname: K
- Optional options: undefined | WiredNameOptionsMap[K]
Returns WiredNameMap[K]

wsOnClose

wsOnClose(event: any): void

Inherited from ObnizConnection.wsOnClose
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:32
Parameters
- event: any
Returns void

wsOnError

wsOnError(event: any): void

Inherited from ObnizConnection.wsOnError
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:35
Parameters
- event: any
Returns void

wsOnMessage

wsOnMessage(data: any): void

Inherited from ObnizConnection.wsOnMessage
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:31
Parameters
- data: any
Returns void

wsOnOpen

wsOnOpen(): void

Inherited from ObnizConnection.wsOnOpen
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:30
Returns void

wsOnUnexpectedResponse

wsOnUnexpectedResponse(req: any, res?: any): void

Inherited from ObnizConnection.wsOnUnexpectedResponse
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:36
Parameters
- req: any
- Optional res: any
Returns void

wsconnect

wsconnect(desired_server?: any): void

Inherited from ObnizConnection.wsconnect
- Defined in node_modules/obniz/dist/src/obniz/ObnizConnection.d.ts:37
Parameters
- Optional desired_server: any
Returns void

Static Parts

Parts(name: any): any

Inherited from ObnizParts.Parts
- Defined in node_modules/obniz/dist/src/obniz/ObnizParts.d.ts:6
Parameters
- name: any
Returns any

Static PartsRegistrate

PartsRegistrate(arg0: any, arg1?: any): void

Inherited from ObnizParts.PartsRegistrate
- Defined in node_modules/obniz/dist/src/obniz/ObnizParts.d.ts:5
Parameters
- arg0: any
- Optional arg1: any
Returns void

Static _parts

_parts(): any

Inherited from ObnizParts._parts
- Defined in node_modules/obniz/dist/src/obniz/ObnizParts.d.ts:4
Returns any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: any

Optional options: any

Returns ObnizComponents

Properties

_allComponentKeys

_connectionRetryCount

_sendQueue

_sendQueueTimer

_waitForLocalConnectReadyTimer

Optional ad0

Optional ad1

Optional ad10

Optional ad11

Optional ad2

Optional ad3

Optional ad4

Optional ad5

Optional ad6

Optional ad7

Optional ad8

Optional ad9

Optional ble

bufferdAmoundWarnBytes

connectionState

debugprint

debugprintBinary

debugs

Optional display

emitter

firmware_ver

hw

Optional i2c0

id

io

Optional io0

Optional io1

Optional io10

Optional io11

Optional io2

Optional io3

Optional io4

Optional io5

Optional io6

Optional io7

Optional io8

Optional io9

isNode

Optional logicAnalyzer

Optional measure

onConnectCalled

onclose

onconnect

onopen

options

pongObservers

Optional pwm0

Optional pwm1

Optional pwm2

Optional pwm3

Optional pwm4

Optional pwm5

sendPool

socket

socket_local

Optional spi0

Optional spi1

Optional switch

Optional uart0

Optional uart1

wscommand

wscommands