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
- setProperties(props) ⇒
boolean
- attach(success, failure)
attaches the library to the current component
call detach when unmounting/onDestroy
NOTE: params are to be passed as an object
- detach(onDisconnection)
detaches library from component resetting callbacks & properties
- enumerate() ⇒
number
Calls "onEnumerate" callback function and returns the number of rfid scanners
may crash when starting an rfid operation()ms current rfid reader
- onEnumerate(callback)
- onTagLocate(callback)
- locateTag()
locates a tag with the given rfid
- startInventory()
performs inventory and triggers tagEvent
- onInventory(callback)
- scanSingleRfid()
Scans a single rfid tag
- onScanSingleRfid(callback)
Typedefs
- onEnumerateEvent :
function
- onInventoryEvent :
function
- onTagLocateEvent :
function
- onScanSingleRfidEvent :
function
- statusDefinition :
Object
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/
| Param | Type | Description |
| --- | --- | --- |
| props |
object | rfid object properties |
attach(success, failure)
NOTE: params are to be passed as an objectent
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| success |
function | gets called on connection event |
| failure |
function | gets called on connection event |
detach(onDisconnection)
detaches library from component resetting callbacks & properties
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| onDisconnection |
function | called 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
| Param | Type | Description |
| --- | --- | --- |
| callback |
onEnumerateEvent | function that gets called during "enumerate()" execution |
onTagLocate(callback)
Kind: global function
| Param | Type | Description |
| --- | --- | --- |
| callback |
onTagLocateEvent | function 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
| Param | Type | Description |
| --- | --- | --- |
| callback |
onInventoryEvent | function that gets called during "startInventory()" execution |
scanSingleRfid()
Scans a single rfid tag
statusDefinition : Object
Kind: global typedef
| Param | Type | Description |
| --- | --- | --- |
| name |
string | name of the status to be associated with statusManager |
| errorCode |
string | || vendorMessage |
string | |
| method |
string | |
| internalCode |
string | unique assigned code with which to identify associated callbacks |