1.1.1 • Published 2 years ago

zebra-rfid-library v1.1.1

Weekly downloads
-
License
-
Repository
github
Last release
2 years ago

zebra-rfid-library

Warning: requires script injection from eb to be enabled

Getting started

It is advised to setup enterprise browser's script tag injection to inject required libraries (eb-module.js & elements.js) into the page.

Using the library

1) import the library (import * as rfidlib from 'zebra-rfid-library') 2) setup attach and detach calls, react example below:

  useEffect(() => {
   rfidlib.attach();
   return rfidlib.detach;
 }, []);

this is to prevent memory leaks and conflicts between different components which use the library

Functions

Typedefs

setProperties(props) ⇒ boolean

Kind: global function Returns: boolean - operation success/failure Link: for the list of parameters see official zebra documentation: https://techdocs.zebra.com/enterprise-browser/3-3/api/re2x/rfid/

ParamTypeDescription
propsobjectrfid object properties

attach(success, failure)

NOTE: params are to be passed as an objectent

Kind: global function

ParamTypeDescription
successfunctiongets called on connection event
failurefunctiongets called on connection event

detach(onDisconnection)

detaches library from component resetting callbacks & properties

Kind: global function

ParamTypeDescription
onDisconnectionfunctioncalled on disconnection event

enumerate() ⇒ number

Calls "onEnumerate" callback function and returns the number of rfid scanners

Kind: global function Returns: number - number of rfid scanners found may crash when starting an rfid operation">rogram

may crash when starting an rfid operation()he program Kind: global function

onEnumerate(callback)

Kind: global function

ParamTypeDescription
callbackonEnumerateEventfunction that gets called during "enumerate()" execution

onTagLocate(callback)

Kind: global function

ParamTypeDescription
callbackonTagLocateEventfunction called when locating a tag

locateTag()

locates a tag with the given rfid

Kind: global function

startInventory()

performs inventory and triggers tagEvent

Kind: global function

onInventory(callback)

Kind: global function

ParamTypeDescription
callbackonInventoryEventfunction that gets called during "startInventory()" execution

scanSingleRfid()

Scans a single rfid tag

statusDefinition : Object

Kind: global typedef

ParamTypeDescription
namestringname of the status to be associated with statusManager
errorCodestringvendorMessagestring
methodstring
internalCodestringunique assigned code with which to identify associated callbacks
1.1.1

2 years ago

1.0.2

2 years ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.4.3-alpha

2 years ago

0.4.2-alpha

2 years ago

0.4.1-alpha

2 years ago

0.4.0-alpha

2 years ago

0.3.6-alpha

2 years ago

0.3.5-alpha

2 years ago

0.3.4-alpha

2 years ago

0.3.3-alpha

2 years ago

0.3.2-alpha

2 years ago

0.3.1-alpha

2 years ago

0.3.0-alpha

2 years ago

0.2.2-alpha

2 years ago

0.2.1-alpha

2 years ago

0.2.0-alpha

2 years ago

0.1.4-alpha

2 years ago

0.1.3-alpha

2 years ago

0.1.2-alpha

2 years ago

0.1.1-alpha

2 years ago

0.1.0-alpha

2 years ago