Search
Preparing search index...
The search index is not available
micro:bit Web Bluetooth API Documentation
AD
Button
State
IO
Magnetometer
Calibration
Accelerometer
Service
Button
Service
Device
Information
Service
Event
Service
Led
Service
Magnetometer
Service
add
Event
Listener
add
Listener
calibrate
dispatch
Event
emit
event
Names
get
Magnetometer
Period
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
read
Magnetometer
Bearing
read
Magnetometer
Data
remove
All
Listeners
remove
Event
Listener
remove
Listener
set
Magnetometer
Period
set
Max
Listeners
Temperature
Service
Uart
Service
Accelerometer
Data
Accelerometer
Events
Button
Events
Device
Information
Io
Pin
Events
Magnetometer
Data
Magnetometer
Events
Microbit
Event
Microbit
Events
Pin
Data
Pwm
Control
Data
Services
Temperature
Events
Uart
Events
Accelerometer
Period
Led
Matrix
Magnetometer
Period
little
Endian
get
Services
request
Microbit
Type parameters
T
Hierarchy
TypedDispatcher
MagnetometerService
Index
Methods
add
Event
Listener
add
Listener
calibrate
dispatch
Event
emit
event
Names
get
Magnetometer
Period
get
Max
Listeners
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
read
Magnetometer
Bearing
read
Magnetometer
Data
remove
All
Listeners
remove
Event
Listener
remove
Listener
set
Magnetometer
Period
set
Max
Listeners
Methods
add
Event
Listener
add
Event
Listener<K>
(
type
:
K
, listener
:
function
)
:
void
Type parameters
K
:
keyof T
Parameters
type:
K
listener:
function
(
event
:
CustomEvent
<
T[K]
>
)
:
void
Parameters
event:
CustomEvent
<
T[K]
>
Returns
void
Returns
void
add
Listener
add
Listener<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
calibrate
calibrate
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
dispatch
Event
dispatch
Event
(
event
:
CustomEvent
<
T
>
)
:
boolean
Parameters
event:
CustomEvent
<
T
>
Returns
boolean
dispatch
Event<K>
(
type
:
K
, detail
:
T[K]
)
:
boolean
Type parameters
K
:
keyof T
Parameters
type:
K
detail:
T[K]
Returns
boolean
emit
emit<K>
(
event
:
K
, data
:
T[K]
)
:
boolean
Type parameters
K
:
keyof T
Parameters
event:
K
data:
T[K]
Returns
boolean
event
Names
event
Names<K>
(
)
:
Array
<
K
>
Type parameters
K
:
keyof T
Returns
Array
<
K
>
get
Magnetometer
Period
get
Magnetometer
Period
(
)
:
Promise
<
MagnetometerPeriod
>
Returns
Promise
<
MagnetometerPeriod
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
listener
Count
listener
Count<K>
(
type
:
K
)
:
number
Type parameters
K
:
keyof T
Parameters
type:
K
Returns
number
listeners
listeners<K>
(
event
:
K
)
:
Function[]
Type parameters
K
:
keyof T
Parameters
event:
K
Returns
Function[]
on
on<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
once
once<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
prepend
Listener
prepend
Listener<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
read
Magnetometer
Bearing
read
Magnetometer
Bearing
(
)
:
Promise
<
number
|
undefined
>
Returns
Promise
<
number
|
undefined
>
read
Magnetometer
Data
read
Magnetometer
Data
(
)
:
Promise
<
MagnetometerData
>
Returns
Promise
<
MagnetometerData
>
remove
All
Listeners
remove
All
Listeners<K>
(
event
:
K
)
:
this
Type parameters
K
:
keyof T
Parameters
Optional
event:
K
Returns
this
remove
Event
Listener
remove
Event
Listener<K>
(
type
:
K
, callback
:
function
)
:
void
Type parameters
K
:
keyof T
Parameters
type:
K
callback:
function
(
event
:
CustomEvent
<
T[K]
>
)
:
void
Parameters
event:
CustomEvent
<
T[K]
>
Returns
void
Returns
void
remove
Listener
remove
Listener<K>
(
event
:
K
, listener
:
function
)
:
this
Type parameters
K
:
keyof T
Parameters
event:
K
listener:
function
(
data
:
T[K]
)
:
void
Parameters
data:
T[K]
Returns
void
Returns
this
set
Magnetometer
Period
set
Magnetometer
Period
(
frequency
:
MagnetometerPeriod
)
:
Promise
<
void
>
Parameters
frequency:
MagnetometerPeriod
Returns
Promise
<
void
>
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this