Show:

BO.io.AnalogAccelerometer Class

Extends BO.PhysicalInputBase
Defined in: src/io/AnalogAccelerometer.js:29

Creates an interface to an analog accelerometer. Use the accelerometer to read the acceleration along the x, y, and z axis of an object it is attached to. You can also obtain the pitch and roll. This object should interface with most analog accelerometers. See Breakout/examples/sensors/analog_accelerometer.html and Breakout/examples/three_js/accelerometer.html for example applications.

Constructor

BO.io.AnalogAccelerometer

(
  • board
  • xPin
  • yPin
  • zPin
  • dynamicRange
  • enableSmoothing
)

Defined in src/io/AnalogAccelerometer.js:29

Parameters:

  • board IOBoard

    A reference to the IOBoard instance

  • xPin Pin

    A reference to the Pin connected to the x axis of the accelerometer

  • yPin Pin

    A reference to the Pin connected to the y axis of the accelerometer

  • zPin Pin

    A reference to the Pin connected to the z axis of the accelerometer

  • dynamicRange Number

    The range of the acceleromter in Gs (typically 2 or 3 for an analog accelerometer). See the datasheet for the acceleromter to get the exact value.

  • enableSmoothing Boolean

    True to enable smoothing, false to disable. Default is false.

Methods

addEventListener

(
  • type
  • listener
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:37

Parameters:

  • type String

    The event type

  • listener Function

    The function to be called when the event is fired

dispatchEvent

(
  • type
  • optionalParams
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:78

Parameters:

  • type Event

    The Event object.

  • optionalParams Object

    Optional parameters passed as an object. return {boolean} True if dispatch is successful, false if not.

getCalibratedRange

(
  • minVoltage
  • maxVoltage
  • supplyVoltage
)
Object

Defined in src/io/AnalogAccelerometer.js:235

Use this method to get the minimum and maximum range values for an axis. Create a new object to store the return value and then pass obj.min and obj.max along with the respective axis identifier to the setRangeFor method.

Parameters:

  • minVoltage Number

    The minimum value reported on the axis

  • maxVoltage Number

    The maximum value reported on the axis

  • supplyVoltage Number

    The supply voltage of the Acceleromter (enter as 3.3, 3.0, 5.0, etc).

Returns:

Object:

An object containing the min and max range values to be passed to the setRangeFor method.

hasEventListener

(
  • type
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:65

Parameters:

  • type String

    The event type return {boolean} True is listener exists for this type, false if not.

removeEventListener

(
  • type
  • listener
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:50

Parameters:

  • type String

    The event type

  • listener Function

    The function to be called when the event is fired

setRangeFor

(
  • axis
  • minimum
  • maximum
)

Defined in src/io/AnalogAccelerometer.js:192

Scale the range for the specified axis (from 0 to 1) to (minimum to maximum).

Parameters:

  • axis Object

    the axis to set new range (AnalogAccelerometer.X_AXIS, AnalogAccelerometer.Y_AXIS or AnalogAccelerometer.Z_AXIS).

  • minimum Number

    The new minimum value

  • maximum Number

    The new maximum value

xAxisChanged

() private

Defined in src/io/AnalogAccelerometer.js:266

yAxisChanged

() private

Defined in src/io/AnalogAccelerometer.js:275

zAxisChanged

() private

Defined in src/io/AnalogAccelerometer.js:284

Properties

AnalogAccelerometer.X_AXIS

Unknown static

Defined in src/io/AnalogAccelerometer.js:293

AnalogAccelerometer.Y_AXIS

Unknown static

Defined in src/io/AnalogAccelerometer.js:298

AnalogAccelerometer.Z_AXIS

Unknown static

Defined in src/io/AnalogAccelerometer.js:303

dynamicRange

Number

Defined in src/io/AnalogAccelerometer.js:99

[read-only] the accelerometer dynamic range in Gs (either 2G, 4G, 8G, or 16G for this sensor)..

pitch

Number

Defined in src/io/AnalogAccelerometer.js:143

[read-only] The pitch value in degrees

roll

Number

Defined in src/io/AnalogAccelerometer.js:157

[read-only] The roll value in degrees

x

Number

Defined in src/io/AnalogAccelerometer.js:110

[read-only] The acceleration value in Gs (9.8m/sec^2) along the x-axis.

y

Number

Defined in src/io/AnalogAccelerometer.js:121

[read-only] The acceleration value in Gs (9.8m/sec^2) along the y-axis.

z

Number

Defined in src/io/AnalogAccelerometer.js:132

[read-only] The acceleration value in Gs (9.8m/sec^2) along the z-axis.

Events

update

BO.io.AccelerometerEvent.UPDATE

Defined in src/io/AnalogAccelerometer.js:312

The update event is dispatched when the accelerometer values are updated.

Event Payload: