M5StickC | M5Stack.js

Hierarchy

Obniz
- M5StickC

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new M5StickC(id: string, options?: any): M5StickC

Overrides Obniz.constructor
- Defined in src/m5stickc.ts:38
Parameters
- id: string
- Optional options: any
Returns M5StickC

Properties

_allComponentKeys

_allComponentKeys: any

_connectionRetryCount

_connectionRetryCount: number

_sendQueue

_sendQueue: any

_sendQueueTimer

_sendQueueTimer: any

_waitForLocalConnectReadyTimer

_waitForLocalConnectReadyTimer: any

bufferdAmoundWarnBytes

bufferdAmoundWarnBytes: number

Optional buttonA

buttonA: Button

Optional buttonB

buttonB: Button

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

Optional imu

imu: MPU6886 | SH200Q

io

io: PeripheralDirective

Optional io0

io0: PeripheralIO

Optional io1

io1: PeripheralIO

Optional io10

io10: PeripheralIO

Optional io11

io11: PeripheralIO

Optional io13

io13: IO

Optional io15

io15: IO

Optional io18

io18: IO

Optional io2

io2: PeripheralIO

Optional io23

io23: IO

Optional io26

io26: IO

Optional io3

io3: PeripheralIO

Optional io32

io32: IO

Optional io33

io33: IO

Optional io34

io34: IO

Optional io36

io36: IO

Optional io4

io4: PeripheralIO

Optional io5

io5: PeripheralIO

Optional io6

io6: PeripheralIO

Optional io7

io7: PeripheralIO

Optional io8

io8: PeripheralIO

Optional io9

io9: PeripheralIO

Optional ir

ir: InfraredLED

isNode

isNode: any

Optional led

led: LED

Optional logicAnalyzer

logicAnalyzer: LogicAnalyzer

looper

looper: any

Optional m5display

m5display: ST7735S

Optional m5i2c

m5i2c: I2C

Optional measure

measure: ObnizMeasure

onConnectCalled

onConnectCalled: any

onclose

onclose: any

onconnect

onconnect: any

ondebug

ondebug: any

onmessage

onmessage: 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

repeatInterval

repeatInterval: any

send

send: any

sendPool

sendPool: any

showAlertUI

showAlertUI: 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

util

util: any

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 api

get api(): ObnizApi

Inherited from Obniz.api
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:35
Returns ObnizApi

Static version

get version(): any

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

Methods

Private _addToAllComponentKeys

_addToAllComponentKeys(): void

- Defined in src/m5stickc.ts:135
Returns void

_callOnConnect

_callOnConnect(): void

Inherited from Obniz._callOnConnect

Overrides ObnizUIs._callOnConnect
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:26
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 ObnizUIs._disconnectLocal

Overrides ObnizConnection._disconnectLocal
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:14
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

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

Private _methodSwith

_methodSwith(obj: any, func1: string, func2: string): void

- Defined in src/m5stickc.ts:128
Parameters
- obj: any
- func1: string
- func2: string
Returns void

_prepareComponents

_prepareComponents(): void

Overrides ObnizComponents._prepareComponents
- Defined in src/m5stickc.ts:45
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

Inherited from ObnizComponents._resetComponents
- 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

accelerationWait

accelerationWait(): Promise<object>

- Defined in src/m5stickc.ts:85
Returns Promise<object>

addPongObserver

addPongObserver(callback: any): void

Inherited from ObnizComponents.addPongObserver
- 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

Inherited from ObnizUIs.close

Overrides ObnizComponents.close
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:13
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 Obniz.error

Overrides ObnizConnection.error
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:30
Parameters
- msg: any
Returns void

getAD

getAD(io: number): PeripheralAD

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

getDebugDoms

getDebugDoms(): object | undefined

Inherited from ObnizUIs.getDebugDoms
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:7
Returns object | undefined

getFreeI2C

getFreeI2C(): PeripheralI2C

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

getFreePwm

getFreePwm(): PeripheralPWM

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

getFreeSpi

getFreeSpi(): PeripheralSPI

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

getFreeTcp

getFreeTcp(): any

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

getFreeUart

getFreeUart(): PeripheralUART

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

getI2CWithConfig

getI2CWithConfig(config: any): PeripheralI2C

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

getIO

getIO(io: number): PeripheralIO

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

getSpiWithConfig

getSpiWithConfig(config: any): PeripheralSPI

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

gyroWait

gyroWait(): Promise<object>

- Defined in src/m5stickc.ts:77
Returns Promise<object>

handleSystemCommand

handleSystemCommand(wsObj: any): void

Inherited from ObnizComponents.handleSystemCommand

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

