Barcode
The Barcode Module provides access to control the functionality of the device’s scanner. Because RhoMobile Suite is designed to run on both Consumer devices and Symbol Technologies' enterprise devices support for the Barcode API will vary for each method and properties depending on which platform you are running on. Please note that a lot these APIs are optimized for the extended functionality that Symbol Technologies devices provide. Check the platform indicators in each property or method section. In general if you are developing for a consumer device the number of symbologies available to you will be limited to just the most common ones, eg EAN13, UPCA etc and your scanning will be via the device camera. If your application is running on Symbol Technologies' hardware you will have much finer control over a more fully featured Scanner, often with a choice of scanner hardware on the device. In general if you wish to capture a single barcode in a ‘one shot’ use case, eg your App just wants to capture a single barcode to be submitted to a price comparison website then use Barcode.take(callback); if your application is expecting a number of barcodes to be received, common in enterprise scenarios for example a user in a warehouse then use Barcode.enable(callback). The Barcode API will not run on non-Symbol Technologies Windows Mobile / CE devices.Only the foreground application is given access to the scanning hardware, when an application is sent to the background its state will be saved and it will automatically relinquish control of the scanner. When brought back to the foreground, an application previously using the barcode API will have its previous configuration reapplied automatically.In VC70 scanner will work only if connected in SSI Mode. In Symbol android devices, it is recommended to use EMDK for KitKat devices and not to use EMDK in JellyBean devices.
Enabling the API
In order to use this API you must include the following extension in your build.yml
:::ruby
extensions: [“barcode”]
| If you are building a Windows Mobile or Windows CE app with this API, you must set your app_type as “rhoelements” in your build.yml as shown here. |
JavaScript Usage
Be sure to review the JavaScript API Usage guide for important information about using this API in JavaScript
Ruby Usage
Be sure to review the Ruby API Usage guide for important information about using this API in Ruby
Methods
Recognizes a barcode on an image. Returns a string with recognized code, or empty string if the barcode is not recognized.
Parameters
- imageFilePath : STRING
Path to the image that contains the barcode to be recognized.
Synchronous Return:
- STRING :
String with recognized code, or empty string if the barcode is not recognized.
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.barcode_recognize(STRING imageFilePath)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.barcode_recognize(STRING imageFilePath) - Ruby:
Rho::Barcode.barcode_recognize(STRING imageFilePath)
- JavaScript:
Instruct the connected RS507 scanner to perform some action.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Parameters
- command : STRING
The action the RS507 scanner should perform, can be ‘Disconnect’ which disconnects the bluetooth RS507; ‘unpair’ which unpairs the RS507 from the device for association with another device; ‘StartPaging’ or ‘StopPaging’ which will cause the RS507 scanner to start or stop emitting a beep, to allow it to be located.
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.commandRemoteScanner(STRING command)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.commandRemoteScanner(STRING command) - Ruby:
Rho::Barcode.commandRemoteScanner(STRING command)
- JavaScript:
Disables the barcode scanner. This reverts the scanner to its default state and flushes any current decoder settings.
(Symbol Technologies' scanners)
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.disable()
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.disable() - Ruby:
Rho::Barcode.disable()
- JavaScript:
Enabling the scanner puts it in a state where it will respond to the trigger (on devices with a hardware trigger) or will accept a command to initiate a soft scan (start method). Scanned barcodes will be available to the application through the callback provided to this method. Only one scanner on the device can be enabled at any one time, to switch between the imager and camera scanners (for example) then first disable the currently enabled scanner. If you do not specify a callback to this method you will received the scanned data as keystrokes. Note that it is necessary to enable the scanner on WM/CE devices prior to being able to retrieve the state of properties.
This method replaces Barcode.enable from RhoElements 2.2 and takes a different prototype, no longer taking a ‘deviceName’ parameter this method can now be called on the individual scanner instances returned by Barcode.enumerate to control which hardware scanner on the device is enabled. Please consider using Barcode.take if you only require a ‘single shot’ scan and Barcode.enable if your user will be using the trigger to return scan events. |
(Symbol Technologies' Scanners which support a hardware or software trigger to invoke the scan.)
Parameters
- propertyMap : HASH Optional
Provide a set of properties to configure the scanner, for example enable specific symbologies or check digits.
Valid `properties` for this parameter are the properties avaliable to this API module. Check the property sectionNot providing properties to this function will use the scanner’s default properties, or those previously set on the Scanner instance.
- callback : CallBackHandler Optional
Async Callback Returning Parameters: HASH
- data : STRING
The data decoded by the scanner or imaging device.
- source : STRING
The source device and human readable decoder type of the decoded barcode or symbol.
- type : STRING
Hex value representing the decoder type.
- time : STRING
The time at which the decode occurred (hh:mm:ss)
- length : STRING
The length of the decoded barcode or symbol.
- direction : STRING
The direction the barcode was scanned, either forward, reverse or unavailable.
Synchronous Return:
- Void : this method also supports async callbacks - check the Callback tab for callback return parameters.
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.enable(HASH propertyMap, CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.enable(HASH propertyMap, CallBackHandler callback) - Ruby:
Rho::Barcode.enable(HASH propertyMap, CallBackHandler callback)
- JavaScript:
Used to gain access to all scanner objects present on the device. For consumer devices you will most likely only have a single scanner, your device’s camera but Enterprise grade hardware may have two or more scanners attached.
This method replaces Barcode.enumerate from RhoElements 2.2 and takes a different prototype. Enumerate now returns an array of objects which can be used to control the specific scanner instance whereas previously it took a callback which returned the ‘name’ and ‘id’ of scanners present on the device. |
This method will return all of object/value pairs for the propertyNames of the API class.
Parameters
- callback : CallBackHandler Optional
Async Callback Returning Parameters: HASH
- : STRING
Synchronous Return:
- HASH :
Map of all available properties
: this method also supports async callbacks - check the Callback tab for callback return parameters.- : STRING
- : STRING
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.getAllProperties(CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.getAllProperties(CallBackHandler callback) - Ruby:
Rho::Barcode.getAllProperties(CallBackHandler callback)
- JavaScript:
This method will return an object that represents the default instance of the API Class. For example Camera.getDefault will return a Camera object that represents the default camera.
Synchronous Return:
- SELF_INSTANCE :
Default object of Module.
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.Barcode.getDefault() - Ruby:
Rho::Barcode.getDefault()
- JavaScript:
This method will return a set of object/value pairs for the list of the propertyName that is passed in. The propertyNames must be a valid property of the API class.
Parameters
- arrayofNames : ARRAY
List of properties I want to know about
-
Object : STRING
- callback : CallBackHandler Optional
Async Callback Returning Parameters: HASH
- : STRING
Synchronous Return:
- HASH :
Map of properties I want to know about
: this method also supports async callbacks - check the Callback tab for callback return parameters.- : STRING
- : STRING
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.getProperties(ARRAY arrayofNames, CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.getProperties(ARRAY arrayofNames, CallBackHandler callback) - Ruby:
Rho::Barcode.getProperties(ARRAY arrayofNames, CallBackHandler callback)
- JavaScript:
This method will return the value of the propertyName that is passed in. The propertyName must be a valid property of the API class.
Parameters
- propertyName : STRING
The property to return info about.
- callback : CallBackHandler Optional
Async Callback Returning Parameters: STRING
Synchronous Return:
- STRING :
The property to return info about.
: this method also supports async callbacks - check the Callback tab for callback return parameters.
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.getProperty(STRING propertyName, CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.getProperty(STRING propertyName, CallBackHandler callback) - Ruby:
Rho::Barcode.getProperty(STRING propertyName, CallBackHandler callback)
- JavaScript:
Return array of properties supported by this scanner.
(Symbol Technologies' scanners)
Parameters
- callback : CallBackHandler Optional
Async Callback Returning Parameters: ARRAY
-
Object : STRING
Synchronous Return:
- ARRAY :
Array of property names supported by this scanner.
: this method also supports async callbacks - check the Callback tab for callback return parameters.-
Object : STRING
-
Object : STRING
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.getSupportedProperties(CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.getSupportedProperties(CallBackHandler callback) - Ruby:
Rho::Barcode.getSupportedProperties(CallBackHandler callback)
- JavaScript:
If you are using an RS507 barcode scanner you can register to receive connected or disconnected events through this method.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Parameters
- callback : CallBackHandler Mandatory
Async Callback Returning Parameters: HASH
- status : STRING
The message describing the bluetooth connection: BluetoothConnected, BluetoothDisconnected or BTScanAssociationBarcode. See below for further descriptions.
Synchronous Return:
- Void : this method also supports async callbacks - check the Callback tab for callback return parameters.
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.registerBluetoothStatus(CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.registerBluetoothStatus(CallBackHandler callback) - Ruby:
Rho::Barcode.registerBluetoothStatus(CallBackHandler callback)
- JavaScript:
This method allows you to set the attributes of the default object instance by passing in an object of the same class.
Parameters
- defaultInstance : SELF_INSTANCE: Rho::Barcode
An instance object that is of the same class.
Synchronous Return:
- Void
Method Access:
-
Class Method: This method can only be accessed via the API class object.
- JavaScript:
Rho.Barcode.setDefault(SELF_INSTANCE: Rho::Barcode defaultInstance) - Ruby:
Rho::Barcode.setDefault(SELF_INSTANCE: Rho::Barcode defaultInstance)
- JavaScript:
This method will set the values of a list of properties for the API class. The propertyName must be a valid property for the class and must also not be read only.
Parameters
- propertyMap : HASH
Map of properties I want to set
-
Object : STRING
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.setProperties(HASH propertyMap)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.setProperties(HASH propertyMap) - Ruby:
Rho::Barcode.setProperties(HASH propertyMap)
- JavaScript:
This method will set the value of a property for the API class. The propertyName must be a valid property for the class and must also not be read only.
Parameters
- propertyName : STRING
The one property name that I want to set
- propertyValue : STRING
The one property value that I want to set
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.setProperty(STRING propertyName, STRING propertyValue)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.setProperty(STRING propertyName, STRING propertyValue) - Ruby:
Rho::Barcode.setProperty(STRING propertyName, STRING propertyValue)
- JavaScript:
Performs a soft trigger start, initiating a scan without pressing the hardware trigger. If the scan does not result in a decode it is necessary to perform a soft stop before another soft start.
(Symbol Technologies' scanners)
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.start()
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.start() - Ruby:
Rho::Barcode.start()
- JavaScript:
Performs a soft trigger stop.
(Symbol Technologies' scanners)
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.stop()
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.stop() - Ruby:
Rho::Barcode.stop()
- JavaScript:
Enable the scanner and start capturing the barcode automatically. On Symbol Technologies' devices the amount of time to scan the barcode is defined by the scanTimeout property. On iPhone and Android if a barcode is found, the user can confirm barcode recognition, or continue to try to recognize the barcode. When the user confirms or cancels, the callback is called. Once the callback has been called the barcode hardware is disabled.This method will work only on scanners which support soft scan.
Parameters
- propertyMap : HASH Optional
Provide a set of properties to configure the scanner, for example enable specific symbologies or check digits.
Valid `properties` for this parameter are the properties avaliable to this API module. Check the property sectionNot providing properties to this function will use the scanner’s default properties, or those previously set on the Scanner instance.
- callback : CallBackHandler Mandatory
Async Callback Returning Parameters: HASH
- barcode : STRING
The data decoded by the scanner or imaging device.
- status : STRING
Whether or not the barcode was successfully scanned, status will be ‘ok’ or ‘cancel’
Synchronous Return:
- Void : this method also supports async callbacks - check the Callback tab for callback return parameters.
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.take(HASH propertyMap, CallBackHandler callback)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.take(HASH propertyMap, CallBackHandler callback) - Ruby:
Rho::Barcode.take(HASH propertyMap, CallBackHandler callback)
- JavaScript:
Deprecated old method for Barcode.take().
Parameters
- rubyCallbackURL : STRING
Ruby callback URL.
- propertyMap : HASH Optional
Provide a set of properties to configure the scanner, for example enable specific symbologies or check digits.
Valid `properties` for this parameter are the properties avaliable to this API module. Check the property sectionNot providing properties to this function will use the scanner’s default properties, or those previously set on the Scanner instance.
Synchronous Return:
- Void
Method Access:
-
Instance Method: This method can be accessed via an instance object of this class:
myObject.take_barcode(STRING rubyCallbackURL, HASH propertyMap)
-
Default Instance: This method can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.take_barcode(STRING rubyCallbackURL, HASH propertyMap) - Ruby:
Rho::Barcode.take_barcode(STRING rubyCallbackURL, HASH propertyMap)
- JavaScript:
Properties
Enables or disables adaptive scanning. When set to true, the scan engine will automatically toggle between 2 scan angles, wide and narrow, allowing the scan engine to decode barcodes both in close proximity and far away (~100 inches). Adaptive scanning is only supported in high performance, long working range scan engines such as SE960.
(Laser Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.adaptiveScanning
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.adaptiveScanning - Ruby:
Rho::Barcode.adaptiveScanning
- JavaScript:
Defines the aiming mode to use.
(Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: none
No Aiming (Can be overridden by picklistMode).
String: dot
Laser barcode readers will show a dot for aiming.
String: slab
Laser barcode readers will show a slab for aiming.
String: reticle
Imager barcode readers will show a reticle for aiming.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.aimMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.aimMode - Ruby:
Rho::Barcode.aimMode
- JavaScript:
Describes the type of aiming to use.
(Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: trigger
Standard trigger mode. Holding the trigger will start a decoding session.
String: timedHold
Aiming lasts for the time specified by ‘timedAimDuration’ before decoding. The opportunity to scan will last until the barcode is decoded or scanTimeout occurs.
String: timedRelease
Aiming lasts until trigger is released. If the timedAimDuration has expired when the trigger is released then a decode session is started until a barcode is decoded or for the remaining time equal to the scanTimeout value.
String: presentation
Provided to support Kiosk devices. The scanner illuminates when movement is detected in the range of the scanner window. In order to use this mode the scanner must be initiated with a softscan using the Rho.Barcode.start() method and again after each decode. The device must be equipped with a sensor to detect movement to use presentation mode. MK31XX devices come with presentation mode pre-enabled in the scanner driver and the aimType cannot be modified for these devices.
String: pressAndRelease
Scan will continue after the trigger is released until scanTimeout occurs.
String: continuousRead
Once the trigger is pulled barcodes will continue to be scanned as long as the trigger is held, enabling rapid scanning, to be used in conjunction with sameSymbolTimeout and differentSymbolTimeout. This value is ignored if viewfinderMode is set to ‘dynamicReticle’
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.aimType
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.aimType - Ruby:
Rho::Barcode.aimType
- JavaScript:
When set to true, the barcode scanner will read all barcode types that the scanner is capable of reading. When set to false, the barcode scanner will not be able to decode any symbologies, this is most useful if you want to set the scanner to a default state before only enabling your required symbologies. The fewer symbologies that are enabled the faster the decoding performance of the scanning engine will be. This property will return true only if all supported symbologies by the scanner are enabled, if only a subset of supported symbologies are enabled then false will be returned. Note that some decoders will not be enabled as some symbologies use the same systems to encode data, making it impossible to differentiate between them. For example: “canpostal” and “auspostal” both use a 4-state system, so devices will only enable either “canpostal” OR “auspostal” when “alldecoders” is enabled. Note that other symbologies also share the 4-state system.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.allDecoders
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.allDecoders - Ruby:
Rho::Barcode.allDecoders
- JavaScript:
Enables or disables the symbology for Australian Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ausPostal
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ausPostal - Ruby:
Rho::Barcode.ausPostal
- JavaScript:
When true, automatically appends the character code for ‘enter’ to the end of any barcodes scanned. This is useful if you want to submit forms following a scan without further interaction. This property will only take effect if you have not specified a callback to the enable method. AutoEnter and AutoTab are mutually exclusive properties.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.autoEnter
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.autoEnter - Ruby:
Rho::Barcode.autoEnter
- JavaScript:
When true, automatically appends the tab character to the end of any barcodes scanned. This is useful if you are populating a form and want to jump to the next field in the form without further interaction. This property will only take effect if you have not specified a callback to the enable method. AutoTab and AutoEnter are mutually exclusive properties.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.autoTab
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.autoTab - Ruby:
Rho::Barcode.autoTab
- JavaScript:
Enables or disables the symbology for Aztec barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.aztec
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.aztec - Ruby:
Rho::Barcode.aztec
- JavaScript:
Specifies the format in which the barcode data is returned, binary data is returned in Data URI format with the appropriate mime type. This parameter is designed to be used primarily with image based symbologies (eg. Signature). Binary data will not be output as keystrokes, you must set a decode callback in order to receive scanned data.
(Camera / Imager Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: binary
Scanned data will be returned in Data URI format.
String: text
Scanned data will be returned in Text format.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.barcodeDataFormat
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.barcodeDataFormat - Ruby:
Rho::Barcode.barcodeDataFormat
- JavaScript:
Specifies the width of the laser beam. All devices will support normal beam widths but other widths may not be supported on your device.
(Laser Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: normal
Laser beam width is normal.
String: wide
Laser beam width is wide.
String: narrow
Laser beam width is narrow.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.beamWidth
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.beamWidth - Ruby:
Rho::Barcode.beamWidth
- JavaScript:
Enables or disables bidirectional redundancy.
(Laser Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.bidirectionalRedundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.bidirectionalRedundancy - Ruby:
Rho::Barcode.bidirectionalRedundancy
- JavaScript:
Enables or disables the symbology for Canadian Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.canPostal
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.canPostal - Ruby:
Rho::Barcode.canPostal
- JavaScript:
Enables or disables the symbology for Chinese 2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.chinese2of5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.chinese2of5 - Ruby:
Rho::Barcode.chinese2of5
- JavaScript:
Enables or disables the symbology for Codabar barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabar
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabar - Ruby:
Rho::Barcode.codabar
- JavaScript:
Enables Codabar CLSi formatting when set to true.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabarClsiEditing
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabarClsiEditing - Ruby:
Rho::Barcode.codabarClsiEditing
- JavaScript:
Specifies the maximum number of allowable characters in a Codabar barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabarMaxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabarMaxLength - Ruby:
Rho::Barcode.codabarMaxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Codabar barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabarMinLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabarMinLength - Ruby:
Rho::Barcode.codabarMinLength
- JavaScript:
Enables Codabar NotisEditing formatting when set to true.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabarNotisEditing
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabarNotisEditing - Ruby:
Rho::Barcode.codabarNotisEditing
- JavaScript:
Sets the Codabar Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.codabarRedundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.codabarRedundancy - Ruby:
Rho::Barcode.codabarRedundancy
- JavaScript:
Enables or disables the symbology for Code11 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11 - Ruby:
Rho::Barcode.code11
- JavaScript:
Specifies whether to verify 0, 1 or 2 check digits.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Scanning engine will verify no Code 11 check digits.
String: one
Scanning engine will verify one Code 11 check digit.
String: two
Scanning engine will verify two Code 11 check digits.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11checkDigitCount
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11checkDigitCount - Ruby:
Rho::Barcode.code11checkDigitCount
- JavaScript:
Specifies the maximum number of allowable characters in a Code 11 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11maxLength - Ruby:
Rho::Barcode.code11maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Code 11 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11minLength - Ruby:
Rho::Barcode.code11minLength
- JavaScript:
Sets the Code 11 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11redundancy - Ruby:
Rho::Barcode.code11redundancy
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned Code 11 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code11reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code11reportCheckDigit - Ruby:
Rho::Barcode.code11reportCheckDigit
- JavaScript:
Enables or disables the symbology for Code128 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128 - Ruby:
Rho::Barcode.code128
- JavaScript:
When true, decodes concatenated Code128 output only if the pair belongs to one of the commonly concatenated pairs as defined by the standard.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128checkIsBtTable
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128checkIsBtTable - Ruby:
Rho::Barcode.code128checkIsBtTable
- JavaScript:
When true, barcodes with the EAN128 subtype property set will be read.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128ean128
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128ean128 - Ruby:
Rho::Barcode.code128ean128
- JavaScript:
When true, barcodes with the isbt128 subtype property set will be read.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128isbt128
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128isbt128 - Ruby:
Rho::Barcode.code128isbt128
- JavaScript:
Sets the Code128 ISBT concatenation mode property. This feature allows a pair of barcodes which meet certain criteria defined in the ISBT128 spec to be reported as a single barcode. This parameter describes the different concatenation modes available for ISBT128.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: never
Will ignore the barcode pair and only output decode data for one of the barcodes.
String: always
Will not decode if both barcodes are not present or if one of them can not be decoded.
String: auto
Auto-Discriminate.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128isbt128ConcatMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128isbt128ConcatMode - Ruby:
Rho::Barcode.code128isbt128ConcatMode
- JavaScript:
Specifies the maximum number of allowable characters in a Code 128 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128maxLength - Ruby:
Rho::Barcode.code128maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Code 128 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128minLength - Ruby:
Rho::Barcode.code128minLength
- JavaScript:
Sets the other 128 property which enables the non EAN and non ISBT 128 subtype.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128other128
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128other128 - Ruby:
Rho::Barcode.code128other128
- JavaScript:
Sets the Code 128 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128redundancy - Ruby:
Rho::Barcode.code128redundancy
- JavaScript:
Sets the Code 128 security level and accepts a value between 0 and 3 inclusive. 0: Allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most ‘in-spec’ barcodes. 1: Eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code128securityLevel
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code128securityLevel - Ruby:
Rho::Barcode.code128securityLevel
- JavaScript:
Enables or disables the symbology for Code 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39 - Ruby:
Rho::Barcode.code39
- JavaScript:
Enables reporting of the Code32 prefix when a Code39 barcode is converted.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39code32Prefix
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39code32Prefix - Ruby:
Rho::Barcode.code39code32Prefix
- JavaScript:
Enables conversion from Code39 to Code 32 barcodes, when set the decoded barcode is converted to Code 32.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39convertToCode32
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39convertToCode32 - Ruby:
Rho::Barcode.code39convertToCode32
- JavaScript:
Enables full ASCII conversion of Code 39 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39fullAscii
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39fullAscii - Ruby:
Rho::Barcode.code39fullAscii
- JavaScript:
Specifies the maximum number of allowable characters in a Code 39 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39maxLength - Ruby:
Rho::Barcode.code39maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Code 39 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39minLength - Ruby:
Rho::Barcode.code39minLength
- JavaScript:
Sets the Code 39 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39redundancy - Ruby:
Rho::Barcode.code39redundancy
- JavaScript:
Enables reporting of the Code 39 check digit when a Code 39 barcode is scanned.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39reportCheckDigit - Ruby:
Rho::Barcode.code39reportCheckDigit
- JavaScript:
Sets the Code 128 security level and accepts a value between 0 and 3 inclusive. 0: This setting allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most ‘in-spec’ barcodes. 1: This setting eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39securityLevel
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39securityLevel - Ruby:
Rho::Barcode.code39securityLevel
- JavaScript:
Turns on verification of the Code 39 check digit.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code39verifyCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code39verifyCheckDigit - Ruby:
Rho::Barcode.code39verifyCheckDigit
- JavaScript:
Enables or disables the symbology for Code 93 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code93
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code93 - Ruby:
Rho::Barcode.code93
- JavaScript:
Specifies the maximum number of allowable characters in a Code 93 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code93maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code93maxLength - Ruby:
Rho::Barcode.code93maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Code 93 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code93minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code93minLength - Ruby:
Rho::Barcode.code93minLength
- JavaScript:
Sets the Code 93 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.code93redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.code93redundancy - Ruby:
Rho::Barcode.code93redundancy
- JavaScript:
Enables or disables the symbology for Composite AB barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.compositeAb
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.compositeAb - Ruby:
Rho::Barcode.compositeAb
- JavaScript:
Describes whether UCC link mode is enabled.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: never
Link flag is ignored.
String: always
Composite AB barcodes are always linked.
String: auto
Auto-discriminate whether Composite AB barcodes are linked.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.compositeAbUccLinkMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.compositeAbUccLinkMode - Ruby:
Rho::Barcode.compositeAbUccLinkMode
- JavaScript:
This setting causes the UPC rules specified in the UPC EAN parameters to be used when reporting composite decode data.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.compositeAbUseUpcPreambleCheckDigitRules
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.compositeAbUseUpcPreambleCheckDigitRules - Ruby:
Rho::Barcode.compositeAbUseUpcPreambleCheckDigitRules
- JavaScript:
Enables or disables the symbology for Composite C barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.compositeC
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.compositeC - Ruby:
Rho::Barcode.compositeC
- JavaScript:
Specifies the time, in seconds, that an external scanner will be allowed to remain idle before the connection is terminated to conserve power.
(Bluetooth Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.connectionIdleTimeout
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.connectionIdleTimeout - Ruby:
Rho::Barcode.connectionIdleTimeout
- JavaScript:
Enables or disables the symbology for D2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.d2of5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.d2of5 - Ruby:
Rho::Barcode.d2of5
- JavaScript:
Specifies the maximum number of allowable characters in a D2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.d2of5maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.d2of5maxLength - Ruby:
Rho::Barcode.d2of5maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a D2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.d2of5minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.d2of5minLength - Ruby:
Rho::Barcode.d2of5minLength
- JavaScript:
Sets the D2of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.d2of5redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.d2of5redundancy - Ruby:
Rho::Barcode.d2of5redundancy
- JavaScript:
Specifies the number of bytes allocated to receive the scanned barcode. This parameter is designed to be used primarily with image based symbologies and should not be modified unless absolutely necessary (eg. Signature).
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.dataBufferSize
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.dataBufferSize - Ruby:
Rho::Barcode.dataBufferSize
- JavaScript:
Enables or disables the symbology for Datamatrix barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.datamatrix
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.datamatrix - Ruby:
Rho::Barcode.datamatrix
- JavaScript:
Describes the type of Digital Bar Pulse (DBP) being produced by the scan engine.
(Laser Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: normal
Tells the scan engine to produce normal DBP.
String: composite
Tells the scan engine to produce composite DBP, which is 2 different sets of DBP data multiplexed together for better decode performance. In order to enable this mode it must be supported by the scanner.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.dbpMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.dbpMode - Ruby:
Rho::Barcode.dbpMode
- JavaScript:
The duration of the device beeper when a barcode is scanned, in milliseconds.
(Scanners on Symbol Technologies' devices)
Default: 250
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.decodeDuration
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.decodeDuration - Ruby:
Rho::Barcode.decodeDuration
- JavaScript:
The frequency of the device beeper when a barcode is successfully decoded. This should be within the range of the beeper but the API will accept values in the range 0 to 65535.
(Scanners on Symbol Technologies' devices)
Default: 3000
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.decodeFrequency
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.decodeFrequency - Ruby:
Rho::Barcode.decodeFrequency
- JavaScript:
Path to a local wave file to be played when the scanner successfully decodes a barcode. This setting overrides the scanner beeper. In Android, this settings will not override beeper and hence not supported.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.decodeSound
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.decodeSound - Ruby:
Rho::Barcode.decodeSound
- JavaScript:
The volume of the device beeper when a barcode is scanned. Volume specified using 0 to 5, with 5 being the loudest. The value of 0 is device dependent, some Windows Mobile / CE devices interpret this as the quietest volume; if you wish to completely disable the beeper on scan please set decodeSound to an empty or invalid sound file.
(Scanners on Symbol Technologies' devices)
Default: 5
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.decodeVolume
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.decodeVolume - Ruby:
Rho::Barcode.decodeVolume
- JavaScript:
When the aimType:continuousRead property is applied this value defines the interval between which different barcodes can be scanned. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this setting to allow time for the operator to re-aim the device between successive scans.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.differentSymbolTimeout
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.differentSymbolTimeout - Ruby:
Rho::Barcode.differentSymbolTimeout
- JavaScript:
By default if you have enabled the Scanner on a page, through either JavaScript or Ruby and navigate to a new page the Scanner will automatically disable. To override this behavior you can set this option to false and once enabled the Scanner will remain so in the foreground application until you disable it.
(Scanners on Symbol Technologies' devices)
Forces the scanner to disconnect from the terminal when it is ‘disabled’. Since the scanner is disabled when you navigate to a new page, set this value to false if you want to maintain the bluetooth connection to your remote scanner.
(Bluetooth Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.disconnectBtOnDisable
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.disconnectBtOnDisable - Ruby:
Rho::Barcode.disconnectBtOnDisable
- JavaScript:
If set to true the bluetooth address will be displayed as a barcode on the screen during the pairing process, initiated by calling ‘enable’ on a bluetooth scanner. Not all devices support this functionality. Note you must specify this parameter before or within the call to ‘enable’.
(Bluetooth Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.displayBtAddressBarcodeOnEnable
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.displayBtAddressBarcodeOnEnable - Ruby:
Rho::Barcode.displayBtAddressBarcodeOnEnable
- JavaScript:
Allows Direct Part Marking (DPM) barcodes to be read When true, but may adversely affect overall decoding performance. DPM is a way of stamping barcodes directly on physical objects and is only available on DPM terminals.
(Imager / Camera Scanners on Symbol Technologies' devices. The scanning engine must support DPM barcodes.)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.dpmMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.dpmMode - Ruby:
Rho::Barcode.dpmMode
- JavaScript:
Enables or disables the symbology for Dutch Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.dutchPostal
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.dutchPostal - Ruby:
Rho::Barcode.dutchPostal
- JavaScript:
Enables or disables the symbology for EAN 13 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ean13
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ean13 - Ruby:
Rho::Barcode.ean13
- JavaScript:
Enables or disables the symbology for EAN 8 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ean8
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ean8 - Ruby:
Rho::Barcode.ean8
- JavaScript:
When true, EAN 8 barcodes will be converted to EAN 13 and EAN 13 parameters used.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ean8convertToEan13
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ean8convertToEan13 - Ruby:
Rho::Barcode.ean8convertToEan13
- JavaScript:
Configures the time (in seconds) allowed to pair with the external bluetooth scanner after calling the ‘enable()’ method. You must specify this parameter before calling ‘enable’ to change the default.
(Bluetooth Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.enableTimeout
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.enableTimeout - Ruby:
Rho::Barcode.enableTimeout
- JavaScript:
Sets the focus mode in use.
(Imager / Camera Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: fixed
Use fixed focus.
String: auto
Use auto focus.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.focusMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.focusMode - Ruby:
Rho::Barcode.focusMode
- JavaScript:
Returns the friendly name associated with the scanner.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.friendlyName
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.friendlyName - Ruby:
Rho::Barcode.friendlyName
- JavaScript:
Enables or disables the symbology for GS1 DataBar barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rss.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.gs1dataBar
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.gs1dataBar - Ruby:
Rho::Barcode.gs1dataBar
- JavaScript:
Enables or disables the symbology for GS1 Databar Expanded barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rssExp.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.gs1dataBarExpanded
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.gs1dataBarExpanded - Ruby:
Rho::Barcode.gs1dataBarExpanded
- JavaScript:
Enables or disables the symbology for GS1 Databar Limited barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rssLim.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.gs1dataBarLimited
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.gs1dataBarLimited - Ruby:
Rho::Barcode.gs1dataBarLimited
- JavaScript:
Controls the haptic feedback on decode. This means that if this is set to true, then the device will vibrate when a decode occurs.
(Scanners on Symbol Technologies' devices)
Default: true
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.hapticFeedback
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.hapticFeedback - Ruby:
Rho::Barcode.hapticFeedback
- JavaScript:
Enables or disables the symbology for I2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5 - Ruby:
Rho::Barcode.i2of5
- JavaScript:
When true, EAN 8 barcodes will be converted to EAN 13 and EAN 13 parameters used.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5convertToEan13
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5convertToEan13 - Ruby:
Rho::Barcode.i2of5convertToEan13
- JavaScript:
Specifies the maximum number of allowable characters in a I2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5maxLength - Ruby:
Rho::Barcode.i2of5maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a I2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5minLength - Ruby:
Rho::Barcode.i2of5minLength
- JavaScript:
Sets the I2of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5redundancy - Ruby:
Rho::Barcode.i2of5redundancy
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned I2of5 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5reportCheckDigit - Ruby:
Rho::Barcode.i2of5reportCheckDigit
- JavaScript:
Enables the verification of the I2of5 check digit.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Disables verification of the check digit.
String: uss
Enables the USS format for the check digit.
String: opcc
Enables the OPCC format for the check digit.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.i2of5verifyCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.i2of5verifyCheckDigit - Ruby:
Rho::Barcode.i2of5verifyCheckDigit
- JavaScript:
Selects the illumination mode to use. Not currently supported on Android (illumination is always on).
(Imager / Camera Scanners on Symbol Technologies devices)
Possible Values (STRING):
String: auto
Auto-exposure algorithms will decide whether illumination is required. Not currently supported on Android.
String: alwaysOn
External illumination is always on.
String: alwaysOff
External illumination is always off.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.illuminationMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.illuminationMode - Ruby:
Rho::Barcode.illuminationMode
- JavaScript:
The frequency of the device beeper when a barcode is scanned but not successfully decoded. This should be within the range of the beeper but the API will accept values in the range 0 to 65535.
(Scanners on Symbol Technologies' devices)
Default: 2500
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.invalidDecodeFrequency
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.invalidDecodeFrequency - Ruby:
Rho::Barcode.invalidDecodeFrequency
- JavaScript:
Path to a local wave file to be played when a barcode is scanned but not successfully decoded. This setting overrides the scanner beeper.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.invalidDecodeSound
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.invalidDecodeSound - Ruby:
Rho::Barcode.invalidDecodeSound
- JavaScript:
Allows the user to select inverse 1D barcodes for decoding.
(Scanners on Symbol Technologies' devices. The scanning engine must support inverse barcodes)
Possible Values (STRING):
String: enabled
Inverse 1D symbology decoding is enabled.
String: disabled
Inverse 1D symbology decoding is disabled.
String: auto
Allows decoding of both positive and inverse 1D symbologies.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.inverse1dMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.inverse1dMode - Ruby:
Rho::Barcode.inverse1dMode
- JavaScript:
Enables or disables the symbology for Japanese Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.japPostal
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.japPostal - Ruby:
Rho::Barcode.japPostal
- JavaScript:
Enables or disables the Klasse Eins laser on time function.
(Laser Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.klasseEins
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.klasseEins - Ruby:
Rho::Barcode.klasseEins
- JavaScript:
Enables or disables the symbology for Korean 3of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.korean3of5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.korean3of5 - Ruby:
Rho::Barcode.korean3of5
- JavaScript:
Specifies the maximum number of allowable characters in a Korean 3of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.korean3of5maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.korean3of5maxLength - Ruby:
Rho::Barcode.korean3of5maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Korean 3of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.korean3of5minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.korean3of5minLength - Ruby:
Rho::Barcode.korean3of5minLength
- JavaScript:
Sets Korean 3of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.korean3of5redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.korean3of5redundancy - Ruby:
Rho::Barcode.korean3of5redundancy
- JavaScript:
Controls whether LCD Mode is enabled on the scanner. LCD Mode makes it easier to scan barcodes off of LCD screens (like mobile device screens)
(Scanners on Symbol Technologies' devices)
Default: false
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.lcdMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.lcdMode - Ruby:
Rho::Barcode.lcdMode
- JavaScript:
Describes the linear security level used during decoding. This determines the number of times a barcode must be read before it is decoded. If the successive reads of the barcode do not match, it will not be decoded.
(Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: redundancyAndLength
Double redundancy based on redundancy flags and code length. Only applicable to laser scanners, not BlockBuster imager scanners. Not supported on Android with EMDK version 3.1 and above.
String: shortOrCodabar
Double redundancy if short barcode or Codabar.
String: longAndShort
Double redundancy for long barcodes, triple for short barcodes.
String: allTwice
Double redundancy for all barcodes.
String: allThrice
Triple redundancy for all barcodes.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.linearSecurityLevel
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.linearSecurityLevel - Ruby:
Rho::Barcode.linearSecurityLevel
- JavaScript:
Set to false to disable scanning when the battery is low / critical or set to true to enable it.
(Scanners on Symbol Technologies' devices)
Default: false
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.lowBatteryScan
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.lowBatteryScan - Ruby:
Rho::Barcode.lowBatteryScan
- JavaScript:
Enables or disables the symbology for MacroMicroPDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroMicroPdf
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroMicroPdf - Ruby:
Rho::Barcode.macroMicroPdf
- JavaScript:
If true, the scanner driver will return the barcode data only after the complete macroMicroPdf sequence has been read. If false, the scanner driver will return each barcode in the macroMicroPdf sequence as it is read.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroMicroPdfBufferLabels
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroMicroPdfBufferLabels - Ruby:
Rho::Barcode.macroMicroPdfBufferLabels
- JavaScript:
If true, MacroMicroPDF barcodes will be converted to MicroPDF codes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroMicroPdfConvertToMicroPdf
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroMicroPdfConvertToMicroPdf - Ruby:
Rho::Barcode.macroMicroPdfConvertToMicroPdf
- JavaScript:
If true, the scanner driver will not complete read requests while in the middle of a macroMicroPdf sequence. Once a macroMicroPdf sequence has been started it must be completed or canceled before the scan driver will complete other read requests.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroMicroPdfExclusive
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroMicroPdfExclusive - Ruby:
Rho::Barcode.macroMicroPdfExclusive
- JavaScript:
If true, the appended info is concatenated to the decoded data before being returned.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroMicroPdfReportAppendInfo
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroMicroPdfReportAppendInfo - Ruby:
Rho::Barcode.macroMicroPdfReportAppendInfo
- JavaScript:
Enables or disables the symbology for Macro PDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroPdf
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroPdf - Ruby:
Rho::Barcode.macroPdf
- JavaScript:
When true, the scanner driver will return he barcode data only after the complete macroPdf sequence has been read. If false, the scan driver will return each barcode in the macroPdf sequence as it is read.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroPdfBufferLabels
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroPdfBufferLabels - Ruby:
Rho::Barcode.macroPdfBufferLabels
- JavaScript:
If true, MacroPDF barcodes will be converted to PDF417 codes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroPdfConvertToPdf417
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroPdfConvertToPdf417 - Ruby:
Rho::Barcode.macroPdfConvertToPdf417
- JavaScript:
If true, the scanner driver will not complete read requests while in the middle of a macroPdf sequence. Once a macroPdf sequence has been started it must be completed or canceled before the scan driver will complete other read requests.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.macroPdfExclusive
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.macroPdfExclusive - Ruby:
Rho::Barcode.macroPdfExclusive
- JavaScript:
Enables or disables the symbology for Matrix 2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.matrix2of5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.matrix2of5 - Ruby:
Rho::Barcode.matrix2of5
- JavaScript:
Specifies the maximum number of allowable characters in a Matrix 2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.matrix2of5maxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.matrix2of5maxLength - Ruby:
Rho::Barcode.matrix2of5maxLength
- JavaScript:
Specifies the minimum number of allowable characters in a Matrix 2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.matrix2of5minLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.matrix2of5minLength - Ruby:
Rho::Barcode.matrix2of5minLength
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned Matrix 2of5 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.matrix2of5reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.matrix2of5reportCheckDigit - Ruby:
Rho::Barcode.matrix2of5reportCheckDigit
- JavaScript:
Enables verification of the Matrix 2of5 symbology check digit.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.matrix2of5verifyCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.matrix2of5verifyCheckDigit - Ruby:
Rho::Barcode.matrix2of5verifyCheckDigit
- JavaScript:
Enables or disables the symbology for Maxicode barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.maxiCode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.maxiCode - Ruby:
Rho::Barcode.maxiCode
- JavaScript:
Enables or disables the symbology for Micro PDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.microPdf
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.microPdf - Ruby:
Rho::Barcode.microPdf
- JavaScript:
Enables or disables the symbology for Micro QR barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.microQr
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.microQr - Ruby:
Rho::Barcode.microQr
- JavaScript:
Enables or disables the symbology for MSI barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msi
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msi - Ruby:
Rho::Barcode.msi
- JavaScript:
Specifies the check digit scheme used to verify MSI barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: mod11
The first check digit is MOD 11, the second is MOD 10.
String: mod10
Both check digits are MOD 10.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiCheckDigitScheme
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiCheckDigitScheme - Ruby:
Rho::Barcode.msiCheckDigitScheme
- JavaScript:
Sets the number of MSI check digits to use.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: one
Use one check digit for MSI barcodes.
String: two
Use two check digits for MSI barcodes.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiCheckDigits
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiCheckDigits - Ruby:
Rho::Barcode.msiCheckDigits
- JavaScript:
Specifies the maximum number of allowable characters in a MSI barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiMaxLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiMaxLength - Ruby:
Rho::Barcode.msiMaxLength
- JavaScript:
Specifies the minimum number of allowable characters in a MSI barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiMinLength
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiMinLength - Ruby:
Rho::Barcode.msiMinLength
- JavaScript:
Sets the MSI Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiRedundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiRedundancy - Ruby:
Rho::Barcode.msiRedundancy
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned MSI barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.msiReportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.msiReportCheckDigit - Ruby:
Rho::Barcode.msiReportCheckDigit
- JavaScript:
Enables or disables the symbology for PDF 417 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.pdf417
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.pdf417 - Ruby:
Rho::Barcode.pdf417
- JavaScript:
Allows the imager to decode only the barcode that is directly under the cross-hair / center of the reticle. This feature is most useful in applications where multiple barcodes may appear in the field of view during a decode session and only one of them is targeted for decode. When enabled picklistMode will override aimMode or, if no aiming is chosen, and use aimMode:reticle. This mode will also interact with viewfinderMode, see the EMDK for C help file for more information. Enabling picklist mode may adversely affect overall decoding performance.
(Imager / Camera Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: disabled
Disables picklist mode so any barcode within the field of view can be decoded.
String: hardwareReticle
Enables picklist mode so that only the barcode under the projected reticle can be decoded. On Windows, if the imager does not support a projected reticle then the behavior is the same as softwareReticle. On Android, this is only supported for Imager (non-viewfinder) based scanners.
String: softwareReticle
Enables picklist mode so that only the barcode in the center of the image is decoded. This is most useful when used in conjunction with static and dynamic reticle viewfinder modes. This value is not supported on Android Platform.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.picklistMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.picklistMode - Ruby:
Rho::Barcode.picklistMode
- JavaScript:
Allows poor quality 1D barcodes to be read When true, but this will adversely affect the overall decoding performance.
(Imager / Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.poorQuality1dMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.poorQuality1dMode - Ruby:
Rho::Barcode.poorQuality1dMode
- JavaScript:
Enables or disables the symbology for QR Code barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.qrCode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.qrCode - Ruby:
Rho::Barcode.qrCode
- JavaScript:
Vertical rastering height to use, as a percentage, when rasterMode:openAlways is applied. This value must be between 0 and 100.
(Laser Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rasterHeight
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rasterHeight - Ruby:
Rho::Barcode.rasterHeight
- JavaScript:
Describes the type of vertical rastering to use.
(Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: none
No vertical rastering.
String: openAlways
Vertical rastering is always full open. To adjust the rastering height use the rasterHeight property.
String: smart
Vertical rastering mode is ‘Smart’.
String: cyclone
Vertical rastering mode is ‘Cyclone’.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rasterMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rasterMode - Ruby:
Rho::Barcode.rasterMode
- JavaScript:
The remaining capacity of the battery, in the range 0 to 100. ‘unknown’ will be returned if the capacity could not be determined, for example if the scanner had no battery.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBatteryCapacity
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBatteryCapacity - Ruby:
Rho::Barcode.rsmBatteryCapacity
- JavaScript:
One of ‘simple’, ‘double’, ‘disabled’ or ‘unknown’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBatteryId
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBatteryId - Ruby:
Rho::Barcode.rsmBatteryId
- JavaScript:
Indicates the status of the remote scanner’s battery, will be one of ‘unknown’, ‘full’, ‘medium’, ‘empty’, ‘chargingFullRate’, ‘chargingHalfRate’, ‘chargingTrickle’ or ‘discharging’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBatteryStatus
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBatteryStatus - Ruby:
Rho::Barcode.rsmBatteryStatus
- JavaScript:
Bluetooth address as FF:FF:FF:FF:FF:FF where FF is a hex number.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothAddress
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothAddress - Ruby:
Rho::Barcode.rsmBluetoothAddress
- JavaScript:
True if authentication is required.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothAuthentication
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothAuthentication - Ruby:
Rho::Barcode.rsmBluetoothAuthentication
- JavaScript:
Bluetooth reconnection scheme.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Possible Values (STRING):
String: none
No scheme.
String: onPower
When powered on.
String: onOutOfRange
When device goes out of range.
String: onPowerOutOfRange
When powered on or when the device goes out of range.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothAutoReconnect
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothAutoReconnect - Ruby:
Rho::Barcode.rsmBluetoothAutoReconnect
- JavaScript:
When true, scanner will emit 5 beeps every 5 seconds whilst re-connection in progress.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothBeepOnReconnectAttempt
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothBeepOnReconnectAttempt - Ruby:
Rho::Barcode.rsmBluetoothBeepOnReconnectAttempt
- JavaScript:
True if encryption is required.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothEncryption
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothEncryption - Ruby:
Rho::Barcode.rsmBluetoothEncryption
- JavaScript:
Friendly Bluetooth name, e.g. ‘MyBTScanner’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothFriendlyName
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothFriendlyName - Ruby:
Rho::Barcode.rsmBluetoothFriendlyName
- JavaScript:
‘neverReconnect’, ‘reconnectOnData’ or ‘reconnectImmediately’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothHidAutoReconnect
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothHidAutoReconnect - Ruby:
Rho::Barcode.rsmBluetoothHidAutoReconnect
- JavaScript:
To use a general inquiry mode, ‘general’ else, ‘limited’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothInquiryMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothInquiryMode - Ruby:
Rho::Barcode.rsmBluetoothInquiryMode
- JavaScript:
Up to 5 character PIN code used for Bluetooth authentication.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothPinCode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothPinCode - Ruby:
Rho::Barcode.rsmBluetoothPinCode
- JavaScript:
‘UseStored’ will use the PIN code stored in the memory of the ring scanner, by default ‘12345’. ‘PromptUser’ indicates that the ring scanner should be used to scan 5 alpha numeric barcodes to define the PIN, eg. “1”, “2”, “3”, “4”, “5” (for PIN 12345). This parameter is not saved permanently on the ring scanner.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothPinCodeType
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothPinCodeType - Ruby:
Rho::Barcode.rsmBluetoothPinCodeType
- JavaScript:
How long the scanner tries to re-establish connection if it goes out of range, in seconds. This value must be a multiple of 5 and in the range 30 to 60 seconds.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmBluetoothReconnectionAttempts
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmBluetoothReconnectionAttempts - Ruby:
Rho::Barcode.rsmBluetoothReconnectionAttempts
- JavaScript:
Ring scanner date of manufacture as DDMMYY.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmDateOfManufacture
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmDateOfManufacture - Ruby:
Rho::Barcode.rsmDateOfManufacture
- JavaScript:
Ring scanner date of service as DDMMYY.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmDateOfService
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmDateOfService - Ruby:
Rho::Barcode.rsmDateOfService
- JavaScript:
If true, the remote scanner beeps and illuminates its green LED on a successful decode.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmDecodeFeedback
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmDecodeFeedback - Ruby:
Rho::Barcode.rsmDecodeFeedback
- JavaScript:
The device class of the ring scanner.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmDeviceClass
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmDeviceClass - Ruby:
Rho::Barcode.rsmDeviceClass
- JavaScript:
Scanner’s operating system version.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmFirmwareVersion
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmFirmwareVersion - Ruby:
Rho::Barcode.rsmFirmwareVersion
- JavaScript:
Force saving the barcode assigned to the device to which the scanner has been paired.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmForceSavePairingBarcode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmForceSavePairingBarcode - Ruby:
Rho::Barcode.rsmForceSavePairingBarcode
- JavaScript:
Delay between good scans in proximity continuous mode, measured in milliseconds. Range 0 to 15000. This value must be a multiple of 100.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmGoodScansDelay
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmGoodScansDelay - Ruby:
Rho::Barcode.rsmGoodScansDelay
- JavaScript:
Feature for ignoring Code 128 barcodes beginning with 420 and 421.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmIgnoreCode128Usps
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmIgnoreCode128Usps - Ruby:
Rho::Barcode.rsmIgnoreCode128Usps
- JavaScript:
Whether or not the ring scanner should give a low battery indication.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmLowBatteryIndication
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmLowBatteryIndication - Ruby:
Rho::Barcode.rsmLowBatteryIndication
- JavaScript:
Low battery indication cycle time, in seconds. Must be one of 15, 30, 60, 90 or 120.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmLowBatteryIndicationCycle
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmLowBatteryIndicationCycle - Ruby:
Rho::Barcode.rsmLowBatteryIndicationCycle
- JavaScript:
If you press the trigger on an RSM scanner, proximity enabled will be turned off, even though it still reports its self as being turned on if you query the property. In order to use ProximityEnable you need to also have Mems enabled, this is the motion sensor and if you disable Mems the scanner will not function.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmMems
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmMems - Ruby:
Rho::Barcode.rsmMems
- JavaScript:
Ring scanner model number.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmModelNumber
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmModelNumber - Ruby:
Rho::Barcode.rsmModelNumber
- JavaScript:
Range 0 to 15 to specify the pattern for the paging beep sequence.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmPagingBeepSequence
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmPagingBeepSequence - Ruby:
Rho::Barcode.rsmPagingBeepSequence
- JavaScript:
Specify whether paging the device is enabled.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmPagingEnable
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmPagingEnable - Ruby:
Rho::Barcode.rsmPagingEnable
- JavaScript:
Proximity continuous mode.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmProximityContinuous
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmProximityContinuous - Ruby:
Rho::Barcode.rsmProximityContinuous
- JavaScript:
Specify the distance for the proximity feature as ‘short’, ‘medium’ or ‘long’
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmProximityDistance
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmProximityDistance - Ruby:
Rho::Barcode.rsmProximityDistance
- JavaScript:
If you press the trigger on an RSM scanner, proximity enabled will be turned off, even though it still reports its self as being turned on if you query the property. In order to use ProximityEnable you need to also have Mems enabled, this is the motion sensor and if you disable Mems the scanner will not function.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmProximityEnable
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmProximityEnable - Ruby:
Rho::Barcode.rsmProximityEnable
- JavaScript:
The laser scan line width, ‘wide’ or ‘narrow’.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmScanLineWidth
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmScanLineWidth - Ruby:
Rho::Barcode.rsmScanLineWidth
- JavaScript:
Scanner trigger will wakeup the device from a low power state.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmScanTriggerWakeup
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmScanTriggerWakeup - Ruby:
Rho::Barcode.rsmScanTriggerWakeup
- JavaScript:
Ring scanner serial number.
(Symbol Technologies' Bluetooth barcode scanners, model RS507)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.rsmSerialNumber
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.rsmSerialNumber - Ruby:
Rho::Barcode.rsmSerialNumber
- JavaScript:
When the aimType:continuousRead property is applied this value defines the interval between which the same barcode can be decoded twice. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this value to prevent accidental duplicate scans.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.sameSymbolTimeout
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.sameSymbolTimeout - Ruby:
Rho::Barcode.sameSymbolTimeout
- JavaScript:
Maximum time in milliseconds that laser scanners will emit a beam or imager scanners will enable the imager. A value of 0 indicates an infinite timeout. This parameter is compatible with aimType:trigger, aimType:timedHold, aimType:timedRelease and aimType:pressAndRelease. Note that for regulatory reasons scanTimeout is not configurable on all laser / imager scanners. Scan timeout is extent to hardware capabilities and limitations.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.scanTimeout
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.scanTimeout - Ruby:
Rho::Barcode.scanTimeout
- JavaScript:
The type of scanner in use, will be one of ‘Camera’, ‘Imager’ or ‘Laser’. Camera scanners capture and process an image taken via the devices camera. Imager scanners rely on capturing and processing an image of the barcode via dedicated scanning hardware. Both camera and imager scanners are capable of decoding 1D and 2D barcodes. Laser scanners are only capable of decoding 1D barcodes and rely on a sweeping laser.
(All Scanners)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.scannerType
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.scannerType - Ruby:
Rho::Barcode.scannerType
- JavaScript:
Enables or disables the symbology for Signature barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.signature
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.signature - Ruby:
Rho::Barcode.signature
- JavaScript:
Specifies the output height of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a number greater than or equal to 20.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.signatureImageHeight
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.signatureImageHeight - Ruby:
Rho::Barcode.signatureImageHeight
- JavaScript:
Specifies the output quality of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a value between 10 and 100 inclusive.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.signatureImageQuality
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.signatureImageQuality - Ruby:
Rho::Barcode.signatureImageQuality
- JavaScript:
Specifies the output width of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a number greater than or equal to 20.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.signatureImageWidth
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.signatureImageWidth - Ruby:
Rho::Barcode.signatureImageWidth
- JavaScript:
Aim duration in milliseconds for aimType:timedHold and aimType:timedRelease.
(Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.timedAimDuration
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.timedAimDuration - Ruby:
Rho::Barcode.timedAimDuration
- JavaScript:
Enables or disables the symbology for TLC 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.tlc39
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.tlc39 - Ruby:
Rho::Barcode.tlc39
- JavaScript:
Only applies to an enabled laser or imaging scanner. Disconnecting the trigger will prevent the scan beam from being emitted, this can temporarily prevent a user from scanning without having to disable the scanner, which can take longer. By default the trigger will be connected when the scanner is first enabled, you do not have to connect it separately. Please note that disconnecting the trigger will also prevent the start method from emitting a laser. This property will only affect the scanner and will have no effect on the ‘captureTrigger’ API.
(Scanners on Symbol Technologies' devices)
Default: true
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.triggerConnected
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.triggerConnected - Ruby:
Rho::Barcode.triggerConnected
- JavaScript:
Enables or disables the symbology for Trioptic 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.trioptic39
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.trioptic39 - Ruby:
Rho::Barcode.trioptic39
- JavaScript:
Sets the Trioptic 39 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.trioptic39Redundancy
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.trioptic39Redundancy - Ruby:
Rho::Barcode.trioptic39Redundancy
- JavaScript:
Enables or disables the symbology for UK Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ukPostal
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ukPostal - Ruby:
Rho::Barcode.ukPostal
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned UK Postal barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.ukPostalReportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.ukPostalReportCheckDigit - Ruby:
Rho::Barcode.ukPostalReportCheckDigit
- JavaScript:
Enables or disables decoding of UPC EAN Bookland barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanBookland
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanBookland - Ruby:
Rho::Barcode.upcEanBookland
- JavaScript:
Specifies the bookland format to use when decoding UPC EAN Bookland barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: isbn10
Causes 978 bookland barcodes to be reported in 10 digit mode.
String: isbn13
Causes 978/979 bookland barcodes to be transmitted as EAN13 as per 2007 ISBN-13 protocol.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanBooklandFormat
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanBooklandFormat - Ruby:
Rho::Barcode.upcEanBooklandFormat
- JavaScript:
If true, RSS barcodes will be converted to UPC/EAN format. For this setting to work UPC/EAN symbologies must be enabled.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanConvertGs1dataBarToUpcEan
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanConvertGs1dataBarToUpcEan - Ruby:
Rho::Barcode.upcEanConvertGs1dataBarToUpcEan
- JavaScript:
Enables or disables decoding of UPC EAN Coupon barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanCoupon
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanCoupon - Ruby:
Rho::Barcode.upcEanCoupon
- JavaScript:
Sets the linear decode property.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanLinearDecode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanLinearDecode - Ruby:
Rho::Barcode.upcEanLinearDecode
- JavaScript:
When true, enables random weight check digit verification.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanRandomWeightCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanRandomWeightCheckDigit - Ruby:
Rho::Barcode.upcEanRandomWeightCheckDigit
- JavaScript:
Sets the retry count for auto-discriminating for supplementals. The value must be between 2 - 20 inclusive.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanRetryCount
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanRetryCount - Ruby:
Rho::Barcode.upcEanRetryCount
- JavaScript:
Sets the Security level for decoding UPC EAN barcodes and accepts a value between 0 and 3 inclusive. 0: This setting allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most ‘in-spec’ barcodes. 1: This setting eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanSecurityLevel
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanSecurityLevel - Ruby:
Rho::Barcode.upcEanSecurityLevel
- JavaScript:
When true, enables the supplemental barcode decoding. Note you must have upcEanSupplementalMode:always set for this parameter to take effect.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanSupplemental2
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanSupplemental2 - Ruby:
Rho::Barcode.upcEanSupplemental2
- JavaScript:
When true, enables the supplemental barcode decoding. Note you must have upcEanSupplementalMode:always set for this parameter to take effect.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanSupplemental5
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanSupplemental5 - Ruby:
Rho::Barcode.upcEanSupplemental5
- JavaScript:
Describes the UPC EAN Supplemental mode.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Supplementals are ignored.
String: auto
Auto-discriminates supplementals.
String: always
Will not decode upc/ean without supplementals.
String: smart
The decoder will return the decoded value of the main block right away if it does not belong to any of the supplemental types. If the barcode starts with one of the prefixes it will search the image more aggressively for a supplemental. The scanner will try to scan the supplemental if it is present but if that fails, the main barcode will be returned.
String: 378or379
Auto-discriminates supplemental for upc/ean codes starting with 378 or 379. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.
String: 978or979
Auto-discriminates supplemental for upc/ean codes starting with 978 or 979. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.
String: 414or419or434or439
Auto-discriminates supplemental for upc/ean codes starting with 414 or 419 or 434 or 439. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcEanSupplementalMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcEanSupplementalMode - Ruby:
Rho::Barcode.upcEanSupplementalMode
- JavaScript:
Enables or disables the symbology for UPCA barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upca
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upca - Ruby:
Rho::Barcode.upca
- JavaScript:
Controls the preamble applied to the UPCA barcode.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Applies no preamble to the bar code.
String: systemChar
Applies system character preamble to the bar code.
String: countryAndSystemChars
Applies both system and country code preamble to the bar code.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcaPreamble
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcaPreamble - Ruby:
Rho::Barcode.upcaPreamble
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned UPCA barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upcaReportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upcaReportCheckDigit - Ruby:
Rho::Barcode.upcaReportCheckDigit
- JavaScript:
Enables or disables the symbology for UPCE0 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce0
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce0 - Ruby:
Rho::Barcode.upce0
- JavaScript:
When true, scanned UPCE0 barcodes will be converted to UPCA and UPCA parameters used.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce0convertToUpca
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce0convertToUpca - Ruby:
Rho::Barcode.upce0convertToUpca
- JavaScript:
Controls the preamble applied to the UPCE0 barcode.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Applies no preamble to the bar code.
String: systemChar
Applies system character preamble to the bar code.
String: countryAndSystemChars
Applies both system and country code preamble to the bar code.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce0preamble
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce0preamble - Ruby:
Rho::Barcode.upce0preamble
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned UPCE0 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce0reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce0reportCheckDigit - Ruby:
Rho::Barcode.upce0reportCheckDigit
- JavaScript:
Enables or disables the symbology for UPCE1 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce1
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce1 - Ruby:
Rho::Barcode.upce1
- JavaScript:
When true, scanned UPCE1 barcodes will be converted to UPCA and UPCA parameters used.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce1convertToUpca
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce1convertToUpca - Ruby:
Rho::Barcode.upce1convertToUpca
- JavaScript:
Controls the preamble applied to the UPCE1 barcode.
(Not all scanning engines support all symbologies or all symbology properties)
Possible Values (STRING):
String: none
Applies no preamble to the bar code.
String: systemChar
Applies system character preamble to the bar code.
String: countryAndSystemChars
Applies both system and country code preamble to the bar code.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce1preamble
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce1preamble - Ruby:
Rho::Barcode.upce1preamble
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned UPCE1 barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.upce1reportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.upce1reportCheckDigit - Ruby:
Rho::Barcode.upce1reportCheckDigit
- JavaScript:
Enables or disables the symbology for US 4-State barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.us4state
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.us4state - Ruby:
Rho::Barcode.us4state
- JavaScript:
Enables or disables the symbology for US 4-State FICS barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.us4stateFics
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.us4stateFics - Ruby:
Rho::Barcode.us4stateFics
- JavaScript:
Enables or disables the symbology for US Planet barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.usPlanet
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.usPlanet - Ruby:
Rho::Barcode.usPlanet
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned US Planet barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.usPlanetReportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.usPlanetReportCheckDigit - Ruby:
Rho::Barcode.usPlanetReportCheckDigit
- JavaScript:
Enables or disables the symbology for US Post Net barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.usPostNet
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.usPostNet - Ruby:
Rho::Barcode.usPostNet
- JavaScript:
When true, the barcode check digit(s) will be reported for scanned US Post Net barcodes.
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.usPostNetReportCheckDigit
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.usPostNetReportCheckDigit - Ruby:
Rho::Barcode.usPostNetReportCheckDigit
- JavaScript:
Configures the feedback given after a successful scan. This value is ignored if aimType is set to continuousRead and no feedback will be given. Not supported on Android with EMDK version 3.1 and above.
(Camera Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: enabled
The last image that was successfully decoded is displayed. The time for which the image is displayed can be configured by the viewfinderFeedbackTime parameter.
String: disabled
No feedback is given in the viewfinder after a successful decode.
String: reticle
The last image that was successfully decoded is displayed along with a red reticle in the center of the image. The time for which the image is displayed can be configured by the viewfinderFeedbackTime parameter.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderFeedback
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderFeedback - Ruby:
Rho::Barcode.viewfinderFeedback
- JavaScript:
If the viewfinderFeedback:enabled or viewfinderFeedback:reticle are applied then the decoded barcode will remain on the screen for this duration, specified in milliseconds. Not supported on Android with EMDK version 3.1 and above.
(Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderFeedbackTime
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderFeedbackTime - Ruby:
Rho::Barcode.viewfinderFeedbackTime
- JavaScript:
When scanning a barcode using a Camera scanner the viewfinder preview window will be this number of pixels in height. The images displayed in the viewfinder will be scaled as appropriate.
(Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderHeight
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderHeight - Ruby:
Rho::Barcode.viewfinderHeight
- JavaScript:
Configures the mode of the scanner viewfinder window. This attribute is not supported on all Scanners and will interact with the picklistMode parameter, see the EMDK for C help file for more information.
(Camera Scanners on Symbol Technologies' devices)
Possible Values (STRING):
String: enabled
Only the viewfinder is enabled (not the reticle). Displays a viewfinder on the screen showing the image being captured by the camera.
String: disabled
The viewfinder will not be displayed during aiming or scanning.
String: staticReticle
Displays the viewfinder as well as draws a red reticle in the center of the image which helps with tracking the barcode.
String: dynamicReticle
Displays the viewfinder as well as draws a red reticle in the center of the image. If the barcode in the image is ‘decodable’ the reticle turns green to indicate this. This mode requires a second trigger press to decode the barcode after the reticle turns green. Not supported on Android.
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderMode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderMode - Ruby:
Rho::Barcode.viewfinderMode
- JavaScript:
When scanning a barcode using a Camera scanner the viewfinder preview window will be this number of pixels wide. The images displayed in the viewfinder will be scaled as appropriate.
(Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderWidth
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderWidth - Ruby:
Rho::Barcode.viewfinderWidth
- JavaScript:
When scanning a barcode using a Camera scanner the viewfinder preview window will appear this number of pixels from the left hand side of the screen. The images displayed in the viewfinder will be scaled as appropriate.
(Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderX
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderX - Ruby:
Rho::Barcode.viewfinderX
- JavaScript:
When scanning a barcode using a Camera scanner the viewfinder preview window will appear this number of pixels from the top of the screen. The images displayed in the viewfinder will be scaled as appropriate.
(Camera Scanners on Symbol Technologies' devices)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.viewfinderY
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.viewfinderY - Ruby:
Rho::Barcode.viewfinderY
- JavaScript:
Enables or disables the symbology for Webcode barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. Deprecated in Android 4.1 (Jelly Bean).
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.webcode
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.webcode - Ruby:
Rho::Barcode.webcode
- JavaScript:
If true, the GT Webcode subtype will be decoded. Deprecated in Android 4.1 (Jelly Bean).
(Not all scanning engines support all symbologies or all symbology properties)
Property Access:
-
Instance: This property can be accessed via an instance object of this class:
myObject.webcodeDecodeGtSubtype
-
Default Instance: This property can be accessed via the default instance object of this class.
- JavaScript:
Rho.Barcode.webcodeDecodeGtSubtype - Ruby:
Rho::Barcode.webcodeDecodeGtSubtype
- JavaScript:
Examples
Getting started with barcode scanning is very straightforward. If you do not need to customize the defaults, you need very little code.
function scan_using_default_scanner(){ // Scan with default options Rho.Barcode.take({}, scan_received); } function scan_received(params){ // Did we actually find a barcode ? // If status is not 'ok', the scan was canceled if (params["status"]=="ok") { alert('Barcode scanning complete. Scanned barcode: '+params["barcode"]); } else { alert('Barcode scanning aborted'); } Rho.Barcode.stop(); }
def scan_using_default_scanner # Scan with default options Rho::Barcode.take({}, url_for(:action => :scan_received)) end def scan_received # Did we actually find a barcode ? # If status is not 'ok', the scan was canceled if @params["status"] == "ok" Rho::Log.info(@params["barcode"],"Barcode result") else Rho::Log.info("canceled", "Barcode result") end end
By default, Rho::Barcode will select a hardware scanner if present on the device. If you want to let the user choose which scanner to use at any particular time, you must enumerate the available scanners and select one from the set.
var scanners; function choose_scanner(){ // Enumerate returns an array of scanner objects // Devices without a hardware scanner will return a software-based recognizer scanners = Rho.Barcode.enumerate(); } function scan_using_chosen_scanner(scanner_index) { var scanner = scanners[scanner_index]; scanner.take({}, scan_received_callback); } function scan_received_callback(params){ // Did we actually find a barcode? // If status is not 'ok' the scan is canceled if (params["status"]=="ok") { alert('Barcode scanning complete. Scanned barcode: '+params["barcode"]); } else { alert('Barcode scanning aborted'); } Rho.Barcode.stop(); }
# --------------- # controller.rb # --------------- def choose_scanner # Obtain list of available scanners on the system. Devices without a hardware scanner will return a software-based recognizer $scanners = Rho::Barcode.enumerate render end def scan_using_chosen_scanner # receive an integer as parameter, which represent the number of the scanner we wish to use scanner = $scanners[@params["scannerIndex"].to_i] scanner.take({}, url_for(:action => :scan_received_callback)) end def scan_received_callback # Did we actually find a barcode ? # If status is not 'ok', the scan was canceled if @params["status"] == "ok" Rho::Log.info(@params["barcode"],"Barcode result") else Rho::Log.info("canceled", "Barcode result") end end # --------------- # choose_scanner.erb # --------------- <ul data-role="listview"> <% $scanners.each_with_index do |scanner, index| %> <li><a href="<%= url_for(:action => :scan_using_chosen_scanner, :query => {:scanner_index => index}) %>"><%= scanner.friendlyName %></li> <% end %> </ul>
Specify which symbologies the barcode scanner must recognize.
// For the purpose of this example, let's say our application only needs to recognize one type of barcode. // In that case, we will disable all decoders... Rho.Barcode.allDecoders = false; // ... and enable only the one we are interested in: Rho.Barcode.upca = true; // All other barcode symbologies will be ignored Rho.Barcode.take({}, scan_received_callback);
# For the purpose of this example, let's say our application only needs to recognize one type of barcode. # In that case, we will disable all decoders... Rho::Barcode.allDecoders = false # ... and enable only the one we are interested in: Rho::Barcode.upca = true # All other barcode symbologies will be ignored Rho::Barcode.take({}, url_for(:action => :scan_received_callback))
Examples of setting barcode scanner properties.
// There are over 200 properties to fine-tune the barcode scanner functionality and adapt it to suit your application. // Almost all properties depend on the scanner hardware for support, please check the documentation to see if your device // supports a particular setting // Here are examples of setting some of the properties. The documentation lists the acceptable values for each of them // Aiming mode (visual cue): Rho.Barcode.aimMode = "none"; Rho.Barcode.aimMode = "dot"; Rho.Barcode.aimMode = "slab"; Rho.Barcode.aimMode = "reticle"; // Aiming type (processing mode): Rho.Barcode.aimType = "trigger"; Rho.Barcode.aimType = "timedHold"; Rho.Barcode.aimType = "timedRelease"; Rho.Barcode.aimType = "presentation"; Rho.Barcode.aimType = "pressAndRelease"; Rho.Barcode.aimType = "continuousRead"; // Generate an "Enter" keypress after a barcode is recognized. Useful for sending forms automatically after a scan Rho.Barcode.autoEnter = true; // Select the beam width of the scanner (only supported on some devices) Rho.Barcode.beamWidth = "normal"; Rho.Barcode.beamWidth = "narrow"; Rho.Barcode.beamWidth = "wide";
# There are over 200 properties to fine-tune the barcode scanner functionality and adapt it to suit your application. # Almost all properties depend on the scanner hardware for support, please check the documentation to see if your device # supports a particular setting # Here are examples of setting some of the properties. The documentation lists the acceptable values for each of them # Aiming mode (visual cue): Rho::Barcode.aimMode = "none" Rho::Barcode.aimMode = "dot" Rho::Barcode.aimMode = "slab" Rho::Barcode.aimMode = "reticle" # Aiming type (processing mode): Rho::Barcode.aimType = "trigger" Rho::Barcode.aimType = "timedHold" Rho::Barcode.aimType = "timedRelease" Rho::Barcode.aimType = "presentation" Rho::Barcode.aimType = "pressAndRelease" Rho::Barcode.aimType = "continuousRead" # Generate an "Enter" keypress after a barcode is recognized. Useful for sending forms automatically after a scan Rho::Barcode.autoEnter = true # Select the beam width of the scanner (only supported on some devices) Rho::Barcode.beamWidth = "normal" Rho::Barcode.beamWidth = "narrow" Rho::Barcode.beamWidth = "wide"
You can customize or eliminate the beep that the device emits when a barcode is recognized. Support and valid ranges for these values depend on the device.
// Maximum volume (default) Rho.Barcode.decodeVolume = 5; // Low-pitched sound Rho.Barcode.decodeFrequency = 1000; // One-second long Rho.Barcode.decodeDuration = 1000; Rho.Barcode.take({}, scan_received_callback);
# Maximum volume (default) Rho::Barcode.decodeVolume = 5 # Low-pitched sound Rho::Barcode.decodeFrequency = 1000 # One-second long Rho::Barcode.decodeDuration = 1000 Rho::Barcode.take({}, url_for(:action => :scan_received_callback))
Remarks
Once associated with the Device a Bluetooth Scanner will remain associated even after losing the BT connection. In order to associate a different Bluetooth scanner with the device it is necessary to scan the ‘unpairing’ barcode and then invoke the ‘disabled’ method followed by the ‘enabled’ method, this will allow you to scan the BT association barcode with a different scanner. You can override this default behavior using the disconnectBtOnDisable property.
The following messages will be received from the Bluetooth Scanner in the bluetoothStatus event:
‘BTScanAssociationBarcode’
Means the device is ready to be associated with a BT scanner. You must scan the association barcode. It is only necessary to scan the association barcode when you first associate a scanner with the device, this pairing will be remembered until you scan the unpairing barcode.
‘BluetoothConnected’
The remote scanner has successfully connected to the device.
‘BluetoothDisconnected’
The remote scanner has become disconnected from the device, this may be due to loss of battery, being out of range or scanning the ‘unpairing’ barcode. The scanner will attempt to reconnect automatically for a period of time once it regains power or goes out of range, if it fails to reconnect after the specified timeout the reconnect button on the device should be pushed. Once the unpairing barcode is scanned it is necessary to disable the scanner and then re-enable it before another scanner can be associated.
On Symbol Technologies' scanners the scanner viewfinder window is not infinitely resizable, when setting ViewFinderX, ViewFinderY, ViewFinderWidth and ViewFinderHeight ensure you do not exceed the size of the screen and it is recommended to use the same aspect ratio as your device. For applications designed to handle screen rotation it is recommended to use a scan window whose longest side will fit within both the screen width and screen height. If your viewfinder position fails to be applied it is recommended you query your log file to see which parameter is causing trouble, or reposition the window away from the edges of the screen.
In some device configurations the scanner and camera share the same hardware. Where two modules share the same physical hardware they cannot be enabled simultaneously, in this circumstance once the scanner is enabled it must be disabled before the camera can be used, and vice versa.
On WM/CE, it is first necessary to enable the scanner before most of the properties can be retrieved. The case of scanner properties will differ across platforms. On WM/CE, some of the scanner properties are not exposed to set but can be retrieved. On Android, only supported scanner properties can be retrieved in “getAllProperties” method.
On WM/CE, for some properties, it is first necessary to apply those properties before enabling the scanner.
As google barcode scanning library(Zxing library) supported only in Landscape mode. Barcode scanning window only appears at centre of screen in Landscape mode.
In order to use the scanner with RhoElements Native Apps you will need to either disable DataWedge or create a DataWedge profile for your app. Disabling Datawedge
- Start the DataWedge app
- Click the menu button > “Settings” and untick “DataWedge enabled”.
RhoElements Datawedge Profile
- Install your RhoElements native app,
- Start the DataWedge app
- Click the menu button > “New Profile” and enter a name,
- Click on the link to the new profile in the profile list,
- Click on “Associated apps” in the “Applications” section,
- Click the menu button > “New app/activity”,
- Select the package name for your app,
- Select “*”,
- Click the “Back” capacitive button,
- Make sure the “Profile enabled” checkbox is ticked.
- Uncheck all three “Enabled” checkboxes under the sections of: “Barcode input”, “Keystroke output” and “Intent output”.