boost-movehub
Version:
Connects with your Lego Boost Movehub vie Bluetooth Low Energy (BLE).
2,217 lines (1,074 loc) • 163 kB
HTML
<!doctype html>
<html>
<head>
<meta charset='utf-8'>
<title>boost-movehub 0.1.0 | Documentation</title>
<meta name='description' content='Connects with your Lego Boost Movehub vie Bluetooth Low Energy (BLE).'>
<meta name='viewport' content='width=device-width,initial-scale=1'>
<link href='assets/bass.css' rel='stylesheet'>
<link href='assets/style.css' rel='stylesheet'>
<link href='assets/github.css' rel='stylesheet'>
<link href='assets/split.css' rel='stylesheet'>
</head>
<body class='documentation m0'>
<div class='flex'>
<div id='split-left' class='overflow-auto fs0 height-viewport-100'>
<div class='py1 px2'>
<h3 class='mb0 no-anchor'>boost-movehub</h3>
<div class='mb1'><code>0.1.0</code></div>
<input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
<div id='toc'>
<ul class='list-reset h5 py1-ul'>
<li><a
href='#boost'
class=" toggle-sibling">
Boost
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#booststartscanning'
class='regular pre-open'>
#startScanning
</a></li>
<li><a
href='#booststopscanning'
class='regular pre-open'>
#stopScanning
</a></li>
<li><a
href='#boostondiscover'
class='regular pre-open'>
#onDiscover
</a></li>
</ul>
</div>
</li>
<li><a
href='#eventboosthubconnected'
class="">
Boost#hubConnected
</a>
</li>
<li><a
href='#hub'
class=" toggle-sibling">
Hub
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hubaddress'
class='regular pre-open'>
#address
</a></li>
<li><a
href='#hubuuid'
class='regular pre-open'>
#uuid
</a></li>
<li><a
href='#hubconnect'
class='regular pre-open'>
#connect
</a></li>
<li><a
href='#hubdisconnect'
class='regular pre-open'>
#disconnect
</a></li>
<li><a
href='#hubswitchoff'
class='regular pre-open'>
#switchOff
</a></li>
<li><a
href='#hubimmediateshutdown'
class='regular pre-open'>
#immediateShutdown
</a></li>
<li><a
href='#hubsendmessage'
class='regular pre-open'>
#sendMessage
</a></li>
<li><a
href='#hubactivatealerts'
class='regular pre-open'>
#activateAlerts
</a></li>
<li><a
href='#hubdeactivatealerts'
class='regular pre-open'>
#deactivateAlerts
</a></li>
<li><a
href='#hub_receivemessage'
class='regular pre-open'>
#_receiveMessage
</a></li>
</ul>
</div>
</li>
<li><a
href='#eventhuberror'
class="">
Hub#error
</a>
</li>
<li><a
href='#eventhubdisconnect'
class="">
Hub#disconnect
</a>
</li>
<li><a
href='#eventhubrssi'
class="">
Hub#rssi
</a>
</li>
<li><a
href='#eventhubconnect'
class="">
Hub#connect
</a>
</li>
<li><a
href='#eventhubhubalert'
class="">
Hub#hubAlert
</a>
</li>
<li><a
href='#r2d2'
class=" toggle-sibling">
R2D2
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#r2d2on'
class='regular pre-open'>
#on
</a></li>
</ul>
</div>
</li>
<li><a
href='#r2d2rgbledsetcolor'
class="">
R2D2.rgbLed.setColor
</a>
</li>
<li><a
href='#r2d2wheelsdrive'
class="">
R2D2.wheels.drive
</a>
</li>
<li><a
href='#r2d2wheelsdrivedistance'
class="">
R2D2.wheels.driveDistance
</a>
</li>
<li><a
href='#r2d2wheelsdrivetime'
class="">
R2D2.wheels.driveTime
</a>
</li>
<li><a
href='#r2d2wheelsstop'
class="">
R2D2.wheels.stop
</a>
</li>
<li><a
href='#r2d2chassisisopen'
class="">
R2D2.chassis.isOpen
</a>
</li>
<li><a
href='#r2d2chassisopen'
class="">
R2D2.chassis.open
</a>
</li>
<li><a
href='#r2d2chassisclose'
class="">
R2D2.chassis.close
</a>
</li>
<li><a
href='#r2d2headturn'
class="">
R2D2.head.turn
</a>
</li>
<li><a
href='#r2d2headstop'
class="">
R2D2.head.stop
</a>
</li>
<li><a
href='#r2d2headturndegrees'
class="">
R2D2.head.turnDegrees
</a>
</li>
<li><a
href='#r2d2headturntime'
class="">
R2D2.head.turnTime
</a>
</li>
<li><a
href='#create'
class="">
create
</a>
</li>
<li><a
href='#devicemessage'
class=" toggle-sibling">
DeviceMessage
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#devicemessagelength'
class='regular pre-open'>
#length
</a></li>
</ul>
</div>
</li>
<li><a
href='#genericerror'
class="">
GenericError
</a>
</li>
<li><a
href='#hubaction'
class=" toggle-sibling">
HubAction
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#hubactionbuild'
class='regular pre-open'>
.build
</a></li>
</ul>
</div>
</li>
<li><a
href='#hubalert'
class=" toggle-sibling">
HubAlert
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#hubalertbuild'
class='regular pre-open'>
.build
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hubalertalerttypetostring'
class='regular pre-open'>
#alertTypeToString
</a></li>
</ul>
</div>
</li>
<li><a
href='#hubattachedmessage'
class=" toggle-sibling">
HubAttachedMessage
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#hubattachedmessageportid'
class='regular pre-open'>
#portId
</a></li>
<li><a
href='#hubattachedmessageeventtype'
class='regular pre-open'>
#eventType
</a></li>
<li><a
href='#hubattachedmessageiomembers'
class='regular pre-open'>
#ioMembers
</a></li>
</ul>
</div>
</li>
<li><a
href='#portinputformat'
class="">
PortInputFormat
</a>
</li>
<li><a
href='#portinputformatsetup'
class=" toggle-sibling">
PortInputFormatSetup
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#portinputformatsetupbuild'
class='regular pre-open'>
.build
</a></li>
</ul>
</div>
</li>
<li><a
href='#portoutput'
class=" toggle-sibling">
PortOutput
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#portoutputbuildwritedirectmodedata'
class='regular pre-open'>
.buildWriteDirectModeData
</a></li>
<li><a
href='#portoutputbuild'
class='regular pre-open'>
.build
</a></li>
</ul>
</div>
</li>
<li><a
href='#portoutputcommandfeedbackmessage'
class=" toggle-sibling">
PortOutputCommandFeedbackMessage
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#portoutputcommandfeedbackmessagepayload'
class='regular pre-open'>
#payload
</a></li>
<li><a
href='#portoutputcommandfeedbackmessagevaluesforports'
class='regular pre-open'>
#valuesForPorts
</a></li>
</ul>
</div>
</li>
<li><a
href='#portvaluesinglemessage'
class="">
PortValueSingleMessage
</a>
</li>
<li><a
href='#create'
class="">
create
</a>
</li>
<li><a
href='#currentsensor'
class=" toggle-sibling">
CurrentSensor
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#currentsensorreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
</ul>
</div>
</li>
<li><a
href='#motor'
class=" toggle-sibling">
Motor
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#motorstartpower'
class='regular pre-open'>
#startPower
</a></li>
<li><a
href='#motorstartspeed'
class='regular pre-open'>
#startSpeed
</a></li>
<li><a
href='#motorstartspeedfortime'
class='regular pre-open'>
#startSpeedForTime
</a></li>
<li><a
href='#motorstartspeedfordegrees'
class='regular pre-open'>
#startSpeedForDegrees
</a></li>
<li><a
href='#motorstop'
class='regular pre-open'>
#stop
</a></li>
<li><a
href='#motorcombinedstartspeed'
class='regular pre-open'>
#combinedStartSpeed
</a></li>
<li><a
href='#motorcombinedstartpower'
class='regular pre-open'>
#combinedStartPower
</a></li>
<li><a
href='#motorcombinedstartspeedfortime'
class='regular pre-open'>
#combinedStartSpeedForTime
</a></li>
<li><a
href='#motorcombinedstartspeedfordegrees'
class='regular pre-open'>
#combinedStartSpeedForDegrees
</a></li>
<li><a
href='#motorcombinedstop'
class='regular pre-open'>
#combinedStop
</a></li>
<li><a
href='#motorreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
<li><a
href='#motorreceivecommandfeedback'
class='regular pre-open'>
#receiveCommandFeedback
</a></li>
</ul>
</div>
</li>
<li><a
href='#eventmotorstart'
class="">
Motor#start
</a>
</li>
<li><a
href='#eventmotorstop'
class="">
Motor#stop
</a>
</li>
<li><a
href='#peripheral'
class=" toggle-sibling">
Peripheral
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Static members</span></li>
<li><a
href='#peripheraldev_motor'
class='regular pre-open'>
.DEV_MOTOR
</a></li>
</ul>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#peripheralsubscribe'
class='regular pre-open'>
#subscribe
</a></li>
<li><a
href='#peripheralunsubscribe'
class='regular pre-open'>
#unsubscribe
</a></li>
<li><a
href='#peripheralreceivesubscriptionack'
class='regular pre-open'>
#receiveSubscriptionAck
</a></li>
<li><a
href='#peripheralsetvalue'
class='regular pre-open'>
#setValue
</a></li>
<li><a
href='#peripheralgetvalueasync'
class='regular pre-open'>
#getValueAsync
</a></li>
</ul>
</div>
</li>
<li><a
href='#eventperipheralvalue'
class="">
Peripheral#value
</a>
</li>
<li><a
href='#eventperipheralvalue'
class="">
Peripheral#value
</a>
</li>
<li><a
href='#rgbled'
class=" toggle-sibling">
RgbLed
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#rgbledsetcolor'
class='regular pre-open'>
#setColor
</a></li>
<li><a
href='#rgbledsetrgbcolor'
class='regular pre-open'>
#setRgbColor
</a></li>
<li><a
href='#rgbledreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
</ul>
</div>
</li>
<li><a
href='#tiltsensor'
class=" toggle-sibling">
TiltSensor
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#tiltsensorreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
</ul>
</div>
</li>
<li><a
href='#unknownperipheral'
class="">
UnknownPeripheral
</a>
</li>
<li><a
href='#visionsensor'
class=" toggle-sibling">
VisionSensor
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#visionsensorreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
<li><a
href='#visionsensorsetvalue'
class='regular pre-open'>
#setValue
</a></li>
</ul>
</div>
</li>
<li><a
href='#eventvisionsensordistance'
class="">
VisionSensor#distance
</a>
</li>
<li><a
href='#eventvisionsensorcolor'
class="">
VisionSensor#color
</a>
</li>
<li><a
href='#eventvisionsensorcolor'
class="">
VisionSensor#color
</a>
</li>
<li><a
href='#voltagesensor'
class=" toggle-sibling">
VoltageSensor
<span class='icon'>▸</span>
</a>
<div class='toggle-target display-none'>
<ul class='list-reset py1-ul pl1'>
<li class='h5'><span>Instance members</span></li>
<li><a
href='#voltagesensorreceivevalue'
class='regular pre-open'>
#receiveValue
</a></li>
</ul>
</div>
</li>
</ul>
</div>
<div class='mt1 h6 quiet'>
<a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
</div>
</div>
</div>
<div id='split-right' class='relative overflow-auto height-viewport-100'>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='boost'>
Boost
</h3>
</div>
<p>The Boost instance scans for Boost devices like your movehub.</p>
<div class='pre p1 fill-light mt0'>Boost</div>
<p>
Extends
EventEmitter
</p>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>hubAddressOrUuid</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code>
The UUID or MAC address of the movehub to connect to.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>options</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?)</code>
Some options.
</div>
<table class='mt1 mb2 fixed-table h5 col-12'>
<colgroup>
<col width='30%' />
<col width='70%' />
</colgroup>
<thead>
<tr class='bold fill-light'>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class='mt1'>
<tr>
<td class='break-word'><span class='code bold'>options.logger</span> <code class='quiet'><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>?</code>
</td>
<td class='break-word'><span>Logger implementation when logging is desired.
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='booststartscanning'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>startScanning()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Starts scanning for peripherals.</p>
<div class='pre p1 fill-light mt0'>startScanning()</div>
</section>
</div>
</div>
<div class='border-bottom' id='booststopscanning'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>stopScanning()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Stops scanning for peripherals.</p>
<div class='pre p1 fill-light mt0'>stopScanning()</div>
</section>
</div>
</div>
<div class='border-bottom' id='boostondiscover'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>onDiscover(peripheral)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Called when noble is discovering a matching BLE Peripheral.</p>
<div class='pre p1 fill-light mt0'>onDiscover(peripheral: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>peripheral</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</code>
Peripheral data found by noble.
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventboosthubconnected'>
Boost#hubConnected
</h3>
</div>
<div class='pre p1 fill-light mt0'>Boost#hubConnected</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>hub</span> <code class='quiet'>(<a href="#hub">Hub</a>)</code>
The hub that just connected.
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='hub'>
Hub
</h3>
</div>
<p>Movehub implementation that handles all the sending and receiving of messages
between us and the Movehub device.</p>
<div class='pre p1 fill-light mt0'>Hub</div>
<p>
Extends
EventEmitter
</p>
<div class='py1 quiet mt1 prose-big'>Instance Members</div>
<div class="clearfix">
<div class='border-bottom' id='hubaddress'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>address</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>MAC Address of connected Movehub.</p>
<div class='pre p1 fill-light mt0'>address</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubuuid'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>uuid</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>UUID of connected Movehub.</p>
<div class='pre p1 fill-light mt0'>uuid</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubconnect'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>connect()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Tries connecting to initialized Movehub.</p>
<div class='pre p1 fill-light mt0'>connect()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubdisconnect'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>disconnect()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Sends disconnection signal and disconnects from Movehub.</p>
<div class='pre p1 fill-light mt0'>disconnect()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubswitchoff'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>switchOff()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Sends SwitchOff signal to Movehub.</p>
<div class='pre p1 fill-light mt0'>switchOff()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubimmediateshutdown'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>immediateShutdown()</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Sends signal to immediately shut down Movehub.</p>
<div class='pre p1 fill-light mt0'>immediateShutdown()</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubsendmessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>sendMessage(msg, callback)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Sends given device message to connected Movehub.</p>
<div class='pre p1 fill-light mt0'>sendMessage(msg: <a href="#devicemessage">DeviceMessage</a>, callback: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">function</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>msg</span> <code class='quiet'>(<a href="#devicemessage">DeviceMessage</a>)</code>
Message to send.
</div>
</div>
<div class='space-bottom0'>
<div>
<span class='code bold'>callback</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function">function</a>
= <code>null</code>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubactivatealerts'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>activateAlerts(filter = null)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>This subscribes to all or specific Hub Alerts.</p>
<div class='pre p1 fill-light mt0'>activateAlerts(filter: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>?)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>filter</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>?
= <code>null</code>)</code>
List of HubAlert to subscribe to. Default are all.
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hubdeactivatealerts'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>deactivateAlerts(filter = null)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>This unsubscribes from all or specifc Hub Alerts.</p>
<div class='pre p1 fill-light mt0'>deactivateAlerts(filter: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>?)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>filter</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a><<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>>?
= <code>null</code>)</code>
List of HubAlert to subscribe to. Default are all.
</div>
</div>
</div>
</section>
</div>
</div>
<div class='border-bottom' id='hub_receivemessage'>
<div class="clearfix small pointer toggle-sibling">
<div class="py1 contain">
<a class='icon pin-right py1 dark-link caret-right'>▸</a>
<span class='code strong strong truncate'>_receiveMessage(msg)</span>
</div>
</div>
<div class="clearfix display-none toggle-target">
<section class='p2 mb2 clearfix bg-white minishadow'>
<p>Called when a Movehub sends a message.</p>
<div class='pre p1 fill-light mt0'>_receiveMessage(msg: <a href="#devicemessage">DeviceMessage</a>)</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>msg</span> <code class='quiet'>(<a href="#devicemessage">DeviceMessage</a>)</code>
</div>
</div>
</div>
</section>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventhuberror'>
Hub#error
</h3>
</div>
<p>Fires when an error is received when connecting to the Movehub.</p>
<div class='pre p1 fill-light mt0'>Hub#error</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>error</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>)</code>
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventhubdisconnect'>
Hub#disconnect
</h3>
</div>
<p>Fires when a Movehub gets disconnected.</p>
<div class='pre p1 fill-light mt0'>Hub#disconnect</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventhubrssi'>
Hub#rssi
</h3>
</div>
<p>Fires when new RSSI value is received from BLE device.</p>
<div class='pre p1 fill-light mt0'>Hub#rssi</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>rssi</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>)</code>
The received RSSI value.
</div>
</div>
</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventhubconnect'>
Hub#connect
</h3>
</div>
<p>Fires when a connection to the Move Hub is established.</p>
<div class='pre p1 fill-light mt0'>Hub#connect</div>
</section>
<section class='p2 mb2 clearfix bg-white minishadow'>
<div class='clearfix'>
<h3 class='fl m0' id='eventhubhubalert'>
Hub#hubAlert
</h3>
</div>
<p>Fires on received Hub Alert.</p>
<div class='pre p1 fill-light mt0'>Hub#hubAlert</div>
<div class='py1 quiet mt1 prose-big'>Parameters</div>
<div class='prose'>
<div class='space-bottom0'>
<div>
<span class='code bold'>va