Rsm Module

The Rsm Module is used to configure or to retrieve attributes relating to a remote scanner either tethered to the device or connected via Bluetooth. The properties of the scanner which can be configured are detailed in the ‘Remarks’ section. When used for retrieval navigation to URL or call to JavaScript function happens immediately.

• Syntax
• Methods
• Parameters
• Events
• Multi Instance
• Remarks
• #
• Requirements
• HTML/JavaScript Examples

Syntax

Methods

Items listed in this section indicate methods or, in some cases, indicate parameters which will be retrieved.

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

Events

Values are returned to the caller in RhoElements via Events. Most modules contain events and those returned from this module are given below along with the event parameters. Events can cause a navigation to a new URL or a JavaScript function on the page to be invoked. Each event will in most cases have a number of parameters associated with it which will either be strings or JavaScript arrays. Event parameters can be accessed either directly or via JSON objects.

rsmGetEvent

Multi Instance

When multiple RhoElememts applications are running the following considerations should be made: Only the foreground RhoElements application is given access to the device scanner, 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 scanner will have its previous configuration (eg. selected decoders) reapplied to the scanner automatically.

Remarks

#

The following is a mapping between Attributes, their possible values and whether they are read / write:

Attribute                      Access  Associated Value

modelNumber                      R     The model number    
serialNumber                     R     The serial number    
dateOfManufacture                R     Date of manufacture as DDMMYY    
dateOfService                    R     Date of service as DDMMYY    
bluetoothAddress                 R     Bluetooth address as FF:FF:FF:FF:FF:FF where FF is a hex number.    
firmwareVersion                  R     Scanner's operating system version.    
deviceClass                      R     The device class of the system    
batteryStatus                    R     Indicates the status us the scanner's battery, 'Unknown', 'Full', 
                                       'Medium', 'Empty', 'Charging-FullRate', 'Charging-HalfRate', 
                                       'Charging-Trickle' or 'Discharging'    
batteryCapacity                  R     Remaining capacity of the battery, integer in the range '0' to 
                                       '100'.  'Unknown' if unable to determine, e.g. if no battery in the scanner.    
batteryID                        R     'Simple', 'Double', 'Cabled', 'Unknown'    
bluetoothAuthentication          RW    'True' if authentication is required, else 'False'    
bluetoothEncryption              RW    True' if encryption is required, else 'False'    
bluetoothPinCode                 RW    Up to 5 character PIN code used for Bluetooth authentication    
bluetoothPinCodeType             RW    'PromptUser' to prompt the user for the PIN code or 'UseStored' to 
                                       use the code stored in memory.    
bluetoothReconnectAttempts       RW    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.
bluetoothBeepOnReconnectAttempt  RW    When 'True' scanner will emit 5 beeps every 5 seconds whilst 
                                       re-connection in progress, else 'False'    
bluetoothHidAutoReconnect        RW    'NeverReconnect', 'ReconnectOnData' or 'ReconnectImmediately'    
bluetoothFriendlyName            RW    Friendly Bluetooth name, e.g. 'MyBTScanner'    
bluetoothInquiryMode             RW    'General' to use a general inquiry mode, else 'Limited'    
bluetoothAutoReconnect           RW    Bluetooth reconnection scheme: 
                                         'None' - No scheme
                                         'OnPower' - when powered on
                                         'OnOutofRange' - when device goes out of range
                                         'OnPowerOutofRange' - when powered on or when device goes out
                                         of range.    
forceSavePairingBarcode          RW    Force saving the barcode assigned to the device to which the scanner has
                                       been paired.  'Enabled' or 'Disabled'
bluetoothDisconnect              W     Command scanner to disconnect from its connected device.
bluetoothUnpair                  W     Command scanner to unpair from its paired device.  Allows scanner to associate
                                       with a different device.
lowBatteryIndication             RW    Low battery indication 'Enabled' or 'Disabled'    
lowBatteryIndicationCycle        RW    Low battery indication cycle time, in seconds 
                                       ('10', '20', '30', '40' or '50').   
