Search
Preparing search index...
The search index is not available
M5Stack.js
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"src/m5stack"
M5Stack
Class M5Stack
Hierarchy
Obniz
M5Stack
Index
Constructors
constructor
Properties
ad0
ad1
ad10
ad11
ad2
ad3
ad4
ad5
ad6
ad7
ad8
ad9
ble
buttonA
buttonB
buttonC
connection
State
debugprint
display
hasIMU
i2c0
io
io0
io1
io10
io11
io12
io13
io14
io15
io16
io17
io18
io19
io2
io21
io22
io23
io25
io26
io27
io3
io32
io33
io34
io35
io36
io39
io4
io5
io6
io7
io8
io9
logic
Analyzer
m5display
m5i2c
measure
mpu9250
onclose
onconnect
pwm0
pwm1
pwm2
pwm3
pwm4
pwm5
spi0
spi1
switch
uart0
uart1
util
Obniz
Methods
_prepare
Components
acceleration
Wait
close
connect
connect
Wait
getAD
get
Free
I2C
get
Free
Pwm
get
Free
Spi
get
Free
Uart
getIO
gyro
Wait
is
ValidIO
keep
Working
AtOffline
repeat
reset
reset
OnDisconnect
set
Vcc
Gnd
setupIMU
wait
wired
Constructors
constructor
new
M5Stack
(
id
:
string
, options
?:
any
)
:
M5Stack
Parameters
id:
string
Optional
options:
any
Returns
M5Stack
Properties
ad0
ad0
:
AD
ad1
ad1
:
AD
ad10
ad10
:
AD
ad11
ad11
:
AD
ad2
ad2
:
AD
ad3
ad3
:
AD
ad4
ad4
:
AD
ad5
ad5
:
AD
ad6
ad6
:
AD
ad7
ad7
:
AD
ad8
ad8
:
AD
ad9
ad9
:
AD
ble
ble
:
any
Optional
buttonA
buttonA
:
Button
Optional
buttonB
buttonB
:
Button
Optional
buttonC
buttonC
:
Button
connection
State
connection
State
:
ConnectionState
debugprint
debugprint
:
boolean
display
display
:
Display
Private
hasIMU
hasIMU
:
boolean
= false
i2c0
i2c0
:
I2C
io
io
:
any
io0
io0
:
IO
io1
io1
:
IO
io10
io10
:
IO
io11
io11
:
IO
Optional
io12
io12
:
IO
Optional
io13
io13
:
IO
Optional
io14
io14
:
IO
Optional
io15
io15
:
IO
Optional
io16
io16
:
IO
Optional
io17
io17
:
IO
Optional
io18
io18
:
IO
Optional
io19
io19
:
IO
io2
io2
:
IO
Optional
io21
io21
:
IO
Optional
io22
io22
:
IO
Optional
io23
io23
:
IO
Optional
io25
io25
:
IO
Optional
io26
io26
:
IO
Optional
io27
io27
:
IO
io3
io3
:
IO
Optional
io32
io32
:
IO
Optional
io33
io33
:
IO
Optional
io34
io34
:
IO
Optional
io35
io35
:
IO
Optional
io36
io36
:
IO
Optional
io39
io39
:
IO
io4
io4
:
IO
io5
io5
:
IO
io6
io6
:
IO
io7
io7
:
IO
io8
io8
:
IO
io9
io9
:
IO
logic
Analyzer
logic
Analyzer
:
any
Optional
m5display
m5display
:
M5Display
Optional
m5i2c
m5i2c
:
I2C
measure
measure
:
any
Private
Optional
mpu9250
mpu9250
:
Mpu9250
onclose
onclose
:
function
Type declaration
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
onconnect
onconnect
:
function
Type declaration
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
pwm0
pwm0
:
PWM
pwm1
pwm1
:
PWM
pwm2
pwm2
:
PWM
pwm3
pwm3
:
PWM
pwm4
pwm4
:
PWM
pwm5
pwm5
:
PWM
spi0
spi0
:
SPI
spi1
spi1
:
SPI
switch
switch
:
any
uart0
uart0
:
UART
uart1
uart1
:
UART
util
util
:
any
Static
Obniz
Obniz
:
ObnizConstructor
Methods
_prepare
Components
_prepare
Components
(
)
:
void
Returns
void
acceleration
Wait
acceleration
Wait
(
)
:
Promise
<
Xyz
>
Returns
Promise
<
Xyz
>
close
close
(
)
:
void
Returns
void
connect
connect
(
)
:
void
Returns
void
connect
Wait
connect
Wait
(
options
?:
ConnectOptions
)
:
Promise
<
boolean
>
Parameters
Optional
options:
ConnectOptions
Returns
Promise
<
boolean
>
getAD
getAD
(
pin
:
number
)
:
AD
Parameters
pin:
number
Returns
AD
get
Free
I2C
get
Free
I2C
(
)
:
I2C
Returns
I2C
get
Free
Pwm
get
Free
Pwm
(
)
:
PWM
Returns
PWM
get
Free
Spi
get
Free
Spi
(
)
:
SPI
Returns
SPI
get
Free
Uart
get
Free
Uart
(
)
:
UART
Returns
UART
getIO
getIO
(
pin
:
number
)
:
IO
Parameters
pin:
number
Returns
IO
gyro
Wait
gyro
Wait
(
)
:
Promise
<
Xyz
>
Returns
Promise
<
Xyz
>
is
ValidIO
is
ValidIO
(
io
:
any
)
:
boolean
Parameters
io:
any
Returns
boolean
keep
Working
AtOffline
keep
Working
AtOffline
(
working
:
boolean
)
:
void
Parameters
working:
boolean
Returns
void
repeat
repeat
(
callback
:
function
)
:
void
Parameters
callback:
function
(
)
:
void
Returns
void
Returns
void
reset
reset
(
)
:
void
Returns
void
reset
OnDisconnect
reset
OnDisconnect
(
reset
:
boolean
)
:
void
Parameters
reset:
boolean
Returns
void
set
Vcc
Gnd
set
Vcc
Gnd
(
vcc
:
number
, gnd
:
number
, drive
:
DriveType
)
:
void
Parameters
vcc:
number
gnd:
number
drive:
DriveType
Returns
void
setupIMU
setupIMU
(
)
:
void
Returns
void
wait
wait
(
time
:
number
)
:
Promise
<
void
>
Parameters
time:
number
Returns
Promise
<
void
>
wired
wired<K>
(
name
:
K
, options
?:
undefined
|
WiredNameOptionsMap[K]
)
:
WiredNameMap[K]
Type parameters
K
:
keyof WiredNameMap
Parameters
name:
K
Optional
options:
undefined
|
WiredNameOptionsMap[K]
Returns
WiredNameMap[K]
Globals
"src/m5stack"
M5
Stack
constructor
ad0
ad1
ad10
ad11
ad2
ad3
ad4
ad5
ad6
ad7
ad8
ad9
ble
buttonA
buttonB
buttonC
connection
State
debugprint
display
hasIMU
i2c0
io
io0
io1
io10
io11
io12
io13
io14
io15
io16
io17
io18
io19
io2
io21
io22
io23
io25
io26
io27
io3
io32
io33
io34
io35
io36
io39
io4
io5
io6
io7
io8
io9
logic
Analyzer
m5display
m5i2c
measure
mpu9250
onclose
onconnect
pwm0
pwm1
pwm2
pwm3
pwm4
pwm5
spi0
spi1
switch
uart0
uart1
util
Obniz
_prepare
Components
acceleration
Wait
close
connect
connect
Wait
getAD
get
Free
I2C
get
Free
Pwm
get
Free
Spi
get
Free
Uart
getIO
gyro
Wait
is
ValidIO
keep
Working
AtOffline
repeat
reset
reset
OnDisconnect
set
Vcc
Gnd
setupIMU
wait
wired
Generated using
TypeDoc