diff --git a/docs/BoostMoveHub.html b/docs/BoostMoveHub.html index ad5e5c5..7da73ba 100644 --- a/docs/BoostMoveHub.html +++ b/docs/BoostMoveHub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1257,7 +1257,7 @@ @@ -2037,7 +2037,7 @@ @@ -2208,7 +2208,7 @@ @@ -2427,7 +2427,7 @@ @@ -2665,7 +2665,7 @@ @@ -2922,7 +2922,7 @@ @@ -3163,7 +3163,7 @@ @@ -3334,7 +3334,7 @@ @@ -3455,7 +3455,7 @@ @@ -4268,6 +4268,225 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    attach

    @@ -4584,7 +4803,7 @@ @@ -4755,7 +4974,7 @@ @@ -4950,7 +5169,7 @@ @@ -5273,7 +5492,7 @@ @@ -5444,7 +5663,349 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -5537,7 +6098,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -5589,6 +6150,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -5639,7 +6224,7 @@
    @@ -5718,7 +6303,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/ControlPlusHub.html b/docs/ControlPlusHub.html index 0d37393..8c1ce02 100644 --- a/docs/ControlPlusHub.html +++ b/docs/ControlPlusHub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1257,7 +1257,7 @@ @@ -2037,7 +2037,7 @@ @@ -2208,7 +2208,7 @@ @@ -2427,7 +2427,7 @@ @@ -2665,7 +2665,7 @@ @@ -2922,7 +2922,7 @@ @@ -3163,7 +3163,7 @@ @@ -3334,7 +3334,7 @@ @@ -3455,7 +3455,7 @@ @@ -4268,6 +4268,225 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    attach

    @@ -4584,7 +4803,7 @@ @@ -4755,7 +4974,7 @@ @@ -4950,7 +5169,7 @@ @@ -5273,7 +5492,7 @@ @@ -5444,7 +5663,349 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -5537,7 +6098,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -5589,6 +6150,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -5639,7 +6224,7 @@
    @@ -5718,7 +6303,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/DuploTrainBase.html b/docs/DuploTrainBase.html index 12c4a01..5e4bc71 100644 --- a/docs/DuploTrainBase.html +++ b/docs/DuploTrainBase.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1257,7 +1257,7 @@ @@ -1965,7 +1965,7 @@ @@ -2199,7 +2199,7 @@ @@ -2366,7 +2366,7 @@ @@ -2585,7 +2585,7 @@ @@ -2826,7 +2826,7 @@ @@ -2997,7 +2997,7 @@ @@ -3118,7 +3118,7 @@ @@ -3931,6 +3931,572 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    attach

    + + +
    +
    + + +
    +

    Emits when a motor or sensor is attached to the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    type + + +DeviceType + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    button

    + + +
    +
    + + +
    +

    Emits when a button is pressed.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    button + + +string + + + + +
    state + + +ButtonState + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    color

    @@ -4071,7 +4637,696 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    colorAndDistance

    + + +
    +
    + + +
    +

    A combined color and distance event, emits when the sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    detach

    + + +
    +
    + + +
    +

    Emits when an attached motor or sensor is detached from the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    distance

    + + +
    +
    + + +
    +

    Emits when a distance sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    rotate

    + + +
    +
    + + +
    +

    Emits when a rotation sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    rotation + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -4242,7 +5497,397 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -4321,7 +5966,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/Hub.html b/docs/Hub.html index ea03a4c..875742f 100644 --- a/docs/Hub.html +++ b/docs/Hub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -2586,7 +2586,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/LPF2Hub.html b/docs/LPF2Hub.html index 8f2c36b..256dc66 100644 --- a/docs/LPF2Hub.html +++ b/docs/LPF2Hub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1747,7 +1747,7 @@
    @@ -1957,7 +1957,7 @@ @@ -2119,7 +2119,7 @@ @@ -2231,7 +2231,7 @@ @@ -3024,6 +3024,216 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    attach

    @@ -3326,7 +3536,7 @@ @@ -3488,7 +3698,7 @@ @@ -3674,7 +3884,7 @@ @@ -3983,7 +4193,7 @@ @@ -4145,7 +4355,7 @@ @@ -4307,7 +4517,169 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -4400,7 +4772,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -4452,6 +4824,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -4493,7 +4889,7 @@
    @@ -4572,7 +4968,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/PUPHub.html b/docs/PUPHub.html index ade4ec4..3ef6626 100644 --- a/docs/PUPHub.html +++ b/docs/PUPHub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1257,7 +1257,7 @@ @@ -2037,7 +2037,7 @@ @@ -2208,7 +2208,7 @@ @@ -2427,7 +2427,7 @@ @@ -2665,7 +2665,7 @@ @@ -2922,7 +2922,7 @@ @@ -3163,7 +3163,7 @@ @@ -3334,7 +3334,7 @@ @@ -3455,7 +3455,7 @@ @@ -4268,6 +4268,225 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    attach

    @@ -4584,7 +4803,7 @@ @@ -4755,7 +4974,7 @@ @@ -4950,7 +5169,7 @@ @@ -5273,7 +5492,7 @@ @@ -5444,7 +5663,349 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -5537,7 +6098,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -5589,6 +6150,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -5639,7 +6224,7 @@
    @@ -5718,7 +6303,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/PUPRemote.html b/docs/PUPRemote.html index 4135120..3b637c8 100644 --- a/docs/PUPRemote.html +++ b/docs/PUPRemote.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1808,7 +1808,7 @@ @@ -2023,7 +2023,7 @@ @@ -2194,7 +2194,7 @@ @@ -2315,7 +2315,7 @@ @@ -3128,6 +3128,401 @@
    +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    attach

    + + +
    +
    + + +
    +

    Emits when a motor or sensor is attached to the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    type + + +DeviceType + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + +

    button

    @@ -3268,7 +3663,178 @@ + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    +
    +

    color

    + + +
    +
    + + +
    +

    Emits when a color sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -3463,7 +4029,1062 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    detach

    + + +
    +
    + + +
    +

    Emits when an attached motor or sensor is detached from the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    distance

    + + +
    +
    + + +
    +

    Emits when a distance sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    rotate

    + + +
    +
    + + +
    +

    Emits when a rotation sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    rotation + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -3542,7 +5163,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/PoweredUP.html b/docs/PoweredUP.html index 558c77a..c6017cf 100644 --- a/docs/PoweredUP.html +++ b/docs/PoweredUP.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1018,7 +1018,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/WeDo2SmartHub.html b/docs/WeDo2SmartHub.html index f2f4c88..477808c 100644 --- a/docs/WeDo2SmartHub.html +++ b/docs/WeDo2SmartHub.html @@ -40,7 +40,7 @@
  • Events
    • @@ -1220,7 +1220,7 @@
    @@ -1937,7 +1937,7 @@ @@ -2171,7 +2171,7 @@ @@ -2333,7 +2333,7 @@ @@ -2543,7 +2543,7 @@ @@ -2781,7 +2781,7 @@ @@ -3019,7 +3019,7 @@ @@ -3181,7 +3181,7 @@ @@ -3293,7 +3293,7 @@ @@ -4388,7 +4388,7 @@ @@ -4550,7 +4550,7 @@ @@ -4859,7 +4859,7 @@ @@ -5021,7 +5021,7 @@ @@ -5207,7 +5207,7 @@ @@ -5286,7 +5286,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/boostmovehub.js.html b/docs/boostmovehub.js.html index 54cde12..1c04001 100644 --- a/docs/boostmovehub.js.html +++ b/docs/boostmovehub.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -109,11 +109,6 @@ const debug = Debug("boostmovehub"); * @extends Hub */ class BoostMoveHub extends lpf2hub_1.LPF2Hub { - // We set JSDoc to ignore these events as a Boost Move Hub will never emit them. - /** - * @event BoostMoveHub#speed - * @ignore - */ static IsBoostMoveHub(peripheral) { return (peripheral.advertisement && peripheral.advertisement.serviceUuids && @@ -371,7 +366,7 @@ exports.BoostMoveHub = BoostMoveHub; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/classes.list.html b/docs/classes.list.html index ee0ed23..6a35a98 100644 --- a/docs/classes.list.html +++ b/docs/classes.list.html @@ -40,7 +40,7 @@
  • Events
    • @@ -195,7 +195,7 @@
    -

    attach

    +

    accel

    @@ -203,7 +203,7 @@
    -

    Emits when a motor or sensor is attached to the Hub.

    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    @@ -260,1213 +260,6 @@ - - - type - - - - - -DeviceType - - - - - - - - - - - - - - - - - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - -
    Overrides:
    -
    - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - - - - - -
    -
    -

    button

    - - -
    -
    - - -
    -

    Emits when a button is pressed.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    button - - -string - - - - -
    state - - -ButtonState - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    color

    - - -
    -
    - - -
    -

    Emits when a color sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    color - - -Color - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    colorAndDistance

    - - -
    -
    - - -
    -

    A combined color and distance event, emits when the sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    color - - -Color - - - - -
    distance - - -number - - - - -

    Distance, in millimeters.

    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    detach

    - - -
    -
    - - -
    -

    Emits when an attached motor or sensor is detached from the Hub.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - -
    Overrides:
    -
    - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    distance

    - - -
    -
    - - -
    -

    Emits when a distance sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    distance - - -number - - - - -

    Distance, in millimeters.

    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    rotate

    - - -
    -
    - - -
    -

    Emits when a rotation sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    rotation - - -number - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    tilt

    - - -
    -
    - - -
    -

    Emits when a tilt sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -1510,6 +303,30 @@ + + + + + + + + + + + + + + + + @@ -1532,7 +349,7 @@
    @@ -1564,7 +381,7 @@ @@ -1911,7 +728,7 @@ @@ -2082,7 +899,7 @@ @@ -2277,7 +1094,7 @@ @@ -2600,7 +1417,7 @@ @@ -2771,373 +1588,7 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    -

    tilt

    - - -
    -
    - - -
    -

    Emits when a tilt sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - -
    NameTypeDescription
    port - - -string - - - - -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    x
    z + + +number + + + + +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    x - - -number - - - - -
    y - - -number - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    - -
    - - - - - - - -
    - - - - - - - - - - - - - - - -
    - - - -
    -
    -

    color

    - - -
    -
    - - -
    -

    Emits when a color sensor is activated.

    -
    - - - - - - - - -
    Parameters:
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescription
    port - - -string - - - - -
    color - - -Color - - - - -
    - - - - -
    - - - - - - - -
    Inherited From:
    -
    - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Source:
    -
    -
    @@ -3308,7 +1759,4371 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    attach

    + + +
    +
    + + +
    +

    Emits when a motor or sensor is attached to the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    type + + +DeviceType + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    button

    + + +
    +
    + + +
    +

    Emits when a button is pressed.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    button + + +string + + + + +
    state + + +ButtonState + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    color

    + + +
    +
    + + +
    +

    Emits when a color sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    colorAndDistance

    + + +
    +
    + + +
    +

    A combined color and distance event, emits when the sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    detach

    + + +
    +
    + + +
    +

    Emits when an attached motor or sensor is detached from the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    distance

    + + +
    +
    + + +
    +

    Emits when a distance sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    rotate

    + + +
    +
    + + +
    +

    Emits when a rotation sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    rotation + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    attach

    + + +
    +
    + + +
    +

    Emits when a motor or sensor is attached to the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    type + + +DeviceType + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    button

    + + +
    +
    + + +
    +

    Emits when a button is pressed.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    button + + +string + + + + +
    state + + +ButtonState + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    color

    + + +
    +
    + + +
    +

    Emits when a color sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    colorAndDistance

    + + +
    +
    + + +
    +

    A combined color and distance event, emits when the sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    detach

    + + +
    +
    + + +
    +

    Emits when an attached motor or sensor is detached from the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    distance

    + + +
    +
    + + +
    +

    Emits when a distance sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    rotate

    + + +
    +
    + + +
    +

    Emits when a rotation sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    rotation + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -3635,6 +6450,216 @@ +
    + + + +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + +
    @@ -3941,7 +6966,7 @@ @@ -4103,7 +7128,7 @@ @@ -4289,7 +7314,7 @@ @@ -4598,7 +7623,7 @@ @@ -4760,7 +7785,7 @@ @@ -4922,7 +7947,169 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -5015,7 +8202,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -5067,6 +8254,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -5108,7 +8319,7 @@
    @@ -5285,6 +8496,225 @@ + + + + +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + +
    @@ -5605,7 +9035,7 @@ @@ -5776,7 +9206,7 @@ @@ -5971,7 +9401,7 @@ @@ -6294,7 +9724,7 @@ @@ -6465,7 +9895,349 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -6558,7 +10330,7 @@ -

    If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used.

    +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    @@ -6610,6 +10382,30 @@ + + + + z + + + + + +number + + + + + + + + + + +

    (Only available when using a Control+ Hub)

    + + + @@ -6660,7 +10456,402 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    accel

    + + +
    +
    + + +
    +

    Emits when accelerometer detects movement. Measured in DPS - degrees per second.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    attach

    + + +
    +
    + + +
    +

    Emits when a motor or sensor is attached to the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    type + + +DeviceType + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -6831,7 +11022,178 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    color

    + + +
    +
    + + +
    +

    Emits when a color sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    color + + +Color + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -7026,7 +11388,1062 @@ +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    detach

    + + +
    +
    + + +
    +

    Emits when an attached motor or sensor is detached from the Hub.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + +
    Overrides:
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    distance

    + + +
    +
    + + +
    +

    Emits when a distance sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    distance + + +number + + + + +

    Distance, in millimeters.

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    rotate

    + + +
    +
    + + +
    +

    Emits when a rotation sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    rotation + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    speed

    + + +
    +
    + + +
    +

    Emits on a speed change.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +
    speed + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    temp

    + + +
    +
    + + +
    +

    Emits when a change is detected on a temperature sensor. Measured in degrees centigrade.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature.

    temp + + +number + + + + +
    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    + +
    + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +
    +
    +

    tilt

    + + +
    +
    + + +
    +

    Emits when a tilt sensor is activated.

    +
    + + + + + + + + +
    Parameters:
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    port + + +string + + + + +

    If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used.

    x + + +number + + + + +
    y + + +number + + + + +
    z + + +number + + + + +

    (Only available when using a Control+ Hub)

    + + + + +
    + + + + + + + +
    Inherited From:
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Source:
    +
    +
    @@ -7359,7 +12776,7 @@
    @@ -7521,7 +12938,7 @@ @@ -7830,7 +13247,7 @@ @@ -7992,7 +13409,7 @@ @@ -8178,7 +13595,7 @@ @@ -8257,7 +13674,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/consts.js.html b/docs/consts.js.html index 3e56973..d0a0363 100644 --- a/docs/consts.js.html +++ b/docs/consts.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -307,7 +307,7 @@ var BLECharacteristic; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/controlplushub.js.html b/docs/controlplushub.js.html index 4996f0f..037be03 100644 --- a/docs/controlplushub.js.html +++ b/docs/controlplushub.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -105,11 +105,6 @@ const debug = Debug("ControlPlusHub"); * @extends Hub */ class ControlPlusHub extends lpf2hub_1.LPF2Hub { - // We set JSDoc to ignore these events as a Powered UP Remote will never emit them. - /** - * @event ControlPlusHub#speed - * @ignore - */ static IsControlPlusHub(peripheral) { return (peripheral.advertisement && peripheral.advertisement.serviceUuids && @@ -133,6 +128,9 @@ class ControlPlusHub extends lpf2hub_1.LPF2Hub { return new Promise(async (resolve, reject) => { debug("Connecting to Control+ Hub"); await super.connect(); + this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x62, 0x00, 0x0a, 0x00, 0x00, 0x00, 0x01])); // Accelerometer + this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x63, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01])); // Gyro/Tilt + this._writeMessage(Consts.BLECharacteristic.LPF2_ALL, Buffer.from([0x41, 0x3d, 0x00, 0x0a, 0x00, 0x00, 0x00, 0x01])); // Temperature debug("Connect completed"); return resolve(); }); @@ -358,7 +356,7 @@ exports.ControlPlusHub = ControlPlusHub; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/duplotrainbase.js.html b/docs/duplotrainbase.js.html index 4b70e8b..83287e7 100644 --- a/docs/duplotrainbase.js.html +++ b/docs/duplotrainbase.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -105,35 +105,6 @@ const debug = Debug("duplotrainbase"); * @extends Hub */ class DuploTrainBase extends lpf2hub_1.LPF2Hub { - // We set JSDoc to ignore these events as a Duplo Train Base will never emit them. - /** - * @event DuploTrainBase#distance - * @ignore - */ - /** - * @event DuploTrainBase#colorAndDistance - * @ignore - */ - /** - * @event DuploTrainBase#tilt - * @ignore - */ - /** - * @event DuploTrainBase#rotate - * @ignore - */ - /** - * @event DuploTrainBase#button - * @ignore - */ - /** - * @event DuploTrainBase#attach - * @ignore - */ - /** - * @event DuploTrainBase#detach - * @ignore - */ static IsDuploTrainBase(peripheral) { return (peripheral.advertisement && peripheral.advertisement.serviceUuids && @@ -300,7 +271,7 @@ exports.DuploTrainBase = DuploTrainBase; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/global.html b/docs/global.html index d440477..1664d18 100644 --- a/docs/global.html +++ b/docs/global.html @@ -40,7 +40,7 @@
  • Events
    • @@ -3416,7 +3416,7 @@ Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/hub.js.html b/docs/hub.js.html index 8765fdd..c4e3bda 100644 --- a/docs/hub.js.html +++ b/docs/hub.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -462,7 +462,7 @@ exports.Hub = Hub; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/index.html b/docs/index.html index a435d03..d998439 100644 --- a/docs/index.html +++ b/docs/index.html @@ -40,7 +40,7 @@
  • Events
    • @@ -360,7 +360,7 @@ console.log("Scanning for Hubs..."); Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/lpf2hub.js.html b/docs/lpf2hub.js.html index 9c78452..8361a14 100644 --- a/docs/lpf2hub.js.html +++ b/docs/lpf2hub.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -108,6 +108,7 @@ class LPF2Hub extends hub_1.Hub { super(...arguments); this._lastTiltX = 0; this._lastTiltY = 0; + this._lastTiltZ = 0; this._messageBuffer = Buffer.alloc(0); } connect() { @@ -415,6 +416,12 @@ class LPF2Hub extends hub_1.Hub { this._voltage = 9620.0 * voltage / 3893.0 / 1000.0; return; } + else if ((data[3] === 0x3c && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Voltage (Control+ Hub) + data = this._padMessage(data, 6); + const voltage = data.readUInt16LE(4); + this._voltage = 9615.0 * voltage / 4095.0 / 1000.0; + return; + } else if (data[3] === 0x3c) { // Voltage (Others) data = this._padMessage(data, 6); const voltage = data.readUInt16LE(4); @@ -430,6 +437,41 @@ class LPF2Hub extends hub_1.Hub { this._current = 2444 * current / 4095.0; return; } + if ((data[3] === 0x62 && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ Accelerometer + const accelX = Math.round((data.readInt16LE(4) / 28571) * 2000); + const accelY = Math.round((data.readInt16LE(6) / 28571) * 2000); + const accelZ = Math.round((data.readInt16LE(8) / 28571) * 2000); + /** + * Emits when accelerometer detects movement. Measured in DPS - degrees per second. + * @event LPF2Hub#accel + * @param {string} port + * @param {number} x + * @param {number} y + * @param {number} z + */ + this.emit("accel", "ACCEL", accelX, accelY, accelZ); + return; + } + if ((data[3] === 0x63 && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ Accelerometer + const tiltZ = data.readInt16LE(4); + const tiltY = data.readInt16LE(6); + const tiltX = data.readInt16LE(8); + this._lastTiltX = tiltX; + this._lastTiltY = tiltY; + this._lastTiltZ = tiltZ; + this.emit("tilt", "TILT", this._lastTiltX, this._lastTiltY, this._lastTiltZ); + return; + } + if ((data[3] === 0x3d && this.type === Consts.HubType.CONTROL_PLUS_HUB)) { // Control+ CPU Temperature + /** + * Emits when a change is detected on a temperature sensor. Measured in degrees centigrade. + * @event LPF2Hub#temp + * @param {string} port For Control+ Hubs, port will be "CPU" as the sensor reports CPU temperature. + * @param {number} temp + */ + this.emit("temp", "CPU", ((data.readInt16LE(4) / 900) * 90).toFixed(2)); + return; + } const port = this._getPortForPortNumber(data[3]); if (!port) { return; @@ -487,11 +529,12 @@ class LPF2Hub extends hub_1.Hub { /** * Emits when a tilt sensor is activated. * @event LPF2Hub#tilt - * @param {string} port If the event is fired from the Move Hub's in-built tilt sensor, the special port "TILT" is used. + * @param {string} port If the event is fired from the Move Hub or Control+ Hub's in-built tilt sensor, the special port "TILT" is used. * @param {number} x * @param {number} y + * @param {number} z (Only available when using a Control+ Hub) */ - this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY); + this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY, this._lastTiltY); break; } case Consts.DeviceType.BOOST_TACHO_MOTOR: { @@ -523,7 +566,9 @@ class LPF2Hub extends hub_1.Hub { case Consts.DeviceType.BOOST_TILT: { const tiltX = data[4] > 160 ? data[4] - 255 : data[4]; const tiltY = data[5] > 160 ? 255 - data[5] : data[5] - (data[5] * 2); - this.emit("tilt", port.id, tiltX, tiltY); + this._lastTiltX = tiltX; + this._lastTiltY = tiltY; + this.emit("tilt", port.id, this._lastTiltX, this._lastTiltY, this._lastTiltZ); break; } case Consts.DeviceType.POWERED_UP_REMOTE_BUTTON: { @@ -614,7 +659,7 @@ exports.LPF2Hub = LPF2Hub; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/poweredup-node.js.html b/docs/poweredup-node.js.html index 4721a60..da85b0c 100644 --- a/docs/poweredup-node.js.html +++ b/docs/poweredup-node.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -273,7 +273,7 @@ exports.PoweredUP = PoweredUP; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/puphub.js.html b/docs/puphub.js.html index b790eb0..02762f9 100644 --- a/docs/puphub.js.html +++ b/docs/puphub.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -109,11 +109,6 @@ const debug = Debug("puphub"); * @extends Hub */ class PUPHub extends lpf2hub_1.LPF2Hub { - // We set JSDoc to ignore these events as a Powered UP Remote will never emit them. - /** - * @event PUPHub#speed - * @ignore - */ static IsPUPHub(peripheral) { return (peripheral.advertisement && peripheral.advertisement.serviceUuids && @@ -365,7 +360,7 @@ exports.PUPHub = PUPHub; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/pupremote.js.html b/docs/pupremote.js.html index 471029c..f9f2a3a 100644 --- a/docs/pupremote.js.html +++ b/docs/pupremote.js.html @@ -40,7 +40,7 @@
  • Events
    • @@ -105,35 +105,6 @@ const debug = Debug("pupremote"); * @extends Hub */ class PUPRemote extends lpf2hub_1.LPF2Hub { - // We set JSDoc to ignore these events as a Powered UP Remote will never emit them. - /** - * @event PUPRemote#distance - * @ignore - */ - /** - * @event PUPRemote#color - * @ignore - */ - /** - * @event PUPRemote#tilt - * @ignore - */ - /** - * @event PUPRemote#rotate - * @ignore - */ - /** - * @event PUPRemote#speed - * @ignore - */ - /** - * @event PUPRemote#attach - * @ignore - */ - /** - * @event PUPRemote#detach - * @ignore - */ static IsPUPRemote(peripheral) { return (peripheral.advertisement && peripheral.advertisement.serviceUuids && @@ -238,7 +209,7 @@ exports.PUPRemote = PUPRemote; Documentation generated by JSDoc 3.6.3 - on Tue Aug 6th 2019 + on Wed Aug 7th 2019 using the DocStrap template. diff --git a/docs/quicksearch.html b/docs/quicksearch.html index 7dd5d0c..741eea1 100644 --- a/docs/quicksearch.html +++ b/docs/quicksearch.html @@ -7,7 +7,7 @@