isValidObnizId

isValidObnizId(str: string): boolean | null

Inherited from ObnizUIs.isValidObnizId
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:4
Parameters
- str: string
Returns boolean | null

keepWorkingAtOffline

keepWorkingAtOffline(working: any): void

Inherited from ObnizSystemMethods.keepWorkingAtOffline
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:8
Parameters
- working: any
Returns void

loop

loop(): Promise<void>

Inherited from Obniz.loop
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:25
Returns Promise<void>

message

message(target: any, message: any): void

Inherited from Obniz.message
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:27
Parameters
- target: any
- message: any
Returns void

notifyToModule

notifyToModule(obj: any): void

Inherited from Obniz.notifyToModule

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

pingWait

pingWait(unixtime?: any, rand?: any, forceGlobalNetwork?: any): Promise<unknown>

Inherited from ObnizSystemMethods.pingWait
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:14
Parameters
- Optional unixtime: any
- Optional rand: any
- Optional forceGlobalNetwork: any
Returns Promise<unknown>

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

reboot

reboot(): void

Inherited from ObnizSystemMethods.reboot
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:6
Returns void

removePongObserver

removePongObserver(callback: any): void

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

repeat

repeat(callback: any, interval: any): void

Inherited from Obniz.repeat
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:24
Parameters
- callback: any
- interval: any
Returns void

reset

reset(): void

Inherited from ObnizSystemMethods.reset
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:5
Returns void

resetOnDisconnect

resetOnDisconnect(reset: any): void

Inherited from ObnizSystemMethods.resetOnDisconnect
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:9
Parameters
- reset: any
Returns void

selfCheck

selfCheck(): void

Inherited from ObnizSystemMethods.selfCheck
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:7
Returns void

setVccGnd

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

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

Private setupIMUWait

setupIMUWait(imuName?: "MPU6886" | "SH200Q"): Promise<MPU6886 | SH200Q>

- Defined in src/m5stickc.ts:93
Parameters
- Default value imuName: "MPU6886" | "SH200Q" = "MPU6886"
Returns Promise<MPU6886 | SH200Q>

showOffLine

showOffLine(): void

Inherited from ObnizUIs.showOffLine
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:17
Returns void

showOnLine

showOnLine(isConnectedLocally: any): void

Inherited from ObnizUIs.showOnLine
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:16
Parameters
- isConnectedLocally: any
Returns void

sleep

sleep(date: any): void

Inherited from ObnizSystemMethods.sleep
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:12
Parameters
- date: any
Returns void

sleepIoTrigger

sleepIoTrigger(trigger: any): void

Inherited from ObnizSystemMethods.sleepIoTrigger
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:13
Parameters
- trigger: any
Returns void

sleepMinute

sleepMinute(minute: any): void

Inherited from ObnizSystemMethods.sleepMinute
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:11
Parameters
- minute: any
Returns void

sleepSeconds

sleepSeconds(sec: any): void

Inherited from ObnizSystemMethods.sleepSeconds
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:10
Parameters
- sec: any
Returns void

updateOnlineUI

updateOnlineUI(): void

Inherited from ObnizUIs.updateOnlineUI
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:15
Returns void

wait

wait(msec: any): Promise<unknown>

Inherited from ObnizSystemMethods.wait
- Defined in node_modules/obniz/dist/src/obniz/ObnizSystemMethods.d.ts:4
Parameters
- msec: any
Returns Promise<unknown>

warning

warning(msg: any): void

Inherited from Obniz.warning

Overrides ObnizConnection.warning
- Defined in node_modules/obniz/dist/src/obniz/index.d.ts:29
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 ObnizUIs.wsconnect

Overrides ObnizConnection.wsconnect
- Defined in node_modules/obniz/dist/src/obniz/ObnizUIs.d.ts:5
Parameters
- 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: string

Optional options: any

Returns M5StickC

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 axp

Optional ble

bufferdAmoundWarnBytes

Optional buttonA

Optional buttonB

connectionState

debugprint

debugprintBinary

debugs

Optional display

emitter

firmware_ver

hw

Optional i2c0

id

Optional imu

io

Optional io0

Optional io1

Optional io10

Optional io11

Optional io13

Optional io15

Optional io18

Optional io2

Optional io23

Optional io26

Optional io3

Optional io32

Optional io33

Optional io34

Optional io36

Optional io4

Optional io5

Optional io6

Optional io7

Optional io8

Optional io9

Optional ir

isNode

Optional led

Optional logicAnalyzer

looper

Optional m5display

Optional m5i2c

Optional measure

onConnectCalled

onclose

onconnect

ondebug