Search
Preparing search index...
The search index is not available
obniz
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
Parts
AK8963
AK8963
Class AK8963
Hierarchy
I2cCompassAbstract
AK8963
Implements
ObnizPartsInterface
Index
Constructors
constructor
Properties
address
i2cinfo
keys
params
required
Keys
Methods
char2short
clear
Flag
Wait
get
Adc
Array
Wait
get
Adc
Wait
get
Array
Wait
get
Range
get
Unit
get
Wait
i2c
Info
read
Wait
set
Config
set
Unit
wired
write
write
Flag
Wait
calibrate
Wait
char
Array
ToInt16
char
Array
ToXyz
heading
Wait
info
Constructors
constructor
new AK8963
(
)
:
AK8963
Returns
AK8963
Properties
address
address
:
any
i2cinfo
i2cinfo
:
I2cInfo
keys
keys
:
string
[]
params
params
:
any
required
Keys
required
Keys
:
string
[]
Methods
char2short
char2short
(
val1
:
number
, val2
:
number
)
:
any
Parameters
val1:
number
val2:
number
Returns
any
clear
Flag
Wait
clear
Flag
Wait
(
address
:
number
, index
:
number
)
:
Promise
<
void
>
Parameters
address:
number
index:
number
Returns
Promise
<
void
>
get
Adc
Array
Wait
get
Adc
Array
Wait
(
)
:
Promise
<
number
[]
>
Returns
Promise
<
number
[]
>
get
Adc
Wait
get
Adc
Wait
(
)
:
Promise
<
Xyz
>
Returns
Promise
<
Xyz
>
get
Array
Wait
get
Array
Wait
(
)
:
Promise
<
number
[]
>
Returns
Promise
<
number
[]
>
get
Range
get
Range
(
)
:
string
Returns
string
get
Unit
get
Unit
(
)
:
compassUnit
Returns
compassUnit
get
Wait
get
Wait
(
)
:
Promise
<
Xyz
>
Returns
Promise
<
Xyz
>
i2c
Info
i2c
Info
(
)
:
I2cInfo
Returns
I2cInfo
read
Wait
read
Wait
(
command
:
number
, length
:
number
)
:
Promise
<
number
[]
>
Parameters
command:
number
length:
number
Returns
Promise
<
number
[]
>
set
Config
set
Config
(
ADC_cycle
:
number
)
:
void
Parameters
ADC_cycle:
number
Returns
void
set
Unit
set
Unit
(
new_unit
:
compassUnit
)
:
void
Parameters
new_unit:
compassUnit
Returns
void
wired
wired
(
obniz
:
Obniz
)
:
void
Parameters
obniz:
Obniz
Returns
void
write
write
(
command
:
any
, buf
:
any
)
:
void
Parameters
command:
any
buf:
any
Returns
void
write
Flag
Wait
write
Flag
Wait
(
address
:
number
, index
:
number
)
:
Promise
<
void
>
Parameters
address:
number
index:
number
Returns
Promise
<
void
>
Static
calibrate
Wait
calibrate
Wait
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Static
char
Array
ToInt16
char
Array
ToInt16
(
values
:
[
number
,
number
]
, endian
?:
string
)
:
number
Parameters
values:
[
number
,
number
]
Default value
endian:
string
= "b"
Returns
number
Static
char
Array
ToXyz
char
Array
ToXyz
(
data
:
number
[]
, endian
?:
string
, scaleFunc
?:
(Anonymous function)
)
:
Xyz
Parameters
data:
number
[]
Default value
endian:
string
= "b"
Default value
scaleFunc:
(Anonymous function)
= (d: number): number => d
Returns
Xyz
Static
heading
Wait
heading
Wait
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Static
info
info
(
)
:
ObnizPartsInfo
Returns
ObnizPartsInfo
Globals
AK8963
constructor
address
i2cinfo
keys
params
required
Keys
char2short
clear
Flag
Wait
get
Adc
Array
Wait
get
Adc
Wait
get
Array
Wait
get
Range
get
Unit
get
Wait
i2c
Info
read
Wait
set
Config
set
Unit
wired
write
write
Flag
Wait
calibrate
Wait
char
Array
ToInt16
char
Array
ToXyz
heading
Wait
info
AK8963
Options
Generated using
TypeDoc