Show:

BO.io.AccelerometerADXL345 Class

Extends BO.I2CBase
Defined in: src/io/AccelerometerADXL345.js:31

Creates an interface to an ADXL345 3-axis 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. See the example in Breakout/examples/sensors/adxl345.html.

Constructor

BO.io.AccelerometerADXL345

(
  • board
  • range
  • address
)

Defined in src/io/AccelerometerADXL345.js:31

Parameters:

  • board IOBoard

    The IOBoard instance

  • range Number

    The dynamic range selection in Gs (options RANGE_2G, RANGE_4G, RANGE_8G, RANGE_16G). Default is RANGE_2G.

  • address Number

    The i2c address of the accelerometer (default is 0x53)

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.

getAxisOffset

()

Defined in src/io/AccelerometerADXL345.js:344

Get the value of the x, y, and z axis offset.

handleI2C

() private

Inherited from BO.I2CBase but overwritten in src/io/AccelerometerADXL345.js:288

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.

powerOn

() private

Defined in src/io/AccelerometerADXL345.js:372

readAccel

() private

Defined in src/io/AccelerometerADXL345.js:401

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

sendI2CRequest

(
  • command
  • data
)
protected

Inherited from BO.I2CBase: src/core/I2CBase.js:116

Send an i2c request command to the board

Parameters:

  • command Number
  • data Number

setAxisOffset

()

Defined in src/io/AccelerometerADXL345.js:329

Offset the x, y, or z axis output by the respective input value.

setRangeAndFullRes

() private

Defined in src/io/AccelerometerADXL345.js:257

setRegisterBit

() private

Defined in src/io/AccelerometerADXL345.js:385

startReading

()

Defined in src/io/AccelerometerADXL345.js:309

Start continuous reading of the sensor.

stopReading

()

Defined in src/io/AccelerometerADXL345.js:320

Stop continuous reading of the sensor.

update

()

Inherited from BO.I2CBase but overwritten in src/io/AccelerometerADXL345.js:360

Sends read request to accelerometer and updates accelerometer values.

Properties

AccelerometerADXL345.DEFAULT_SENSITIVITY

Unknown static

Defined in src/io/AccelerometerADXL345.js:479

AccelerometerADXL345.DEVICE_ID

Unknown static

Defined in src/io/AccelerometerADXL345.js:474

AccelerometerADXL345.RANGE_16G

Unknown static

Defined in src/io/AccelerometerADXL345.js:469

AccelerometerADXL345.RANGE_2G

Unknown static

Defined in src/io/AccelerometerADXL345.js:454

AccelerometerADXL345.RANGE_4G

Unknown static

Defined in src/io/AccelerometerADXL345.js:459

AccelerometerADXL345.RANGE_8G

Unknown static

Defined in src/io/AccelerometerADXL345.js:464

address

Number

Inherited from BO.I2CBase: src/core/I2CBase.js:76

[read-only] The address of the i2c device.

dynamicRange

Number

Defined in src/io/AccelerometerADXL345.js:93

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

I2CBase.I2C_REPLY

Unknown

Inherited from BO.I2CBase: src/core/I2CBase.js:204

isRunning

Boolean

Defined in src/io/AccelerometerADXL345.js:200

[read-only] The state of continuous read mode. True if continuous read mode is enabled, false if it is disabled.

pitch

Number

Defined in src/io/AccelerometerADXL345.js:137

[read-only] The pitch value in degrees

rawX

Number

Defined in src/io/AccelerometerADXL345.js:167

[read-only] The raw value of the x axis

rawY

Number

Defined in src/io/AccelerometerADXL345.js:178

[read-only] The raw value of the y axis

rawZ

Number

Defined in src/io/AccelerometerADXL345.js:189

[read-only] The raw value of the z axis

roll

Number

Defined in src/io/AccelerometerADXL345.js:151

[read-only] The roll value in degrees

sensitivityX

Number

Defined in src/io/AccelerometerADXL345.js:214

The sensitivity value for the x axis (default value = 0.0390625).

sensitivityY

Number

Defined in src/io/AccelerometerADXL345.js:228

The sensitivity value for the y axis (default value = 0.0390625).

sensitivityZ

Number

Defined in src/io/AccelerometerADXL345.js:242

The sensitivity value for the z axis (default value = 0.0390625).

x

Number

Defined in src/io/AccelerometerADXL345.js:104

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

y

Number

Defined in src/io/AccelerometerADXL345.js:115

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

z

Number

Defined in src/io/AccelerometerADXL345.js:126

[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/AccelerometerADXL345.js:487

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

Event Payload: