webduino-js

  • API Docs for Version: 0.7.0

    • Show:

    webduino.module.Barcode

    Extends webduino.Module

    The Barcode class.

    Table of Contents

    Constructor

    webduino.module.Barcode
    (
    • board
    • rxPin
    • txPin
    )

    Defined in src/module/Barcode.js:26

    Parameters:

    • board webduino.Board

      The board the barcode scanner is attached to.

    • rxPin webduino.Pin | Number

      Receivin pin (number) the barcode scanner is connected to.

    • txPin webduino.Pin | Number

      Transmitting pin (number) the barcode scanner is connected to.

    Methods

    addListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:117

    Add a listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    emit
    (
    • type
    • object,...
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:58

    Emit an event of certain type.

    Parameters:

    • type String

      Event type.

    • [object,...] Object optional

      Event object(s).

    listeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:310

    Return the listener list bound to certain type of event.

    Parameters:

    • type String

      Evnet type.

    off ()

    Defined in src/module/Barcode.js:113

    Stop scanning.

    on
    (
    • callback
    )
    deprecated

    Inherited from webduino.EventEmitter but overwritten in src/module/Barcode.js:87

    Deprecated: `on()` is deprecated, use `scan()` instead.

    Start scanning.

    Parameters:

    • [callback] Function optional

      Scanning callback.

    once
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:183

    Add a one-time listener for a certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    removeAllListeners
    (
    • type
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:264

    Remove all listeners of certain type.

    Parameters:

    • type String

      Event type.

    removeListener
    (
    • type
    • listener
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:211

    Remove a listener for certain type of event.

    Parameters:

    • type String

      Event type.

    • listener Function

      Event listener.

    scan
    (
    • callback
    )

    Defined in src/module/Barcode.js:80

    Start scanning.

    Parameters:

    • [callback] Function optional

      Scanning callback.

    setMaxListeners
    (
    • n
    )

    Inherited from webduino.EventEmitter: src/core/EventEmitter.js:45

    Set maximum number of listeners that is allow to bind on an emitter.

    Parameters:

    • n Number

      Number of listeners.

    Attributes

    state

    String 'on' or 'off'

    Defined in src/module/Barcode.js:64

    The state indicating whether the module is scanning.

    type

    String readonly

    Inherited from webduino.Module: src/core/Module.js:30

    Type of the module.

    Events

    BarcodeEvent.MESSAGE

    Defined in src/module/Barcode.js:18

    Fires when the barcode scanner scans a code.