Show:

BO.I2CBase Class

Uses
Defined in: src/core/I2CBase.js:21

A base class for I2C objects. Extend this class when creating an interface for a new I2C device. I2CBase should not be instantiated directly.

Constructor

BO.I2CBase

(
  • board
  • address
  • delayUS
)

Defined in src/core/I2CBase.js:21

Parameters:

  • board IOBoard

    A reference to the IOBoard instance

  • address Number

    The I2C address of the device

  • delayUS Number

    The number of microseconds ...

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.

handleI2C

() protected

Defined in src/core/I2CBase.js:151

To be implemented in subclass. Data should be: slave address, register, data0, data1...

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

sendI2CRequest

(
  • command
  • data
)
protected

Defined in src/core/I2CBase.js:116

Send an i2c request command to the board

Parameters:

  • command Number
  • data Number

update

() protected

Defined in src/core/I2CBase.js:142

To be implemented in subclass

Properties

address

Number

Defined in src/core/I2CBase.js:76

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

I2CBase.I2C_CONFIG

Unknown static

Defined in src/core/I2CBase.js:208

I2CBase.I2C_REPLY

Unknown

Defined in src/core/I2CBase.js:204

I2CBase.I2C_REQUEST

Unknown static

Defined in src/core/I2CBase.js:199

I2CBase.READ

Unknown static

Defined in src/core/I2CBase.js:219

I2CBase.READ_CONTINUOUS

Unknown static

Defined in src/core/I2CBase.js:224

I2CBase.STOP_READING

Unknown static

Defined in src/core/I2CBase.js:229

I2CBase.WRITE

Unknown static

Defined in src/core/I2CBase.js:214