@arriva/wedge

Wedge reader for browsers

Wedge module will capture data from keyboard wedge readers and send them to a listener function. Essentially all barcode readers, magnetic stripe readers and RFID readers that sends data over keyboard commands and that can be programmed to use start and end characters can be used.

Installation

npm i @arriva/wedge

Examples

ES6

import wedge from '@arriva/wedge'

let options = {
    // Configuration options
}

let wedge = new Wedge(options)

let eventListener = wedge.listen(function(data){
    console.log([data])
})

eventListener.destroy()

Browser support

<script src="js/wedge.js"></script>
<script>
    var options = {
        // Configuration options
    }

    var wedge = new Wedge(options)

    var instance = wedge.listen(function(data){
        console.log([data])
    })

    instance.destroy()
</script>

Configuration options

When initializing Wedge the following options can be set:

• escapeStringBegin: Character that starts the code read sequence. (Default: ¤)
• escapeStringEnd: Character that ends the code read sequence. (Default: ¤)
• delay: Milliseconds minimum delay between keystrokes to allow read

    var options = {
        escapeStringBegin: '¤',
        escapeStringEnd: '¤',
        delay: 50
    }

    var instance = new Wedge(options)

Methods and properties

Wedge instance

• Wedge::listen(listenerFunc): Create listener. Listener instance object returned.
• Wedge::trigger(data): Manually trigger as if data string was read by Wedge.
• Wedge::purge([listenerId]): Destroy all listeners. Optional [listenerId] will destroy only that listener.

Listener instance

• Listener::id: Return listener id.
• Listener::destroy(): Destroy this listener.

Method examples

    var options = {
        escapeStringBegin: '¤',
        escapeStringEnd: '¤',
        delay: 50
    }

    var instance = new Wedge(options)

    var listener1 = instance.listen(function(data){
        console.log(data)
    })
    var listener2 = instance.listen(function(data){
        console.log(data)
    })

    // Trigger all listeners
    instance.trigger('123456789')

    // Purge listener with id
    instance.purge(listener1.id)

    // Purge all listeners
    instance.purge()

Tested units

• OPTICON NLV-5201 ( https://opticon.com/product/nlv-5201/ )

Conflict situations

If two or more instances of Wedge is launched, listening at same trigger characters, they will interfere and it is unpredictable which listener will catch what characters. Avoid this situation.

Contact information

Contact information will be published later.