scanLineWidth                    RW    The laser scan line width, 'Wide' or 'Narrow'.
goodScansDelay                   RW    Delay between good scans in proximity continuous mode, measured in milliseconds.
                                       Range 0 to 15000.  This value must be a multiple of 100.                                      
decodeFeedback                   RW    The remote scanner beeps and illuminates its green LED on a 
                                       successful decode.  'Enabled' or 'Disabled'.
ignoreCode128Usps                RW    Feature for ignoring Code 128 barcodes beginning with 420 and 421,
                                       'Enabled' or 'Disabled' 
scanTriggerWakeup                RW    Scanner trigger will wakeup the device from a low power state, 
                                       'Enabled' or 'Disabled'    
mems                             RW    Mems feature 'Enabled' or 'Disabled'    
proximityEnable                  RW    Proximity feature 'Enabled' or 'Disabled'    
proximityContinuous              RW    Proximity continuous mode 'Enabled' or 'Disabled'
proximityDistance                RW    Specify the distance for the proximity feature as 'Short', 'Medium' 
                                       or 'Long'    
pagingEnable                     RW    Specify whether paging the device is 'Enabled' or 'Disabled'    
pagingBeepSequence               RW    Range '0' to '15' to specify the pattern for the paging beep 
                                       sequence.    
pagingActivate                   W     'Start' or 'Stop' paging to the scanner.

ProximityEnable / Mems

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 RSM parameter. 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.

Requirements

HTML/JavaScript Examples

The following example configures some parameters associated with the remote Bluetooth scanner:

<META HTTP-Equiv="Scanner" Content="Enabled:SCN2">
<META HTTP-Equiv="RSM" Content="BluetoothAuthentication:True">
<META HTTP-Equiv="RSM" Content="BluetoothPinCode:5678">
<META HTTP-Equiv="RSM" Content="BluetoothReconnectAttempts:6">
<META HTTP-Equiv="RSM" Content="BluetoothBeepOnReconnectAttempt:True">
<META HTTP-Equiv="RSM" Content="BluetoothPINCodeType:UseStored">
<META HTTP-Equiv="RSM" Content="BluetoothAutoReconnect:OnPowerOutOfRange">

The following example retrieves some attributes of the Bluetooth Scanner:

<SCRIPT TYPE="TEXT/JAVASCRIPT">

function onRSMAttributes(jsonObject)
{
    //  Receive array of attribute values in the order they were registered and populate SPAN tags.
    var spanID;
    var spanElement;
    for(i=0; i < jsonObject.attributeArray.length; i++)
    {
        spanID = "Span" + (i+1);
        spanElement = document.getElementById(spanID);
        spanElement.innerText = jsonObject.attributeArray[i];
    }
}

function onTest()
{
    //Invoke some attributes to be returned 
    rsm.markForRetrievalModelNumber();  //  Array Index 0
    rsm.markForRetrievalSerialNumber();         
    rsm.markForRetrievalBluetoothAddress();     
    rsm.markForRetrievalBluetoothPinCode();
    rsm.markForRetrievalBluetoothFriendlyName();
    rsm.markForRetrievalProximityEnable();  //  Array Index 5

    //  Finally assign a function for RSMGetEvent, this will call onRSMAttributes with the array of parameters we have registered for above.
    rsm.rsmGetEvent = onRSMAttributes(%json);

}
</SCRIPT>

<HTML>
    <HEAD>
        <!-- Scanner must be enabled to use RSM functionality -->
        <META HTTP-Equiv="Scanner" Content="Enabled:SCN2">
    </HEAD>
    <BODY>
        <a href="javascript:onTest()">Get Values</a><br>
        Model Number: <span id=Span1></span><br>
        Serial Number: <span id=Span2></span><br>
        BT Address: <span id=Span3></span><br>
        BT PINcode: <span id=Span4></span><br>
        BT Friendly Name: <span id=Span5></span><br>
        Proximity Enable: <span id=Span6></span><br>
    </BODY>
</HTML>