Show:

BO.generators.Oscillator Class

Extends BO.generators.GeneratorBase
Defined in: src/generators/Oscillator.js:25

The Oscillator object can be attached to a Pin or LED object to output a waveform. This is useful for blinking an LED or fading it on and off. In most cases (unless you are simply using it to blink and LED on or off), the Oscillator should be attached to a Pin or LED object associated with a PWM pin on the I/O board. See Breakout/examples/generators/oscillator.html for an example application.

Constructor

BO.generators.Oscillator

(
  • wave
  • freq
  • amplitude
  • offset
  • phase
  • times
)

Defined in src/generators/Oscillator.js:25

Parameters:

  • wave Number

    waveform

  • freq Number

    frequency

  • amplitude Number

    amplitude

  • offset Number

    offset

  • phase Number

    phase

  • times Number

    The repeat count from 0 to infinite.

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

autoUpdate

() private

Defined in src/generators/Oscillator.js:137

computeValue

() private

Defined in src/generators/Oscillator.js:147

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.

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.

Oscillator.IMPULSE

() static

Defined in src/generators/Oscillator.js:214

impulse

Oscillator.LINEAR

() static

Defined in src/generators/Oscillator.js:223

linear

Oscillator.SAW

() static

Defined in src/generators/Oscillator.js:200

saw wave

Oscillator.SIN

() static

Defined in src/generators/Oscillator.js:172

sine wave

Oscillator.SQUARE

() static

Defined in src/generators/Oscillator.js:181

square wave

Oscillator.TRIANGLE

() static

Defined in src/generators/Oscillator.js:190

triangle wave

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

reset

()

Defined in src/generators/Oscillator.js:113

Resets the oscillator.

start

()

Defined in src/generators/Oscillator.js:90

Starts the oscillator.

stop

()

Defined in src/generators/Oscillator.js:103

Stops the oscillator.

update

(
  • interval
)

Defined in src/generators/Oscillator.js:122

By default the interval is 33 milliseconds. The Osc is updated every 33ms.

Parameters:

  • interval Number

    The update interval in milliseconds.

Properties

serviceInterval

Number

Defined in src/generators/Oscillator.js:76

The service interval in milliseconds. Default is 33ms.

value

Number protected

Inherited from BO.generators.GeneratorBase: src/generators/GeneratorBase.js:47

[read-only] Get a generated number.

Events

update

BO.generators.GeneratorEvent.UPDATE

Defined in src/generators/Oscillator.js:234

The update event is dispatched at the rate specified by the serviceInterval parameter (default = 33ms).

Event Payload: