Show:

BO.Serial Class

Uses
Defined in: src/core/Serial.js:33

Enables use of Hardware (UART) and Software serial ports on the board.

Constructor

BO.Serial

(
  • opts
)

Defined in src/core/Serial.js:33

Parameters:

  • opts Object

    Options:

    • board {IOBoard} A reference to the IOBoard instance.
    • port {Number} The serial port to use (HW_SERIAL1, HW_SERIAL2, HW_SERIAL3, SW_SERIAL0, SW_SERIAL1, SW_SERIAL2, SW_SERIAL3)
    • baud {Number} The baud rate of the serial port. Default = 57600.
    • rxPin {Number} [SoftwareSerial only] The RX pin of the SoftwareSerial instance
    • txPin {Number} [SoftwareSerial only] The TX pin of the SoftwareSerial instance

Example:

// Use a SoftwareSerial instance
var serial = new BO.Serial({
  board: arduino,
  port: BO.Serial.SW_SERIAL0,
  baud: 57600,
  txPin: 10,
  rxPin: 11
});
serial.addEventListener(BO.SerialEvent.DATA, function (event) {
  console.log(event.data);
});
serial.startReading();
// Use a HardwareSerial instance (pins RX1, TX1 on Leonardo, Mega, Due, etc)
var serial = new BO.Serial({
  board: arduino,
  port: BO.Serial.HW_SERIAL1,
  baud: 57600
});
serial.addEventListener(BO.SerialEvent.DATA, function (event) {
  console.log(event.data);
});
serial.startReading();

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

close

()

Defined in src/core/Serial.js:183

Close the serial port. A new instance must be created in order to reopen the port.

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.

flush

()

Defined in src/core/Serial.js:192

For HardwareSerial, waits for the transmission of outgoing serial data to complete. For SoftwareSerial, removes any buffered incoming serial data.

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.

listen

()

Defined in src/core/Serial.js:202

For SoftwareSerial only. Only a single SoftwareSerial instance can read data at a time. Call this method to set this port to be the reading port in the case there are multiple SoftwareSerial instances.

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

startReading

(
  • maxBytesToRead
)

Defined in src/core/Serial.js:157

Start reading the serial port.

Parameters:

  • maxBytesToRead Number

    [optional] The number of bytes to read on each iteration of the main loop.

stopReading

()

Defined in src/core/Serial.js:175

Stop reading the serial port.

write

(
  • val
)

Defined in src/core/Serial.js:134

Write an array of data.

Parameters:

  • val Number | Array

    A single byte or an array of bytes to write

Properties

Serial.HW_SERIAL0

Unknown static

Defined in src/core/Serial.js:251

Not currently used. Corresponds to the default Arduino Serial port

Serial.HW_SERIAL1

Unknown static

Defined in src/core/Serial.js:257

Pins RX1 and TX1 on the board

Serial.HW_SERIAL2

Unknown static

Defined in src/core/Serial.js:263

Pins RX2 and TX2 on the board

Serial.HW_SERIAL3

Unknown static

Defined in src/core/Serial.js:269

Pins RX3 and TX3 on the board

Serial.SW_SERIAL0

Unknown static

Defined in src/core/Serial.js:276

One of four software serial instances

Serial.SW_SERIAL1

Unknown static

Defined in src/core/Serial.js:282

One of four software serial instances

Serial.SW_SERIAL2

Unknown static

Defined in src/core/Serial.js:288

One of four software serial instances

Serial.SW_SERIAL3

Unknown static

Defined in src/core/Serial.js:294

One of four software serial instances