-
+
+
+
+
+
- new AbsoluteMotor()
+ + + - - - - - -- new AbsoluteMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/absolutemotor.js, line 26
-
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
-
-
- - devices/absolutemotor.js, line 26 - -
Extends
+Extends
- + --
-
- TachoMotor -
-
+
- TachoMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,167 +175,152 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- - + + + + + + + +gotoRealZero(speedopt) → {Promise}
+ + + -
+
+
+
+
@@ -455,126 +390,117 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Source: +
- + + - - + + +
+
-
-
-
-
-
-
-
-
-
-
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -712,176 +625,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - - -
- How much the motor should be rotated (in degrees). - - |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
-
-
-
-
-
- number
-
+
+ rotateByDegrees(degrees, speedopt) → {Promise}+ - - |
-
-
-
- <optional> - +
+
-
-
- Rotate a motor by a given amount of degrees. + |
-
-
-
+
+
+
+
+
+
+ Parameters:+ + +
Parameters:- + +Returns:+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished). +
- setAccelerationTime(time) → {Promise} -- - + + + + + + +setAccelerationTime(time) → {Promise}+ + + -
+
@@ -928,115 +896,104 @@ Set the global acceleration time -
- |
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- + +Promise + + + +
- setBrakingStyle(style) -
- + + + + + + +setBrakingStyle(style)
+ - + -
+
+
+
@@ -1084,115 +1062,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
@@ -1239,115 +1203,104 @@ Set the global deceleration time
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- + +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1395,115 +1368,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1550,144 +1512,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
+Events
- + + - - - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/BaseHub.html b/docs/BaseHub.html index a96b56a0..83547988 100644 --- a/docs/BaseHub.html +++ b/docs/BaseHub.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,46 +215,42 @@
-
-
+
@@ -408,46 +325,42 @@
-
-
+
@@ -529,46 +435,42 @@
-
-
+
@@ -650,46 +545,42 @@
-
-
+
@@ -771,46 +655,42 @@
-
-
+
@@ -892,46 +765,42 @@
-
-
+
@@ -1013,46 +875,42 @@
-
-
+
@@ -1134,46 +985,42 @@
-
-
+
@@ -1255,46 +1095,42 @@
-
-
+
@@ -1376,46 +1205,42 @@
-
-
+
@@ -1497,46 +1315,42 @@
-
+
+
-
- - BaseHub -
- -
+ BaseHub()
- BaseHub
-
-
-
-
-
-
+
+
+
+
+
- new BaseHub()
+ + + - - - - - -- new BaseHub() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/basehub.js, line 61
-
-
-
-
+ -
+ hubs/basehub.js, line 65
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/basehub.js, line 61 - -
- + hubs/basehub.js, line 65 +
Extends
+Extends
+ + - +-
+
- EventEmitter +
-
-
- EventEmitter -
Extends
- + @@ -216,10 +150,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -348,59 +270,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ + -- (readonly) connecting -
@@ -469,59 +381,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -590,59 +490,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
-- (readonly) hardwareVersion -
@@ -711,59 +599,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ + -- (readonly) name -
@@ -832,59 +711,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -953,59 +820,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1074,59 +929,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ + -- (readonly) rssi -
@@ -1195,59 +1041,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -1316,59 +1149,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
+ ||||
type |
+
- - - - - string - + | + + +string - + + | - - + - + - +Hub type |
+
- Hub type - |
-
-
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1437,59 +1259,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- @@ -1553,24 +1366,26 @@Properties:
-+
- + + + \ No newline at end of file diff --git a/docs/BasicMotor.html b/docs/BasicMotor.html index 323c6f4b..7d6947c3 100644 --- a/docs/BasicMotor.html +++ b/docs/BasicMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
-
+
+
-
+
+
+
+
-
- - BasicMotor -
- -
+ BasicMotor()
- BasicMotor
-
-
-
-
-
-
+
+
+
+
+
- new BasicMotor()
+ + + - - - - - -- new BasicMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 26
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/basicmotor.js, line 26 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
-- (readonly) mode -
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ + -- (readonly) portName -
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- brake() → {Promise} -
- + +brake() → {Promise}
+ - + -
+
+
+
+
+
@@ -1036,46 +875,42 @@ Brake the motor.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 73
-
-
-
-
+
@@ -1091,30 +926,52 @@
-
+
+Returns:
+
+
+ Resolved upon successful issuance of the command.
+
-
-
-
-
-
-
- rampPower(fromPower, toPower, time) → {Promise}
-
-
+
+ -
+ Type
+
+ -
+
+Promise
-
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+ rampPower(fromPower, toPower, time) → {Promise}
+
+
+
+
+
+
+
Ramp the motor power.
-
+
+
+
@@ -1122,164 +979,143 @@
- Parameters:
-
+ Parameters:
+
-
-
- - devices/basicmotor.js, line 73 - -
Returns:
+ +
+
-
-
-
-
-
- Resolved upon successful issuance of the command.
+- rampPower(fromPower, toPower, time) → {Promise} -
- +-
+
- + Type + +
- + +Promise - + +
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1122,164 +979,143 @@ rampPower(fromPower, toPower, time) → {Promise}
+ + + + + + +Ramp the motor power.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fromPower |
-
- - + | |||
fromPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
toPower |
-
- - + | |||
toPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the ramp should last (in milliseconds). - - |
- How long the ramp should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 46 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
-
-
-
-
-
- Resolved upon successful completion of command.
+- setPower(power) → {Promise} -
- +-
+
- + Type + +
- + +Promise - + +
+
+
+
+
+
+
+
+
+
+
+
@@ -1326,106 +1182,99 @@ setPower(power) → {Promise}
+ + + + + + +Set the motor power.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
power |
-
- - + | |||
power |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 34 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise - + +
- stop() → {Promise} -
- + - -
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1477,46 +1349,42 @@ stop() → {Promise}
+ + + + + + +Stop the motor.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 64
-
-
-
-
+
@@ -1532,30 +1400,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
-
-
-
- - devices/basicmotor.js, line 64 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
+
- + + + \ No newline at end of file diff --git a/docs/ColorDistanceSensor.html b/docs/ColorDistanceSensor.html index 892f9b24..5786aa03 100644 --- a/docs/ColorDistanceSensor.html +++ b/docs/ColorDistanceSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
-
+
+
-
-
+
+
-
-
- ColorDistanceSensor -
- -
+ ColorDistanceSensor()
- ColorDistanceSensor
-
-
-
-
-
-
+
+
+
+
+
- new ColorDistanceSensor()
+ + + - - - - - -- new ColorDistanceSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/colordistancesensor.js, line 26
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/colordistancesensor.js, line 26 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
+ ||||
portName |
+
- - - - - string - + | + + +string - + + | - - + - - - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- sendPFIRMessage(message) → {Promise} -
- + +sendPFIRMessage(message) → {Promise}
+ - + -
+
+
+
+
@@ -1031,106 +869,97 @@ Send a raw Power Functions IR command
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
message |
-
- - + | |||
message |
-
- Buffer
-
-
+ + + +Buffer - - | + + - + - + -
- 2 byte payload making up a Power Functions protocol command. NOTE: Only specify nibbles 1-3, nibble 4 should be zeroed. - - |
- 2 byte payload making up a Power Functions protocol command. NOTE: Only specify nibbles 1-3, nibble 4 should be zeroed. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 217 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- setColor(color) → {Promise} -
- + +setColor(color) → {Promise}
+ - + -
+
+
+
+
@@ -1177,106 +1028,97 @@ Set the color of the LED on the sensor via a color value.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 235 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- setDistanceCount(distance) → {Promise} -
- - + + + + + + + +setDistanceCount(distance) → {Promise}
+ + + -
+
+
+
+
@@ -1323,106 +1187,97 @@ Set the distance count value.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
distance |
-
- - + | |||
distance |
-
- count
-
-
+ + + +count - - | + + - + - + -
- count between 0 and 2^32 - - |
- count between 0 and 2^32 |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 256 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful issuance of the command.
+- setPFExtendedChannel(channel) → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Switches the IR receiver into extended channel mode. After setting this, use channels 5-8 instead of 1-4 for this receiver.
-NOTE: Calling this with channel 5-8 with switch off extended channel mode for this receiver.
-
+
Parameters:
- + -| Name | - + +Type | + + + + +Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
channel |
+ Name | -- - - - number - + | Type | + + + + +Description | +
|---|---|---|---|---|
channel |
+
-
-
+ + + +number - - + + | -
- Channel number, between 1-8 - - |
- Channel number, between 1-8 |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 155 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- setPFPower(channel, output, power) → {Promise} -
- - + + + -
+
+
+
@@ -1616,164 +1504,145 @@ setPFPower(channel, output, power) → {Promise}
+ + + + + + +Set the power of a Power Functions motor via IR
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
channel |
-
- - + | |||
channel |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Channel number, between 1-4 - - |
- Channel number, between 1-4 |
+
- |
output |
-
- - + | |||
output |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Outport port, "RED" (A) or "BLUE" (B) - - |
- Outport port, "RED" (A) or "BLUE" (B) |
+
- |
power |
-
- - + | |||
power |
-
- number
-
-
+ + + +number - - | + + - + - + -
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. - - |
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 175 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
- startPFMotors(channel, powerA, powerB) → {Promise} -
- - + + -
+
+
+
+
+
+
@@ -1821,164 +1711,144 @@ startPFMotors(channel, powerA, powerB) → {Promise}
+ + + + + + +Start Power Functions motors running via IR
NOTE: This command is designed for bang-bang style operation. To keep the motors running, the sensor needs to be within range of the IR receiver constantly.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
channel |
-
- - + | |||
channel |
-
- Buffer
-
-
+ + + +Buffer - - | + + - + - + -
- Channel number, between 1-4 - - |
- Channel number, between 1-4 |
+
- |
powerA |
-
- - + | |||
powerA |
-
- Buffer
-
-
+ + + +Buffer - - | + + - + - + -
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. - - |
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. |
+
- |
powerB |
-
- - + | |||
powerB |
-
- Buffer
-
-
+ + + +Buffer - - | + + - + - + -
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. - - |
- 7 (full reverse) to 7 (full forward). 0 is stop. 8 is brake. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 195 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- ambient :object -
- + +ambient
+ - + -
+
+
+
+ Event measuring abient light change, emits when the sensor is activated.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
percentage |
-
- - + | |||
percentage |
-
- number
-
-
+ + + +number - - | + + - + - + -
- from 0 to 100. - - |
- from 0 to 100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 102 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- color :object -
- - + + + + + + +color
+ + + -
+
+
+
+
+
+
+
+
+ Emits when a color sensor is activated.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 40 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- colorAndDistance :object -
- - + + + + + + + + +colorAndDistance
+ + + -
+
+
+ A combined color and distance event, emits when the sensor is activated.
-Type:
+-
+
-
+
+object
-
Parameters:
- +
+
Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - | |
distance |
-
- - + | |||
distance |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Distance, in millimeters. - - |
- Distance, in millimeters. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 141 - -
-
+ - + + + + + + + +
Parameters:
- + + - - - - - - -- distance :object -
- + +distance
+ - + -
+
+
+
+ Emits when a distance sensor is activated.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
distance |
-
- - + | |||
distance |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Distance, in millimeters. - - |
- Distance, in millimeters. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 58 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- distanceCount :object -
- - + + + + + + + + +distanceCount
+ + + -
+
+
+
+
+
+
+
+ Emits when distance is reduced to less than 10 centimeters.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
number |
-
- - + | |||
number |
-
- number
-
-
+ + + +number - - | + + - + - + -
- of distance events. - - |
- of distance events. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 76 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- reflect :object -
- - + + + + + + +reflect
+ + + + -
+
+
+
+
+
+
+
+
+ Event measuring reflection change, emits when the sensor is activated.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
percentage |
-
- - + | |||
percentage |
-
- number
-
-
+ + + +number - - | + + - + - + -
- from 0 to 100. - - |
- from 0 to 100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 89 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rgbIntensity :object -
- - + + + + + + + + +rgbIntensity
+ + + -
+
+
+
+
+
+ Emits when a color sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
red |
-
- - + | |||
red |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
green |
-
- - + | |||
green |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
blue |
-
- - + | |||
blue |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/colordistancesensor.js, line 121 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/CurrentSensor.html b/docs/CurrentSensor.html index 59283194..06aef4f3 100644 --- a/docs/CurrentSensor.html +++ b/docs/CurrentSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- CurrentSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - CurrentSensor -
- -
-
- CurrentSensor
+ CurrentSensor()
-
-
-
-
-
+
+
+
+
+
- new CurrentSensor()
+ + + - - - - - -- new CurrentSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/currentsensor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/currentsensor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- current :object -
- + +current
+ - + -
+
+
+
+
+
+
+
+ Emits when a current change is detected.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
current |
-
- - + | |||
current |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/currentsensor.js, line 51 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/Device.html b/docs/Device.html index f8961907..e1138b6b 100644 --- a/docs/Device.html +++ b/docs/Device.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- Device
+
-
-
-
+
-
+
-
-
+
@@ -287,46 +215,42 @@
-
-
+
@@ -408,46 +325,42 @@
-
-
+
@@ -529,46 +435,42 @@
-
-
+
@@ -650,46 +545,42 @@
-
-
+
@@ -771,46 +655,42 @@
-
-
+
@@ -892,46 +765,42 @@
-
+
+
-
- - Device -
- -
-
- Device
+ Device()
-
-
-
-
-
+
+
+
+
+
- new Device()
+ + + - - - - - -- new Device() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/device.js, line 25
-
-
-
-
+ -
+ devices/device.js, line 29
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
-
-
- - devices/device.js, line 25 - -
- + devices/device.js, line 29 +
Extends
+Extends
- + --
-
- EventEmitter -
-
+
- EventEmitter +
Extends
- + + + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
+ ||||
connected |
+
- - - - - boolean - + | + + +boolean - + + | - - + - + - +Check if the device is still attached. |
+
- Check if the device is still attached. - |
-
-
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -348,59 +270,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -469,59 +380,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -590,59 +491,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -711,59 +600,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -832,59 +710,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -948,24 +816,26 @@Properties:
-+
- + + + \ No newline at end of file diff --git a/docs/DuploTrainBase.html b/docs/DuploTrainBase.html index 9cded21c..74fb331a 100644 --- a/docs/DuploTrainBase.html +++ b/docs/DuploTrainBase.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - DuploTrainBase -
- -
+ DuploTrainBase()
- DuploTrainBase
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new DuploTrainBase() -
- + +new DuploTrainBase()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The DuploTrainBase is emitted if the discovered device is a Duplo Train Base.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/duplotrainbase.js, line 27
-
-
-
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/duplotrainbase.js, line 27 - -
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1688,144 +1450,126 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- setName(name) → {Promise} -
- + + + + - + +setName(name) → {Promise}
+ + + -
+
+
@@ -1872,115 +1636,104 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + LPF2Hub#setName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- shutdown() → {Promise} -
- - + + + + + + +shutdown() → {Promise}
+ + + -
+
+
+
+
+
@@ -2032,55 +1808,47 @@ Shutdown the Hub.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- LPF2Hub#shutdown
-
-
-
-
+ -
+ LPF2Hub#shutdown
+
- Source:
- -
-
- -
- hubs/lpf2hub.js, line 53
-
-
-
-
+ -
+ hubs/lpf2hub.js, line 57
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
-
- - LPF2Hub#shutdown - -
- + LPF2Hub#shutdown +
-
-
- - hubs/lpf2hub.js, line 53 - -
- + hubs/lpf2hub.js, line 57 +
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2135,144 +1925,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/DuploTrainBaseColorSensor.html b/docs/DuploTrainBaseColorSensor.html index 8606edf6..2078ac38 100644 --- a/docs/DuploTrainBaseColorSensor.html +++ b/docs/DuploTrainBaseColorSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
+
+
-
+
+
-
+
+
-
- - DuploTrainBaseColorSensor -
- -
+ DuploTrainBaseColorSensor()
- DuploTrainBaseColorSensor
-
-
-
-
-
-
+
+
+
+
+
- new DuploTrainBaseColorSensor()
+ + + - - - - - -- new DuploTrainBaseColorSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- color :object -
- + +color
+ - + -
+
+
+ Emits when a color sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- - - - - - - -- intensity :object -
- - + + + + + + + + +intensity
+ + + -
+
+
+
+
+ Emits when intensity of the color/light changes.
-Type:
+-
+
- + +object + + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
intensity |
-
- - + | |||
intensity |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- - - - - - - -- reflect :object -
- - + + + + + + + + +reflect
+ + + -
+
+
+
+
+
+
+ Emits when the light reflectivity changes.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
reflect |
-
- - + | |||
reflect |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Percentage, from 0 to 100. - - |
- Percentage, from 0 to 100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- - - - - - - -- rgb :object -
- - + + + + + + +rgb
+ -
+
+
+
+
+
+
+
+
+
+
+
+ Emits when the light reflectivity changes.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
red |
-
- - + | |||
red |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
green |
-
- - + | |||
green |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
blue |
-
- - + | |||
blue |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/DuploTrainBaseMotor.html b/docs/DuploTrainBaseMotor.html index 40345fdd..df7fab43 100644 --- a/docs/DuploTrainBaseMotor.html +++ b/docs/DuploTrainBaseMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
-
+
+
-
+
+
+
+
-
- - DuploTrainBaseMotor -
- -
+ DuploTrainBaseMotor()
- DuploTrainBaseMotor
-
-
-
-
-
-
+
+
+
+
+
- new DuploTrainBaseMotor()
+ + + - - - - - -- new DuploTrainBaseMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/duplotrainbasemotor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/duplotrainbasemotor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- BasicMotor +
-
-
- BasicMotor -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
-- (readonly) mode -
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ + -- (readonly) portName -
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- brake() → {Promise} -
- + +brake() → {Promise}
+ - + -
+
+
+
+
+
@@ -1036,55 +875,47 @@ Brake the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#brake
-
-
-
-
+ -
+ BasicMotor#brake
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 73
-
-
-
-
+
@@ -1100,30 +931,51 @@
-
+
+Returns:
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- rampPower(fromPower, toPower, time) → {Promise}
-
-
+
+
+
+
+
+
+ rampPower(fromPower, toPower, time) → {Promise}
+
-
+
-
+
Ramp the motor power.
-
+
+
@@ -1131,173 +983,149 @@
- Parameters:
-
+
+ Parameters:
+
-
-
- - BasicMotor#brake - -
- + BasicMotor#brake +
-
-
- - devices/basicmotor.js, line 73 - -
Returns:
+ +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
- rampPower(fromPower, toPower, time) → {Promise} -
- + + + + + + +rampPower(fromPower, toPower, time) → {Promise}
+ - + -
+
+
+
@@ -1131,173 +983,149 @@ Ramp the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fromPower |
-
- - + | |||
fromPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
toPower |
-
- - + | |||
toPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the ramp should last (in milliseconds). - - |
- How long the ramp should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#rampPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 46 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
-
-
-
-
-
- Resolved upon successful completion of command.
+- setPower(power) → {Promise} -
- +-
+
- + Type + +
- + +Promise + + + +
setPower(power) → {Promise}
+ + + -
+
+
+
+
+
@@ -1344,115 +1193,103 @@ Set the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
power |
-
- - + | |||
power |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#setPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 34 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- stop() → {Promise} -
- - + + + + + + +stop() → {Promise}
+ + + -
+
+
+
+
+
@@ -1504,55 +1364,47 @@ Stop the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#stop
-
-
-
-
+ -
+ BasicMotor#stop
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 64
-
-
-
-
+
@@ -1568,30 +1420,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
-
-
-
- - BasicMotor#stop - -
- + BasicMotor#stop +
-
-
- - devices/basicmotor.js, line 64 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
+
- + + + \ No newline at end of file diff --git a/docs/DuploTrainBaseSpeaker.html b/docs/DuploTrainBaseSpeaker.html index 1ab54aff..3cf630f0 100644 --- a/docs/DuploTrainBaseSpeaker.html +++ b/docs/DuploTrainBaseSpeaker.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
-
+
+
-
+
+
+
+
-
- - DuploTrainBaseSpeaker -
- -
+ DuploTrainBaseSpeaker()
- DuploTrainBaseSpeaker
-
-
-
-
-
-
+
+
+
+
+
- new DuploTrainBaseSpeaker()
+ + + - - - - - -- new DuploTrainBaseSpeaker() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/duplotrainbasespeaker.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/duplotrainbasespeaker.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- playSound(sound) → {Promise} -
- + +playSound(sound) → {Promise}
+ - + -
+
+
@@ -1031,106 +867,99 @@ Play a built-in train sound.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
sound |
-
- - + | |||
sound |
-
- DuploTrainBaseSound
-
-
+ + + +DuploTrainBaseSound - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/duplotrainbasespeaker.js, line 33 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
- playTone(tone) → {Promise} -
- - + + + + +playTone(tone) → {Promise}
+ + + -
+
+
+
+
+
@@ -1177,106 +1027,98 @@ Play a built-in system tone.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
tone |
-
- - + | |||
tone |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/duplotrainbasespeaker.js, line 46 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
+
- + + + \ No newline at end of file diff --git a/docs/DuploTraniBaseSpeedometer.html b/docs/DuploTraniBaseSpeedometer.html index be88d1e8..5c5e3ef0 100644 --- a/docs/DuploTraniBaseSpeedometer.html +++ b/docs/DuploTraniBaseSpeedometer.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- DuploTraniBaseSpeedometer
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
- - DuploTraniBaseSpeedometer -
- -
-
- DuploTraniBaseSpeedometer
+ DuploTraniBaseSpeedometer()
-
-
-
-
-
+
+
+
+
+
- new DuploTraniBaseSpeedometer()
+ + + - - - - - -- new DuploTraniBaseSpeedometer() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- Device -
-
+
- Device +
Extends
- + + + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,24 +846,26 @@Properties:
-+
- + + + \ No newline at end of file diff --git a/docs/Hub.html b/docs/Hub.html index afd460b5..7efab581 100644 --- a/docs/Hub.html +++ b/docs/Hub.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
+
+
-
-
-
+
-
-
-
+
+
+
+
-Source:
-
-
-
-
-
-
-
+
-
-
+
+
-
-
- Hub -
- -
+ Hub()
- Hub
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new Hub() -
- + +new Hub()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The Hub is emitted if the discovered device is a Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/hub.js, line 31
-
-
-
-
+ -
+ hubs/hub.js, line 32
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/hub.js, line 31 - -
- + hubs/hub.js, line 32 +
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
+ -- (readonly) primaryMACAddress -
@@ -1143,59 +971,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
+ -- (readonly) uuid -
@@ -1533,59 +1316,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- connect() → {Promise} -
- + +connect() → {Promise}
+ - + -
+
+
+
+
+
@@ -1692,46 +1456,42 @@ Connect to the Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/basehub.js, line 167
-
-
-
-
+ -
+ hubs/basehub.js, line 171
+
@@ -1747,31 +1507,51 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful connect.
+
+
+
+
+
+ -
+ Type
+
+ -
+Promise
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+
+
+
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
+
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
@@ -1779,144 +1559,127 @@
- Parameters:
-
+
+
+ Parameters:
+
-
-
- - hubs/basehub.js, line 167 - -
- + hubs/basehub.js, line 171 +
Returns:
+ + +
+
+
+
+
+Resolved upon successful connect.
+-
+
- + Type + +
- +Promise + + + +
- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + + + + - + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ + + -
+
+
@@ -1779,144 +1559,127 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful issuance of command.
+- disconnect() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Disconnect the Hub.
-
+
disconnect() → {Promise}
+ + --
-
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 181 - -
-
-
-
+ - Source: +
- + hubs/basehub.js, line 185 +
+
+
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
- Disconnect the Hub.
+-
-
-
- getDeviceAtPort(portName) → {Device|undefined} -
- - -
-
@@ -2054,236 +1804,219 @@ Retrieves the device attached to a given port.
-
- Parameters:
-
-
| Name | - -Type | +Description | -
|---|---|---|
portName |
+- - - - string - + + + - - | - + + -
- The name of the port to retrieve the device from. - - |
-
getDeviceAtPort(portName) → {Device|undefined}
+ + +
+
-Retrieves the device attached to a given port.
+-
-
-
-
-
-
-
-
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 189 - -
-
+ - Source: +
- + hubs/basehub.js, line 193 +
+
+
+
+
+- Source: -
-
-
-
-
- - hubs/basehub.js, line 229 - -
-
+
+ - + Type + +
- + +Device +| +undefined + +
- Source: +
- + hubs/basehub.js, line 233 +
+
-
-- Source: -
-
-
-
-
- - hubs/basehub.js, line 237 - -
-
-
-
-
-
-
-
- - + Type + +
- + +Array.<Device> + +
- Overrides: -
-
-
-
-
- - LPF2Hub#setName - -
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/basehub.js, line 241 +
+
-
+
-
+
-
+
- + Type + +
- + +Array.<Device> - - -
- Overrides: -
-
-
-
-
- - LPF2Hub#shutdown - -
-
-
-
-
-
-
-
-
-
+ - Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 53 - -
-
-
+
+
-
+
-
- - Overrides: +
- + LPF2Hub#setName +
+
-
+
-
+
- - Source: +
- + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
+- Source: -
-
-
-
-
- - hubs/basehub.js, line 282 - -
-
-
-
-
-
Parameters:
+ - +| Name | + - +Type | - + - + - -Description | +
|---|---|---|
portName |
+
-
-
+ + + +string + + | + + +The name of the port to retrieve the device from. |
+
-
+
-
-
+
+
-
+
-
-
-
-
-
- getDevices() → {Array.<Device>} -
- + - + + + -
-
+
+
+
+
+
+ Retrieves all attached devices.
--
-
-
-
-
-
-
-
-
-
-
-
-
+
Returns:
- -
+
-
-
-
-The device attached to the port.
+-
+
getDevices() → {Array.<Device>}
+ + - - +
+
-
-
-
-
-
- Retrieves all attached devices.
+- getDevicesByType(deviceType) → {Array.<Device>} -
- - -
-
@@ -2291,145 +2024,105 @@ Retrieves an array of devices of the specified type.
-
- Parameters:
-
+
-
-
-
-
- Name
-
+
- Type
+
-
+
-
+
- Description
-
-
+
-
-
-
- deviceType
-
-
-
- number
-
+
+
-
-
+
-
+
-
+
-
- The device type to lookup.
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+ Array of all attached devices.
+
+
+
+
-
+
+
+
+
+ getDevicesByType(deviceType) → {Array.<Device>}
+
-
+
-
-
-
-
-
- setName(name) → {Promise}
-
-
-
+
+ Retrieves an array of devices of the specified type.
+
-
- Set the name of the Hub.
-
@@ -2437,115 +2130,97 @@
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | + - + - + -Description | -
|---|---|---|
deviceType |
-
- - - - - number - + + - - | + - + - + -
- The device type to lookup. - - |
-
Array of all attached devices.
+Retrieves an array of devices of the specified type.
+Set the name of the Hub.
-Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
deviceType |
-
- string
-
-
+ + + +number - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- The device type to lookup. |
+
-
+
-
-
+
-
+
-
+
-
-
Parameters:
- - - - - - - - - - -- shutdown() → {Promise} -
- - - - - - -
-
-
-
-
-
-
-
-
+Shutdown the Hub.
-Returns:
+ +
+
-Array of all devices of the specified type.
+-
-
-
+
-
+
setName(name) → {Promise}
+ + +
+
@@ -2660,179 +2289,162 @@ Set the name of the Hub.
+
+ Parameters:
+
-
+
| Name | +Type | - + - - - - -Description | +
|---|---|---|
name |
+
- + + +string + + | + + +New name of the hub (14 characters or less, ASCII only). |
+
Parameters:
- -| Name | - -Type | - - -Description | -
|---|---|---|
delay |
-
-
- - - - - number - + - - | + +
- How long to sleep (in milliseconds). - - |
-
-
+
+
Returns:
+ +
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- + +Promise + +
shutdown() → {Promise}
+ - - - - -- wait(commands) → {Promise} -
- + - +
+
- Shutdown the Hub.
+
-
@@ -2840,146 +2452,116 @@ Wait until a given list of concurrently running commands are complete.
-Note: This is a helper method to make it easier to wait for concurrent commands to complete.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
commands |
-
-
- - - - - Array.<Promise.<any>> - + - - | + +
- Array of executing commands. - - |
-
-
+
+
- Source: +
- + hubs/lpf2hub.js, line 57 +
+
-
+
-
+
-
+
+
-
-
- - hubs/basehub.js, line 295 - -
Returns:
+ +
+
+Resolved upon successful disconnect.
+-
+
- + Type + +
- + +Promise + +
sleep(delay) → {Promise}
+ - + - - - - -- waitForDeviceAtPort(portName) → {Promise} -
- - +
+
- Sleep a given amount of time.
+Note: This is a helper method to make it easier to add delays into a chain of commands.
+
-
@@ -2987,106 +2569,97 @@ Retrieves the device attached to a given port, waiting until one is attached if there isn't one.
-Note: If a device is never attached, the returned promise may never resolve.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
- - + | |||
delay |
-
- string
-
-
+ + + +number - - | + + - + - + -
- The name of the port to retrieve the device from. - - |
- How long to sleep (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 204 - -
-
+ - + hubs/basehub.js, line 286 +
+
-
+
-
+
-
+
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved after the delay is finished.
+- waitForDeviceByType(deviceType) → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Retrieves the first device attached of the specified type, waiting until one is attached if there isn't one.
-Note: If a device is never attached, the returned promise may never resolve.
-
+
Parameters:
- + -| Name | - + +Type | - - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | -deviceType |
+
+ Type | + -- - - - number - + + + | Description | +
|---|---|---|---|---|
commands |
+
+
+ + + +Array.<Promise.<any>> - - | - + + - + + + -
- The device type to lookup. - - |
- Array of executing commands. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 246 - -
-
+ - + hubs/basehub.js, line 299 +
+
-
+
-
+
-
+
Parameters:
- - - +Returns:
+ + +
+
+
+
+
+Resolved after the commands are finished.
+-
+
- + Type + +
- + +Promise + + + +
Events
- + + + + + + + + +waitForDeviceAtPort(portName) → {Promise}
+ - + - - - - -- attach -
- - +
+
- Retrieves the device attached to a given port, waiting until one is attached if there isn't one.
+Note: If a device is never attached, the returned promise may never resolve.
+
-
@@ -3288,106 +2889,97 @@ Emits when a device is attached to the Hub.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
device |
-
- - + | |||
portName |
-
- Device
-
-
+ + + +string - - | + + - + - + -- - - | -The name of the port to retrieve the device from. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 337 - -
-
+ - + hubs/basehub.js, line 208 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ +
+
+
-
+Resolved once a device is attached, or resolved immediately if a device is already attached.
+-
+
- + Type + +
-
+
+Promise
-
-
-
-
-
- button -
- - +
+
-
+
+
+
+
+ Emits when a button is pressed.
-waitForDeviceByType(deviceType) → {Promise}
+ + -Parameters:
- -| Name | - -Type | +Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
button |
-
-
-
-
-
- string
-
+
+
+ Parameters:+
Parameters:- + +Returns:+ +
+
+
-
+Resolved once a device is attached, or resolved immediately if a device is already attached. +
-
+
+
+
+
+
+
+
+
+ Emits when a device is detached from the Hub. -Events+ + + + + + + +attach+ + + + + + +
+
+
+
@@ -3618,106 +3216,97 @@ Emits when a device is attached to the Hub. +
- |
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
device |
-
- - + | |||
device |
-
- Device
-
-
+ + + +Device - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 354 - -
-
+ - + hubs/basehub.js, line 341 +
+
-
+
-
+
-
+
Parameters:
- - - - - - - - - - -- disconnect -
- - -
-
+
+
+
+
+ Emits when the hub is disconnected.
-button
+ + +
+
-Emits when a button is pressed.
+-
-
-
-
-
-
-
-
+
- Overrides: +
- + + + + + + + - + + + + + + + + + + + +
- Source: +
- + hubs/lpf2hub.js, line 186 +
+
+
+
+
+
+
+
+- Source: +
- + hubs/basehub.js, line 358 +
+
+
+
+
+
+
+
+- Source: -
-
-
-
-
- - hubs/basehub.js, line 83 - -
-
+ - + hubs/basehub.js, line 87 +
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/technicsmallhub.js, line 27 - -
-
+ - + - + - + - +
- Overrides: +
- + + + + + + + + + + + + + + + + + + + +
- Source: +
- + hubs/basehub.js, line 161 +
+
+
+
+
+
+
+
+- Overrides: +
- + + + + + + + + + + + + + + + + + + + +
- Source: +
- + hubs/basehub.js, line 105 +
+
+
+
+
+
+
+
+- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
- Source: +
- + hubs/basehub.js, line 171 +
+
-- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
-
-
-
+ - + Type + +
- + +Promise + + +
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 167 - -
-
-
-
-
- - Source: +
- + hubs/basehub.js, line 185 +
+
-
+
-
-
-
-
- - + Type + +
-
+Promise
-
-
- -First port name
- - - Overrides: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - Source: +
- + hubs/basehub.js, line 193 +
+
-- Source: -
-
-
-
-
- - hubs/basehub.js, line 181 - -
-
-
-
-
- - + Type + +
- + +Device +| +undefined + +
- Source: +
- + hubs/basehub.js, line 233 +
+
-
+
-
+
-
+
+- Source: -
-
-
-
-
- - hubs/basehub.js, line 189 - -
-
-
-
-
- - + Type + +
- + +Array.<Device> + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 229 - -
-
-
-
-
-
+ - Source: +
- + hubs/basehub.js, line 241 +
+
-
+
-
-
-
-
- - + Type + +
-
+Array.<Device>
-
-
- -The device type to lookup.
- - - Source: -
-
-
-
-
- - hubs/basehub.js, line 237 - -
-
-
-
-
- - Overrides: +
- + LPF2Hub#setName +
+
+
+
+
- - Source: +
- + hubs/lpf2hub.js, line 65 +
+
-
- - Overrides: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + Type + +
- + +Promise - - + +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
-
-
-
- - Overrides: +
- + LPF2Hub#shutdown +
+
+
+
+
+
+
+
+
-- Source: +
- + hubs/lpf2hub.js, line 57 +
+
-
+
-
+
+
+
+- Overrides: -
-
-
-
-
- - LPF2Hub#shutdown - -
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 53 - -
-
-
-
-
- - + Type + +
- + +Promise + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 282 - -
-
+ - + hubs/basehub.js, line 286 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 295 - -
-
+ - + hubs/basehub.js, line 299 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 204 - -
-
+ - + hubs/basehub.js, line 208 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 246 - -
-
+ - + hubs/basehub.js, line 250 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 337 - -
-
+ - + hubs/basehub.js, line 341 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 354 - -
-
+ - + hubs/basehub.js, line 358 +
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 83 - -
-
+ - + hubs/basehub.js, line 87 +
+
-
+
-
+
-
+
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/hubled.js, line 25 - -
-
+ - + devices/hubled.js, line 29 +
+
-
+
-
+
-
+
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - devices/hubled.js, line 33 - -
-
+ - + devices/hubled.js, line 37 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Source: -
-
-
-
-
- - devices/hubled.js, line 55 - -
-
+ - + devices/hubled.js, line 59 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 29 - -
-
+ - + hubs/lpf2hub.js, line 33 +
+
-
+
-
+
-
+
- BaseHub +
- BaseHub -
- Inherited From: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 53 - -
-
+ - + hubs/lpf2hub.js, line 57 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/light.js, line 26 - -
-
+ - + devices/light.js, line 30 +
+
-
+
-
+
-
+
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - devices/light.js, line 49 - -
-
+ - + devices/light.js, line 53 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Source: -
-
-
-
-
- - devices/light.js, line 34 - -
-
+ - + devices/light.js, line 38 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - hubs/mario.js, line 27 - -
-
+ - + hubs/mario.js, line 31 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + LPF2Hub#setName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#shutdown - -
-
+ - + LPF2Hub#shutdown +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 53 - -
-
+ - + hubs/lpf2hub.js, line 57 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/marioaccelerometer.js, line 25 - -
-
+ - + - + - + - +
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- + +object + + + +
- Source: -
-
-
-
-
- - devices/marioaccelerometer.js, line 37 - -
-
+ - + - + - + - +
-
+
+object
-
Parameters:
- +
+ - Source: -
-
-
-
-
- - devices/marioaccelerometer.js, line 51 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/mariobarcodesensor.js, line 25 - -
-
+ - + - + - + - +
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- + +object + + + +
- Source: -
-
-
-
-
- - devices/mariobarcodesensor.js, line 37 - -
-
+ - + - + - + - +
- + +object + + + +
- Source: -
-
-
-
-
- - devices/mariobarcodesensor.js, line 55 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/mariopantssensor.js, line 25 - -
-
+ - + - + - + - +
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- + +object + +
- Source: -
-
-
-
-
- - devices/mariopantssensor.js, line 37 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/mediumlinearmotor.js, line 25 - -
-
+ - + - + - + - +
- TachoMotor -
- TachoMotor +
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
- + Type + +
- + +Promise + + + +
-
+
+object
-
Parameters:
- +
+ - Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/motionsensor.js, line 25 - -
-
+ - + - + - + - +
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- + +object + +
- Source: -
-
-
-
-
- - devices/motionsensor.js, line 42 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - hubs/movehub.js, line 31 - -
-
+ - + hubs/movehub.js, line 32 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + LPF2Hub#setName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#shutdown - -
-
+ - + LPF2Hub#shutdown +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 53 - -
-
+ - + hubs/lpf2hub.js, line 57 +
+
-
+
-
+
-
+
- + Type + +
- + +Promise + + + +
- Inherited From: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
- - - - - - - - - - -
- Source: -
- - - - +
- + - + - + - +
- TachoMotor -
- TachoMotor +
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
- + Type + +
- +Promise + + + +
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
- + Type + +
- + +Promise + + + +
-
+
+object
-
Parameters:
- +
+ - Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/movehubtiltsensor.js, line 25 - -
-
+ - + - + - + - +
- Device -
- Device +
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- + +object + +
- Source: -
-
-
-
-
- - devices/movehubtiltsensor.js, line 37 - -
-
+ - + - + - + - +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - devices/piezobuzzer.js, line 25 - -
-
+ - + - + - + - +
- Device +
- Device -
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - devices/piezobuzzer.js, line 33 - -
-
+ - + - + - + - +
- + Type + +
- + +Promise + + + +
- - - - - - - - - - -
- Source: -
-
-
-
-
- - poweredup-browser.js, line 36 - -
-
+ - + - + - + - +
- EventEmitter +
- EventEmitter -
- Source: -
-
-
-
-
- - poweredup-browser.js, line 97 - -
-
+ - + - + - + - +
- + Type + +
- +BaseHub + + + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 117 - -
-
+ - + - + - + - +
- + Type + +
- +BaseHub + + + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 88 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - poweredup-node.js, line 108 - -
-
+
-
+
-
+
-
- - Source: +
- + + + + + - - - - - - - -
- + Type + +
- + +BaseHub +| +null + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 80 - -
-
-
-
-
- - Source: +
- + + + + +
- + Type + +
- + +Array.<BaseHub> - - -
- Source: -
-
-
-
-
- - poweredup-node.js, line 100 - -
-
-
-
-
-
-
-
- Source: +
- + - + - + - + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 106 - -
-
-
-
-
- - + Type + +
- + +Array.<BaseHub> + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 126 - -
-
+ - + - + - + - +
- + Type + +
- + +Array.<BaseHub> + + + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 115 - -
-
+ - + - + - + - +
- + Type + +
- +Array.<BaseHub> - + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 135 - -
-
-
-
-
-
+ - Source: +
- + + - + - - - - -
- + Type + +
- + +Array.<BaseHub> - - + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 46 - -
-
+
-
+
+ - Source: -
-
-
-
-
- - poweredup-node.js, line 74 - -
-
+ - + - + - + - +
- + Type + +
- + +Array.<BaseHub> + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 89 - -
-
-
-
-
- - Source: +
- -
- Source: -
-
-
-
-
- - poweredup-browser.js, line 225 - -
-
+ - + poweredup-node.js, line 78 +
+
-
+
-
+
-
+
- Source: +
- + poweredup-node.js, line 92 +
+
+
+
+
+
+
-- Source: -
-
-
-
-
- - poweredup-node.js, line 188 - -
-
-
-
-
- - Source: -
-
-
-
-
- - poweredup-node.js, line 64 - -
-
+
-
+
+
+
+
+
+
+
+
+
+ - Source: +
- + + + - + - +
- Source: +
- + + + + + + + +
- EventEmitter -
- Source: +
- + poweredup-node.js, line 68 +
+
+
+
+
+
+
+
+- EventEmitter +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 97 - -
-
+ - + - + - + - +
- + Type + +
- + +BaseHub + + + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 117 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 88 - -
-
+ - + - + - + - +
- + Type + +
- +BaseHub +| + +null + + +
- Source: +
- + + + + + + + +
- + Type + +
- + +BaseHub +| + +null + + + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 108 - -
-
-
-
-
-
+ - Source: +
- + + + -
- + Type + +
- + +Array.<BaseHub> - - + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 80 - -
-
-
-
-
- - Source: +
- + - + - + - + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 100 - -
-
-
-
-
- - + Type + +
- + +Array.<BaseHub> + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 106 - -
-
+ - + - + - + - +
- + Type + +
- +Array.<BaseHub> + + + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 126 - -
-
+ - + - + - + - +
- + Type + +
- + +Array.<BaseHub> + + + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 115 - -
-
+ - + - + - + - +
- + Type + +
- + +Array.<BaseHub> + + + +
- Source: -
-
-
-
-
- - poweredup-node.js, line 135 - -
-
+ - + - + - + - +
- + Type + +
- + +Array.<BaseHub> + + + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 46 - -
-
+ - + - + - + - +
- Source: -
-
-
-
-
- - poweredup-node.js, line 74 - -
-
+ - + poweredup-node.js, line 78 +
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - poweredup-node.js, line 89 - -
-
+ - + poweredup-node.js, line 92 +
+
-
+
-
+
-
+
- Source: +
- + - + - + - + +
- Source: -
-
-
-
-
- - poweredup-browser.js, line 225 - -
-
-
-
-
-
@@ -4127,30 +4195,23 @@
Parameters:
+ - +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
button |
+
+
+ + + +string + + + + | + + + + + ++ |
state |
+
+
+ + + +ButtonState + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
detach
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+ Emits when a device is detached from the Hub.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
device |
+
+
+ + + +Device + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
disconnect
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Emits when the hub is disconnected.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
+
+
+
+
+
+
+
-
+
+
+
+
+
-
+
+
-
-
- Hub
+ Hub()
-
-
-
-
+
-
+
-
+
+
-
-
-
-
-
-
-
- new Hub()
-
-
+
+ new Hub()
+
-
+
-
+
The TechnicSmallHub is emitted if the discovered device is a Technic Small Hub.
-
+
+
+
+
@@ -3883,46 +3772,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3938,21 +3823,29 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
-
+
@@ -3960,7 +3853,7 @@ Extends
-
+
@@ -3969,10 +3862,124 @@ Members
+(readonly) batteryLevel
+
+
+
+
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ batteryLevel
+
+
+number
+
+
+
+
+
+
+
+
+
+ Battery level of the hub (Percentage between 0-100)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(readonly) connected
+
-
- (readonly) batteryLevel
-
@@ -3980,59 +3987,169 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
+
+
+
+
+
+
+ connected
+
+
+string
+
+
+
+
+
+
+
+
+
+ Connected status
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(readonly) connecting
+
+
+
+
+
+
+
+
+
+
+ Properties:
-
+
+
-
- batteryLevelName
+
+
+ Type
+
+
-
-
-
- number
-
-
+ Description
+
+
+
+
+
+
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Connecting status
@@ -4040,55 +4157,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4096,13 +4205,12 @@ Properties:
-
+(readonly) firmwareVersion
+
+
-
- (readonly) connected
-
@@ -4110,59 +4218,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Firmware version of the hub
@@ -4170,55 +4272,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4226,13 +4320,10 @@ Properties:
-
+(readonly) hardwareVersion
-
- (readonly) connecting
-
@@ -4240,59 +4331,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Hardware version of the hub
@@ -4300,55 +4387,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4356,13 +4435,12 @@ Properties:
-
+(readonly) name
+
+
-
- (readonly) firmwareVersion
-
@@ -4370,59 +4448,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Name of the hub
@@ -4430,55 +4502,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4486,13 +4550,10 @@ Properties:
-
+(readonly) ports
-
- (readonly) hardwareVersion
-
@@ -4500,59 +4561,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Array of port names
@@ -4560,55 +4617,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4616,13 +4665,12 @@ Properties:
-
+(readonly) primaryMACAddress
+
+
-
- (readonly) name
-
@@ -4630,59 +4678,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Primary MAC address of the hub
@@ -4690,55 +4732,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4746,13 +4780,10 @@ Properties:
-
+(readonly) rssi
-
- (readonly) ports
-
@@ -4760,59 +4791,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Signal strength of the hub
@@ -4820,55 +4847,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -4876,13 +4895,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) primaryMACAddress
-
@@ -4890,59 +4908,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Hub type
@@ -4950,55 +4962,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -5006,13 +5010,10 @@ Properties:
-
+(readonly) uuid
-
- (readonly) rssi
-
@@ -5020,59 +5021,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ UUID of the hub
@@ -5080,55 +5077,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -5136,259 +5125,267 @@ Properties:
-
+
+
+
+
+ Methods
+
-
- (readonly) type
-
+
+
+
+ connect() → {Promise}
+
+
+
+
+ Connect to the Hub.
+
+
+
- Properties:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
+
+
-
-
- type
-
-
-
- string
-
+
+
-
-
+
-
+
-
+
-
- Hub type
-
-
+
-
-
-
+
+
+
+
+
+
-
+
+
+
+
-
-
-
- Returns:
+
+
+
+ Resolved upon successful connect.
+
+
+
+
+
+
+
-
-
- (readonly) uuid
-
+
+
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
+
+
+
+
+ Combines two ports with into a single virtual port.
+Note: The devices attached to the ports must be of the same device type.
+
- Properties:
-
-
-
+
+
+ Parameters:
+
+
+
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
+
+ firstPortName
-
-
-
- string
-
+
+
+
+string
+
+
+
+
+
+
+
+
+
+ First port name
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
- UUID of the hub
-
-
+
+
+
+
+ Second port name
+
+
-
+
-
+
-
+
-
+
@@ -5396,129 +5393,113 @@ Properties:
-
-
-
-
- Methods
-
-
-
-
-
-
-
-
- connect() → {Promise}
-
-
-
-
- Connect to the Hub.
-
+Returns:
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
-
-
-
+
+
+
+
+
+
+ disconnect() → {Promise}
+
+
+
-
-
-
+
+ Disconnect the Hub.
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
-
+
+
-
- Combines two ports with into a single virtual port.
-Note: The devices attached to the ports must be of the same device type.
-
@@ -5526,274 +5507,217 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+Returns:
-
-
-
-
- firstPortName
-
-
-
- string
-
-
-
+
+ Resolved upon successful disconnect.
+
-
-
+
+
+
+
-
-
- secondPortName
-
-
-
- string
-
-
-
-
-
-
-
- Second port name
-
-
-
+
-
-
-
-
+
+ getDeviceAtPort(portName) → {Device|undefined}
+
+
-
-
-
-
-
-
-
-
+ Retrieves the device attached to a given port.
+
-
-
-
-
-
-
-
-
-
- Parameters:
+
-
+
+
+
+
+ Name
+
-
+ Type
-
-
+
+
+ Description
+
+
+
+
+
+
+ portName
+
+
+string
+
+
+
+
+ The name of the port to retrieve the device from.
+
+
+
-
-
-
-
-
-
-
-
- disconnect() → {Promise}
-
-
+
-
+
+
+
-
- Disconnect the Hub.
-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+ The device attached to the port.
+
+
+
+
-
+
+
-
+
+ getDevices() → {Array.<Device>}
+
-
-
-
-
-
- getDeviceAtPort(portName) → {Device|undefined}
-
-
+
-
+
+ Retrieves all attached devices.
+
-
- Retrieves the device attached to a given port.
-
@@ -5801,145 +5725,109 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+
-
-
-
- portName
-
-
-
- string
-
+
-
-
+
-
+
-
+
-
- The name of the port to retrieve the device from.
-
-
-
+
-
-
+
+
+
+
-
+
+
-
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+ Array of all attached devices.
+
+
+
+
-
+
+
-
+
+ getDevicesByType(deviceType) → {Array.<Device>}
+
-
-
-
-
-
- getDevices() → {Array.<Device>}
-
-
+
-
+
+ Retrieves an array of devices of the specified type.
+
-
- Retrieves all attached devices.
-
@@ -5948,89 +5836,101 @@
+ Parameters:
+
+
+
+
+
+ Name
+
-
+ Type
-
+
-
+
-
+ Description
+
+
-
+
+
-
+
+
+ deviceType
+
+
+number
-
-
+
+
-
+
-
+
-
+ The device type to lookup.
-
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
- getDevicesByType(deviceType) → {Array.<Device>}
-
-
+
-
+
+
-
- Retrieves an array of devices of the specified type.
-
@@ -6038,268 +5938,218 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+Returns:
-
-
-
-
- deviceType
-
-
-
- number
-
-
-
+
+ Array of all devices of the specified type.
+
-
-
+
+
+
+
-
-
-
-
-
+
+
-
+
-
+
+ setName(name) → {Promise}
+
-
+
-
-
-
+
+ Set the name of the Hub.
+
-
-
-
-
-
-
-
+ Parameters:
+
+
+
+
+
+ Name
+
+ Type
+
+
+ Description
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+ New name of the hub (14 characters or less, ASCII only).
-
-
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
-
+
-
- Set the name of the Hub.
-
+
+
+
+
+ Parameters:
-
+
-
-
-
-
- Name
-
+
- Type
+
-
+
-
+
- Description
-
-
+
+
-
- name
-
-
-
- string
-
+
+
-
-
-
-
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
-
-
-
-
-
-
-
-
- Returns:
-
+
+
+ Resolved upon successful issuance of command.
+
-
-
-
+
+
-
+
-
-
-
+
+
+
+
+ shutdown() → {Promise}
+
+
+
+ Shutdown the Hub.
+
@@ -6308,131 +6158,115 @@ Parameters:
-
-
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
-
- Shutdown the Hub.
-
+
+
+
+
+
-
+
+
-
-
+Returns:
+
+
+ Resolved upon successful disconnect.
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- sleep(delay) → {Promise}
-
-
+
+ sleep(delay) → {Promise}
+
-
+
-
+
Sleep a given amount of time.
Note: This is a helper method to make it easier to add delays into a chain of commands.
-
+
+
@@ -6440,106 +6274,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- delay
-
+
+
+ delay
+
+
+number
-
-
+
+
-
+
-
+
-
- How long to sleep (in milliseconds).
-
-
-
+ How long to sleep (in milliseconds).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -6555,31 +6381,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved after the delay is finished.
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
-
-
-
-
-
- wait(commands) → {Promise}
-
-
+
+ wait(commands) → {Promise}
+
-
+
-
+
Wait until a given list of concurrently running commands are complete.
Note: This is a helper method to make it easier to wait for concurrent commands to complete.
-
+
+
@@ -6587,106 +6434,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- commands
-
+
+
+ commands
+
+
+Array.<Promise.<any>>
-
-
+
+
-
+
-
+
-
- Array of executing commands.
-
-
-
+ Array of executing commands.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -6702,31 +6541,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved after the commands are finished.
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- waitForDeviceAtPort(portName) → {Promise}
-
-
-
+
+
+
+
+
+
+ waitForDeviceAtPort(portName) → {Promise}
+
+
+
-
+
Retrieves the device attached to a given port, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
-
+
+
@@ -6734,106 +6594,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The name of the port to retrieve the device from.
-
-
-
+ The name of the port to retrieve the device from.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -6849,31 +6701,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved once a device is attached, or resolved immediately if a device is already attached.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
- waitForDeviceByType(deviceType) → {Promise}
-
-
+
+ waitForDeviceByType(deviceType) → {Promise}
+
-
+
-
+
Retrieves the first device attached of the specified type, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
-
+
+
@@ -6881,106 +6754,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- deviceType
-
+
+
+ deviceType
+
+
+number
-
-
+
+
-
+
-
+
-
- The device type to lookup.
-
-
-
+ The device type to lookup.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -6996,38 +6861,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved once a device is attached, or resolved immediately if a device is already attached.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- attach
-
-
+
+ attach
+
-
+
-
+
Emits when a device is attached to the Hub.
-
+
+
+
@@ -7035,106 +6922,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- device
-
+
+
+ device
+
+
+Device
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -7150,30 +7028,30 @@ Parameters:
-
-
-
-
-
-
-
-
- button
-
-
-
+
+
+
+
+
+
+
+
+ button
+
+
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -7181,144 +7059,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
@@ -7334,30 +7193,30 @@ Parameters:
-
-
-
-
-
-
-
-
- detach
-
-
-
+
+
+
+
+
+
+
+
+ detach
+
+
+
-
+
Emits when a device is detached from the Hub.
-
+
+
+
@@ -7365,106 +7224,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- device
-
+
+
+ device
+
+
+Device
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -7480,30 +7330,31 @@ Parameters:
-
-
-
-
-
-
-
-
- disconnect
-
-
-
+
+
+
+
+
+
+
+
+ disconnect
+
+
+
-
+
Emits when the hub is disconnected.
-
+
+
+
+
@@ -7516,46 +7367,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -7571,26 +7418,34 @@
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/HubLED.html b/docs/HubLED.html
index 80fbbc67..69e1c55b 100644
--- a/docs/HubLED.html
+++ b/docs/HubLED.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- HubLED - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: HubLED
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- HubLED
-
-
-
-
+
+
-
+ HubLED()
- HubLED
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new HubLED()
+
+
+
-
-
-
-
-
-
- new HubLED()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- setColor(color) → {Promise}
-
-
+
+ setColor(color) → {Promise}
+
-
+
-
+
Set the color of the LED on the Hub via a color value.
-
+
@@ -1031,106 +867,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- color
-
+
+
+ color
+
+
+Color
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1146,30 +975,51 @@ Parameters:
-
+
+Returns:
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setRGB(red, green, blue) → {Promise}
-
-
+
+ setRGB(red, green, blue) → {Promise}
+
-
+
-
+
Set the color of the LED on the Hub via RGB values.
-
+
+
@@ -1177,164 +1027,144 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- red
-
+
+
+ red
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- green
-
+
+
+ green
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- blue
-
+
+
+ blue
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1350,30 +1180,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html
index 11a8cdd7..b8040792 100644
--- a/docs/LPF2Hub.html
+++ b/docs/LPF2Hub.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- LPF2Hub - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: LPF2Hub
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- LPF2Hub
-
-
-
-
+
+
-
+ LPF2Hub()
- LPF2Hub
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new LPF2Hub()
+
+
+
-
-
-
-
-
-
- new LPF2Hub()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) batteryLevel
+
+
-
- (readonly) batteryLevel
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,10 @@ Properties:
-
+(readonly) connected
-
- (readonly) connected
-
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) connecting
+
+
-
- (readonly) connecting
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,10 @@ Properties:
-
+(readonly) firmwareVersion
-
- (readonly) firmwareVersion
-
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,12 @@ Properties:
-
+(readonly) hardwareVersion
+
+
-
- (readonly) hardwareVersion
-
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) name
-
- (readonly) name
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,13 +838,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1007,59 +850,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1067,55 +905,47 @@ Properties:
-
+
-
+
-
+
@@ -1123,13 +953,11 @@ Properties:
-
+(readonly) primaryMACAddress
+
-
- (readonly) primaryMACAddress
-
@@ -1137,59 +965,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1197,55 +1020,47 @@ Properties:
-
+
-
+
-
+
@@ -1253,13 +1068,12 @@ Properties:
-
+(readonly) rssi
+
+
-
- (readonly) rssi
-
@@ -1267,59 +1081,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1327,55 +1135,47 @@ Properties:
-
+
-
+
-
+
@@ -1383,13 +1183,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1397,59 +1195,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1457,55 +1250,47 @@ Properties:
-
+
-
+
-
+
@@ -1513,13 +1298,11 @@ Properties:
-
+(readonly) uuid
+
-
- (readonly) uuid
-
@@ -1527,59 +1310,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1587,55 +1365,47 @@ Properties:
-
+
-
+
-
+
@@ -1643,38 +1413,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1682,135 +1444,121 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1826,30 +1574,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
-
+
+
-
+
+
+
+ setName(name) → {Promise}
+
+
+
+
+
+
+
Set the name of the Hub.
-
+
+
@@ -1857,106 +1626,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1972,30 +1733,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
-
+
+ shutdown() → {Promise}
+
+
+
+
+
+
+
Shutdown the Hub.
-
+
+
+
+
@@ -2008,46 +1792,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2063,38 +1843,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2102,135 +1904,120 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2246,26 +2033,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/Light.html b/docs/Light.html
index 6cf93192..f437ea08 100644
--- a/docs/Light.html
+++ b/docs/Light.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- Light - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: Light
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- Light
-
-
-
-
+
+
-
+ Light()
- Light
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new Light()
+
+
+
-
-
-
-
-
-
- new Light()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- rampBrightness(fromBrightness, toBrightness, time) → {Promise}
-
-
+
+ rampBrightness(fromBrightness, toBrightness, time) → {Promise}
+
-
+
-
+
Ramp the light brightness.
-
+
@@ -1031,164 +867,145 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- fromBrightness
-
+
+
+ fromBrightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
-
- toBrightness
-
+
+
+ toBrightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the ramp should last (in milliseconds).
-
-
-
+ How long the ramp should last (in milliseconds).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1204,30 +1021,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrightness(brightness) → {Promise}
-
-
+
+ setBrightness(brightness) → {Promise}
+
-
+
-
+
Set the light brightness.
-
+
+
@@ -1235,106 +1073,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- brightness
-
+
+
+ brightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1350,30 +1180,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command.
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/Mario.html b/docs/Mario.html
index 43e5da51..5a90a36a 100644
--- a/docs/Mario.html
+++ b/docs/Mario.html
@@ -1,129 +1,59 @@
-
-
-
-
-
- Mario - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: Mario
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- Mario
-
-
-
-
+
+
-
+ Mario()
- Mario
-
-
-
-
-
+
-
+
-
+
+
-
-
-
-
-
-
-
- new Mario()
-
-
+
+ new Mario()
+
-
+
-
+
Mario is emitted if the discovered device is a LEGO Super Mario brick.
-
+
+
+
+
@@ -136,46 +66,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
-
+
@@ -213,7 +147,7 @@ Extends
-
+
@@ -222,10 +156,9 @@ Members
+(readonly) batteryLevel
+
-
- (readonly) batteryLevel
-
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -293,55 +221,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -349,13 +269,11 @@ Properties:
-
+(readonly) connected
+
-
- (readonly) connected
-
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -423,55 +336,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -479,13 +384,11 @@ Properties:
-
+(readonly) connecting
+
-
- (readonly) connecting
-
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -553,55 +451,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -609,13 +499,11 @@ Properties:
-
+(readonly) firmwareVersion
+
-
- (readonly) firmwareVersion
-
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -683,55 +566,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -739,13 +614,11 @@ Properties:
-
+(readonly) hardwareVersion
+
-
- (readonly) hardwareVersion
-
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -813,55 +681,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -869,13 +729,11 @@ Properties:
-
+(readonly) name
+
-
- (readonly) name
-
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -943,55 +796,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -999,13 +844,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1073,55 +911,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1129,13 +959,10 @@ Properties:
-
+(readonly) primaryMACAddress
-
- (readonly) primaryMACAddress
-
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1203,55 +1026,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1259,13 +1074,11 @@ Properties:
-
+(readonly) rssi
+
-
- (readonly) rssi
-
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1333,55 +1141,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1389,13 +1189,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1463,55 +1256,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1519,13 +1304,10 @@ Properties:
-
+(readonly) uuid
-
- (readonly) uuid
-
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1593,55 +1371,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1649,38 +1419,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1688,144 +1450,126 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
@@ -1841,30 +1585,50 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
+
+
+
+
-
+
+ setName(name) → {Promise}
+
+
+
-
+
Set the name of the Hub.
-
+
@@ -1872,115 +1636,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
@@ -1996,30 +1749,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
+
+
+
+ shutdown() → {Promise}
+
+
+
-
+
Shutdown the Hub.
-
+
+
+
+
@@ -2032,55 +1808,47 @@
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -2288,26 +2059,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioAccelerometer.html b/docs/MarioAccelerometer.html
index faae0d53..50c49d3d 100644
--- a/docs/MarioAccelerometer.html
+++ b/docs/MarioAccelerometer.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioAccelerometer - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioAccelerometer
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioAccelerometer
-
-
-
-
+
+
-
-
- MarioAccelerometer
+ MarioAccelerometer()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioAccelerometer()
+
+
+
-
-
-
-
-
-
- new MarioAccelerometer()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) type
-
- (readonly) type
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,197 +846,180 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- accel :object
-
-
+
+ accel
+
-
+
-
+
Emits when accelerometer detects movement. Measured in mG.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- x
-
+
+
+ x
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- y
-
+
+
+ y
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- z
-
+
+
+ z
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1208,137 +1035,138 @@ Parameters:
-
-
-
-
-
-
-
-
- gest :object
-
-
-
+
+
+
+
+
+
+
+
+ gest
+
+
+
-
+
Emits when a gesture is detected
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- gesture
-
+
+
+ gesture
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1354,26 +1182,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioBarcodeSensor.html b/docs/MarioBarcodeSensor.html
index 53ee1317..780ad9bf 100644
--- a/docs/MarioBarcodeSensor.html
+++ b/docs/MarioBarcodeSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioBarcodeSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioBarcodeSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioBarcodeSensor
-
-
-
-
+
+
-
-
- MarioBarcodeSensor
+ MarioBarcodeSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioBarcodeSensor()
+
+
+
-
-
-
-
-
-
- new MarioBarcodeSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) type
-
- (readonly) type
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- barcode :object
-
-
+
+ barcode
+
-
+
-
+
Emits when the barcode sensor sees a barcode.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- id
-
+
+
+ id
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,195 +989,184 @@ Parameters:
-
-
-
-
-
-
-
-
- rgb :object
-
-
-
+
+
+
+
+
+
+ rgb
+
-
+
+
+
+
+
Emits when the barcode sensor sees a RGB color.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- r
-
+
+
+ r
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- g
-
+
+
+ g
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- b
-
+
+
+ b
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1354,26 +1182,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioPantsSensor.html b/docs/MarioPantsSensor.html
index a81f45aa..5be25c98 100644
--- a/docs/MarioPantsSensor.html
+++ b/docs/MarioPantsSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioPantsSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioPantsSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioPantsSensor
-
-
-
-
+
+
-
-
- MarioPantsSensor
+ MarioPantsSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioPantsSensor()
+
+
+
-
-
-
-
-
-
- new MarioPantsSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- pants :object
-
-
+
+ pants
+
-
+
-
+
Emits when the user changes the pants on Mario.
-
+
+
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- pants
-
+
+
+ pants
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,26 +989,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MediumLinearMotor.html b/docs/MediumLinearMotor.html
index 7bb73b64..dd2444ed 100644
--- a/docs/MediumLinearMotor.html
+++ b/docs/MediumLinearMotor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MediumLinearMotor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MediumLinearMotor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MediumLinearMotor
-
-
-
-
+
+
-
+ MediumLinearMotor()
- MediumLinearMotor
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new MediumLinearMotor()
+
+
+
-
-
-
-
-
-
- new MediumLinearMotor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,39 +139,35 @@ Extends
-
+
- Methods
-
-
+
+ Methods
+
+
-
+
-
-
-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise}
-
-
+
+ rotateByDegrees(degrees, speedopt) → {Promise}
+
-
+
-
+
Rotate a motor by a given amount of degrees.
-
+
+
+
@@ -247,176 +175,157 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
Attributes
-
+
-
+
Default
-
+
- Description
+ Description
-
+
-
+
-
-
- degrees
-
+
+
+ degrees
+
+
+number
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
-
- How much the motor should be rotated (in degrees).
-
-
-
+ How much the motor should be rotated (in degrees).
-
- speed
-
+
+
+ speed
+
+
+number
-
-
-
-
-
- <optional>
+
+
+
+ <optional>
+
+
+
+
+
-
-
-
-
- 100
+
+
+ 100
+
+
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
+
-
+
-
+
-
+
@@ -432,30 +341,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setAccelerationTime(time) → {Promise}
-
-
+
+ setAccelerationTime(time) → {Promise}
+
-
+
-
+
Set the global acceleration time
-
+
+
+
@@ -463,115 +394,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long acceleration should last (in milliseconds).
-
-
-
+ How long acceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -587,31 +505,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrakingStyle(style)
-
-
+
+ setBrakingStyle(style)
+
-
+
-
+
Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
+
+
@@ -619,115 +559,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -743,146 +670,133 @@ Parameters:
-
-
-
-
-
-
-
-
- setDecelerationTime(time) → {Promise}
-
-
-
+
+
-
- Set the global deceleration time
-
+
+
+ setDecelerationTime(time) → {Promise}
+
+
+
+
+
+
+
+ Set the global deceleration time
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long deceleration should last (in milliseconds).
-
-
-
+ How long deceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -898,31 +812,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setMaxPower(style)
-
-
-
+
+
+
+
+
+
+ setMaxPower(style)
+
+
+
-
+
Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
@@ -930,115 +864,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -1054,30 +977,30 @@ Parameters:
-
-
-
-
-
-
-
-
- setSpeed(speed, time) → {Promise}
-
-
-
+
+
+
+
+
+
+
+
+ setSpeed(speed, time) → {Promise}
+
+
+
-
+
Set the motor speed.
-
+
+
+
@@ -1085,144 +1008,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- speed
-
+
+
+ speed
+
+
+number
-
-
+
+
-
+
-
+
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the motor should run for (in milliseconds).
-
-
-
+ How long the motor should run for (in milliseconds).
+
-
+
-
+
-
+
@@ -1238,154 +1142,173 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- rotate :object
-
-
+
+ rotate
+
-
+
-
+
Emits when a rotation sensor is activated.
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rotation
-
+
+
+ rotation
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -1401,26 +1324,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MotionSensor.html b/docs/MotionSensor.html
index 207e5fe7..3c076aa2 100644
--- a/docs/MotionSensor.html
+++ b/docs/MotionSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MotionSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MotionSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MotionSensor
-
-
-
-
+
+
-
-
- MotionSensor
+ MotionSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MotionSensor()
+
+
+
-
-
-
-
-
-
- new MotionSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- distance :object
-
-
+
+ distance
+
-
+
-
+
Emits when a distance sensor is activated.
-
+
+
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- distance
-
+
+
+ distance
+
+
+number
-
-
+
+
-
+
-
+
-
- Distance, in millimeters.
-
-
-
+ Distance, in millimeters.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,26 +989,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHub.html b/docs/MoveHub.html
index afbfeb93..0e313863 100644
--- a/docs/MoveHub.html
+++ b/docs/MoveHub.html
@@ -1,129 +1,59 @@
-
-
-
-
-
- MoveHub - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHub
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHub
-
-
-
-
+
+
-
+ MoveHub()
- MoveHub
-
-
-
-
-
+
-
+
-
+
+
-
-
-
-
-
-
-
- new MoveHub()
-
-
+
+ new MoveHub()
+
-
+
-
+
The MoveHub is emitted if the discovered device is a Move Hub.
-
+
+
+
+
@@ -136,46 +66,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
-
+
@@ -213,7 +147,7 @@ Extends
-
+
@@ -222,10 +156,9 @@ Members
+(readonly) batteryLevel
+
-
- (readonly) batteryLevel
-
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -293,55 +221,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -349,13 +269,11 @@ Properties:
-
+(readonly) connected
+
-
- (readonly) connected
-
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -423,55 +336,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -479,13 +384,11 @@ Properties:
-
+(readonly) connecting
+
-
- (readonly) connecting
-
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -553,55 +451,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -609,13 +499,11 @@ Properties:
-
+(readonly) firmwareVersion
+
-
- (readonly) firmwareVersion
-
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -683,55 +566,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -739,13 +614,11 @@ Properties:
-
+(readonly) hardwareVersion
+
-
- (readonly) hardwareVersion
-
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -813,55 +681,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -869,13 +729,11 @@ Properties:
-
+(readonly) name
+
-
- (readonly) name
-
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -943,55 +796,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -999,13 +844,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1073,55 +911,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1129,13 +959,10 @@ Properties:
-
+(readonly) primaryMACAddress
-
- (readonly) primaryMACAddress
-
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1203,55 +1026,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1259,13 +1074,11 @@ Properties:
-
+(readonly) rssi
+
-
- (readonly) rssi
-
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1333,55 +1141,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1389,13 +1189,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1463,55 +1256,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1519,13 +1304,10 @@ Properties:
-
+(readonly) uuid
-
- (readonly) uuid
-
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1593,55 +1371,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1649,38 +1419,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1688,144 +1450,126 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
@@ -1841,30 +1585,50 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
+
+
+
+
-
+
+ setName(name) → {Promise}
+
+
+
-
+
Set the name of the Hub.
-
+
@@ -1872,115 +1636,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
@@ -1996,30 +1749,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
+
+
+
+ shutdown() → {Promise}
+
+
+
-
+
Shutdown the Hub.
-
+
+
+
+
@@ -2032,55 +1808,47 @@
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -2288,26 +2059,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHubMediumLinearMotor.html b/docs/MoveHubMediumLinearMotor.html
index 9a87177a..3f6ae183 100644
--- a/docs/MoveHubMediumLinearMotor.html
+++ b/docs/MoveHubMediumLinearMotor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MoveHubMediumLinearMotor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHubMediumLinearMotor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHubMediumLinearMotor
-
-
-
-
+
+
-
+ MoveHubMediumLinearMotor()
- MoveHubMediumLinearMotor
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new MoveHubMediumLinearMotor()
+
+
+
-
-
-
-
-
-
- new MoveHubMediumLinearMotor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,39 +139,35 @@ Extends
-
+
- Methods
-
-
+
+ Methods
+
+
-
+
-
-
-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise}
-
-
+
+ rotateByDegrees(degrees, speedopt) → {Promise}
+
-
+
-
+
Rotate a motor by a given amount of degrees.
-
+
+
+
@@ -247,176 +175,157 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
Attributes
-
+
-
+
Default
-
+
- Description
+ Description
-
+
-
+
-
-
- degrees
-
+
+
+ degrees
+
+
+number
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
-
- How much the motor should be rotated (in degrees).
-
-
-
+ How much the motor should be rotated (in degrees).
-
- speed
-
+
+
+ speed
+
+
+number
-
-
-
-
-
- <optional>
+
+
+
+ <optional>
+
+
+
+
+
-
-
-
-
- 100
+
+
+ 100
+
+
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
+
-
+
-
+
-
+
@@ -432,30 +341,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setAccelerationTime(time) → {Promise}
-
-
+
+ setAccelerationTime(time) → {Promise}
+
-
+
-
+
Set the global acceleration time
-
+
+
+
@@ -463,115 +394,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long acceleration should last (in milliseconds).
-
-
-
+ How long acceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -587,31 +505,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrakingStyle(style)
-
-
+
+ setBrakingStyle(style)
+
-
+
-
+
Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
+
+
@@ -619,115 +559,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -743,146 +670,133 @@ Parameters:
-
-
-
-
-
-
-
-
- setDecelerationTime(time) → {Promise}
-
-
-
+
+
-
- Set the global deceleration time
-
+
+
+ setDecelerationTime(time) → {Promise}
+
+
+
+
+
+
+
+ Set the global deceleration time
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long deceleration should last (in milliseconds).
-
-
-
+ How long deceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -898,31 +812,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setMaxPower(style)
-
-
-
+
+
+
+
+
+
+ setMaxPower(style)
+
+
+
-
+
Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
@@ -930,115 +864,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -1054,30 +977,30 @@ Parameters:
-
-
-
-
-
-
-
-
- setSpeed(speed, time) → {Promise}
-
-
-
+
+
+
+
+
+
+
+
+ setSpeed(speed, time) → {Promise}
+
+
+
-
+
Set the motor speed.
-
+
+
+
@@ -1085,144 +1008,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- speed
-
+
+
+ speed
+
+
+number
-
-
+
+
-
+
-
+
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the motor should run for (in milliseconds).
-
-
-
+ How long the motor should run for (in milliseconds).
+
-
+
-
+
-
+
@@ -1238,154 +1142,173 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- rotate :object
-
-
+
+ rotate
+
-
+
-
+
Emits when a rotation sensor is activated.
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rotation
-
+
+
+ rotation
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -1401,26 +1324,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHubTiltSensor.html b/docs/MoveHubTiltSensor.html
index 9544c818..e3efb764 100644
--- a/docs/MoveHubTiltSensor.html
+++ b/docs/MoveHubTiltSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MoveHubTiltSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHubTiltSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHubTiltSensor
-
-
-
-
+
+
-
-
- MoveHubTiltSensor
+ MoveHubTiltSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MoveHubTiltSensor()
+
+
+
-
-
-
-
-
-
- new MoveHubTiltSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,7 +139,9 @@ Extends
-
+
+
+
@@ -216,10 +150,9 @@ Members
+(readonly) connected
+
-
- (readonly) connected
-
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,11 @@ Properties:
-
+(readonly) isVirtualPort
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,168 +846,157 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- tilt :object
-
-
+
+ tilt
+
-
+
-
+
Emits when a tilt sensor is activated.
-
+
+
+
+
+
+ Type:
+
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- x
-
+
+
+ x
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- y
-
+
+
+ y
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1179,26 +1012,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/PiezoBuzzer.html b/docs/PiezoBuzzer.html
index f0894b1d..50298e22 100644
--- a/docs/PiezoBuzzer.html
+++ b/docs/PiezoBuzzer.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- PiezoBuzzer - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: PiezoBuzzer
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- PiezoBuzzer
-
-
-
-
+
+
-
-
- PiezoBuzzer
+ PiezoBuzzer()
-
-
-
-
+
-
+
-
+
+
+
+
+ new PiezoBuzzer()
+
+
+
-
-
-
-
-
-
- new PiezoBuzzer()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,8 @@ Members
+(readonly) connected
-
- (readonly) connected
-
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- playTone(frequency, time) → {Promise}
-
-
+
+ playTone(frequency, time) → {Promise}
+
-
+
-
+
Play a tone on the Hub's in-built buzzer
-
+
@@ -1031,135 +867,122 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- frequency
-
+
+
+ frequency
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the tone should play for (in milliseconds).
-
-
-
+ How long the tone should play for (in milliseconds).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1175,30 +998,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the tone has finished playing).
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html
index 01ed0fff..55e4c14e 100644
--- a/docs/PoweredUP.html
+++ b/docs/PoweredUP.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- PoweredUP - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: PoweredUP
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- PoweredUP
-
-
-
-
+
+
-
+ PoweredUP()
- PoweredUP
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new PoweredUP()
+
+
+
-
-
-
-
-
-
- new PoweredUP()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,39 +141,31 @@ Extends
-
+
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
-
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
@@ -247,106 +173,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -362,30 +281,47 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
-
+
+
+
+
+
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
+
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -393,106 +329,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -508,30 +436,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubByUUID(uuid) → {BaseHub|null}
-
-
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
-
+
-
+
Retrieve a Powered UP Hub by UUID.
-
+
+
+
@@ -539,106 +485,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -654,229 +591,212 @@ Parameters:
-
+
+Returns:
+
-
+
+
-
- Retrieve a Powered UP Hub by UUID.
-
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
- Parameters:
-
+
-
-
-
-
- Name
-
- Type
-
+
+ Retrieve a Powered UP Hub by UUID.
+
-
- Description
-
-
-
-
-
-
- uuid
-
-
-
- string
-
+
+
+
+
+ Parameters:
+
+
+
+
+ Name
+
-
-
+ Type
-
-
-
-
-
+ Description
+
+
+
-
-
+
+
+ uuid
+
+
+string
+
+
-
+
-
+
-
+
-
+
+
+
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
+
+
+
+
+
+
+
+
- getHubs() → {Array.<BaseHub>}
-
-
-
-
- Retrieve a list of Powered UP Hubs.
-
+Returns:
+
+
+
-
+
-
-
-
-
-
+
+
-
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
+
-
-
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
-
-
@@ -885,39 +805,45 @@
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
+
-
+
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
@@ -925,87 +851,54 @@
-
-
-
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
- Retrieve a list of Powered UP Hub by name.
-
@@ -1013,145 +906,106 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+
-
-
-
- name
-
-
-
- string
-
+
-
-
-
-
+
-
+
-
-
-
-
-
+
-
-
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
+
@@ -1159,106 +1013,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1274,137 +1119,146 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
-
-
- Retrieve a list of Powered UP Hub by type.
-
+
+
+
+
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
+
+
+
+
+
+
+ Retrieve a list of Powered UP Hub by name.
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1420,176 +1274,151 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
+
-
-
- Retrieve a list of Powered UP Hub by type.
-
+
+
+
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
+
- Parameters:
-
+
+ Retrieve a list of Powered UP Hub by type.
+
+
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
-
- name
-
-
-
- string
-
+ Parameters:
+
+
+
+
+ Name
+
-
-
+ Type
-
-
-
-
-
+ Description
+
+
+
-
-
+
+
+ name
+
+
+string
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
- scan()
-
-
+
+
-
-
- Begin scanning for Powered UP Hub devices.
-
@@ -1600,51 +1429,46 @@
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
-
-
+
+
-
- getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
-
+
+ Retrieve a list of Powered UP Hub by type.
+
@@ -1654,37 +1478,53 @@
+ Parameters:
+
+
+
+
+
+ Name
+
+ Type
-
+
-
+ Description
+
+
-
-
-
-
-
- scan()
-
-
+
+
-
+
+
+ name
+
+
+string
-
- Begin scanning for Powered UP Hub devices.
-
+
+
+
+
+
+
+
+
@@ -1693,46 +1533,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1748,129 +1584,105 @@
-
-
-
-
-
-
-
-
-
-
- stop()
-
-
-
-
+Returns:
+
-
- Stop scanning for Powered UP Hub devices.
-
+
+
+
+
+
+
-
+
+ scan()
+
-
+
-
-
-
+
+ Begin scanning for Powered UP Hub devices.
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+ Events
-
-
+
+
-
-
-
-
-
-
- discover
-
-
-
-
- Emits when a Powered UP Hub device is found.
-
@@ -1878,83 +1690,36 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
- hub
-
-
- WeDo2SmartHub
-
- |
-
-
- MoveHub
-
+
- |
+
+ scan()
+
-
- TechnicMediumHub
-
+
- |
-
- RemoteControl
-
- |
+
+ Begin scanning for Powered UP Hub devices.
+
-
- DuploTrainBase
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1962,46 +1727,42 @@ Parameters:
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2017,271 +1778,236 @@ Parameters:
-
-
-
-
-
-
-
-
- discover
-
-
-
+
+
-
- Emits when a Powered UP Hub device is found.
-
+
+
+ stop()
+
+
+
+ Stop scanning for Powered UP Hub devices.
+
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
-
- hub
-
-
-
- WeDo2SmartHub
-
- |
-
- MoveHub
-
- |
-
- TechnicMediumHub
-
+
- |
+
-
- RemoteControl
-
+
- |
+
-
- DuploTrainBase
-
+
+
-
-
+
-
+
-
+
-
-
-
-
-
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+ Events
+
+
+
+
+ discover
+
+
+
+ Emits when a Powered UP Hub device is found.
+
-
-
-
-
-
-
+
+
+
+ Parameters:
-
+
+
+
+
- PoweredUP
+ Name
-
-
-
-
+ Type
-
-
-
+
-
+ Description
+
+
-
-
-
-
-
- new PoweredUP()
-
-
+
+
-
+
+
+ hub
+
+
+WeDo2SmartHub
+|
+MoveHub
+|
+TechnicMediumHub
+|
+RemoteControl
+|
+DuploTrainBase
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
@@ -2297,59 +2023,316 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+ discover
+
+
+
+
+
+
+
+ Emits when a Powered UP Hub device is found.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ hub
+
+
+WeDo2SmartHub
+|
+
+MoveHub
+|
+
+TechnicMediumHub
+|
+
+RemoteControl
+|
+
+DuploTrainBase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PoweredUP()
+
+
+
+
+
+
- Extends
+
+
+
+
+
+ new PoweredUP()
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
- Methods
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Extends
+
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
-
+
+
+
-
+
+ Methods
+
+
+
+
+
+
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
+
+
+
+
+
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -2357,106 +2340,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2472,30 +2447,47 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
-
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -2503,106 +2495,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2618,30 +2602,46 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
+
+
-
+
Retrieve a Powered UP Hub by UUID.
-
+
@@ -2649,106 +2649,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2764,30 +2757,50 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubByUUID(uuid) → {BaseHub|null}
-
-
-
-
+
+
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
+
+
+
+
+
+
Retrieve a Powered UP Hub by UUID.
-
+
+
@@ -2795,145 +2808,208 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
+
-
-
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
+
-
+
+
- Retrieve a list of Powered UP Hubs.
-
+
+
@@ -2944,55 +3020,50 @@
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
+
+
+
+
+ getHubs() → {Array.<BaseHub>}
+
+
+
+ Retrieve a list of Powered UP Hubs.
+
@@ -3001,121 +3072,105 @@
-
-
-
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
-
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
@@ -3123,106 +3178,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3238,30 +3285,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
+
@@ -3269,106 +3334,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3384,30 +3440,47 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by type.
-
+
+
@@ -3415,106 +3488,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3530,30 +3595,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
-
+
+ Retrieve a list of Powered UP Hub by type.
+
-
- Retrieve a list of Powered UP Hub by type.
-
@@ -3561,106 +3644,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3676,30 +3750,49 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- scan()
-
-
+
+ scan()
+
-
+
-
+
Begin scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3712,46 +3805,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3767,30 +3856,31 @@
-
-
-
-
-
-
-
-
- scan()
-
-
-
+
+
+
+
+
+
+
+
+ scan()
+
+
+
-
+
Begin scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3803,46 +3893,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3858,30 +3944,31 @@
-
-
-
-
-
-
-
-
- stop()
-
-
-
+
+
+
+
+
+
+
+
+ stop()
+
+
+
-
+
Stop scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3894,46 +3981,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3949,38 +4032,37 @@
-
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -3988,131 +4070,117 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
+
-
- WeDo2SmartHub
-
+ hub
+
+
+WeDo2SmartHub
+|
+
+MoveHub
+|
- |
+TechnicMediumHub
+|
-
- MoveHub
-
+RemoteControl
+|
- |
+DuploTrainBase
-
- TechnicMediumHub
-
- |
+
+
-
- RemoteControl
-
+
- |
+
-
- DuploTrainBase
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
-
+
+
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
+
-
-
-
- Parameters:
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -4158,131 +4219,117 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
+
+
+ hub
-
- WeDo2SmartHub
-
+
+WeDo2SmartHub
+|
+
+MoveHub
+|
- |
+TechnicMediumHub
+|
-
- MoveHub
-
+RemoteControl
+|
- |
+DuploTrainBase
-
- TechnicMediumHub
-
- |
+
+
-
- RemoteControl
-
+
- |
+
-
- DuploTrainBase
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
-
-
- Hub
+ Hub()
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new Hub() -
- + +new Hub()
+ - + -
+
+
+
+
+
@@ -3883,46 +3772,42 @@ The TechnicSmallHub is emitted if the discovered device is a Technic Small Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3938,21 +3823,29 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - + - + @@ -3960,7 +3853,7 @@Extends
- + @@ -3969,10 +3862,124 @@Members
+(readonly) batteryLevel
+ + + + + + + + + + +Properties:
+ + + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
batteryLevel |
+
+
+ + + +number + + + + | + + + + + +Battery level of the hub (Percentage between 0-100) |
+
-
+
+
+
+
+
+
+
+
+
(readonly) connected
+ -- (readonly) batteryLevel -
@@ -3980,59 +3987,169 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
+
+
+ + + +string + + + + | + + + + + +Connected status |
+
-
+
+
+
+
+
+
+
+
+
(readonly) connecting
+ + + + + + + + + + +Properties:
- +batteryLevel |
-
+
+ Name | + + +Type | + + -- - - number - - + | Description | +
|---|---|---|---|---|
connecting |
+
+
+ + + +string - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ + -- (readonly) connected -
@@ -4110,59 +4218,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
-- (readonly) connecting -
@@ -4240,59 +4331,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ + -- (readonly) firmwareVersion -
@@ -4370,59 +4448,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
-- (readonly) hardwareVersion -
@@ -4500,59 +4561,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Hardware version of the hub - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
+ + -- (readonly) name -
@@ -4630,59 +4678,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
-- (readonly) ports -
@@ -4760,59 +4791,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Array of port names - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) primaryMACAddress -
@@ -4890,59 +4908,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) rssi -
@@ -5020,59 +5021,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- Signal strength of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- + + + + +Methods
+ -- (readonly) type -
+ + + +connect() → {Promise}
+ + + +
+
+
+
- Connect to the Hub.
+Properties:
- -| Name | - -Type | - - -Description | -
|---|---|---|
type |
-
+
- - - - - string - + + - - | + - + - + -
- Hub type - |
-
-
+
-
+
+
+
+
Returns:
+ + +
+
+
+
+
+Resolved upon successful connect.
+-
+
- (readonly) uuid -
+ + + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ + + + +
+
- Combines two ports with into a single virtual port.
+Note: The devices attached to the ports must be of the same device type.
+Properties:
- -| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
+ ||||
firstPortName |
+
- - - - - string - + | + + +string + + + + | + + + + + +First port name |
+ |
secondPortName |
+
-
-
+ + + +string - - + + | -
- UUID of the hub - |
- Second port name |
+
-
-
+
+
-
-
+
-
+
-
+
-
+
Properties:
- - - - -Methods
- - - - - - - -- connect() → {Promise} -
- - -
-
+Connect to the Hub.
-Returns:
+ +
+
+Resolved upon successful issuance of command.
+-
+
-
-
-
+
+
+
+
+
+
+
disconnect() → {Promise}
+ + + - - - +
+
-
-
-
-
-
-
-
-
- Disconnect the Hub.
+-
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + - + +
-
@@ -5526,274 +5507,217 @@ Combines two ports with into a single virtual port.
-Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
firstPortName |
-
-
-
-
-
- string
-
-
-
+
+
-
- Resolved upon successful disconnect. + |
+|
secondPortName |
-
-
- - - - - string - - - - | - - -
- Second port name - - |
-
getDeviceAtPort(portName) → {Device|undefined}
+ + --
-
-
-
-
-
-
-
+
-
-
-
-
-
-
-
-
-
- Retrieves the device attached to a given port.
+Parameters:
+ - +| Name | + - +Type | - - + + +Description | +
|---|---|---|
portName |
+
+ + + +string + + | + + +The name of the port to retrieve the device from. |
+
- disconnect() → {Promise} -
- +-
-
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+ Disconnect the Hub.
--
+
-
+
-
+
+
Returns:
+ +
+
+The device attached to the port.
+-
+
getDevices() → {Array.<Device>}
+ - - - - -- getDeviceAtPort(portName) → {Device|undefined} -
- + - +
+
- Retrieves all attached devices.
+
-
@@ -5801,145 +5725,109 @@ Retrieves the device attached to a given port.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
portName |
-
-
- - - - - string - + - - | + - + - + -
- The name of the port to retrieve the device from. - - |
-
-
+
+
Returns:
+ +
+
+Array of all attached devices.
+-
+
getDevicesByType(deviceType) → {Array.<Device>}
+ - - - - -- getDevices() → {Array.<Device>} -
- + - +
+
- Retrieves an array of devices of the specified type.
+
-
@@ -5948,89 +5836,101 @@ Retrieves all attached devices.
-
+ Parameters:
+
+
| Name | + -Type | - + - + - +Description | +
|---|---|---|
deviceType |
+
-
+ + + +number - - + + | - + - + - +The device type to lookup. |
+
-
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
- getDevicesByType(deviceType) → {Array.<Device>} -
- + - + +
-
@@ -6038,268 +5938,218 @@ Retrieves an array of devices of the specified type.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
deviceType |
-
-
-
-
-
- number
-
-
-
+
+
-
- Array of all devices of the specified type. + |
+
-
-
-
+
+
-
+
-
+
+
setName(name) → {Promise}
+ - + - - - +
+
-
-
-
-
-
-
- Set the name of the Hub.
+Parameters:
+ +| Name | + +Type | + + +Description | +
|---|---|---|
name |
+
+ + + +string + + | + + +New name of the hub (14 characters or less, ASCII only). |
+
- setName(name) → {Promise} -
- - +-
-
-
+
+
+
+
+ Set the name of the Hub.
-Parameters:
- + -| Name | - + -Type | + - + - + -Description | -
|---|---|---|
name |
-
- - - - - string - + + - - | - - -
- New name of the hub (14 characters or less, ASCII only). - - |
-
-
-
-
-
-
-
Returns:
- + +
+
-
-
-
+Resolved upon successful issuance of command.
+-
+
shutdown() → {Promise}
+ + +
+
@@ -6308,131 +6158,115 @@ Shutdown the Hub.
+Parameters:
- - - - - - - -- shutdown() → {Promise} -
- - +-
+
-
-
+
+
+
+ Shutdown the Hub.
--
+
-
+
+
Returns:
+ +
+
+Resolved upon successful disconnect.
+-
+
- sleep(delay) → {Promise} -
- + +sleep(delay) → {Promise}
+ - + -
+
+
+
@@ -6440,106 +6274,98 @@ Sleep a given amount of time.
Note: This is a helper method to make it easier to add delays into a chain of commands.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
delay |
-
- - + | |||
delay |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long to sleep (in milliseconds). - - |
- How long to sleep (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved after the delay is finished.
+-
+
- wait(commands) → {Promise} -
- + +wait(commands) → {Promise}
+ - + -
+
+
+
@@ -6587,106 +6434,98 @@ Wait until a given list of concurrently running commands are complete.
Note: This is a helper method to make it easier to wait for concurrent commands to complete.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
commands |
-
- - + | |||
commands |
-
- Array.<Promise.<any>>
-
-
+ + + +Array.<Promise.<any>> - - | + + - + - + -
- Array of executing commands. - - |
- Array of executing commands. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved after the commands are finished.
+-
+
- waitForDeviceAtPort(portName) → {Promise} -
- - + + + + + + +waitForDeviceAtPort(portName) → {Promise}
+ + + -
+
+
+
@@ -6734,106 +6594,98 @@ Retrieves the device attached to a given port, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
- - + | |||
portName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- The name of the port to retrieve the device from. - - |
- The name of the port to retrieve the device from. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved once a device is attached, or resolved immediately if a device is already attached.
+-
+
- waitForDeviceByType(deviceType) → {Promise} -
- + +waitForDeviceByType(deviceType) → {Promise}
+ - + -
+
+
+
@@ -6881,106 +6754,98 @@ Retrieves the first device attached of the specified type, waiting until one is attached if there isn't one.
Note: If a device is never attached, the returned promise may never resolve.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
deviceType |
-
- - + | |||
deviceType |
-
- number
-
-
+ + + +number - - | + + - + - + -
- The device type to lookup. - - |
- The device type to lookup. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved once a device is attached, or resolved immediately if a device is already attached.
+-
+
Events
- - + +Events
+ + - + - - - - -- attach -
- + +attach
+ - + -
+
+
+
+
@@ -7035,106 +6922,97 @@ Emits when a device is attached to the Hub.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
device |
-
- - + | |||
device |
-
- Device
-
-
+ + + +Device - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- button -
- - + + + + + + + + +button
+ + + -
+
+
+
+
@@ -7181,144 +7059,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- detach -
- - + + + + + + + + +detach
+ + + -
+
+
+
+
@@ -7365,106 +7224,97 @@ Emits when a device is detached from the Hub.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
device |
-
- - + | |||
device |
-
- Device
-
-
+ + + +Device - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- disconnect -
- - + + + + + + + + +disconnect
+ + + -
+
+
+
+
+
@@ -7516,46 +7367,42 @@ Emits when the hub is disconnected.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -7571,26 +7418,34 @@
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/HubLED.html b/docs/HubLED.html
index 80fbbc67..69e1c55b 100644
--- a/docs/HubLED.html
+++ b/docs/HubLED.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- HubLED - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: HubLED
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- HubLED
-
-
-
-
+
+
-
+ HubLED()
- HubLED
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new HubLED()
+
+
+
-
-
-
-
-
-
- new HubLED()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- setColor(color) → {Promise}
-
-
+
+ setColor(color) → {Promise}
+
-
+
-
+
Set the color of the LED on the Hub via a color value.
-
+
@@ -1031,106 +867,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- color
-
+
+
+ color
+
+
+Color
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1146,30 +975,51 @@ Parameters:
-
+
+Returns:
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setRGB(red, green, blue) → {Promise}
-
-
+
+ setRGB(red, green, blue) → {Promise}
+
-
+
-
+
Set the color of the LED on the Hub via RGB values.
-
+
+
@@ -1177,164 +1027,144 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- red
-
+
+
+ red
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- green
-
+
+
+ green
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- blue
-
+
+
+ blue
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1350,30 +1180,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html
index 11a8cdd7..b8040792 100644
--- a/docs/LPF2Hub.html
+++ b/docs/LPF2Hub.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- LPF2Hub - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: LPF2Hub
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- LPF2Hub
-
-
-
-
+
+
-
+ LPF2Hub()
- LPF2Hub
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new LPF2Hub()
+
+
+
-
-
-
-
-
-
- new LPF2Hub()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) batteryLevel
+
+
-
- (readonly) batteryLevel
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,10 @@ Properties:
-
+(readonly) connected
-
- (readonly) connected
-
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) connecting
+
+
-
- (readonly) connecting
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,10 @@ Properties:
-
+(readonly) firmwareVersion
-
- (readonly) firmwareVersion
-
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,12 @@ Properties:
-
+(readonly) hardwareVersion
+
+
-
- (readonly) hardwareVersion
-
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) name
-
- (readonly) name
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,13 +838,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1007,59 +850,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1067,55 +905,47 @@ Properties:
-
+
-
+
-
+
@@ -1123,13 +953,11 @@ Properties:
-
+(readonly) primaryMACAddress
+
-
- (readonly) primaryMACAddress
-
@@ -1137,59 +965,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1197,55 +1020,47 @@ Properties:
-
+
-
+
-
+
@@ -1253,13 +1068,12 @@ Properties:
-
+(readonly) rssi
+
+
-
- (readonly) rssi
-
@@ -1267,59 +1081,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1327,55 +1135,47 @@ Properties:
-
+
-
+
-
+
@@ -1383,13 +1183,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1397,59 +1195,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1457,55 +1250,47 @@ Properties:
-
+
-
+
-
+
@@ -1513,13 +1298,11 @@ Properties:
-
+(readonly) uuid
+
-
- (readonly) uuid
-
@@ -1527,59 +1310,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1587,55 +1365,47 @@ Properties:
-
+
-
+
-
+
@@ -1643,38 +1413,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1682,135 +1444,121 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1826,30 +1574,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
-
+
+
-
+
+
+
+ setName(name) → {Promise}
+
+
+
+
+
+
+
Set the name of the Hub.
-
+
+
@@ -1857,106 +1626,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1972,30 +1733,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
-
+
+ shutdown() → {Promise}
+
+
+
+
+
+
+
Shutdown the Hub.
-
+
+
+
+
@@ -2008,46 +1792,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2063,38 +1843,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2102,135 +1904,120 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2246,26 +2033,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/Light.html b/docs/Light.html
index 6cf93192..f437ea08 100644
--- a/docs/Light.html
+++ b/docs/Light.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- Light - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: Light
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- Light
-
-
-
-
+
+
-
+ Light()
- Light
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new Light()
+
+
+
-
-
-
-
-
-
- new Light()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- rampBrightness(fromBrightness, toBrightness, time) → {Promise}
-
-
+
+ rampBrightness(fromBrightness, toBrightness, time) → {Promise}
+
-
+
-
+
Ramp the light brightness.
-
+
@@ -1031,164 +867,145 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- fromBrightness
-
+
+
+ fromBrightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
-
- toBrightness
-
+
+
+ toBrightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the ramp should last (in milliseconds).
-
-
-
+ How long the ramp should last (in milliseconds).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1204,30 +1021,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrightness(brightness) → {Promise}
-
-
+
+ setBrightness(brightness) → {Promise}
+
-
+
-
+
Set the light brightness.
-
+
+
@@ -1235,106 +1073,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- brightness
-
+
+
+ brightness
+
+
+number
-
-
+
+
-
+
-
+
-
- Brightness value between 0-100 (0 is off)
-
-
-
+ Brightness value between 0-100 (0 is off)
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1350,30 +1180,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command.
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/Mario.html b/docs/Mario.html
index 43e5da51..5a90a36a 100644
--- a/docs/Mario.html
+++ b/docs/Mario.html
@@ -1,129 +1,59 @@
-
-
-
-
-
- Mario - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: Mario
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- Mario
-
-
-
-
+
+
-
+ Mario()
- Mario
-
-
-
-
-
+
-
+
-
+
+
-
-
-
-
-
-
-
- new Mario()
-
-
+
+ new Mario()
+
-
+
-
+
Mario is emitted if the discovered device is a LEGO Super Mario brick.
-
+
+
+
+
@@ -136,46 +66,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
-
+
@@ -213,7 +147,7 @@ Extends
-
+
@@ -222,10 +156,9 @@ Members
+(readonly) batteryLevel
+
-
- (readonly) batteryLevel
-
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -293,55 +221,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -349,13 +269,11 @@ Properties:
-
+(readonly) connected
+
-
- (readonly) connected
-
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -423,55 +336,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -479,13 +384,11 @@ Properties:
-
+(readonly) connecting
+
-
- (readonly) connecting
-
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -553,55 +451,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -609,13 +499,11 @@ Properties:
-
+(readonly) firmwareVersion
+
-
- (readonly) firmwareVersion
-
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -683,55 +566,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -739,13 +614,11 @@ Properties:
-
+(readonly) hardwareVersion
+
-
- (readonly) hardwareVersion
-
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -813,55 +681,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -869,13 +729,11 @@ Properties:
-
+(readonly) name
+
-
- (readonly) name
-
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -943,55 +796,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -999,13 +844,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1073,55 +911,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1129,13 +959,10 @@ Properties:
-
+(readonly) primaryMACAddress
-
- (readonly) primaryMACAddress
-
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1203,55 +1026,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1259,13 +1074,11 @@ Properties:
-
+(readonly) rssi
+
-
- (readonly) rssi
-
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1333,55 +1141,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1389,13 +1189,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1463,55 +1256,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1519,13 +1304,10 @@ Properties:
-
+(readonly) uuid
-
- (readonly) uuid
-
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1593,55 +1371,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1649,38 +1419,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1688,144 +1450,126 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
@@ -1841,30 +1585,50 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
+
+
+
+
-
+
+ setName(name) → {Promise}
+
+
+
-
+
Set the name of the Hub.
-
+
@@ -1872,115 +1636,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
@@ -1996,30 +1749,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
+
+
+
+ shutdown() → {Promise}
+
+
+
-
+
Shutdown the Hub.
-
+
+
+
+
@@ -2032,55 +1808,47 @@
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -2288,26 +2059,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioAccelerometer.html b/docs/MarioAccelerometer.html
index faae0d53..50c49d3d 100644
--- a/docs/MarioAccelerometer.html
+++ b/docs/MarioAccelerometer.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioAccelerometer - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioAccelerometer
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioAccelerometer
-
-
-
-
+
+
-
-
- MarioAccelerometer
+ MarioAccelerometer()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioAccelerometer()
+
+
+
-
-
-
-
-
-
- new MarioAccelerometer()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) type
-
- (readonly) type
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,197 +846,180 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- accel :object
-
-
+
+ accel
+
-
+
-
+
Emits when accelerometer detects movement. Measured in mG.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- x
-
+
+
+ x
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- y
-
+
+
+ y
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- z
-
+
+
+ z
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1208,137 +1035,138 @@ Parameters:
-
-
-
-
-
-
-
-
- gest :object
-
-
-
+
+
+
+
+
+
+
+
+ gest
+
+
+
-
+
Emits when a gesture is detected
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- gesture
-
+
+
+ gesture
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1354,26 +1182,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioBarcodeSensor.html b/docs/MarioBarcodeSensor.html
index 53ee1317..780ad9bf 100644
--- a/docs/MarioBarcodeSensor.html
+++ b/docs/MarioBarcodeSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioBarcodeSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioBarcodeSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioBarcodeSensor
-
-
-
-
+
+
-
-
- MarioBarcodeSensor
+ MarioBarcodeSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioBarcodeSensor()
+
+
+
-
-
-
-
-
-
- new MarioBarcodeSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,10 @@ Properties:
-
+(readonly) type
-
- (readonly) type
-
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- barcode :object
-
-
+
+ barcode
+
-
+
-
+
Emits when the barcode sensor sees a barcode.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- id
-
+
+
+ id
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,195 +989,184 @@ Parameters:
-
-
-
-
-
-
-
-
- rgb :object
-
-
-
+
+
+
+
+
+
+ rgb
+
-
+
+
+
+
+
Emits when the barcode sensor sees a RGB color.
-
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- r
-
+
+
+ r
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- g
-
+
+
+ g
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- b
-
+
+
+ b
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1354,26 +1182,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MarioPantsSensor.html b/docs/MarioPantsSensor.html
index a81f45aa..5be25c98 100644
--- a/docs/MarioPantsSensor.html
+++ b/docs/MarioPantsSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MarioPantsSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MarioPantsSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MarioPantsSensor
-
-
-
-
+
+
-
-
- MarioPantsSensor
+ MarioPantsSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MarioPantsSensor()
+
+
+
-
-
-
-
-
-
- new MarioPantsSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- pants :object
-
-
+
+ pants
+
-
+
-
+
Emits when the user changes the pants on Mario.
-
+
+
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- pants
-
+
+
+ pants
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,26 +989,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MediumLinearMotor.html b/docs/MediumLinearMotor.html
index 7bb73b64..dd2444ed 100644
--- a/docs/MediumLinearMotor.html
+++ b/docs/MediumLinearMotor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MediumLinearMotor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MediumLinearMotor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MediumLinearMotor
-
-
-
-
+
+
-
+ MediumLinearMotor()
- MediumLinearMotor
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new MediumLinearMotor()
+
+
+
-
-
-
-
-
-
- new MediumLinearMotor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,39 +139,35 @@ Extends
-
+
- Methods
-
-
+
+ Methods
+
+
-
+
-
-
-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise}
-
-
+
+ rotateByDegrees(degrees, speedopt) → {Promise}
+
-
+
-
+
Rotate a motor by a given amount of degrees.
-
+
+
+
@@ -247,176 +175,157 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
Attributes
-
+
-
+
Default
-
+
- Description
+ Description
-
+
-
+
-
-
- degrees
-
+
+
+ degrees
+
+
+number
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
-
- How much the motor should be rotated (in degrees).
-
-
-
+ How much the motor should be rotated (in degrees).
-
- speed
-
+
+
+ speed
+
+
+number
-
-
-
-
-
- <optional>
+
+
+
+ <optional>
+
+
+
+
+
-
-
-
-
- 100
+
+
+ 100
+
+
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
+
-
+
-
+
-
+
@@ -432,30 +341,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setAccelerationTime(time) → {Promise}
-
-
+
+ setAccelerationTime(time) → {Promise}
+
-
+
-
+
Set the global acceleration time
-
+
+
+
@@ -463,115 +394,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long acceleration should last (in milliseconds).
-
-
-
+ How long acceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -587,31 +505,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrakingStyle(style)
-
-
+
+ setBrakingStyle(style)
+
-
+
-
+
Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
+
+
@@ -619,115 +559,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -743,146 +670,133 @@ Parameters:
-
-
-
-
-
-
-
-
- setDecelerationTime(time) → {Promise}
-
-
-
+
+
-
- Set the global deceleration time
-
+
+
+ setDecelerationTime(time) → {Promise}
+
+
+
+
+
+
+
+ Set the global deceleration time
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long deceleration should last (in milliseconds).
-
-
-
+ How long deceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -898,31 +812,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setMaxPower(style)
-
-
-
+
+
+
+
+
+
+ setMaxPower(style)
+
+
+
-
+
Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
@@ -930,115 +864,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -1054,30 +977,30 @@ Parameters:
-
-
-
-
-
-
-
-
- setSpeed(speed, time) → {Promise}
-
-
-
+
+
+
+
+
+
+
+
+ setSpeed(speed, time) → {Promise}
+
+
+
-
+
Set the motor speed.
-
+
+
+
@@ -1085,144 +1008,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- speed
-
+
+
+ speed
+
+
+number
-
-
+
+
-
+
-
+
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the motor should run for (in milliseconds).
-
-
-
+ How long the motor should run for (in milliseconds).
+
-
+
-
+
-
+
@@ -1238,154 +1142,173 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- rotate :object
-
-
+
+ rotate
+
-
+
-
+
Emits when a rotation sensor is activated.
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rotation
-
+
+
+ rotation
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -1401,26 +1324,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MotionSensor.html b/docs/MotionSensor.html
index 207e5fe7..3c076aa2 100644
--- a/docs/MotionSensor.html
+++ b/docs/MotionSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MotionSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MotionSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MotionSensor
-
-
-
-
+
+
-
-
- MotionSensor
+ MotionSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MotionSensor()
+
+
+
-
-
-
-
-
-
- new MotionSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,10 @@ Members
+(readonly) connected
+
+
-
- (readonly) connected
-
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,10 @@ Properties:
-
+(readonly) isVirtualPort
-
- (readonly) isVirtualPort
-
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,11 @@ Properties:
-
+(readonly) mode
+
-
- (readonly) mode
-
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,139 +846,134 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- distance :object
-
-
+
+ distance
+
-
+
-
+
Emits when a distance sensor is activated.
-
+
+
+
+
+
+
+ Type:
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- distance
-
+
+
+ distance
+
+
+number
-
-
+
+
-
+
-
+
-
- Distance, in millimeters.
-
-
-
+ Distance, in millimeters.
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1150,26 +989,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHub.html b/docs/MoveHub.html
index afbfeb93..0e313863 100644
--- a/docs/MoveHub.html
+++ b/docs/MoveHub.html
@@ -1,129 +1,59 @@
-
-
-
-
-
- MoveHub - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHub
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHub
-
-
-
-
+
+
-
+ MoveHub()
- MoveHub
-
-
-
-
-
+
-
+
-
+
+
-
-
-
-
-
-
-
- new MoveHub()
-
-
+
+ new MoveHub()
+
-
+
-
+
The MoveHub is emitted if the discovered device is a Move Hub.
-
+
+
+
+
@@ -136,46 +66,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
-
+
@@ -213,7 +147,7 @@ Extends
-
+
@@ -222,10 +156,9 @@ Members
+(readonly) batteryLevel
+
-
- (readonly) batteryLevel
-
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- batteryLevel
-
-
-
- number
-
+
+
+ batteryLevel
+
+
+number
-
-
+
+
-
+
-
+
-
- Battery level of the hub (Percentage between 0-100)
-
-
+ Battery level of the hub (Percentage between 0-100)
@@ -293,55 +221,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -349,13 +269,11 @@ Properties:
-
+(readonly) connected
+
-
- (readonly) connected
-
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- string
-
+
+
+ connected
+
+
+string
-
-
+
+
-
+
-
+
-
- Connected status
-
-
+ Connected status
@@ -423,55 +336,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -479,13 +384,11 @@ Properties:
-
+(readonly) connecting
+
-
- (readonly) connecting
-
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connecting
-
-
-
- string
-
+
+
+ connecting
+
+
+string
-
-
+
+
-
+
-
+
-
- Connecting status
-
-
+ Connecting status
@@ -553,55 +451,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -609,13 +499,11 @@ Properties:
-
+(readonly) firmwareVersion
+
-
- (readonly) firmwareVersion
-
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firmwareVersion
-
-
-
- string
-
+
+
+ firmwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Firmware version of the hub
-
-
+ Firmware version of the hub
@@ -683,55 +566,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -739,13 +614,11 @@ Properties:
-
+(readonly) hardwareVersion
+
-
- (readonly) hardwareVersion
-
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hardwareVersion
-
-
-
- string
-
+
+
+ hardwareVersion
+
+
+string
-
-
+
+
-
+
-
+
-
- Hardware version of the hub
-
-
+ Hardware version of the hub
@@ -813,55 +681,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -869,13 +729,11 @@ Properties:
-
+(readonly) name
+
-
- (readonly) name
-
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
-
-
- string
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- Name of the hub
-
-
+ Name of the hub
@@ -943,55 +796,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -999,13 +844,11 @@ Properties:
-
+(readonly) ports
+
-
- (readonly) ports
-
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- ports
-
-
-
- Array.<string>
-
+
+
+ ports
+
+
+Array.<string>
-
-
+
+
-
+
-
+
-
- Array of port names
-
-
+ Array of port names
@@ -1073,55 +911,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1129,13 +959,10 @@ Properties:
-
+(readonly) primaryMACAddress
-
- (readonly) primaryMACAddress
-
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- primaryMACAddress
-
-
-
- string
-
+
+
+ primaryMACAddress
+
+
+string
-
-
+
+
-
+
-
+
-
- Primary MAC address of the hub
-
-
+ Primary MAC address of the hub
@@ -1203,55 +1026,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1259,13 +1074,11 @@ Properties:
-
+(readonly) rssi
+
-
- (readonly) rssi
-
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rssi
-
-
-
- number
-
+
+
+ rssi
+
+
+number
-
-
+
+
-
+
-
+
-
- Signal strength of the hub
-
-
+ Signal strength of the hub
@@ -1333,55 +1141,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1389,13 +1189,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- string
-
+
+
+ type
+
+
+string
-
-
+
+
-
+
-
+
-
- Hub type
-
-
+ Hub type
@@ -1463,55 +1256,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1519,13 +1304,10 @@ Properties:
-
+(readonly) uuid
-
- (readonly) uuid
-
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
-
-
- string
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
- UUID of the hub
-
-
+ UUID of the hub
@@ -1593,55 +1371,47 @@ Properties:
-
+
-
+
-
+
-
+
@@ -1649,38 +1419,30 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- createVirtualPort(firstPortName, secondPortName) → {Promise}
-
-
+
+ createVirtualPort(firstPortName, secondPortName) → {Promise}
+
-
+
-
+
Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
+
+
@@ -1688,144 +1450,126 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- firstPortName
-
+
+
+ firstPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- First port name
-
-
-
+ First port name
-
- secondPortName
-
+
+
+ secondPortName
+
+
+string
-
-
+
+
-
+
-
+
-
- Second port name
-
-
-
+ Second port name
+
-
+
-
+
-
+
@@ -1841,30 +1585,50 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setName(name) → {Promise}
-
-
+
+
+
+
-
+
+ setName(name) → {Promise}
+
+
+
-
+
Set the name of the Hub.
-
+
@@ -1872,115 +1636,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
- New name of the hub (14 characters or less, ASCII only).
-
-
-
+ New name of the hub (14 characters or less, ASCII only).
+
-
+
-
+
-
+
@@ -1996,30 +1749,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of command.
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- shutdown() → {Promise}
-
-
-
+
+
+
+
+
+
+ shutdown() → {Promise}
+
+
+
-
+
Shutdown the Hub.
-
+
+
+
+
@@ -2032,55 +1808,47 @@
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- button
-
+
+
+ button
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- state
-
+
+
+ state
+
+
+ButtonState
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -2288,26 +2059,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHubMediumLinearMotor.html b/docs/MoveHubMediumLinearMotor.html
index 9a87177a..3f6ae183 100644
--- a/docs/MoveHubMediumLinearMotor.html
+++ b/docs/MoveHubMediumLinearMotor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MoveHubMediumLinearMotor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHubMediumLinearMotor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHubMediumLinearMotor
-
-
-
-
+
+
-
+ MoveHubMediumLinearMotor()
- MoveHubMediumLinearMotor
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new MoveHubMediumLinearMotor()
+
+
+
-
-
-
-
-
-
- new MoveHubMediumLinearMotor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,39 +139,35 @@ Extends
-
+
- Methods
-
-
+
+ Methods
+
+
-
+
-
-
-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise}
-
-
+
+ rotateByDegrees(degrees, speedopt) → {Promise}
+
-
+
-
+
Rotate a motor by a given amount of degrees.
-
+
+
+
@@ -247,176 +175,157 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
Attributes
-
+
-
+
Default
-
+
- Description
+ Description
-
+
-
+
-
-
- degrees
-
+
+
+ degrees
+
+
+number
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
-
- How much the motor should be rotated (in degrees).
-
-
-
+ How much the motor should be rotated (in degrees).
-
- speed
-
+
+
+ speed
+
+
+number
-
-
-
-
-
- <optional>
+
+
+
+ <optional>
+
+
+
+
+
-
-
-
-
- 100
+
+
+ 100
+
+
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100.
+
-
+
-
+
-
+
@@ -432,30 +341,52 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setAccelerationTime(time) → {Promise}
-
-
+
+ setAccelerationTime(time) → {Promise}
+
-
+
-
+
Set the global acceleration time
-
+
+
+
@@ -463,115 +394,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long acceleration should last (in milliseconds).
-
-
-
+ How long acceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -587,31 +505,53 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- setBrakingStyle(style)
-
-
+
+ setBrakingStyle(style)
+
-
+
-
+
Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
+
+
@@ -619,115 +559,102 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -743,146 +670,133 @@ Parameters:
-
-
-
-
-
-
-
-
- setDecelerationTime(time) → {Promise}
-
-
-
+
+
-
- Set the global deceleration time
-
+
+
+ setDecelerationTime(time) → {Promise}
+
+
+
+
+
+
+
+ Set the global deceleration time
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long deceleration should last (in milliseconds).
-
-
-
+ How long deceleration should last (in milliseconds).
+
-
+
-
+
-
+
@@ -898,31 +812,51 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the motor is finished).
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- setMaxPower(style)
-
-
-
+
+
+
+
+
+
+ setMaxPower(style)
+
+
+
-
+
Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
+
@@ -930,115 +864,104 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- style
-
+
+
+ style
+
+
+number
-
-
+
+
-
+
-
+
-
- Either BRAKE or HOLD
-
-
-
+ Either BRAKE or HOLD
+
-
+
-
+
-
+
@@ -1054,30 +977,30 @@ Parameters:
-
-
-
-
-
-
-
-
- setSpeed(speed, time) → {Promise}
-
-
-
+
+
+
+
+
+
+
+
+ setSpeed(speed, time) → {Promise}
+
+
+
-
+
Set the motor speed.
-
+
+
+
@@ -1085,144 +1008,125 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- speed
-
+
+
+ speed
+
+
+number
-
-
+
+
-
+
-
+
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
-
-
+ For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0.
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the motor should run for (in milliseconds).
-
-
-
+ How long the motor should run for (in milliseconds).
+
-
+
-
+
-
+
@@ -1238,154 +1142,173 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- rotate :object
-
-
+
+ rotate
+
-
+
-
+
Emits when a rotation sensor is activated.
-
+
+ Type:
+
+
+
+
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- rotation
-
+
+
+ rotation
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
@@ -1401,26 +1324,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/MoveHubTiltSensor.html b/docs/MoveHubTiltSensor.html
index 9544c818..e3efb764 100644
--- a/docs/MoveHubTiltSensor.html
+++ b/docs/MoveHubTiltSensor.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- MoveHubTiltSensor - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: MoveHubTiltSensor
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- MoveHubTiltSensor
-
-
-
-
+
+
-
-
- MoveHubTiltSensor
+ MoveHubTiltSensor()
-
-
-
-
+
-
+
-
+
+
+
+
+ new MoveHubTiltSensor()
+
+
+
-
-
-
-
-
-
- new MoveHubTiltSensor()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
-
+
-
-
+
+
@@ -207,7 +139,9 @@ Extends
-
+
+
+
@@ -216,10 +150,9 @@ Members
+(readonly) connected
+
-
- (readonly) connected
-
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,11 @@ Properties:
-
+(readonly) hub
+
-
- (readonly) hub
-
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,11 @@ Properties:
-
+(readonly) isVirtualPort
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,12 @@ Properties:
-
+(readonly) type
+
+
-
- (readonly) type
-
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,7 +838,6 @@ Properties:
-
@@ -1002,168 +846,157 @@ Properties:
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- tilt :object
-
-
+
+ tilt
+
-
+
-
+
Emits when a tilt sensor is activated.
-
+
+
+
+
+
+ Type:
+
+
+
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- x
-
+
+
+ x
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- y
-
+
+
+ y
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1179,26 +1012,34 @@ Parameters:
-
+
+
+
+
+
+
+
-
-
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/PiezoBuzzer.html b/docs/PiezoBuzzer.html
index f0894b1d..50298e22 100644
--- a/docs/PiezoBuzzer.html
+++ b/docs/PiezoBuzzer.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- PiezoBuzzer - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: PiezoBuzzer
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- PiezoBuzzer
-
-
-
-
+
+
-
-
- PiezoBuzzer
+ PiezoBuzzer()
-
-
-
-
+
-
+
-
+
+
+
+
+ new PiezoBuzzer()
+
+
+
-
-
-
-
-
-
- new PiezoBuzzer()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,7 +141,7 @@ Extends
-
+
@@ -216,10 +150,8 @@ Members
+(readonly) connected
-
- (readonly) connected
-
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- connected
-
-
-
- boolean
-
+
+
+ connected
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Check if the device is still attached.
-
-
+ Check if the device is still attached.
@@ -287,55 +215,47 @@ Properties:
-
+
-
+
-
+
@@ -343,13 +263,12 @@ Properties:
-
+(readonly) hub
+
+
-
- (readonly) hub
-
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
-
-
- Hub
-
+
+
+ hub
+
+
+Hub
-
-
+
+
-
+
-
+
-
- The Hub the device is attached to.
-
-
+ The Hub the device is attached to.
@@ -417,55 +330,47 @@ Properties:
-
+
-
+
-
+
@@ -473,13 +378,12 @@ Properties:
-
+(readonly) isVirtualPort
+
+
-
- (readonly) isVirtualPort
-
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- isVirtualPort
-
-
-
- boolean
-
+
+
+ isVirtualPort
+
+
+boolean
-
-
+
+
-
+
-
+
-
- Is this device attached to a virtual port (ie. a combined device)
-
-
+ Is this device attached to a virtual port (ie. a combined device)
@@ -547,55 +445,47 @@ Properties:
-
+
-
+
-
+
@@ -603,13 +493,12 @@ Properties:
-
+(readonly) mode
+
+
-
- (readonly) mode
-
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- mode
-
-
-
- number
-
+
+
+ mode
+
+
+number
-
-
+
+
-
+
-
+
-
- The mode the device is currently in
-
-
+ The mode the device is currently in
@@ -677,55 +560,47 @@ Properties:
-
+
-
+
-
+
@@ -733,13 +608,11 @@ Properties:
-
+(readonly) portName
+
-
- (readonly) portName
-
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- portName
-
-
-
- string
-
+
+
+ portName
+
+
+string
-
-
+
+
-
+
-
+
-
- The port the device is attached to.
-
-
+ The port the device is attached to.
@@ -807,55 +675,47 @@ Properties:
-
+
-
+
-
+
@@ -863,13 +723,11 @@ Properties:
-
+(readonly) type
+
-
- (readonly) type
-
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- type
-
-
-
- number
-
+
+
+ type
+
+
+number
-
-
+
+
-
+
-
+
-
- The type of the device
-
-
+ The type of the device
@@ -937,55 +790,47 @@ Properties:
-
+
-
+
-
+
@@ -993,37 +838,28 @@ Properties:
-
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- playTone(frequency, time) → {Promise}
-
-
+
+ playTone(frequency, time) → {Promise}
+
-
+
-
+
Play a tone on the Hub's in-built buzzer
-
+
@@ -1031,135 +867,122 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- frequency
-
+
+
+ frequency
+
+
+number
-
-
+
+
-
+
-
+
-
-
-
-
-
+
-
- time
-
+
+
+ time
+
+
+number
-
-
+
+
-
+
-
+
-
- How long the tone should play for (in milliseconds).
-
-
-
+ How long the tone should play for (in milliseconds).
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1175,30 +998,60 @@ Parameters:
-
+
+Returns:
+
+
+
+ Resolved upon successful completion of command (ie. once the tone has finished playing).
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
-
-
+
-
+
-
-
+
-
+
+
+
\ No newline at end of file
diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html
index 01ed0fff..55e4c14e 100644
--- a/docs/PoweredUP.html
+++ b/docs/PoweredUP.html
@@ -1,123 +1,53 @@
-
-
-
-
-
- PoweredUP - Documentation
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+ JSDoc: Class: PoweredUP
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
-
-
-
-
- PoweredUP
-
-
-
-
+
+
-
+ PoweredUP()
- PoweredUP
-
-
-
-
-
+
-
+
-
+
+
+
+
+ new PoweredUP()
+
+
+
-
-
-
-
-
-
- new PoweredUP()
-
-
-
@@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
- Extends
+ Extends
+
+
-
+
+
-
-
+
@@ -207,39 +141,31 @@ Extends
-
+
- Methods
+ Methods
-
+
+
-
-
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
-
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
@@ -247,106 +173,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -362,30 +281,47 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
-
+
+
+
+
+
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
+
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -393,106 +329,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -508,30 +436,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubByUUID(uuid) → {BaseHub|null}
-
-
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
-
+
-
+
Retrieve a Powered UP Hub by UUID.
-
+
+
+
@@ -539,106 +485,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -654,229 +591,212 @@ Parameters:
-
+
+Returns:
+
-
+
+
-
- Retrieve a Powered UP Hub by UUID.
-
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
- Parameters:
-
+
-
-
-
-
- Name
-
- Type
-
+
+ Retrieve a Powered UP Hub by UUID.
+
-
- Description
-
-
-
-
-
-
- uuid
-
-
-
- string
-
+
+
+
+
+ Parameters:
+
+
+
+
+ Name
+
-
-
+ Type
-
-
-
-
-
+ Description
+
+
+
-
-
+
+
+ uuid
+
+
+string
+
+
-
+
-
+
-
+
-
+
+
+
-
-
-
-
-
-
+
-
+
-
+
-
+
-
-
+
+
+
+
+
+
+
+
- getHubs() → {Array.<BaseHub>}
-
-
-
-
- Retrieve a list of Powered UP Hubs.
-
+Returns:
+
+
+
-
+
-
-
-
-
-
+
+
-
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
+
-
-
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
-
-
@@ -885,39 +805,45 @@
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
+
-
+
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
@@ -925,87 +851,54 @@
-
-
-
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
- Retrieve a list of Powered UP Hub by name.
-
@@ -1013,145 +906,106 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+
-
-
-
- name
-
-
-
- string
-
+
-
-
-
-
+
-
+
-
-
-
-
-
+
-
-
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
+
@@ -1159,106 +1013,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1274,137 +1119,146 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
-
-
- Retrieve a list of Powered UP Hub by type.
-
+
+
+
+
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
+
+
+
+
+
+
+ Retrieve a list of Powered UP Hub by name.
+
- Parameters:
-
+
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1420,176 +1274,151 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
+
-
-
- Retrieve a list of Powered UP Hub by type.
-
+
+
+
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
+
- Parameters:
-
+
+ Retrieve a list of Powered UP Hub by type.
+
+
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
-
- name
-
-
-
- string
-
+ Parameters:
+
+
+
+
+ Name
+
-
-
+ Type
-
-
-
-
-
+ Description
+
+
+
-
-
+
+
+ name
+
+
+string
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
- scan()
-
-
+
+
-
-
- Begin scanning for Powered UP Hub devices.
-
@@ -1600,51 +1429,46 @@
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
-
-
+
+
-
- getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
-
+
+ Retrieve a list of Powered UP Hub by type.
+
@@ -1654,37 +1478,53 @@
+ Parameters:
+
+
+
+
+
+ Name
+
+ Type
-
+
-
+ Description
+
+
-
-
-
-
-
- scan()
-
-
+
+
-
+
+
+ name
+
+
+string
-
- Begin scanning for Powered UP Hub devices.
-
+
+
+
+
+
+
+
+
@@ -1693,46 +1533,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1748,129 +1584,105 @@
-
-
-
-
-
-
-
-
-
-
- stop()
-
-
-
-
+Returns:
+
-
- Stop scanning for Powered UP Hub devices.
-
+
+
+
+
+
+
-
+
+ scan()
+
-
+
-
-
-
+
+ Begin scanning for Powered UP Hub devices.
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+ Events
-
-
+
+
-
-
-
-
-
-
- discover
-
-
-
-
- Emits when a Powered UP Hub device is found.
-
@@ -1878,83 +1690,36 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
- hub
-
-
- WeDo2SmartHub
-
- |
-
-
- MoveHub
-
+
- |
+
+ scan()
+
-
- TechnicMediumHub
-
+
- |
-
- RemoteControl
-
- |
+
+ Begin scanning for Powered UP Hub devices.
+
-
- DuploTrainBase
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1962,46 +1727,42 @@ Parameters:
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2017,271 +1778,236 @@ Parameters:
-
-
-
-
-
-
-
-
- discover
-
-
-
+
+
-
- Emits when a Powered UP Hub device is found.
-
+
+
+ stop()
+
+
+
+ Stop scanning for Powered UP Hub devices.
+
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
-
-
-
-
- hub
-
-
-
- WeDo2SmartHub
-
- |
-
- MoveHub
-
- |
-
- TechnicMediumHub
-
+
- |
+
-
- RemoteControl
-
+
- |
+
-
- DuploTrainBase
-
+
+
-
-
+
-
+
-
+
-
-
-
-
-
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+ Events
+
+
+
+
+ discover
+
+
+
+ Emits when a Powered UP Hub device is found.
+
-
-
-
-
-
-
+
+
+
+ Parameters:
-
+
+
+
+
- PoweredUP
+ Name
-
-
-
-
+ Type
-
-
-
+
-
+ Description
+
+
-
-
-
-
-
- new PoweredUP()
-
-
+
+
-
+
+
+ hub
+
+
+WeDo2SmartHub
+|
+MoveHub
+|
+TechnicMediumHub
+|
+RemoteControl
+|
+DuploTrainBase
+
+
+
+
+
+
+
+
-
-
-
-
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
@@ -2297,59 +2023,316 @@
-
-
+
+
+
+
+
+
+
+
+
+
+
+ discover
+
+
+
+
+
+
+
+ Emits when a Powered UP Hub device is found.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ hub
+
+
+WeDo2SmartHub
+|
+
+MoveHub
+|
+
+TechnicMediumHub
+|
+
+RemoteControl
+|
+
+DuploTrainBase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PoweredUP()
+
+
+
+
+
+
- Extends
+
+
+
+
+
+ new PoweredUP()
+
+
+
+
+
+
+
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
- Methods
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Extends
+
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
-
+
+
+
-
+
+ Methods
+
+
+
+
+
+
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
+
+
+
+
+
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -2357,106 +2340,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2472,30 +2447,47 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubByPrimaryMACAddress(address) → {BaseHub}
-
-
+
+ getHubByPrimaryMACAddress(address) → {BaseHub}
+
-
+
-
+
Retrieve a Powered UP Hub by primary MAC address.
-
+
+
@@ -2503,106 +2495,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- address
-
+
+
+ address
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2618,30 +2602,46 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
+
+
-
+
Retrieve a Powered UP Hub by UUID.
-
+
@@ -2649,106 +2649,99 @@
- Parameters:
-
+
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2764,30 +2757,50 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubByUUID(uuid) → {BaseHub|null}
-
-
-
-
+
+
+
+
+
+
+ getHubByUUID(uuid) → {BaseHub|null}
+
+
+
+
+
+
+
Retrieve a Powered UP Hub by UUID.
-
+
+
@@ -2795,145 +2808,208 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- uuid
-
+
+
+ uuid
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
-
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
+
-
-
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
+
-
+
+
- Retrieve a list of Powered UP Hubs.
-
+
+
@@ -2944,55 +3020,50 @@
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
+
+
+
+
+ getHubs() → {Array.<BaseHub>}
+
+
+
+ Retrieve a list of Powered UP Hubs.
+
@@ -3001,121 +3072,105 @@
-
-
-
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
-
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
@@ -3123,106 +3178,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3238,30 +3285,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
+
@@ -3269,106 +3334,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3384,30 +3440,47 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by type.
-
+
+
@@ -3415,106 +3488,98 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3530,30 +3595,48 @@ Parameters:
-
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
-
-
-
-
- getHubsByType(name) → {Array.<BaseHub>}
-
-
-
+
+ Retrieve a list of Powered UP Hub by type.
+
-
- Retrieve a list of Powered UP Hub by type.
-
@@ -3561,106 +3644,97 @@
- Parameters:
-
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- name
-
+
+
+ name
+
+
+string
-
-
+
+
-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3676,30 +3750,49 @@ Parameters:
-
+
+Returns:
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
- scan()
-
-
+
+ scan()
+
-
+
-
+
Begin scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3712,46 +3805,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3767,30 +3856,31 @@
-
-
-
-
-
-
-
-
- scan()
-
-
-
+
+
+
+
+
+
+
+
+ scan()
+
+
+
-
+
Begin scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3803,46 +3893,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3858,30 +3944,31 @@
-
-
-
-
-
-
-
-
- stop()
-
-
-
+
+
+
+
+
+
+
+
+ stop()
+
+
+
-
+
Stop scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3894,46 +3981,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3949,38 +4032,37 @@
-
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -3988,131 +4070,117 @@
- Parameters:
-
+
+ Parameters:
+
-
+
-
+
Name
-
+
- Type
+ Type
-
+
-
+
- Description
+ Description
-
+
-
+
-
-
- hub
-
+
-
- WeDo2SmartHub
-
+ hub
+
+
+WeDo2SmartHub
+|
+
+MoveHub
+|
- |
+TechnicMediumHub
+|
-
- MoveHub
-
+RemoteControl
+|
- |
+DuploTrainBase
-
- TechnicMediumHub
-
- |
+
+
-
- RemoteControl
-
+
- |
+
-
- DuploTrainBase
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
-
+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/HubLED.html b/docs/HubLED.html index 80fbbc67..69e1c55b 100644 --- a/docs/HubLED.html +++ b/docs/HubLED.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
-
+
+
-
+
+
+
+
-
- - HubLED -
- -
+ HubLED()
- HubLED
-
-
-
-
-
-
+
+
+
+
+
- new HubLED()
+ + + - - - - - -- new HubLED() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- setColor(color) → {Promise} -
- + +setColor(color) → {Promise}
+ - + -
+
+
@@ -1031,106 +867,99 @@ Set the color of the LED on the Hub via a color value.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- setRGB(red, green, blue) → {Promise} -
- + +setRGB(red, green, blue) → {Promise}
+ - + -
+
+
+
@@ -1177,164 +1027,144 @@ Set the color of the LED on the Hub via RGB values.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
red |
-
- - + | |||
red |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
green |
-
- - + | |||
green |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
blue |
-
- - + | |||
blue |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
+
- + + + \ No newline at end of file diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html index 11a8cdd7..b8040792 100644 --- a/docs/LPF2Hub.html +++ b/docs/LPF2Hub.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
@@ -1067,55 +905,47 @@
-
-
+
@@ -1197,55 +1020,47 @@
-
-
+
@@ -1327,55 +1135,47 @@
-
-
+
@@ -1457,55 +1250,47 @@
-
-
+
@@ -1587,55 +1365,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - LPF2Hub -
- -
+ LPF2Hub()
- LPF2Hub
-
-
-
-
-
-
+
+
+
+
+
- new LPF2Hub()
+ + + - - - - - -- new LPF2Hub() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) batteryLevel
+ + -- (readonly) batteryLevel -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) connected
-- (readonly) connected -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ + -- (readonly) connecting -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
-- (readonly) firmwareVersion -
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ + -- (readonly) hardwareVersion -
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) name
-- (readonly) name -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1007,59 +850,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
+ -- (readonly) primaryMACAddress -
@@ -1137,59 +965,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ + -- (readonly) rssi -
@@ -1267,59 +1081,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1397,59 +1195,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) uuid
+ -- (readonly) uuid -
@@ -1527,59 +1310,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1682,135 +1444,121 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- setName(name) → {Promise} -
- - + + -
+
+
+
+
+
+
@@ -1857,106 +1626,98 @@ setName(name) → {Promise}
+ + + + + + +Set the name of the Hub.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- shutdown() → {Promise} -
- - + + + -
+
+
+
+
+
+
@@ -2008,46 +1792,42 @@ shutdown() → {Promise}
+ + + + + + +Shutdown the Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -2063,38 +1843,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2102,135 +1904,120 @@
- Parameters:
-
+ Parameters:
+
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2102,135 +1904,120 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/Light.html b/docs/Light.html index 6cf93192..f437ea08 100644 --- a/docs/Light.html +++ b/docs/Light.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
-
+
+
-
+
+
+
+
-
- - Light -
- -
+ Light()
- Light
-
-
-
-
-
-
+
+
+
+
+
- new Light()
+ + + - - - - - -- new Light() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- rampBrightness(fromBrightness, toBrightness, time) → {Promise} -
- + +rampBrightness(fromBrightness, toBrightness, time) → {Promise}
+ - + -
+
+
@@ -1031,164 +867,145 @@ Ramp the light brightness.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fromBrightness |
-
- - + | |||
fromBrightness |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Brightness value between 0-100 (0 is off) - - |
- Brightness value between 0-100 (0 is off) |
+
- |
toBrightness |
-
- - + | |||
toBrightness |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Brightness value between 0-100 (0 is off) - - |
- Brightness value between 0-100 (0 is off) |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the ramp should last (in milliseconds). - - |
- How long the ramp should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command.
+-
+
- setBrightness(brightness) → {Promise} -
- + +setBrightness(brightness) → {Promise}
+ - + -
+
+
+
@@ -1235,106 +1073,98 @@ Set the light brightness.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
brightness |
-
- - + | |||
brightness |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Brightness value between 0-100 (0 is off) - - |
- Brightness value between 0-100 (0 is off) |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command.
+-
+
+
- + + + \ No newline at end of file diff --git a/docs/Mario.html b/docs/Mario.html index 43e5da51..5a90a36a 100644 --- a/docs/Mario.html +++ b/docs/Mario.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - Mario -
- -
+ Mario()
- Mario
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new Mario() -
- + +new Mario()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ Mario is emitted if the discovered device is a LEGO Super Mario brick.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1688,144 +1450,126 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- setName(name) → {Promise} -
- + + + + - + +setName(name) → {Promise}
+ + + -
+
+
@@ -1872,115 +1636,104 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- shutdown() → {Promise} -
- - + + + + + + +shutdown() → {Promise}
+ + + -
+
+
+
+
+
@@ -2032,55 +1808,47 @@ Shutdown the Hub.
-
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2135,144 +1925,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MarioAccelerometer.html b/docs/MarioAccelerometer.html index faae0d53..50c49d3d 100644 --- a/docs/MarioAccelerometer.html +++ b/docs/MarioAccelerometer.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- MarioAccelerometer
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
+
+
-
- - MarioAccelerometer -
- -
-
- MarioAccelerometer
+ MarioAccelerometer()
-
-
-
-
-
+
+
+
+
+
- new MarioAccelerometer()
+ + + - - - - - -- new MarioAccelerometer() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- @@ -1002,197 +846,180 @@Properties:
-Events
+Events
- + + - - - - - - -- accel :object -
- + +accel
+ - + -
+
+
+
+
+
+ Emits when accelerometer detects movement. Measured in mG.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
z |
-
- - + | |||
z |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- gest :object -
- - + + + + + + + + +gest
+ + + -
+
+
+ Emits when a gesture is detected
-Type:
+-
+
Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
gesture |
-
- - + | |||
gesture |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MarioBarcodeSensor.html b/docs/MarioBarcodeSensor.html index 53ee1317..780ad9bf 100644 --- a/docs/MarioBarcodeSensor.html +++ b/docs/MarioBarcodeSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- MarioBarcodeSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
+
+
-
- - MarioBarcodeSensor -
- -
-
- MarioBarcodeSensor
+ MarioBarcodeSensor()
-
-
-
-
-
+
+
+
+
+
- new MarioBarcodeSensor()
+ + + - - - - - -- new MarioBarcodeSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- barcode :object -
- + +barcode
+ - + -
+
+
+
+
+
+ Emits when the barcode sensor sees a barcode.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
id |
-
- - + | |||
id |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- rgb :object -
- - + + + + + + +rgb
+ -
+
+
+
+
+
+
+
+
+
+ Emits when the barcode sensor sees a RGB color.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
r |
-
- - + | |||
r |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
g |
-
- - + | |||
g |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
b |
-
- - + | |||
b |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MarioPantsSensor.html b/docs/MarioPantsSensor.html index a81f45aa..5be25c98 100644 --- a/docs/MarioPantsSensor.html +++ b/docs/MarioPantsSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- MarioPantsSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - MarioPantsSensor -
- -
-
- MarioPantsSensor
+ MarioPantsSensor()
-
-
-
-
-
+
+
+
+
+
- new MarioPantsSensor()
+ + + - - - - - -- new MarioPantsSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- pants :object -
- + +pants
+ - + -
+
+
+
+
+
+
+
+ Emits when the user changes the pants on Mario.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
pants |
-
- - + | |||
pants |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MediumLinearMotor.html b/docs/MediumLinearMotor.html index 7bb73b64..dd2444ed 100644 --- a/docs/MediumLinearMotor.html +++ b/docs/MediumLinearMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - MediumLinearMotor -
- -
+ MediumLinearMotor()
- MediumLinearMotor
-
-
-
-
-
-
+
+
+
+
+
- new MediumLinearMotor()
+ + + - - - - - -- new MediumLinearMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
-
+
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- rotateByDegrees(degrees, speedopt) → {Promise} -
- + +rotateByDegrees(degrees, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
degrees |
-
- - + | |||||
degrees |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- How much the motor should be rotated (in degrees). - - |
- How much the motor should be rotated (in degrees). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setAccelerationTime(time) → {Promise} -
- + +setAccelerationTime(time) → {Promise}
+ - + -
+
+
+
+
@@ -463,115 +394,102 @@ Set the global acceleration time
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setBrakingStyle(style) -
- + +setBrakingStyle(style)
+ - + -
+
+
+
+
@@ -619,115 +559,102 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + -
-
+
+
+ Set the global deceleration time
-setDecelerationTime(time) → {Promise}
+ + + + + + +
+
- Set the global deceleration time
+Parameters:
- + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setMaxPower(style) -
- - + + + + + + +setMaxPower(style)
+ + + -
+
+
@@ -930,115 +864,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1085,144 +1008,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
Events
- - + +Events
+ + - + - - - - -- rotate :object -
- + +rotate
+ - + -
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MotionSensor.html b/docs/MotionSensor.html index 207e5fe7..3c076aa2 100644 --- a/docs/MotionSensor.html +++ b/docs/MotionSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- MotionSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - MotionSensor -
- -
-
- MotionSensor
+ MotionSensor()
-
-
-
-
-
+
+
+
+
+
- new MotionSensor()
+ + + - - - - - -- new MotionSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- distance :object -
- + +distance
+ - + -
+
+
+
+
+
+
+
+ Emits when a distance sensor is activated.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
distance |
-
- - + | |||
distance |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Distance, in millimeters. - - |
- Distance, in millimeters. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MoveHub.html b/docs/MoveHub.html index afbfeb93..0e313863 100644 --- a/docs/MoveHub.html +++ b/docs/MoveHub.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - MoveHub -
- -
+ MoveHub()
- MoveHub
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new MoveHub() -
- + +new MoveHub()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The MoveHub is emitted if the discovered device is a Move Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1688,144 +1450,126 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- setName(name) → {Promise} -
- + + + + - + +setName(name) → {Promise}
+ + + -
+
+
@@ -1872,115 +1636,104 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- shutdown() → {Promise} -
- - + + + + + + +shutdown() → {Promise}
+ + + -
+
+
+
+
+
@@ -2032,55 +1808,47 @@ Shutdown the Hub.
-
-
+
-
+
-
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2135,144 +1925,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MoveHubMediumLinearMotor.html b/docs/MoveHubMediumLinearMotor.html index 9a87177a..3f6ae183 100644 --- a/docs/MoveHubMediumLinearMotor.html +++ b/docs/MoveHubMediumLinearMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - MoveHubMediumLinearMotor -
- -
+ MoveHubMediumLinearMotor()
- MoveHubMediumLinearMotor
-
-
-
-
-
-
+
+
+
+
+
- new MoveHubMediumLinearMotor()
+ + + - - - - - -- new MoveHubMediumLinearMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
-
+
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- rotateByDegrees(degrees, speedopt) → {Promise} -
- + +rotateByDegrees(degrees, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
degrees |
-
- - + | |||||
degrees |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- How much the motor should be rotated (in degrees). - - |
- How much the motor should be rotated (in degrees). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setAccelerationTime(time) → {Promise} -
- + +setAccelerationTime(time) → {Promise}
+ - + -
+
+
+
+
@@ -463,115 +394,102 @@ Set the global acceleration time
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setBrakingStyle(style) -
- + +setBrakingStyle(style)
+ - + -
+
+
+
+
@@ -619,115 +559,102 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + -
-
+
+
+ Set the global deceleration time
-setDecelerationTime(time) → {Promise}
+ + + + + + +
+
- Set the global deceleration time
+Parameters:
- + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- setMaxPower(style) -
- - + + + + + + +setMaxPower(style)
+ + + -
+
+
@@ -930,115 +864,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1085,144 +1008,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
Events
- - + +Events
+ + - + - - - - -- rotate :object -
- + +rotate
+ - + -
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/MoveHubTiltSensor.html b/docs/MoveHubTiltSensor.html index 9544c818..e3efb764 100644 --- a/docs/MoveHubTiltSensor.html +++ b/docs/MoveHubTiltSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- MoveHubTiltSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - MoveHubTiltSensor -
- -
-
- MoveHubTiltSensor
+ MoveHubTiltSensor()
-
-
-
-
-
+
+
+
+
+
- new MoveHubTiltSensor()
+ + + - - - - - -- new MoveHubTiltSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
-
+
Extends
- + + + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- @@ -1002,168 +846,157 @@Properties:
-Events
+Events
- + + - - - - - - -- tilt :object -
- + +tilt
+ - + -
+
+
+
+
+
+
+ Emits when a tilt sensor is activated.
-Type:
+-
+
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/PiezoBuzzer.html b/docs/PiezoBuzzer.html index f0894b1d..50298e22 100644 --- a/docs/PiezoBuzzer.html +++ b/docs/PiezoBuzzer.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- PiezoBuzzer
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
+
+
+
+
-
- - PiezoBuzzer -
- -
-
- PiezoBuzzer
+ PiezoBuzzer()
-
-
-
-
-
+
+
+
+
+
- new PiezoBuzzer()
+ + + - - - - - -- new PiezoBuzzer() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- playTone(frequency, time) → {Promise} -
- + +playTone(frequency, time) → {Promise}
+ - + -
+
+
@@ -1031,135 +867,122 @@ Play a tone on the Hub's in-built buzzer
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
frequency |
-
- - + | |||
frequency |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the tone should play for (in milliseconds). - - |
- How long the tone should play for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the tone has finished playing).
+-
+
+
- + + + \ No newline at end of file diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html index 01ed0fff..55e4c14e 100644 --- a/docs/PoweredUP.html +++ b/docs/PoweredUP.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
+
-
-
-
-
-
-
-
-
-
+
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
-
-
-
-
-
-
+
+
-
+
+
-
+
+
-
-
-
-
-
-
+
+
@@ -1693,46 +1533,42 @@
-
-
@@ -1962,46 +1727,42 @@
-
-
+
+
+
-
-
-
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+ - PoweredUP -
- -
+ PoweredUP()
- PoweredUP
-
-
-
-
-
-
+
+
+
+
+
- new PoweredUP()
+ + + - - - - - -- new PoweredUP() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
-
-
Extends
- + -Methods
+Methods
- + + - - - - - - -- getHubByPrimaryMACAddress(address) → {BaseHub} -
- + +getHubByPrimaryMACAddress(address) → {BaseHub}
+ - + -
+
+
@@ -247,106 +173,99 @@ Retrieve a Powered UP Hub by primary MAC address.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
address |
-
- - + | |||
address |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
- getHubByPrimaryMACAddress(address) → {BaseHub} -
- - + + + + + + +getHubByPrimaryMACAddress(address) → {BaseHub}
+ + + -
+
+
+
@@ -393,106 +329,98 @@ Retrieve a Powered UP Hub by primary MAC address.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
address |
-
- - + | |||
address |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
- getHubByUUID(uuid) → {BaseHub|null} -
- + +getHubByUUID(uuid) → {BaseHub|null}
+ - + -
+
+
+
+
@@ -539,106 +485,97 @@ Retrieve a Powered UP Hub by UUID.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
- - + | |||
uuid |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - + + -
-
+
+
+
+
+ Retrieve a Powered UP Hub by UUID.
-getHubByUUID(uuid) → {BaseHub|null}
+ -Parameters:
- + -| Name | - -Type | - +Description | -|||
|---|---|---|---|---|---|
uuid |
-
-
-
-
-
- string
-
+
+
+
+
+ Parameters:+
| ||||
uuid |
+
+ + + +string + + | -+ |
-
-
+
-
+
-
+
-
-
- getHubs() → {Array.<BaseHub>} -
- - -
-
+Retrieve a list of Powered UP Hubs.
-Returns:
+ +-
+
-
+
-
-
-
-
-
+
+
-
+
-
+
+
getHubs() → {Array.<BaseHub>}
+ - + - - - +
+
-
-
- Retrieve a list of Powered UP Hubs.
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
+
-
+
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
@@ -925,87 +851,54 @@
-
-
-
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
-
+
+ getHubs() → {Array.<BaseHub>}
+
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
-
+
+ Retrieve a list of Powered UP Hubs.
+
-
- Retrieve a list of Powered UP Hub by name.
-
@@ -1013,145 +906,106 @@
- Parameters:
-
-
-
-
-
- Name
-
- Type
-
-
- Description
-
-
+
-
-
-
- name
-
-
-
- string
-
+
-
-
-
-
+
-
+
-
-
-
-
-
+
-
-
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
+
@@ -1159,106 +1013,97 @@
- Parameters:
-
+ Parameters:
+
- getHubs() → {Array.<BaseHub>} -
- + - + + + -
-
+
+ Retrieve a list of Powered UP Hubs.
--
-
-
-
-
-
-
-
-
+
Returns:
- + - - +-
+
getHubs() → {Array.<BaseHub>}
+ - - - - -- getHubsByName(name) → {Array.<BaseHub>} -
- + - +
+
- Retrieve a list of Powered UP Hubs.
+
-
@@ -1013,145 +906,106 @@ Retrieve a list of Powered UP Hub by name.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
name |
-
-
- - - - - string - + - - | - - + - + -- - - | -
-
+
-
+
+
Returns:
+ +-
+
- getHubsByName(name) → {Array.<BaseHub>} -
- + +getHubsByName(name) → {Array.<BaseHub>}
+ - + -
+
+
+
+
@@ -1159,106 +1013,97 @@ Retrieve a list of Powered UP Hub by name.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - +-
+
- getHubsByType(name) → {Array.<BaseHub>} -
- - -
-
+
+
+
+
+
+ Retrieve a list of Powered UP Hub by type.
-getHubsByName(name) → {Array.<BaseHub>}
+ + + + + + +
+
- Retrieve a list of Powered UP Hub by name.
+Parameters:
- + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
- getHubsByType(name) → {Array.<BaseHub>} -
- + - -
-
+
+
+
+
+ Retrieve a list of Powered UP Hub by type.
-getHubsByType(name) → {Array.<BaseHub>}
+ + -Parameters:
- +
+
+
-Retrieve a list of Powered UP Hub by type.
+| Name | - -Type | - - -Description | -|||
|---|---|---|---|---|---|
name |
-
-
-
-
-
- string
-
+ Parameters:+
| ||||
name |
+
+ + + +string + + | -+ |
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
- scan() -
- + +
-
@@ -1600,51 +1429,46 @@ Begin scanning for Powered UP Hub devices.
-
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
-
-
+
+
-
- getHubsByType(name) → {Array.<BaseHub>}
+
-
+
-
-
+
+ Retrieve a list of Powered UP Hub by type.
+
@@ -1654,37 +1478,53 @@
+ Parameters:
+
+
Returns:
- + - - +-
+
getHubsByType(name) → {Array.<BaseHub>}
+ - + - -Retrieve a list of Powered UP Hub by type.
+Parameters:
+ +| Name | + +Type | - + - +Description | +
|---|---|---|
name |
+
+
+
+
+string
-
-
+
+ Begin scanning for Powered UP Hub devices. - |
+
+
+ + |
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -1748,129 +1584,105 @@
-
-
-
-
-
-
-
-
-
-
- stop()
-
-
-
-
+Returns:
+
-
- Stop scanning for Powered UP Hub devices.
-
+
+
+
+
+
+
-
+
+ scan()
+
-
+
-
-
-
+
+ Begin scanning for Powered UP Hub devices.
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+ Events
-
-
+
+
-
-
-
-
-
-
- discover
-
-
-
-
- Emits when a Powered UP Hub device is found.
-
@@ -1878,83 +1690,36 @@
- Parameters:
-
-
- stop() -
- - - +Returns:
+ -
-
+Stop scanning for Powered UP Hub devices.
--
+
-
+
+
scan()
+ - + - - - +
+
-
-
-
-
-
-
-
-
-
- Begin scanning for Powered UP Hub devices.
+-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
Events
- - + +- discover -
- - -
-
@@ -1878,83 +1690,36 @@ Emits when a Powered UP Hub device is found.
-
- Parameters:
-
-
| Name | - -Type | - - -Description | -
|---|---|---|
hub |
-
-
-
-
-
- WeDo2SmartHub
-
- |
-
-
- MoveHub
-
+
- |
+
+ scan()+ - - TechnicMediumHub - + - | - - RemoteControl - - | +
+
-
- DuploTrainBase
-
-
-
- Begin scanning for Powered UP Hub devices. + |
-
-
- - - - | -
Parameters:
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- - - - - - - -- discover -
- - + + -
-
+
+
+ Emits when a Powered UP Hub device is found.
-stop()
+ + +
+
- Stop scanning for Powered UP Hub devices.
+Parameters:
- -| Name | - -Type | - - -Description | -
|---|---|---|
hub |
-
-
-
-
-
- WeDo2SmartHub
-
- |
-
- MoveHub
-
- |
-
- TechnicMediumHub
-
+
|
+
-
+
-
+
- - - - | -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Events
+ + + + +discover
+ + +
+
-
-
- Emits when a Powered UP Hub device is found.
+Parameters:
-+ +
| Name | - - - - +Type | -Description | +
|---|---|---|
hub |
+
+ + + +WeDo2SmartHub +| +MoveHub +| +TechnicMediumHub +| +RemoteControl +| +DuploTrainBase + + | + + ++ |
-
-
-
-
-
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
-
- -
discover
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+ Emits when a Powered UP Hub device is found.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
hub |
+
+
+ + + +WeDo2SmartHub +| + +MoveHub +| + +TechnicMediumHub +| + +RemoteControl +| + +DuploTrainBase + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
PoweredUP()
+ + +
-
+
+
+ Extends
+ + + + + +new PoweredUP()
+ + + + + + + + + + + - --
-
-
+
+
+
+
+
-
+
+
+
+
+
+
+
-
Methods
- + +Extends
+ - +-
+
- getHubByPrimaryMACAddress(address) → {BaseHub} -
- + - + + + -
+
+
+
+
@@ -2357,106 +2340,98 @@ Methods
+ + + + + + + +getHubByPrimaryMACAddress(address) → {BaseHub}
+ + + + + + +Retrieve a Powered UP Hub by primary MAC address.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
address |
-
- - + | |||
address |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - +-
+
- getHubByPrimaryMACAddress(address) → {BaseHub} -
- + +getHubByPrimaryMACAddress(address) → {BaseHub}
+ - + -
+
+
+
@@ -2503,106 +2495,98 @@ Retrieve a Powered UP Hub by primary MAC address.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
address |
-
- - + | |||
address |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - + + + + + + + + + + + + + + +getHubByUUID(uuid) → {BaseHub|null}
+ + + -
+
+
@@ -2649,106 +2649,99 @@ Retrieve a Powered UP Hub by UUID.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
- - + | |||
uuid |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
- getHubByUUID(uuid) → {BaseHub|null} -
- - -
+
+
+
+
+
+
+
+
+
@@ -2795,145 +2808,208 @@ getHubByUUID(uuid) → {BaseHub|null}
+ + + + + + +Retrieve a Powered UP Hub by UUID.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
- - + | |||
uuid |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
getHubs() → {Array.<BaseHub>}
+ - + - - - +
+
-
-
-
-
-
- Retrieve a list of Powered UP Hubs.
+-
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
-
-
-
- getHubs() → {Array.<BaseHub>} -
- + - + +
-
+
+Retrieve a list of Powered UP Hubs.
-
-
-
-
-
-
-
+Returns:
-
+
-
-
+
+
-
+
-
-
-
+
+
+
+
+ getHubs() → {Array.<BaseHub>}
+
+
+
+ Retrieve a list of Powered UP Hubs.
+
@@ -3001,121 +3072,105 @@
-
-
-
-
-
-
-
-
- getHubs() → {Array.<BaseHub>}
-
-
-
+
+
-
- Retrieve a list of Powered UP Hubs.
-
+
+
+
+
+
+
+
+
+
+
-
+
-
+
+
-
-
-
-
-
-
-
-
-
-
+Returns:
+
+
+
+
-
+
+
-
-
-
-
-
-
-
- getHubsByName(name) → {Array.<BaseHub>}
-
-
+
+ getHubsByName(name) → {Array.<BaseHub>}
+
-
+
-
+
Retrieve a list of Powered UP Hub by name.
-
+
+
@@ -3123,106 +3178,98 @@
- Parameters:
-
+
+ Parameters:
+
Returns:
- + - - +-
+
Retrieve a list of Powered UP Hubs.
+- getHubs() → {Array.<BaseHub>} -
- - +-
+
-
-
+
+
+
+
+
+
+
+
+
+
-Retrieve a list of Powered UP Hubs.
--
+
-
+
+
Returns:
+ +-
+
- getHubsByName(name) → {Array.<BaseHub>} -
- + +getHubsByName(name) → {Array.<BaseHub>}
+ - + -
+
+
+
@@ -3123,106 +3178,98 @@ Retrieve a list of Powered UP Hub by name.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
- getHubsByName(name) → {Array.<BaseHub>} -
- + +getHubsByName(name) → {Array.<BaseHub>}
+ - + -
+
+
+
+
@@ -3269,106 +3334,97 @@ Retrieve a list of Powered UP Hub by name.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - +-
+
- getHubsByType(name) → {Array.<BaseHub>} -
- + +getHubsByType(name) → {Array.<BaseHub>}
+ - + -
+
+
+
@@ -3415,106 +3488,98 @@ Retrieve a list of Powered UP Hub by type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + + + +-
+
getHubsByType(name) → {Array.<BaseHub>}
+ - + - - - - -- getHubsByType(name) → {Array.<BaseHub>} -
- - +
+
- Retrieve a list of Powered UP Hub by type.
+
-
@@ -3561,106 +3644,97 @@ Retrieve a list of Powered UP Hub by type.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ - +-
+
- scan() -
- + +scan()
+ - + -
+
+
+
+
+
@@ -3712,46 +3805,42 @@ Begin scanning for Powered UP Hub devices.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3767,30 +3856,31 @@
-
-
-
-
-
-
-
-
- scan()
-
-
-
+
+
+
+
+
+
+
+
+ scan()
+
+
+
-
+
Begin scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3803,46 +3893,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3858,30 +3944,31 @@
-
-
-
-
-
-
-
-
- stop()
-
-
-
+
+
+
+
+
+
+
+
+ stop()
+
+
+
-
+
Stop scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3894,46 +3981,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3949,38 +4032,37 @@
-
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -3988,131 +4070,117 @@
- Parameters:
-
+
+ Parameters:
+
- scan() -
- - + + + + + + + + +scan()
+ + + -
+
+
+
+
+
@@ -3803,46 +3893,42 @@ Begin scanning for Powered UP Hub devices.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3858,30 +3944,31 @@
-
-
-
-
-
-
-
-
- stop()
-
-
-
+
+
+
+
+
+
+
+
+ stop()
+
+
+
-
+
Stop scanning for Powered UP Hub devices.
-
+
+
+
+
@@ -3894,46 +3981,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3949,38 +4032,37 @@
-
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -3988,131 +4070,117 @@
- Parameters:
-
+
+ Parameters:
+
- stop() -
- - + + + + + + + + +stop()
+ + + -
+
+
+
+
+
@@ -3894,46 +3981,42 @@ Stop scanning for Powered UP Hub devices.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3949,38 +4032,37 @@
-
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- discover
-
-
+
+ discover
+
-
+
-
+
Emits when a Powered UP Hub device is found.
-
+
+
@@ -3988,131 +4070,117 @@
- Parameters:
-
+
+ Parameters:
+
Events
+Events
- + + - - - - - - -- discover -
- + +discover
+ - + -
+
+
+
@@ -3988,131 +4070,117 @@ Emits when a Powered UP Hub device is found.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
- - + | |||
hub |
+
+
+ + + +WeDo2SmartHub +| + +MoveHub +| - | +TechnicMediumHub +| - - MoveHub - +RemoteControl +| - | +DuploTrainBase - - TechnicMediumHub - - | + + | - - RemoteControl - + - | + - - DuploTrainBase - ++ |
-
-
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
+
Parameters:
- + + - - - - - - -- discover -
- + +discover
+ - + -
+
+
+
@@ -4158,131 +4219,117 @@ Emits when a Powered UP Hub device is found.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
- - + | |||
hub |
+
+
+ - - WeDo2SmartHub - + +WeDo2SmartHub +| + +MoveHub +| - | +TechnicMediumHub +| - - MoveHub - +RemoteControl +| - | +DuploTrainBase - - TechnicMediumHub - - | + + | - - RemoteControl - + - | + - - DuploTrainBase - ++ |
-
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
+
- Source: +
- + - + - + - + +
-
-
- - poweredup-node.js, line 188 - -
Parameters:
- + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/RemoteControl.html b/docs/RemoteControl.html index 6541f974..10c1a488 100644 --- a/docs/RemoteControl.html +++ b/docs/RemoteControl.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - RemoteControl -
- -
+ RemoteControl()
- RemoteControl
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new RemoteControl() -
- + +new RemoteControl()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The RemoteControl is emitted if the discovered device is a Remote Control.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/remotecontrol.js, line 27
-
-
-
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/remotecontrol.js, line 27 - -
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1688,144 +1450,126 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- setName(name) → {Promise} -
- + + + + - + +setName(name) → {Promise}
+ + + -
+
+
@@ -1872,115 +1636,104 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + LPF2Hub#setName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- shutdown() → {Promise} -
- - + + + + + + +shutdown() → {Promise}
+ + + -
+
+
+
+
+
@@ -2032,55 +1808,47 @@ Shutdown the Hub.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- LPF2Hub#shutdown
-
-
-
-
+ -
+ LPF2Hub#shutdown
+
- Source:
- -
-
- -
- hubs/lpf2hub.js, line 53
-
-
-
-
+ -
+ hubs/lpf2hub.js, line 57
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
-
- - LPF2Hub#shutdown - -
- + LPF2Hub#shutdown +
-
-
- - hubs/lpf2hub.js, line 53 - -
- + hubs/lpf2hub.js, line 57 +
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2135,144 +1925,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/RemoteControlButton.html b/docs/RemoteControlButton.html index 95b734a7..be5c266d 100644 --- a/docs/RemoteControlButton.html +++ b/docs/RemoteControlButton.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- RemoteControlButton
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - RemoteControlButton -
- -
-
- RemoteControlButton
+ RemoteControlButton()
-
-
-
-
-
+
+
+
+
+
- new RemoteControlButton()
+ + + - - - - - -- new RemoteControlButton() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/remotecontrolbutton.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/remotecontrolbutton.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- button :object -
- + +button
+ - + -
+
+
+
+
+
+
+
+ Emits when a button on the remote is pressed or released.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
event |
-
- - + | |||
event |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/remotecontrolbutton.js, line 37 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/SimpleMediumLinearMotor.html b/docs/SimpleMediumLinearMotor.html index b8d635f1..d690657f 100644 --- a/docs/SimpleMediumLinearMotor.html +++ b/docs/SimpleMediumLinearMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- SimpleMediumLinearMotor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
- - SimpleMediumLinearMotor -
- -
-
- SimpleMediumLinearMotor
+ SimpleMediumLinearMotor()
-
-
-
-
-
+
+
+
+
+
- new SimpleMediumLinearMotor()
+ + + - - - - - -- new SimpleMediumLinearMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- Device -
-
+
- Device +
Extends
- + + + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,24 +846,26 @@Properties:
-+
- + + + \ No newline at end of file diff --git a/docs/TachoMotor.html b/docs/TachoMotor.html index d20e047e..732753ee 100644 --- a/docs/TachoMotor.html +++ b/docs/TachoMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - TachoMotor -
- -
+ TachoMotor()
- TachoMotor
-
-
-
-
-
-
+
+
+
+
+
- new TachoMotor()
+ + + - - - - - -- new TachoMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/tachomotor.js, line 26
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/tachomotor.js, line 26 - -
Extends
+Extends
+ + - +-
+
- BasicMotor +
-
-
- BasicMotor -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
+ ||||
portName |
+
- - - - - string - + | + + +string - + + | - - + - - - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- brake() → {Promise} -
- + +brake() → {Promise}
+ - + -
+
+
+
+
+
@@ -1036,55 +875,47 @@ Brake the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#brake
-
-
-
-
+ -
+ BasicMotor#brake
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 73
-
-
-
-
+
@@ -1100,30 +931,51 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+Promise
+
+
+
+
+
+
+
+
+
-
+
+
+
+
-
-
-
-
-
- rampPower(fromPower, toPower, time) → {Promise}
-
-
+
+ rampPower(fromPower, toPower, time) → {Promise}
+
-
+
-
+
Ramp the motor power.
-
+
+
@@ -1131,173 +983,149 @@
- Parameters:
-
+
+ Parameters:
+
-
-
- - BasicMotor#brake - -
- + BasicMotor#brake +
-
-
- - devices/basicmotor.js, line 73 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- rampPower(fromPower, toPower, time) → {Promise} -
- + +rampPower(fromPower, toPower, time) → {Promise}
+ - + -
+
+
+
@@ -1131,173 +983,149 @@ Ramp the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fromPower |
-
- - + | |||
fromPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
toPower |
-
- - + | |||
toPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the ramp should last (in milliseconds). - - |
- How long the ramp should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#rampPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 46 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command.
+-
+
- + Type + +
- +Promise + + + +
- rotateByDegrees(degrees, speedopt) → {Promise} -
- + +rotateByDegrees(degrees, speedopt) → {Promise}
+ - + -
+
+
+
@@ -1344,167 +1193,153 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
degrees |
-
- - + | |||||
degrees |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- How much the motor should be rotated (in degrees). - - |
- How much the motor should be rotated (in degrees). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
+
-
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- + +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + +setAccelerationTime(time) → {Promise}
+ - + -
+
+
@@ -1551,106 +1406,99 @@ Set the global acceleration time
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
+
-
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
-
+
+Promise
+
-
-
-
-
-
- setBrakingStyle(style) -
- +
+
setBrakingStyle(style)
+ - + -
+
+
+
+
@@ -1698,106 +1568,97 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + -
+
+
+
+
@@ -1844,106 +1704,98 @@ setDecelerationTime(time) → {Promise}
+ + + + + + +Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- - + + + + +setMaxPower(style)
+ -
+
+
+
+
+
+
+
@@ -1991,106 +1864,98 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setPower(power) → {Promise} -
- - + + + + + + + + +setPower(power) → {Promise}
+ + + -
+
+
+
@@ -2137,115 +2001,103 @@ Set the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
power |
-
- - + | |||
power |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#setPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 34 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- setSpeed(speed, time) → {Promise} -
- - + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
@@ -2292,135 +2165,121 @@ Set the motor speed.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- stop() → {Promise} -
- - + + + + + +stop() → {Promise}
+ + + -
+
+
+
+
+
+
@@ -2472,55 +2354,47 @@ Stop the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#stop
-
-
-
-
+ -
+ BasicMotor#stop
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 64
-
-
-
-
+
@@ -2536,145 +2410,168 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- rotate :object
-
-
+
+ rotate
+
-
+
-
+
Emits when a rotation sensor is activated.
-
+
+
+ Type:
+
+ -
+
+object
+
+
+
+
+
- Parameters:
-
+
+ Parameters:
+
-
-
- - BasicMotor#stop - -
- + BasicMotor#stop +
-
-
- - devices/basicmotor.js, line 64 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- rotate :object -
- + +rotate
+ - + -
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/Technic3x3ColorLightMatrix.html b/docs/Technic3x3ColorLightMatrix.html index c06fc6da..2b5a7736 100644 --- a/docs/Technic3x3ColorLightMatrix.html +++ b/docs/Technic3x3ColorLightMatrix.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- Technic3x3ColorLightMatrix
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
+
+
+
+
-
- - Technic3x3ColorLightMatrix -
- -
-
- Technic3x3ColorLightMatrix
+ Technic3x3ColorLightMatrix()
-
-
-
-
-
+
+
+
+
+
- new Technic3x3ColorLightMatrix()
+ + + - - - - - -- new Technic3x3ColorLightMatrix() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
-- (readonly) mode -
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ + -- (readonly) portName -
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- setMatrix(colors) → {Promise} -
- + +setMatrix(colors) → {Promise}
+ - + -
+
+
+
@@ -1031,112 +868,101 @@ Set the LED matrix, one color per LED
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
colors |
-
- - + | |||
colors |
-
- Array.<Color>
-
-
- |
-
- Color
-
+ + + +Array.<Color> +| - +Color - - | + + - + - + -
- Array of 9 colors, 9 Color objects, or a single color - - |
- Array of 9 colors, 9 Color objects, or a single color |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
+
- + + + \ No newline at end of file diff --git a/docs/TechnicColorSensor.html b/docs/TechnicColorSensor.html index 03ef2c77..4485bab6 100644 --- a/docs/TechnicColorSensor.html +++ b/docs/TechnicColorSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
+
+
-
+
+
-
+
+
-
+
+
-
- - TechnicColorSensor -
- -
+ TechnicColorSensor()
- TechnicColorSensor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicColorSensor()
+ + + - - - - - -- new TechnicColorSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/techniccolorsensor.js, line 26
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/techniccolorsensor.js, line 26 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
+ ||||
portName |
+
- - - - - string - + | + + +string - + + | - - + - - - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- setBrightness(firstSegment, secondSegment, thirdSegment) → {Promise} -
- + +setBrightness(firstSegment, secondSegment, thirdSegment) → {Promise}
+ - + -
+
+
+
+
@@ -1031,164 +869,143 @@ Set the brightness (or turn on/off) of the lights around the sensor.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstSegment |
-
- - + | |||
firstSegment |
-
- number
-
-
+ + + +number - - | + + - + - + -
- First light segment. 0-100 brightness. - - |
- First light segment. 0-100 brightness. |
+
- |
secondSegment |
-
- - + | |||
secondSegment |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Second light segment. 0-100 brightness. - - |
- Second light segment. 0-100 brightness. |
+
- |
thirdSegment |
-
- - + | |||
thirdSegment |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Third light segment. 0-100 brightness. - - |
- Third light segment. 0-100 brightness. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/techniccolorsensor.js, line 71 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- ambient :object -
- + +ambient
+ - + -
+
+
+
+
+
+ Emits when the ambient light changes.
-Type:
+-
+
- + +object + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ambient |
-
- - + | |||
ambient |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Percentage, from 0 to 100. - - |
- Percentage, from 0 to 100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/techniccolorsensor.js, line 61 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- color :object -
- - + + + + + + +color
+ + + -
+
+
+
+
+
+
+
+
+
+ Emits when a color sensor is activated.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
color |
-
- - + | |||
color |
-
- Color
-
-
+ + + +Color - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/techniccolorsensor.js, line 40 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- reflect :object -
- - + + + + + + +reflect
+ + + -
+
+
+
+
+ Emits when the light reflectivity changes.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
reflect |
-
- - + | |||
reflect |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Percentage, from 0 to 100. - - |
- Percentage, from 0 to 100. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/techniccolorsensor.js, line 51 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicDistanceSensor.html b/docs/TechnicDistanceSensor.html index 685406bd..3f78954d 100644 --- a/docs/TechnicDistanceSensor.html +++ b/docs/TechnicDistanceSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
+
+
-
+
+
-
+
+
-
- - TechnicDistanceSensor -
- -
+ TechnicDistanceSensor()
- TechnicDistanceSensor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicDistanceSensor()
+ + + - - - - - -- new TechnicDistanceSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/technicdistancesensor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/technicdistancesensor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
+ ||||
portName |
+
- - - - - string - + | + + +string - + + | - - + - - - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- setBrightness(topLeft, bottomLeft, topRight, bottomRight) → {Promise} -
- + +setBrightness(topLeft, bottomLeft, topRight, bottomRight) → {Promise}
+ - + -
+
+
+
@@ -1031,193 +868,167 @@ Set the brightness (or turn on/off) of the lights around the eyes.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
topLeft |
-
- - + | |||
topLeft |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Top left quadrant (above left eye). 0-100 brightness. - - |
- Top left quadrant (above left eye). 0-100 brightness. |
+
- |
bottomLeft |
-
- - + | |||
bottomLeft |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Bottom left quadrant (below left eye). 0-100 brightness. - - |
- Bottom left quadrant (below left eye). 0-100 brightness. |
+
- |
topRight |
-
- - + | |||
topRight |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Top right quadrant (above right eye). 0-100 brightness. - - |
- Top right quadrant (above right eye). 0-100 brightness. |
+
- |
bottomRight |
-
- - + | |||
bottomRight |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Bottom right quadrant (below right eye). 0-100 brightness. - - |
- Bottom right quadrant (below right eye). 0-100 brightness. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicdistancesensor.js, line 58 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
+Events
- + + - - - - - - -- distance :object -
- + +distance
+ - + -
+
+
+
+
+
+
+
+ Emits when the detected distance changes (Slow sampling covers 40mm to 2500mm).
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
distance |
-
- - + | |||
distance |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Distance, from 40 to 2500mm - - |
- Distance, from 40 to 2500mm |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicdistancesensor.js, line 38 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- fastDistance :object -
- - + + + + + + +fastDistance
+ + + + -
+
+
+
+
+ Emits when the detected distance changes (Fast sampling covers 50mm to 320mm).
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fastDistance |
-
- - + | |||
fastDistance |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Distance, from 50 to 320mm - - |
- Distance, from 50 to 320mm |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicdistancesensor.js, line 48 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicForceSensor.html b/docs/TechnicForceSensor.html index 1f723121..6ef07cc6 100644 --- a/docs/TechnicForceSensor.html +++ b/docs/TechnicForceSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
+
+
-
+
+
-
- - TechnicForceSensor -
- -
+ TechnicForceSensor()
- TechnicForceSensor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicForceSensor()
+ + + - - - - - -- new TechnicForceSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/technicforcesensor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/technicforcesensor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- force :object -
- + +force
+ - + -
+
+
+ Emits when force is applied.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
force |
-
- - + | |||
force |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Force, in newtons (0-10). - - |
- Force, in newtons (0-10). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicforcesensor.js, line 38 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- tapped :object -
- - + + + + + + + + +tapped
+ + + -
+
+
+ Emits when the sensor is tapped.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
tapped |
-
- - + | |||
tapped |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How hard the sensor was tapped, from 0-3. - - |
- How hard the sensor was tapped, from 0-3. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicforcesensor.js, line 58 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- touch :object -
- - + + + + -
+
+
+
+
+ touch
+ + + + + + +Emits when the sensor is touched.
-Type:
+-
+
- + +object + + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
touch |
-
- - + | |||
touch |
-
- boolean
-
-
+ + + +boolean - - | + + - + - + -
- Touched on/off (boolean). - - |
- Touched on/off (boolean). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/technicforcesensor.js, line 48 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicLargeAngularMotor.html b/docs/TechnicLargeAngularMotor.html index af94f322..d66a9f49 100644 --- a/docs/TechnicLargeAngularMotor.html +++ b/docs/TechnicLargeAngularMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
-
- TechnicLargeAngularMotor -
- -
+ TechnicLargeAngularMotor()
- TechnicLargeAngularMotor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicLargeAngularMotor()
+ + + - - - - - -- new TechnicLargeAngularMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- AbsoluteMotor -
-
+
- AbsoluteMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoAngle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- + +gotoRealZero(speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -464,135 +395,122 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoRealZero - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#resetZero - -
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Inherited From: +
- + + + + + + + + + + + +
- Source: +
- + + - - + + +
+
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -739,176 +640,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - -
- How much the motor should be rotated (in degrees). - - |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
+ Name | -- - - - number - + | Type | + + +Attributes | + + +Default | + + +Description | +
|---|---|---|---|---|---|---|
degrees |
+
+
+ + + +number - - | - -
- <optional> + |
+
+ + + + + + | - - ++ + | + - -+ | How much the motor should be rotated (in degrees). |
+
speed |
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 100 + + | + + +For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + + - + + +setAccelerationTime(time) → {Promise}
+ + + -
+
+
+
+
@@ -955,115 +912,103 @@ Set the global acceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setBrakingStyle(style) -
- - + + + + + + +setBrakingStyle(style)
+ + + -
+
+
+
+
@@ -1111,115 +1077,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
+
+
+
@@ -1266,115 +1219,103 @@ Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1422,115 +1383,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1577,144 +1527,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#event:absolute - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/TechnicLargeLinearMotor.html b/docs/TechnicLargeLinearMotor.html index 39fb1e8f..a2ed6d6d 100644 --- a/docs/TechnicLargeLinearMotor.html +++ b/docs/TechnicLargeLinearMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
-
- TechnicLargeLinearMotor -
- -
+ TechnicLargeLinearMotor()
- TechnicLargeLinearMotor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicLargeLinearMotor()
+ + + - - - - - -- new TechnicLargeLinearMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- AbsoluteMotor -
-
+
- AbsoluteMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoAngle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- + +gotoRealZero(speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -464,135 +395,122 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoRealZero - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#resetZero - -
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Inherited From: +
- + + + + + + + + + + + +
- Source: +
- + + - - + + +
+
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -739,176 +640,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - -
- How much the motor should be rotated (in degrees). - - |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
+ Name | -- - - - number - + | Type | + + +Attributes | + + +Default | + + +Description | +
|---|---|---|---|---|---|---|
degrees |
+
+
+ + + +number - - | - -
- <optional> + |
+
+ + + + + + | - - ++ + | + - -+ | How much the motor should be rotated (in degrees). |
+
speed |
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 100 + + | + + +For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + + - + + +setAccelerationTime(time) → {Promise}
+ + + -
+
+
+
+
@@ -955,115 +912,103 @@ Set the global acceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setBrakingStyle(style) -
- - + + + + + + +setBrakingStyle(style)
+ + + -
+
+
+
+
@@ -1111,115 +1077,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
+
+
+
@@ -1266,115 +1219,103 @@ Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1422,115 +1383,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1577,144 +1527,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#event:absolute - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/TechnicMediumAngularMotor.html b/docs/TechnicMediumAngularMotor.html index dc1f1097..0681b831 100644 --- a/docs/TechnicMediumAngularMotor.html +++ b/docs/TechnicMediumAngularMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
-
- TechnicMediumAngularMotor -
- -
+ TechnicMediumAngularMotor()
- TechnicMediumAngularMotor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicMediumAngularMotor()
+ + + - - - - - -- new TechnicMediumAngularMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- AbsoluteMotor -
-
+
- AbsoluteMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoAngle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- + +gotoRealZero(speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -464,135 +395,122 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoRealZero - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#resetZero - -
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Inherited From: +
- + + + + + + + + + + + +
- Source: +
- + + - - + + +
+
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -739,176 +640,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - -
- How much the motor should be rotated (in degrees). - - |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
+ Name | -- - - - number - + | Type | + + +Attributes | + + +Default | + + +Description | +
|---|---|---|---|---|---|---|
degrees |
+
+
+ + + +number - - | - -
- <optional> + |
+
+ + + + + + | - - ++ + | + - -+ | How much the motor should be rotated (in degrees). |
+
speed |
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 100 + + | + + +For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + + - + + +setAccelerationTime(time) → {Promise}
+ + + -
+
+
+
+
@@ -955,115 +912,103 @@ Set the global acceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setBrakingStyle(style) -
- - + + + + + + +setBrakingStyle(style)
+ + + -
+
+
+
+
@@ -1111,115 +1077,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
+
+
+
@@ -1266,115 +1219,103 @@ Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1422,115 +1383,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1577,144 +1527,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#event:absolute - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/TechnicMediumHub.html b/docs/TechnicMediumHub.html index b2cdf22b..8ab805ac 100644 --- a/docs/TechnicMediumHub.html +++ b/docs/TechnicMediumHub.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -293,55 +221,47 @@
-
-
+
@@ -423,55 +336,47 @@
-
-
+
@@ -553,55 +451,47 @@
-
-
+
@@ -683,55 +566,47 @@
-
-
+
@@ -813,55 +681,47 @@
-
-
+
@@ -943,55 +796,47 @@
-
-
+
@@ -1073,55 +911,47 @@
-
-
+
@@ -1203,55 +1026,47 @@
-
-
+
@@ -1333,55 +1141,47 @@
-
-
+
@@ -1463,55 +1256,47 @@
-
-
+
@@ -1593,55 +1371,47 @@
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
- - TechnicMediumHub -
- -
+ TechnicMediumHub()
- TechnicMediumHub
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new TechnicMediumHub() -
- + +new TechnicMediumHub()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The TechnicMediumHub is emitted if the discovered device is a Technic Medium Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/technicmediumhub.js, line 27
-
-
-
-
+
@@ -191,21 +117,29 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/technicmediumhub.js, line 27 - -
Extends
+Extends
+ + - + - + @@ -213,7 +147,7 @@Extends
- + @@ -222,10 +156,9 @@Members
+(readonly) batteryLevel
+ -- (readonly) batteryLevel -
@@ -233,59 +166,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ -- (readonly) connected -
@@ -363,59 +281,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
+ -- (readonly) connecting -
@@ -493,59 +396,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ -- (readonly) firmwareVersion -
@@ -623,59 +511,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
+ -- (readonly) hardwareVersion -
@@ -753,59 +626,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -883,59 +741,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1013,59 +856,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1143,59 +970,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
+ -- (readonly) rssi -
@@ -1273,59 +1086,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1403,59 +1201,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
-- (readonly) uuid -
@@ -1533,59 +1315,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
-
+
- Overrides: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- createVirtualPort(firstPortName, secondPortName) → {Promise} -
- + +createVirtualPort(firstPortName, secondPortName) → {Promise}
+ - + -
+
+
+
@@ -1688,144 +1450,126 @@ Combines two ports with into a single virtual port.
Note: The devices attached to the ports must be of the same device type.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firstPortName |
-
- - + | |||
firstPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- First port name - - |
- First port name |
+
- |
secondPortName |
-
- - + | |||
secondPortName |
-
- string
-
-
+ + + +string - - | + + - + - + -
- Second port name - - |
- Second port name |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#createVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 90 - -
-
+ - + hubs/lpf2hub.js, line 94 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- setName(name) → {Promise} -
- + + + + - + +setName(name) → {Promise}
+ + + -
+
+
@@ -1872,115 +1636,104 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#setName - -
-
+ - + LPF2Hub#setName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 61 - -
-
+ - + hubs/lpf2hub.js, line 65 +
+
-
+
-
+
-
+
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise + + + +
- shutdown() → {Promise} -
- - + + + + + + +shutdown() → {Promise}
+ + + -
+
+
+
+
+
@@ -2032,55 +1808,47 @@ Shutdown the Hub.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- LPF2Hub#shutdown
-
-
-
-
+ -
+ LPF2Hub#shutdown
+
- Source:
- -
-
- -
- hubs/lpf2hub.js, line 53
-
-
-
-
+ -
+ hubs/lpf2hub.js, line 57
+
@@ -2096,38 +1864,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
- Events
-
-
+
+ Events
+
+
-
+
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -2135,144 +1925,125 @@
- Parameters:
-
+ Parameters:
+
-
-
- - LPF2Hub#shutdown - -
- + LPF2Hub#shutdown +
-
-
- - hubs/lpf2hub.js, line 53 - -
- + hubs/lpf2hub.js, line 57 +
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -2135,144 +1925,125 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - LPF2Hub#event:button - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/lpf2hub.js, line 182 - -
-
+ - + hubs/lpf2hub.js, line 186 +
+
-
+
-
+
-
+
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicMediumHubAccelerometerSensor.html b/docs/TechnicMediumHubAccelerometerSensor.html index 007ec1d6..c398f1fd 100644 --- a/docs/TechnicMediumHubAccelerometerSensor.html +++ b/docs/TechnicMediumHubAccelerometerSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- TechnicMediumHubAccelerometerSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - TechnicMediumHubAccelerometerSensor -
- -
-
- TechnicMediumHubAccelerometerSensor
+ TechnicMediumHubAccelerometerSensor()
-
-
-
-
-
+
+
+
+
+
- new TechnicMediumHubAccelerometerSensor()
+ + + - - - - - -- new TechnicMediumHubAccelerometerSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
+ ||||
isVirtualPort |
+
- - - - - boolean - + | + + +boolean - + + | - - + - + - +Is this device attached to a virtual port (ie. a combined device) |
+
- Is this device attached to a virtual port (ie. a combined device) - |
-
-
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,197 +846,180 @@Properties:
-Events
+Events
- + + - - - - - - -- accel :object -
- + +accel
+ - + -
+
+
+ Emits when accelerometer detects movement. Measured in mG.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
z |
-
- - + | |||
z |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicMediumHubGyroSensor.html b/docs/TechnicMediumHubGyroSensor.html index 0b9a2c35..a48d1e0e 100644 --- a/docs/TechnicMediumHubGyroSensor.html +++ b/docs/TechnicMediumHubGyroSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- TechnicMediumHubGyroSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - TechnicMediumHubGyroSensor -
- -
-
- TechnicMediumHubGyroSensor
+ TechnicMediumHubGyroSensor()
-
-
-
-
-
+
+
+
+
+
- new TechnicMediumHubGyroSensor()
+ + + - - - - - -- new TechnicMediumHubGyroSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
+ ||||
isVirtualPort |
+
- - - - - boolean - + | + + +boolean - + + | - - + - + - +Is this device attached to a virtual port (ie. a combined device) |
+
- Is this device attached to a virtual port (ie. a combined device) - |
-
-
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
-- (readonly) type -
@@ -877,59 +734,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,197 +846,180 @@Properties:
-Events
+Events
- + + - - - - - - -- gyro :object -
- + +gyro
+ - + -
+
+
+ Emits when gyroscope detects movement. Measured in DPS - degrees per second.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
z |
-
- - + | |||
z |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicMediumHubTiltSensor.html b/docs/TechnicMediumHubTiltSensor.html index a164ad47..5e3177be 100644 --- a/docs/TechnicMediumHubTiltSensor.html +++ b/docs/TechnicMediumHubTiltSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
-
+
+
-
-
+
+
-
-
+
+
-
+
+
-
+
+
-
+
+
-
- - TechnicMediumHubTiltSensor -
- -
+ TechnicMediumHubTiltSensor()
- TechnicMediumHubTiltSensor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicMediumHubTiltSensor()
+ + + - - - - - -- new TechnicMediumHubTiltSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,8 @@Members
+(readonly) connected
-- (readonly) connected -
@@ -227,59 +159,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
-- (readonly) portName -
@@ -747,59 +619,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
+ ||||
portName |
+
- - - - - string - + | + + +string - + + | - - + - + - +The port the device is attached to. |
+
- The port the device is attached to. - |
-
-
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- setImpactCount(impact) → {Promise} -
- + +setImpactCount(impact) → {Promise}
+ - + -
+
+
@@ -1031,106 +867,99 @@ Set the impact count value.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
impact |
-
- - + | |||
impact |
-
- count
-
-
+ + + +count - - | + + - + - + -
- count between 0 and 2^32 - - |
- count between 0 and 2^32 |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise - + +
- setImpactHoldoff(value) → {Promise} -
- + - -
+
+
+
+
+
+
+
+
+
+
+
@@ -1177,106 +1028,97 @@ setImpactHoldoff(value) → {Promise}
+ + + + + + +Set the impact holdoff time.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
value |
-
- - + | |||
value |
-
- holdoff
-
-
+ + + +holdoff - - | + + - + - + -
- between 1 and 127 - - |
- between 1 and 127 |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- setImpactThreshold(value) → {Promise} -
- - + + + + + + +setImpactThreshold(value) → {Promise}
+ + + -
+
+
+
@@ -1323,106 +1186,98 @@ Set the impact threshold.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
value |
-
- - + | |||
value |
-
- threshold
-
-
+ + + +threshold - - | + + - + - + -
- between 1 and 127 - - |
- between 1 and 127 |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
+Events
- + + - - - - - - -- impactCount :object -
- + +impactCount
+ - + -
+
+
+
+
+
+ Emits when proper acceleration is above threshold (e.g. on impact when being thrown to the ground).
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
number |
-
- - + | |||
number |
-
- number
-
-
+ + + +number - - | + + - + - + -
- of impact events. - - |
- of impact events. |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- - - - - - - -- tilt :object -
- - + + + + + + +tilt
+ + + -
+
+
+
+
+
+ Emits when a tilt sensor is activated.
-Type:
+-
+
- + +object + + + +
Parameters:
- + + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
z |
-
- - + | |||
z |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
- - - - +
- + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TechnicSmallAngularMotor.html b/docs/TechnicSmallAngularMotor.html index 5ef5cfc1..562fe61a 100644 --- a/docs/TechnicSmallAngularMotor.html +++ b/docs/TechnicSmallAngularMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
-
- TechnicSmallAngularMotor -
- -
+ TechnicSmallAngularMotor()
- TechnicSmallAngularMotor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicSmallAngularMotor()
+ + + - - - - - -- new TechnicSmallAngularMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- AbsoluteMotor -
-
+
- AbsoluteMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoAngle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- + +gotoRealZero(speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -464,135 +395,122 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoRealZero - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#resetZero - -
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Inherited From: +
- + + + + + + + + + + + +
- Source: +
- + + - - + + +
+
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -739,176 +640,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - -
- How much the motor should be rotated (in degrees). - - |
- ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
+ Name | -- - - - number - + | Type | + + +Attributes | + + +Default | + + +Description | +
|---|---|---|---|---|---|---|
degrees |
+
+
+ + + +number - - | - -
- <optional> + |
+
+ + + + + + | - - ++ + | + - -+ | How much the motor should be rotated (in degrees). |
+
speed |
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 100 + + | + + +For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + + - + + +setAccelerationTime(time) → {Promise}
+ + + -
+
+
+
+
@@ -955,115 +912,103 @@ Set the global acceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setBrakingStyle(style) -
- - + + + + + + +setBrakingStyle(style)
+ + + -
+
+
+
+
@@ -1111,115 +1077,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
+
+
+
@@ -1266,115 +1219,103 @@ Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1422,115 +1383,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1577,144 +1527,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#event:absolute - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/TechnicXLargeLinearMotor.html b/docs/TechnicXLargeLinearMotor.html index f69598c2..a95f09cb 100644 --- a/docs/TechnicXLargeLinearMotor.html +++ b/docs/TechnicXLargeLinearMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
+
-
-
+
+
-
-
-
- TechnicXLargeLinearMotor -
- -
+ TechnicXLargeLinearMotor()
- TechnicXLargeLinearMotor
-
-
-
-
-
-
+
+
+
+
+
- new TechnicXLargeLinearMotor()
+ + + - - - - - -- new TechnicXLargeLinearMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
Extends
+Extends
- + --
-
- AbsoluteMotor -
-
+
- AbsoluteMotor +
Extends
- + -Methods
- - + +Methods
+ + - + - - - - -- gotoAngle(angle, speedopt) → {Promise} -
- + +gotoAngle(angle, speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -247,176 +175,157 @@ Rotate a motor by a given angle.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
angle |
-
- - + | |||||
angle |
-
- number
-
-
-
+ + + +number - - | - -+ | ++ + + + + | - - - -- | - ++ + | + -
- Absolute position the motor should go to (degrees from 0). - - |
- Absolute position the motor should go to (degrees from 0). |
+
-
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoAngle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 52 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- gotoRealZero(speedopt) → {Promise} -
- + +gotoRealZero(speedopt) → {Promise}
+ - + -
+
+
+
+
@@ -464,135 +395,122 @@ Rotate motor to real zero position.
Real zero is marked on Technic angular motors (SPIKE Prime). It is also available on Technic linear motors (Control+) but is unmarked.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - +Attributes | - + - +Default | - + -Description | +Description |
|---|---|---|---|---|---|---|
speed |
-
- - + | |||||
speed |
-
- number
-
-
-
+ + + +number - - | - -
-
- <optional> + |
+
+
+ <optional> + + + + + |
-
-
-
- - 100 + | + + 100 + + | - - -
- Speed between 1 - 100. Note that this will always take the shortest path to zero. - - |
- Speed between 1 - 100. Note that this will always take the shortest path to zero. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#gotoRealZero - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 87 - -
-
+ - + - + - + - +
Parameters:
- - +Returns:
- + +
+
-
-
-
-
- Resolved upon successful completion of command (ie. once the motor is finished).
+- resetZero() → {Promise} -
- - +-
+
- + Type + +
-
+
+Promise
- -+
Reset zero to current position
-
+
resetZero() → {Promise}
+ + --
-
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#resetZero - -
-
-
-
-
-
-
-
-
-
-
-
- - Source: -
-
-
-
-
- - devices/absolutemotor.js, line 118 - -
-
-
-
+ - Inherited From: +
- + + + + + + + + + + + +
- Source: +
- + + - - + + +
+
-
- Reset zero to current position
+-
-
-
- rotateByDegrees(degrees, speedopt) → {Promise} -
- - -
-
@@ -739,176 +640,211 @@ Rotate a motor by a given amount of degrees.
-
- Parameters:
-
-
| Name | - -Type | +Attributes | - + +Default | - -Description | -|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
degrees |
+- - - - number - - + + + - - | - -- - - - | - -- | - -
- How much the motor should be rotated (in degrees). - - |
- |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
speed |
+ Name | -- - - - number - + | Type | + + +Attributes | + + +Default | + + +Description | +
|---|---|---|---|---|---|---|
degrees |
+
+
+ + + +number - - | - -
- <optional> + |
+
+ + + + + + | - - ++ + | + - -+ | How much the motor should be rotated (in degrees). |
+
speed |
-
-
-
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. - - |
- + + +number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 100 + + | + + +For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#rotateByDegrees - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 138 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setAccelerationTime(time) → {Promise} -
- + + - + + +setAccelerationTime(time) → {Promise}
+ + + -
+
+
+
+
@@ -955,115 +912,103 @@ Set the global acceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long acceleration should last (in milliseconds). - - |
- How long acceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setAccelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 73 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setBrakingStyle(style) -
- - + + + + + + +setBrakingStyle(style)
+ + + -
+
+
+
+
@@ -1111,115 +1077,103 @@ Set the braking style of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setBrakingStyle - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 53 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setDecelerationTime(time) → {Promise} -
- - + + + + + + +setDecelerationTime(time) → {Promise}
+ + + -
+
+
+
+
+
@@ -1266,115 +1219,103 @@ Set the global deceleration time
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long deceleration should last (in milliseconds). - - |
- How long deceleration should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setDecelerationTime - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 84 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful completion of command (ie. once the motor is finished).
+-
+
- + Type + +
- +Promise + + + +
- setMaxPower(style) -
- + +setMaxPower(style)
+ - + -
+
+
@@ -1422,115 +1383,104 @@ Set the max power of the motor.
Note: This applies to setSpeed, rotateByDegrees, and gotoAngle.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
style |
-
- - + | |||
style |
-
- number
-
-
+ + + +number - - | + + - + - + -
- Either BRAKE or HOLD - - |
- Either BRAKE or HOLD |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setMaxPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 63 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- setSpeed(speed, time) → {Promise} -
- - + + + + + + + + +setSpeed(speed, time) → {Promise}
+ + + -
+
+
+
+
@@ -1577,144 +1527,125 @@ Set the motor speed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
speed |
-
- - + | |||
speed |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the motor should run for (in milliseconds). - - |
- How long the motor should run for (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#setSpeed - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 95 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
Events
- - + +Events
+ + - + - - - - -- absolute :object -
- + +absolute
+ - + -
+
+
+
+ Emits when a the motors absolute position is changed.
-Type:
+-
+
- + +object + + + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
absolute |
-
- - + | |||
absolute |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - AbsoluteMotor#event:absolute - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/absolutemotor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- - - - - - - -- rotate :object -
- - + + + + + + + + +rotate
+ + + -
+
+
+
+
+
+ Emits when a rotation sensor is activated.
-Type:
+-
+
- + +object + + +
Parameters:
- + +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rotation |
-
- - + | |||
rotation |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - TachoMotor#event:rotate - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/tachomotor.js, line 43 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + - - + + - -+ - + - - +
- + + + \ No newline at end of file diff --git a/docs/TiltSensor.html b/docs/TiltSensor.html index 593602b8..ece94e8a 100644 --- a/docs/TiltSensor.html +++ b/docs/TiltSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- TiltSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - TiltSensor -
- -
-
- TiltSensor
+ TiltSensor()
-
-
-
-
-
+
+
+
+
+
- new TiltSensor()
+ + + - - - - - -- new TiltSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/tiltsensor.js, line 25
-
-
-
-
+
@@ -187,18 +113,24 @@
-
+
+
+
+
+
+
+
-
-
- - devices/tiltsensor.js, line 25 - -
Extends
+Extends
- + --
-
- Device -
-
+
- Device +
Extends
- + + + @@ -216,10 +150,9 @@Members
+(readonly) connected
+ -- (readonly) connected -
@@ -227,59 +160,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ -- (readonly) hub -
@@ -357,59 +275,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ -- (readonly) isVirtualPort -
@@ -487,59 +390,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ + -- (readonly) mode -
@@ -617,59 +506,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,168 +846,157 @@Properties:
-Events
+Events
- + + - - - - - - -- tilt :object -
- + +tilt
+ - + -
+
+
+
+
+
+
+ Emits when a tilt sensor is activated.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
x |
-
- - + | |||
x |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - | |
y |
-
- - + | |||
y |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/tiltsensor.js, line 39 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/TrainMotor.html b/docs/TrainMotor.html index 48903451..ccdbe241 100644 --- a/docs/TrainMotor.html +++ b/docs/TrainMotor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
-
+
+
-
+
+
+
+
-
- - TrainMotor -
- -
+ TrainMotor()
- TrainMotor
-
-
-
-
-
-
+
+
+
+
+
- new TrainMotor()
+ + + - - - - - -- new TrainMotor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/trainmotor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/trainmotor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- BasicMotor +
-
-
- BasicMotor -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
-- (readonly) hub -
@@ -357,59 +274,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
+ + -- (readonly) isVirtualPort -
@@ -487,59 +391,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
-- (readonly) mode -
@@ -617,59 +504,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ + -- (readonly) portName -
@@ -747,59 +621,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -877,59 +735,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- -Methods
+Methods
- + + - - - - - - -- brake() → {Promise} -
- + +brake() → {Promise}
+ - + -
+
+
+
+
+
@@ -1036,55 +875,47 @@ Brake the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#brake
-
-
-
-
+ -
+ BasicMotor#brake
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 73
-
-
-
-
+
@@ -1100,30 +931,51 @@
-
+
+Returns:
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
-
-
-
-
-
-
- rampPower(fromPower, toPower, time) → {Promise}
-
-
+
+
+
+
+
+
+ rampPower(fromPower, toPower, time) → {Promise}
+
-
+
-
+
Ramp the motor power.
-
+
+
@@ -1131,173 +983,149 @@
- Parameters:
-
+
+ Parameters:
+
-
-
- - BasicMotor#brake - -
- + BasicMotor#brake +
-
-
- - devices/basicmotor.js, line 73 - -
Returns:
+ +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
- rampPower(fromPower, toPower, time) → {Promise} -
- + + + + + + +rampPower(fromPower, toPower, time) → {Promise}
+ - + -
+
+
+
@@ -1131,173 +983,149 @@ Ramp the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
fromPower |
-
- - + | |||
fromPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
toPower |
-
- - + | |||
toPower |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
- |
time |
-
- - + | |||
time |
-
- number
-
-
+ + + +number - - | + + - + - + -
- How long the ramp should last (in milliseconds). - - |
- How long the ramp should last (in milliseconds). |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#rampPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 46 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ +
+
-
-
-
-
-
- Resolved upon successful completion of command.
+- setPower(power) → {Promise} -
- +-
+
- + Type + +
- + +Promise + + + +
setPower(power) → {Promise}
+ + + -
+
+
+
+
+
@@ -1344,115 +1193,103 @@ Set the motor power.
-
- Parameters:
-
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
power |
-
- - + | |||
power |
-
- number
-
-
+ + + +number - - | + + - + - + -
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. - - |
- For forward, a value between 1 - 100 should be set. For reverse, a value between -1 to -100. Stop is 0. |
+
-
+
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BasicMotor#setPower - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/basicmotor.js, line 34 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- +Promise + + + +
- stop() → {Promise} -
- - + + + + + + +stop() → {Promise}
+ + + -
+
+
+
+
+
@@ -1504,55 +1364,47 @@ Stop the motor.
-
-
+
-
+
-
+
- Inherited From:
- -
-
- -
- BasicMotor#stop
-
-
-
-
+ -
+ BasicMotor#stop
+
- Source:
- -
-
- -
- devices/basicmotor.js, line 64
-
-
-
-
+
@@ -1568,30 +1420,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful issuance of the command.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
-
-
-
- - BasicMotor#stop - -
- + BasicMotor#stop +
-
-
- - devices/basicmotor.js, line 64 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of the command.
+-
+
- + Type + +
- + +Promise + + + +
+
- + + + \ No newline at end of file diff --git a/docs/VoltageSensor.html b/docs/VoltageSensor.html index 72fdfd0e..22b90f75 100644 --- a/docs/VoltageSensor.html +++ b/docs/VoltageSensor.html @@ -1,123 +1,53 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
-
- VoltageSensor
+
-
-
-
+
-
+
-
-
+
@@ -287,55 +215,47 @@
-
-
+
@@ -417,55 +330,47 @@
-
-
+
@@ -547,55 +445,47 @@
-
-
+
@@ -677,55 +560,47 @@
-
-
+
@@ -807,55 +675,47 @@
-
-
+
@@ -937,55 +790,47 @@
-
+
+
-
+
+
-
- - VoltageSensor -
- -
-
- VoltageSensor
+ VoltageSensor()
-
-
-
-
-
+
+
+
+
+
- new VoltageSensor()
+ + + - - - - - -- new VoltageSensor() -
- - @@ -132,46 +62,42 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- devices/voltagesensor.js, line 25
-
-
-
-
+
@@ -187,19 +113,27 @@
-
+
+
+
+
+
+
+
-
-
- - devices/voltagesensor.js, line 25 - -
Extends
+Extends
+ + - +-
+
- Device +
-
-
- Device -
Extends
- + @@ -216,10 +150,10 @@Members
+(readonly) connected
+ + -- (readonly) connected -
@@ -227,59 +161,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - boolean - + | |||
connected |
+
-
+ + + +boolean - - | + + - + - + -
- Check if the device is still attached. - |
- Check if the device is still attached. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#connected - -
-
+ - + Device#connected +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 76 - -
-
+ - + devices/device.js, line 80 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hub
+ + -- (readonly) hub -
@@ -357,59 +276,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hub |
-
-
- - - - - Hub - + | |||
hub |
+
-
+ + + +Hub - - | + + - + - + -
- The Hub the device is attached to. - |
- The Hub the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#hub - -
-
+ - + Device#hub +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 83 - -
-
+ - + devices/device.js, line 87 +
+
-
+
-
+
-
+
Properties:
- +(readonly) isVirtualPort
-- (readonly) isVirtualPort -
@@ -487,59 +389,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
isVirtualPort |
-
-
- - - - - boolean - + | |||
isVirtualPort |
+
-
+ + + +boolean - - | + + - + - + -
- Is this device attached to a virtual port (ie. a combined device) - |
- Is this device attached to a virtual port (ie. a combined device) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#isVirtualPort - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - devices/device.js, line 120 - -
-
+ - + - + - + - +
Properties:
- +(readonly) mode
+ -- (readonly) mode -
@@ -617,59 +505,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
mode |
-
-
- - - - - number - + | |||
mode |
+
-
+ + + +number - - | + + - + - + -
- The mode the device is currently in - |
- The mode the device is currently in |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#mode - -
-
+ - + Device#mode +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 110 - -
-
+ - + - + - + - +
Properties:
- +(readonly) portName
+ -- (readonly) portName -
@@ -747,59 +620,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
portName |
-
-
- - - - - string - + | |||
portName |
+
-
+ + + +string - - | + + - + - + -
- The port the device is attached to. - |
- The port the device is attached to. |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#portName - -
-
+ - + Device#portName +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 93 - -
-
+ - + devices/device.js, line 97 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ + -- (readonly) type -
@@ -877,59 +736,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - number - + | |||
type |
+
-
+ + + +number - - | + + - + - + -
- The type of the device - |
- The type of the device |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - Device#type - -
-
+ - + Device#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/device.js, line 100 - -
-
+ - + - + - + - +
Properties:
- @@ -1002,139 +846,134 @@Properties:
-Events
+Events
- + + - - - - - - -- voltage :object -
- + +voltage
+ - + -
+
+
+
+
+
+
+
+ Emits when a voltage change is detected.
-Type:
+-
+
- + +object + +
Parameters:
- +Parameters:
+| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
voltage |
-
- - + | |||
voltage |
-
- number
-
-
+ + + +number - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - devices/voltagesensor.js, line 51 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/WeDo2SmartHub.html b/docs/WeDo2SmartHub.html index 62a7590a..0a4fe9ad 100644 --- a/docs/WeDo2SmartHub.html +++ b/docs/WeDo2SmartHub.html @@ -1,129 +1,59 @@ - - - - -
-
+-
-
- - - - - - - - - - -
-
-
+
-
+
-
-
+
-
-
-
+
+
-
+
-
-
-
+
-
+
-
-
+
@@ -291,55 +219,47 @@
-
-
+
@@ -421,55 +334,47 @@
-
-
+
@@ -551,55 +449,47 @@
-
-
+
@@ -681,55 +564,47 @@
-
-
+
@@ -811,55 +679,47 @@
-
-
+
@@ -941,55 +794,47 @@
-
-
+
@@ -1071,55 +909,47 @@
-
-
+
@@ -1201,55 +1024,47 @@
-
-
+
@@ -1331,55 +1139,47 @@
-
-
+
@@ -1461,55 +1254,47 @@
-
-
+
@@ -1591,55 +1369,47 @@
-
-
+
+
-
+
+
-
+
+
-
- - WeDo2SmartHub -
- -
+ WeDo2SmartHub()
- WeDo2SmartHub
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
- - new WeDo2SmartHub() -
- + +new WeDo2SmartHub()
+ - + -
+
+
+
+
+
@@ -136,46 +66,42 @@ The WeDo2SmartHub is emitted if the discovered device is a WeDo 2.0 Smart Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/wedo2smarthub.js, line 28
-
-
-
-
+
@@ -191,19 +117,27 @@
-
+
+
+
+
+
+
+
-
-
- - hubs/wedo2smarthub.js, line 28 - -
Extends
+Extends
+ + - +-
+
- BaseHub +
-
-
- BaseHub -
Extends
- + @@ -220,10 +154,8 @@Members
+(readonly) batteryLevel
-- (readonly) batteryLevel -
@@ -231,59 +163,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
batteryLevel |
-
-
- - - - - number - + | |||
batteryLevel |
+
-
+ + + +number - - | + + - + - + -
- Battery level of the hub (Percentage between 0-100) - |
- Battery level of the hub (Percentage between 0-100) |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#batteryLevel - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 157 - -
-
+ - + hubs/basehub.js, line 161 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connected
+ + -- (readonly) connected -
@@ -361,59 +280,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connected |
-
-
- - - - - string - + | |||
connected |
+
-
+ + + +string - - | + + - + - + -
- Connected status - |
- Connected status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connected - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 101 - -
-
+ - + hubs/basehub.js, line 105 +
+
-
+
-
+
-
+
Properties:
- +(readonly) connecting
-- (readonly) connecting -
@@ -491,59 +393,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
connecting |
-
-
- - - - - string - + | |||
connecting |
+
-
+ + + +string - - | + + - + - + -
- Connecting status - |
- Connecting status |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#connecting - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 108 - -
-
+ - + hubs/basehub.js, line 112 +
+
-
+
-
+
-
+
Properties:
- +(readonly) firmwareVersion
+ + -- (readonly) firmwareVersion -
@@ -621,59 +510,53 @@
- Properties:
+ Properties:
-
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
firmwareVersion |
-
-
- - - - - string - + | |||
firmwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Firmware version of the hub - |
- Firmware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#firmwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 129 - -
-
+ - + hubs/basehub.js, line 133 +
+
-
+
-
+
-
+
Properties:
- +(readonly) hardwareVersion
-- (readonly) hardwareVersion -
@@ -751,59 +623,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
hardwareVersion |
-
-
- - - - - string - + | |||
hardwareVersion |
+
-
+ + + +string - - | + + - + - + -
- Hardware version of the hub - |
- Hardware version of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#hardwareVersion - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 136 - -
-
+ - + hubs/basehub.js, line 140 +
+
-
+
-
+
-
+
Properties:
- +(readonly) name
+ -- (readonly) name -
@@ -881,59 +739,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
-
- - - - - string - + | |||
name |
+
-
+ + + +string - - | + + - + - + -
- Name of the hub - |
- Name of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#name - -
-
+ - + BaseHub#name +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 94 - -
-
+ - + hubs/basehub.js, line 98 +
+
-
+
-
+
-
+
Properties:
- +(readonly) ports
+ -- (readonly) ports -
@@ -1011,59 +854,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
ports |
-
-
- - - - - Array.<string> - + | |||
ports |
+
-
+ + + +Array.<string> - - | + + - + - + -
- Array of port names - |
- Array of port names |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#ports - -
-
+ - + BaseHub#ports +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 122 - -
-
+ - + hubs/basehub.js, line 126 +
+
-
+
-
+
-
+
Properties:
- +(readonly) primaryMACAddress
-- (readonly) primaryMACAddress -
@@ -1141,59 +968,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
primaryMACAddress |
-
-
- - - - - string - + | |||
primaryMACAddress |
+
-
+ + + +string - - | + + - + - + -
- Primary MAC address of the hub - |
- Primary MAC address of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#primaryMACAddress - -
-
+ - + - + - + - + - + - + - + - + - + - + - +
- Source: -
-
-
-
-
- - hubs/basehub.js, line 143 - -
-
+ - + hubs/basehub.js, line 147 +
+
-
+
-
+
-
+
Properties:
- +(readonly) rssi
-- (readonly) rssi -
@@ -1271,59 +1083,55 @@
- Properties:
-
+
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
rssi |
-
-
- - - - - number - + | |||
rssi |
+
-
+ + + +number - - | + + - + - + -
- Signal strength of the hub - |
- Signal strength of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#rssi - -
-
+ - + BaseHub#rssi +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 164 - -
-
+ - + hubs/basehub.js, line 168 +
+
-
+
-
+
-
+
Properties:
- +(readonly) type
+ -- (readonly) type -
@@ -1401,59 +1199,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
type |
-
-
- - - - - string - + | |||
type |
+
-
+ + + +string - - | + + - + - + -
- Hub type - |
- Hub type |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#type - -
-
+ - + BaseHub#type +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 115 - -
-
+ - + hubs/basehub.js, line 119 +
+
-
+
-
+
-
+
Properties:
- +(readonly) uuid
+ -- (readonly) uuid -
@@ -1531,59 +1314,54 @@
- Properties:
-
+ Properties:
+
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
uuid |
-
-
- - - - - string - + | |||
uuid |
+
-
+ + + +string - - | + + - + - + -
- UUID of the hub - |
- UUID of the hub |
+
-
-
+
+
Properties:
-
-
+
-
+
-
+
- Inherited From: -
-
-
-
-
- - BaseHub#uuid - -
-
+ - + BaseHub#uuid +
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/basehub.js, line 150 - -
-
+ - + hubs/basehub.js, line 154 +
+
-
+
-
+
-
+
Properties:
- -Methods
+Methods
- + + - - - - - - -- setName(name) → {Promise} -
- + +setName(name) → {Promise}
+ - + -
+
+
@@ -1685,106 +1446,99 @@ Set the name of the Hub.
-
- Parameters:
-
+
+
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
name |
-
- - + | |||
name |
-
- string
-
-
+ + + +string - - | + + - + - + -
- New name of the hub (14 characters or less, ASCII only). - - |
- New name of the hub (14 characters or less, ASCII only). |
+
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/wedo2smarthub.js, line 107 - -
-
+ - + - + - + - +
Parameters:
- + +Returns:
+ + +
+
+
+
+
+Resolved upon successful issuance of command.
+-
+
- + Type + +
- +Promise - + +
- shutdown() → {Promise} -
- - -
+
+
+
+
+
+
+
+
+
+
+
@@ -1836,46 +1613,42 @@ shutdown() → {Promise}
+ + + + + + +Shutdown the Hub.
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source:
- -
-
- -
- hubs/wedo2smarthub.js, line 99
-
-
-
-
+
@@ -1891,38 +1664,60 @@
-
+
+Returns:
+
+
+
+ Resolved upon successful disconnect.
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
- Events
+ Events
-
+
+
-
-
-
-
-
-
-
- button
-
-
+
+ button
+
-
+
-
+
Emits when a button is pressed.
-
+
+
+
@@ -1930,135 +1725,120 @@
- Parameters:
-
+ Parameters:
+
-
-
- - hubs/wedo2smarthub.js, line 99 - -
Returns:
+ + +
+
+
+
+
+Resolved upon successful disconnect.
+-
+
- + Type + +
- + +Promise + + + +
Events
+Events
- + + - - - - - - -- button -
- + +button
+ - + -
+
+
+
+
@@ -1930,135 +1725,120 @@ Emits when a button is pressed.
-
- Parameters:
-
+ Parameters:
+
| Name | - + -Type | +Type | - + - + -Description | +Description |
|---|---|---|---|---|
button |
-
- - + | |||
button |
-
- string
-
-
+ + + +string - - | + + - + - + -- - - | -+ - | |
state |
-
- - + | |||
state |
-
- ButtonState
-
-
+ + + +ButtonState - - | + + - + - + -- - - | -+ - + |
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- Source: -
-
-
-
-
- - hubs/wedo2smarthub.js, line 182 - -
-
+ - + - + - + - +
Parameters:
- + + + + + + + -+
- + + + \ No newline at end of file diff --git a/docs/consts.js.html b/docs/consts.js.html index 5698802b..6ddf218b 100644 --- a/docs/consts.js.html +++ b/docs/consts.js.html @@ -1,96 +1,32 @@ - - + +
-
-
-
+
-
+
-
-
+
-
-
-
- -
-
- - - - - - - - - - - -
-
-
-
-
+
-
-
- - consts.js -
- - - -"use strict";
+
+
+ "use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MarioColor = exports.MarioPantsType = exports.PortInputFormatSetupSubCommand = exports.ModeInformationType = exports.HWNetworkSubFamily = exports.HWNetworkFamily = exports.HWNetWorkCommandType = exports.ErrorCode = exports.IOTypeID = exports.Event = exports.AlertPayload = exports.AlertOperation = exports.AlertType = exports.ActionType = exports.HubPropertyPayload = exports.HubPropertyOperation = exports.HubPropertyReference = exports.MessageType = exports.BLECharacteristic = exports.BLEService = exports.BLEManufacturerData = exports.DuploTrainBaseSound = exports.BrakingStyle = exports.ButtonState = exports.ColorNames = exports.Color = exports.DeviceTypeNames = exports.DeviceType = exports.HubTypeNames = exports.HubType = void 0;
/**
@@ -116,7 +52,7 @@
HubType[HubType["TECHNIC_MEDIUM_HUB"] = 6] = "TECHNIC_MEDIUM_HUB";
HubType[HubType["MARIO"] = 7] = "MARIO";
HubType[HubType["TECHNIC_SMALL_HUB"] = 8] = "TECHNIC_SMALL_HUB";
-})(HubType = exports.HubType || (exports.HubType = {}));
+})(HubType || (exports.HubType = HubType = {}));
// tslint:disable-next-line
exports.HubTypeNames = HubType;
/**
@@ -202,7 +138,7 @@
DeviceType[DeviceType["MARIO_PANTS_SENSOR"] = 74] = "MARIO_PANTS_SENSOR";
DeviceType[DeviceType["TECHNIC_MEDIUM_ANGULAR_MOTOR_GREY"] = 75] = "TECHNIC_MEDIUM_ANGULAR_MOTOR_GREY";
DeviceType[DeviceType["TECHNIC_LARGE_ANGULAR_MOTOR_GREY"] = 76] = "TECHNIC_LARGE_ANGULAR_MOTOR_GREY";
-})(DeviceType = exports.DeviceType || (exports.DeviceType = {}));
+})(DeviceType || (exports.DeviceType = DeviceType = {}));
// tslint:disable-next-line
exports.DeviceTypeNames = DeviceType;
/**
@@ -234,7 +170,7 @@
Color[Color["RED"] = 9] = "RED";
Color[Color["WHITE"] = 10] = "WHITE";
Color[Color["NONE"] = 255] = "NONE";
-})(Color = exports.Color || (exports.Color = {}));
+})(Color || (exports.Color = Color = {}));
// tslint:disable-next-line
exports.ColorNames = Color;
/**
@@ -252,7 +188,7 @@
ButtonState[ButtonState["UP"] = 1] = "UP";
ButtonState[ButtonState["DOWN"] = 255] = "DOWN";
ButtonState[ButtonState["STOP"] = 127] = "STOP";
-})(ButtonState = exports.ButtonState || (exports.ButtonState = {}));
+})(ButtonState || (exports.ButtonState = ButtonState = {}));
/**
* @typedef BrakingStyle
* @property {number} FLOAT 0
@@ -264,7 +200,7 @@
BrakingStyle[BrakingStyle["FLOAT"] = 0] = "FLOAT";
BrakingStyle[BrakingStyle["HOLD"] = 126] = "HOLD";
BrakingStyle[BrakingStyle["BRAKE"] = 127] = "BRAKE";
-})(BrakingStyle = exports.BrakingStyle || (exports.BrakingStyle = {}));
+})(BrakingStyle || (exports.BrakingStyle = BrakingStyle = {}));
/**
* @typedef DuploTrainBaseSound
* @property {number} BRAKE 3
@@ -280,7 +216,7 @@
DuploTrainBaseSound[DuploTrainBaseSound["WATER_REFILL"] = 7] = "WATER_REFILL";
DuploTrainBaseSound[DuploTrainBaseSound["HORN"] = 9] = "HORN";
DuploTrainBaseSound[DuploTrainBaseSound["STEAM"] = 10] = "STEAM";
-})(DuploTrainBaseSound = exports.DuploTrainBaseSound || (exports.DuploTrainBaseSound = {}));
+})(DuploTrainBaseSound || (exports.DuploTrainBaseSound = DuploTrainBaseSound = {}));
var BLEManufacturerData;
(function (BLEManufacturerData) {
BLEManufacturerData[BLEManufacturerData["DUPLO_TRAIN_BASE_ID"] = 32] = "DUPLO_TRAIN_BASE_ID";
@@ -290,7 +226,7 @@
BLEManufacturerData[BLEManufacturerData["MARIO_ID"] = 67] = "MARIO_ID";
BLEManufacturerData[BLEManufacturerData["TECHNIC_MEDIUM_HUB_ID"] = 128] = "TECHNIC_MEDIUM_HUB_ID";
BLEManufacturerData[BLEManufacturerData["TECHNIC_SMALL_HUB_ID"] = 131] = "TECHNIC_SMALL_HUB_ID";
-})(BLEManufacturerData = exports.BLEManufacturerData || (exports.BLEManufacturerData = {}));
+})(BLEManufacturerData || (exports.BLEManufacturerData = BLEManufacturerData = {}));
var BLEService;
(function (BLEService) {
BLEService["WEDO2_SMART_HUB"] = "00001523-1212-efde-1523-785feabcd123";
@@ -299,7 +235,7 @@
BLEService["WEDO2_SMART_HUB_4"] = "180f";
BLEService["WEDO2_SMART_HUB_5"] = "180a";
BLEService["LPF2_HUB"] = "00001623-1212-efde-1623-785feabcd123";
-})(BLEService = exports.BLEService || (exports.BLEService = {}));
+})(BLEService || (exports.BLEService = BLEService = {}));
var BLECharacteristic;
(function (BLECharacteristic) {
BLECharacteristic["WEDO2_BATTERY"] = "2a19";
@@ -316,7 +252,7 @@
BLECharacteristic["WEDO2_MOTOR_VALUE_WRITE"] = "00001565-1212-efde-1523-785feabcd123";
BLECharacteristic["WEDO2_NAME_ID"] = "00001524-1212-efde-1523-785feabcd123";
BLECharacteristic["LPF2_ALL"] = "00001624-1212-efde-1623-785feabcd123";
-})(BLECharacteristic = exports.BLECharacteristic || (exports.BLECharacteristic = {}));
+})(BLECharacteristic || (exports.BLECharacteristic = BLECharacteristic = {}));
/**
* @typedef MessageType
* @property {number} HUB_PROPERTIES 0x01
@@ -369,7 +305,7 @@
MessageType[MessageType["VIRTUAL_PORT_SETUP"] = 97] = "VIRTUAL_PORT_SETUP";
MessageType[MessageType["PORT_OUTPUT_COMMAND"] = 129] = "PORT_OUTPUT_COMMAND";
MessageType[MessageType["PORT_OUTPUT_COMMAND_FEEDBACK"] = 130] = "PORT_OUTPUT_COMMAND_FEEDBACK";
-})(MessageType = exports.MessageType || (exports.MessageType = {}));
+})(MessageType || (exports.MessageType = MessageType = {}));
/**
* @typedef HubPropertyReference
* @param {number} ADVERTISING_NAME 0x01
@@ -406,7 +342,7 @@
HubPropertyReference[HubPropertyReference["PRIMARY_MAC_ADDRESS"] = 13] = "PRIMARY_MAC_ADDRESS";
HubPropertyReference[HubPropertyReference["SECONDARY_MAC_ADDRESS"] = 14] = "SECONDARY_MAC_ADDRESS";
HubPropertyReference[HubPropertyReference["HARDWARE_NETWORK_FAMILY"] = 15] = "HARDWARE_NETWORK_FAMILY";
-})(HubPropertyReference = exports.HubPropertyReference || (exports.HubPropertyReference = {}));
+})(HubPropertyReference || (exports.HubPropertyReference = HubPropertyReference = {}));
/**
* @typedef HubPropertyOperation
* @param {number} SET_DOWNSTREAM 0x01
@@ -425,7 +361,7 @@
HubPropertyOperation[HubPropertyOperation["RESET_DOWNSTREAM"] = 4] = "RESET_DOWNSTREAM";
HubPropertyOperation[HubPropertyOperation["REQUEST_UPDATE_DOWNSTREAM"] = 5] = "REQUEST_UPDATE_DOWNSTREAM";
HubPropertyOperation[HubPropertyOperation["UPDATE_UPSTREAM"] = 6] = "UPDATE_UPSTREAM";
-})(HubPropertyOperation = exports.HubPropertyOperation || (exports.HubPropertyOperation = {}));
+})(HubPropertyOperation || (exports.HubPropertyOperation = HubPropertyOperation = {}));
/**
* @typedef HubPropertyPayload
* @param {number} ADVERTISING_NAME 0x01
@@ -462,7 +398,7 @@
HubPropertyPayload[HubPropertyPayload["PRIMARY_MAC_ADDRESS"] = 13] = "PRIMARY_MAC_ADDRESS";
HubPropertyPayload[HubPropertyPayload["SECONDARY_MAC_ADDRESS"] = 14] = "SECONDARY_MAC_ADDRESS";
HubPropertyPayload[HubPropertyPayload["HW_NETWORK_FAMILY"] = 15] = "HW_NETWORK_FAMILY";
-})(HubPropertyPayload = exports.HubPropertyPayload || (exports.HubPropertyPayload = {}));
+})(HubPropertyPayload || (exports.HubPropertyPayload = HubPropertyPayload = {}));
/**
* @typedef ActionType
* @param {number} SWITCH_OFF_HUB 0x01
@@ -489,7 +425,7 @@
ActionType[ActionType["HUB_WILL_SWITCH_OFF"] = 48] = "HUB_WILL_SWITCH_OFF";
ActionType[ActionType["HUB_WILL_DISCONNECT"] = 49] = "HUB_WILL_DISCONNECT";
ActionType[ActionType["HUB_WILL_GO_INTO_BOOT_MODE"] = 50] = "HUB_WILL_GO_INTO_BOOT_MODE";
-})(ActionType = exports.ActionType || (exports.ActionType = {}));
+})(ActionType || (exports.ActionType = ActionType = {}));
/**
* @typedef AlertType
* @param {number} LOW_VOLTAGE 0x01
@@ -504,7 +440,7 @@
AlertType[AlertType["HIGH_CURRENT"] = 2] = "HIGH_CURRENT";
AlertType[AlertType["LOW_SIGNAL_STRENGTH"] = 3] = "LOW_SIGNAL_STRENGTH";
AlertType[AlertType["OVER_POWER_CONDITION"] = 4] = "OVER_POWER_CONDITION";
-})(AlertType = exports.AlertType || (exports.AlertType = {}));
+})(AlertType || (exports.AlertType = AlertType = {}));
/**
* @typedef AlertOperation
* @param {number} ENABLE_UPDATE 0x01
@@ -519,7 +455,7 @@
AlertOperation[AlertOperation["HIGH_CURRENT"] = 2] = "HIGH_CURRENT";
AlertOperation[AlertOperation["LOW_SIGNAL_STRENGTH"] = 3] = "LOW_SIGNAL_STRENGTH";
AlertOperation[AlertOperation["OVER_POWER_CONDITION"] = 4] = "OVER_POWER_CONDITION";
-})(AlertOperation = exports.AlertOperation || (exports.AlertOperation = {}));
+})(AlertOperation || (exports.AlertOperation = AlertOperation = {}));
/**
* @typedef AlertPayload
* @param {number} STATUS_OK 0x00
@@ -530,7 +466,7 @@
(function (AlertPayload) {
AlertPayload[AlertPayload["STATUS_OK"] = 0] = "STATUS_OK";
AlertPayload[AlertPayload["ALERT"] = 255] = "ALERT";
-})(AlertPayload = exports.AlertPayload || (exports.AlertPayload = {}));
+})(AlertPayload || (exports.AlertPayload = AlertPayload = {}));
/**
* @typedef Event
* @param {number} DETACHED_IO 0x00
@@ -543,7 +479,7 @@
Event[Event["DETACHED_IO"] = 0] = "DETACHED_IO";
Event[Event["ATTACHED_IO"] = 1] = "ATTACHED_IO";
Event[Event["ATTACHED_VIRTUAL_IO"] = 2] = "ATTACHED_VIRTUAL_IO";
-})(Event = exports.Event || (exports.Event = {}));
+})(Event || (exports.Event = Event = {}));
/**
* @typedef IOTypeID
* @param {number} MOTOR 0x0001
@@ -578,7 +514,7 @@
IOTypeID[IOTypeID["EXTERNAL_MOTOR"] = 38] = "EXTERNAL_MOTOR";
IOTypeID[IOTypeID["INTERNAL_MOTOR"] = 39] = "INTERNAL_MOTOR";
IOTypeID[IOTypeID["INTERNAL_TILT"] = 40] = "INTERNAL_TILT";
-})(IOTypeID = exports.IOTypeID || (exports.IOTypeID = {}));
+})(IOTypeID || (exports.IOTypeID = IOTypeID = {}));
/**
* @typedef ErrorCode
* @param {number} ACK 0x01
@@ -601,7 +537,7 @@
ErrorCode[ErrorCode["INVALID_USE"] = 6] = "INVALID_USE";
ErrorCode[ErrorCode["OVERCURRENT"] = 7] = "OVERCURRENT";
ErrorCode[ErrorCode["INTERNAL_ERROR"] = 8] = "INTERNAL_ERROR";
-})(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
/**
* @typedef HWNetWorkCommandType
* @param {number} CONNECTION_REQUEST 0x02
@@ -634,7 +570,7 @@
HWNetWorkCommandType[HWNetWorkCommandType["EXTENDED_FAMILY"] = 12] = "EXTENDED_FAMILY";
HWNetWorkCommandType[HWNetWorkCommandType["EXTENDED_FAMILY_SET"] = 13] = "EXTENDED_FAMILY_SET";
HWNetWorkCommandType[HWNetWorkCommandType["RESET_LONG_PRESS_TIMING"] = 14] = "RESET_LONG_PRESS_TIMING";
-})(HWNetWorkCommandType = exports.HWNetWorkCommandType || (exports.HWNetWorkCommandType = {}));
+})(HWNetWorkCommandType || (exports.HWNetWorkCommandType = HWNetWorkCommandType = {}));
/**
* @typedef HWNetworkFamily
* @param {number} GREEN 0x01
@@ -659,7 +595,7 @@
HWNetworkFamily[HWNetworkFamily["TEAL"] = 7] = "TEAL";
HWNetworkFamily[HWNetworkFamily["PINK"] = 8] = "PINK";
HWNetworkFamily[HWNetworkFamily["WHITE"] = 0] = "WHITE";
-})(HWNetworkFamily = exports.HWNetworkFamily || (exports.HWNetworkFamily = {}));
+})(HWNetworkFamily || (exports.HWNetworkFamily = HWNetworkFamily = {}));
/**
* @typedef HWNetworkSubFamily
* @param {number} ONE_FLASH 0x01
@@ -680,7 +616,7 @@
HWNetworkSubFamily[HWNetworkSubFamily["FIVE_FLASHES"] = 5] = "FIVE_FLASHES";
HWNetworkSubFamily[HWNetworkSubFamily["SIX_FLASHES"] = 6] = "SIX_FLASHES";
HWNetworkSubFamily[HWNetworkSubFamily["SEVEN_FLASHES"] = 7] = "SEVEN_FLASHES";
-})(HWNetworkSubFamily = exports.HWNetworkSubFamily || (exports.HWNetworkSubFamily = {}));
+})(HWNetworkSubFamily || (exports.HWNetworkSubFamily = HWNetworkSubFamily = {}));
/**
* @typedef ModeInformationType
* @param {number} NAME 0x00
@@ -707,7 +643,7 @@
ModeInformationType[ModeInformationType["MOTOR_BIAS"] = 7] = "MOTOR_BIAS";
ModeInformationType[ModeInformationType["CAPABILITY_BITS"] = 8] = "CAPABILITY_BITS";
ModeInformationType[ModeInformationType["VALUE_FORMAT"] = 128] = "VALUE_FORMAT";
-})(ModeInformationType = exports.ModeInformationType || (exports.ModeInformationType = {}));
+})(ModeInformationType || (exports.ModeInformationType = ModeInformationType = {}));
/**
* @typedef PortInputFormatSetupSubCommand
* @param {number} SET_MODEANDDATASET_COMBINATIONS 0x01
@@ -726,7 +662,7 @@
PortInputFormatSetupSubCommand[PortInputFormatSetupSubCommand["UNLOCKANDSTARTWITHMULTIUPDATEDISABLED"] = 4] = "UNLOCKANDSTARTWITHMULTIUPDATEDISABLED";
PortInputFormatSetupSubCommand[PortInputFormatSetupSubCommand["NOT_USED"] = 5] = "NOT_USED";
PortInputFormatSetupSubCommand[PortInputFormatSetupSubCommand["RESET_SENSOR"] = 6] = "RESET_SENSOR";
-})(PortInputFormatSetupSubCommand = exports.PortInputFormatSetupSubCommand || (exports.PortInputFormatSetupSubCommand = {}));
+})(PortInputFormatSetupSubCommand || (exports.PortInputFormatSetupSubCommand = PortInputFormatSetupSubCommand = {}));
/**
* @typedef MarioPantsType
* @param {number} NONE 0x00
@@ -744,7 +680,7 @@
MarioPantsType[MarioPantsType["FIRE"] = 18] = "FIRE";
MarioPantsType[MarioPantsType["NORMAL"] = 33] = "NORMAL";
MarioPantsType[MarioPantsType["BUILDER"] = 34] = "BUILDER";
-})(MarioPantsType = exports.MarioPantsType || (exports.MarioPantsType = {}));
+})(MarioPantsType || (exports.MarioPantsType = MarioPantsType = {}));
/**
* @typedef MarioColor
* @param {number} WHITE 0x1300
@@ -766,26 +702,27 @@
MarioColor[MarioColor["GREEN"] = 9472] = "GREEN";
MarioColor[MarioColor["BROWN"] = 27136] = "BROWN";
MarioColor[MarioColor["CYAN"] = 16897] = "CYAN";
-})(MarioColor = exports.MarioColor || (exports.MarioColor = {}));
+})(MarioColor || (exports.MarioColor = MarioColor = {}));
//# sourceMappingURL=consts.js.map
-
-
+ +
- + + + diff --git a/docs/devices_absolutemotor.js.html b/docs/devices_absolutemotor.js.html index 0964e661..179f84d6 100644 --- a/docs/devices_absolutemotor.js.html +++ b/docs/devices_absolutemotor.js.html @@ -1,99 +1,39 @@ - - - - - - -
-
-
- -
-
- - - - - - - - - - - -