HID Mobile Access Configuration Application User Guide

Transcription

1 HID Mobile Access Configuration Application User Guide PLT-02075, Rev. A.0 October 2014 hidglobal.com

2 Contents 1 Purpose Background Bluetooth LE (BLE, aka Bluetooth Smart) Power / Range Terminology System Overview Operational Overview Device Requirements Functions and Features of the Configuration Application Mobile Admin Card HID Mobile Access Configuration Application Operation Obtaining the Application Stop the HID Mobile Access Application HID Mobile Access Configuration Application Launch the Application Scan for Readers List Available Readers Available Readers Connection Screen Set Configuration Ranges and Transmit Power Recommended Configuration Values Changing and Saving the Bluetooth Configuration Settings Set Configuration Settings Procedure Templates Create a Template Activate a Template Apply a Template Deactivate a Template Modify a Template Remove a Template Bluetooth Firmware Update Troubleshooting October 2014 Page 2 of 30

3 Copyright Trademarks 2014 HID Global Corporation/ASSA ABLOY AB. All rights reserved. This document may not be reproduced, disseminated or republished in any form without the prior written permission of HID Global Corporation. HID GLOBAL, HID, the HID logo, HID Mobile Access, and iclass SE, are the trademarks or registered trademarks of HID Global Corporation, or its licensors, in the U.S. and other countries. Revision History Date Description Version 10/1/14 Initial release A.0 Contacts For additional offices around the world, see North America 611 Center Ridge Drive Austin, TX USA Phone: Fax: Europe, Middle East and Africa Haverhill Business Park Phoenix Road Haverhill, Suffolk CB9 7AE England Phone: 44 (0) Fax: 44 (0) Asia Pacific 19/F 625 King s Road North Point, Island East Hong Kong Phone: Fax: Brazil Condomínio Business Center Av. Ermano Marchetti, 1435 Galpão A2 CEP Lapa - São Paulo/SP Brazil Phone: HID Global Technical Support: support.hidglobal.com Page 3 of 30 October 2014

4 1 Purpose This document provides instruction for site administrators and installers on the function and usage of the HID Mobile Access Configuration Application for HID Mobile Access readers (using Bluetooth low energy technology) on an Android mobile device. Note: In this document the HID Mobile Access Configuration Application may be referred to as the Configuration Application to simplify the terminology in this document. See HID Mobile Access Deployment Guide PLT for additional information. 2 Background 2.1 Bluetooth LE (BLE, aka Bluetooth Smart) HID iclass SE Mobile Access readers enable interoperability between mobile device and reader to gain access through physical doors and other access points. A primary technology that enables this is Bluetooth Low Energy (BLE), and is found today on many mobile devices, including those running Android 4.3 (ex. Samsung Galaxy S4) and ios 7 (iphone, ipad). 2.2 Power / Range The strength of the signal between an HID Mobile Access Reader and a device loaded with the HID Mobile Access App, is used to determine the threshold (within the device) on which a communication will take place between the reader and the device. Due to the fact that environmental factors can affect the signal of a reader, it may be necessary to adjust the reader s BLE transmission signal strength or threshold, in order to derive an acceptable range for both Tap and Twist and Go operations. 3 Terminology BLE Tap Twist and Go Bluetooth Low Energy, also known as Bluetooth LE, branded Bluetooth Smart. Holding the mobile device near the reader. Twisting the Mobile device in a door knob motion at a distance from the reader. October 2014 Page 4 of 30

5 4 System Overview The following graphic is a top level representation of the reader with a module plugged in. HID Mobile Access Reader Note: Although this application communicates directly with the Bluetooth Communication Controller, configuration settings are transferred and shared with the iclass SE Reader; therefore the Bluetooth Module and Reader are logically linked and should not be separated. Page 5 of 30 October 2014

6 5 Operational Overview 5.1 Device Requirements HID Mobile Access Configuration Application mobile device requirements: Bluetooth 4.x (or higher) Android OS 4.3.x (or higher) Note: Currently HID Global is recommending the following: LG Nexus 5 Samsung S4 Samsung S5 5.2 Functions and Features of the Configuration Application The Configuration Application supports the following functions: Identification of Bluetooth firmware version loaded onto the Bluetooth Communication controller Upload of Bluetooth firmware to the Bluetooth Communication controller Display/modification of current configuration settings of module/iclass SE reader 5.3 Mobile Admin Card A Mobile Admin card is provided to protect against unauthorized modification of the BLE settings on the reader. This card is specific to the end user organization of the HID Mobile Access Reader installation site. Mobile Admin cards (pack of 5) are sent to the designated customer administrator during the HID Mobile Access onboarding process. Note: The administrator is identified in the end users onboarding process, before readers are sent to the customer. To obtain a Mobile Admin card see the end user organization administrator. The installer can use the Configuration Application to link to the reader, and read back the configuration settings of the reader, but if these configurations setting are to be changed the Mobile Admin card must be presented to the reader. This operation initiates a 2 minute window during which the configuration settings or Firmware can be changed / uploaded. October 2014 Page 6 of 30

7 6 HID Mobile Access Configuration Application Operation 6.1 Obtaining the Application The HID Mobile Access Configuration Application is currently available through Play Store. 1. Open Play Store. 2. Search for BLE Config App. 3. Select HID Mobile Access Configuration Application. 4. Select Install. 5. Select Accept to allow the application access to Photos/Media/Files. 6.2 Stop the HID Mobile Access Application Caution: Prior to running the HID Mobile Access Configuration Application, ensure that the HID Mobile Access Application has been stopped. Note: Exact steps vary by device manufacturer and operating system version. The steps in the example below are for a Samsung S4, OS On an Android Mobile device, select Menu > Settings. Page 7 of 30 October 2014

8 2. Select More. 3. Select the mobile device Application Manager. 4. Scroll through the list and select the HID Mobile Access application. 5. Select Force Stop. 6. Click OK to confirm. October 2014 Page 8 of 30

9 7 HID Mobile Access Configuration Application 7.1 Launch the Application Select the Mobile Access Reader Configuration Tool icon to launch the application. 7.2 Scan for Readers This screen allows the user to list all Mobile Access readers within range, and to connect to a given reader List Available Readers Select Scan for Readers. All the readers found are displayed. They will be listed in the following groups: Bonded Devices - displays any Bluetooth device (not HID readers) that may be bonded with the device. Example: hands-free headset. Available Readers - displays a list of Mobile Access enabled readers that are currently within range. Page 9 of 30 October 2014

10 7.2.2 Available Readers The Available readers will display the following information. Application Brand Bluetooth MAC Address Signal Strength Field Bluetooth MAC Address Application Brand Signal Strength Description Displays the reader s BLE MAC address. The Application Brand directly correlates to the Advertising Data used to synchronize reader and mobile application. Assa - For interoperability with ASSA Mobile IDs. HID - For interoperability with HID Mobile IDs. The received signal strength associated with that reader All Available Readers will be displayed. Typically, the reader that is physically closest to the device running the Configuration Application will have the strongest signal. Select the appropriate reader from the list. October 2014 Page 10 of 30

11 7.3 Connection Screen Once the application has connected to the selected reader, the following screen is displayed. Bluetooth Communication Controller Firmware version shown (e.g. v2.11) Application Brand (HID, Assa, etc.) Bluetooth MAC address Firmware file selection window Function buttons Page 11 of 30 October 2014

12 7.4 Set Configuration This screen shows the Bluetooth controller firmware version, Bluetooth MAC address, and Application Brand, as well as the firmware file selection window. If the Set Configuration option is selected, the following screen is displayed: Application Brand Reader Operation Modes Mode Range and Power Settings Power Levels (dbm) Function buttons Field Application Brand Operations Modes Tap In Twist and Go Range Description DO NOT change this setting, unless specifically directed to do so. The result would be the user s applications will no longer be able to communicate with the Reader. This option enables/disables the use of the mobile device at close proximity to the reader (approx. 0 to 4 in.). Default. This option enables/disables the Twist gesture operation, where the use of the mobile device is at a greater distance from the reader (normally 1 to 10 ft.). Range and Power Settings Range and power settings work in tandem to increase or decrease effective read range. Default is Low (-40 dbm). See Section 7.4.1: Ranges and Transmit Power Tap Range for detailed information. Twist and Go Range Transmit Power Default High (-74 dbm). See Section 7.4.1: Ranges and Transmit Power for detailed information. Default -4 dbm. See Section 7.4.1: Ranges and Transmit Power for detailed information. October 2014 Page 12 of 30

13 7.4.1 Ranges and Transmit Power The following diagram illustrates the relationship between Range and Transmit Power. The values for Tap and Twist and Go are set as in Section 7.4: Set Configuration, and the power levels are indicated by the number shown at the bottom right of the setting. Note: The default setting for Tap is low, and the default for Twist and Go is High. Depending on the site installation these can be adjusted to best suit the performance and range of the user s device, but the default setting should always be used as the starting point. Figure 1: Relationship between Range and Transmit Power Page 13 of 30 October 2014

14 To illustrate the effect of the power setting, the following shows the approximate effect on the read distance when adjusting the transmit power only (keeping Range settings the same). If the default setting (-4 dbm) gives a read range of 4m, then changing the transmit power would theoretically have the following effect on read distance: Recommended Configuration Values Due to the fact that the range and performance of mobile devices may vary, it is advised that the appropriate settings are selected based on a representative cross-section of mobile device types to be used. In certain installations a higher or lower Transmit Power may be required, and thus the relative operational distance can be set as shown by the Transmit Power in Section 7.4.1: Ranges and Transmit Power. Note: This setting should only be adjusted if the Read Range settings do not result in the desired read range. It is recommended that the default Transmit Power setting (-4dBm) is not exceeded unless absolutely necessary. October 2014 Page 14 of 30

15 7.5 Changing and Saving the Bluetooth Configuration Settings To change the settings as described in Section 5.3: Mobile Admin Card and select the option boxes or drag the sliders to set the new values. Note: Multiple settings can be set and saved at the same time, but it is recommended that: Application Brand, Operational Modes (Tap and Twist and Go settings) are set and saved first. Range settings are set after a study of the operations at that installation site Set Configuration Settings Procedure Follow this procedure in order to set the Configuration Settings: 1. Verify the Mobile Application is fully closed. See Section 6.2: Stop the HID Mobile Access Application. 2. Open the HID Mobile Access Configuration Application. 3. Link the Reader to the Application. See Section 7.2 Scan for Readers. 4. Select Set Configuration. 5. Modify the settings (Mobile App & Mode(s)) as needed. To configure individual operational modes for the first time first configure the respective Range (Tap or Twist and Go). If the desired range is not achieved, next modify the Transmit Power. The Transmit Power will affect Tap as well as Twist and Go ranges, while the individual Range settings will only affect the specific operational mode. Note: If you adjust the Tap or Twist and Go Range, only the range of that operational mode will be affected. But, if the Transmit Power is adjusted (represented by the red vertical line on Figure 1) both Tap and Twist and Go Range will slide vertically up or down together. 6. Present the Mobile Admin card to the reader. See Section 5.3: Mobile Admin Card. When the Mobile Admin card is presented, the reader will beep twice quickly and the LED will flash blue / purple, indicating that the reader is in Configuration mode and ready to accept new settings. Page 15 of 30 October 2014

16 7. Select Apply Changes. If the changes are applied successfully, a message will be displayed confirming this action. Configuration has been set successfully. Note: Once the settings have been set the reader will beep three times and the LED will return to Red (or default color). The audio visual indictors are controlled by the host if the LED and beeper lines are connected to the controller, and host control is enabled. Note: There is no need to power cycle a reader after the configuration change is completed. 8. The settings can now be verified by launching the HID Mobile Access Application. 9. Test the device. If the Range or Power settings require additional adjustments, repeat the process. See Section 7.5.1: Set Configuration Settings Procedure. October 2014 Page 16 of 30

17 10. Once the desired settings have been found, select the < HID BLE Config App to return to the Application Launch screen, to scan for another reader and repeat the process as described in this section. Page 17 of 30 October 2014

18 8 Templates When applying a configuration to multiple readers, the installer can create a template(s) for convenience. This template can be applied to multiple readers that require the same configuration. 8.1 Create a Template 1. Select Templates on Configuration Application main screen. 2. Select Create. October 2014 Page 18 of 30

19 3. Set new configuration and select Save As to save the Template. 4. Enter a Template Name and select Save. 5. The Application displays all created Templates. Select Close to exit the Templates screen. Page 19 of 30 October 2014

20 8.2 Activate a Template 1. Select and hold on the template name to activate. 2. Select Activate. The Template with display an Activated status. 3. Select Close to exit this screen. 4. Application moves to Template Mode and displays the current template name below reader s name. October 2014 Page 20 of 30

21 8.3 Apply a Template Note: Before the configuration can be applied to the reader, it must be put in Admin Mode by presenting the Mobile Admin card to the reader. 1. Activate a template. See Section 8.2: Activate a Template. 2. Scan for Readers. See Section 7.2: Scan for Readers. 3. After selecting a reader, the application retrieves the current reader configuration, and compares them with activated template, and applies the configuration from the template immediately. 4. If the current configuration operation fails, the Configuration Application displays the Configuration Settings screen, with the Activated Template name. If the Configuration Settings screen appears, select Apply Changes to apply the template configuration to the reader. If the Connection screen appears, select Set Configuration. The application will display the question Would you like to show configuration from reader? Page 21 of 30 October 2014

22 Cancel will display the Configuration Settings for the activated template. The user can select Apply Changes to send this configuration to the reader. Yes will display the Configuration Settings for the reader. The user can modify the configuration and select Apply Changes to send the modified configuration to the reader. October 2014 Page 22 of 30

23 8.4 Deactivate a Template 1. Select Templates from the main screen. 2. Select and hold on the Active Template name. 3. Select Deactivate. The Activated status is removed. 4. Select Close to exit the screen. Page 23 of 30 October 2014

24 5. The Configuration Application returns to standard mode. 8.5 Modify a Template 1. Select Templates from the main screen. 2. Select the template to modify. October 2014 Page 24 of 30

25 3. The Configuration Settings for selected template will display. 4. Click Save As. 5. You have the following two options: Save this new configuration of this template, click Save. Select Yes to confirm. Select Close. Create a new template, by entering a new Template Name and click Save. Select Close. Page 25 of 30 October 2014

26 8.6 Remove a Template 1. Select Templates from the main screen. 2. Select Remove for template to remove. 3. Select Yes to confirm the removal. The template is removed from the list. 4. Select Close. October 2014 Page 26 of 30

27 9 Bluetooth Firmware Update To upload a new version of the HID Global Bluetooth firmware: 1. Go to to download the HID Mobile Access Configuration Application firmware update. Select the brand: iclass SE Select a product: iclass SE Readers Select an OS: Any 2. Plug the Android/iOS device into your PC and open the Windows Explorer. 3. Save the file to the Download folder. Note: The file that was provided may have the same name as other Firmware previously supplied, so it is recommended that a new folder within the Download folder is created for each update and named accordingly. 4. To upload firmware to the Bluetooth Communication controller, launch the HID Mobile Configuration Application, scan for a reader and select it. See Section 6: HID Mobile Access Configuration Application Operation. 5. Verify the HID Mobile Application is fully closed. See Section 6.2: Stop the HID Mobile Access Application. 6. Open the HID Mobile Configuration Application. 7. Link the Reader to the Application. See Section 7.2 Scan for Readers. 8. In the Firmware file selection window, select the Select FW File option. Page 27 of 30 October 2014

28 9. Using the mobile devices file explorer, select the dfu.fw file. Note: Android devices can have different file explorer applications. The one shown in the example above is for the LG Nexus Present the Mobile Admin card to the reader. See Section 5.3: Mobile Admin Card. When the Mobile Admin card is presented, the reader will beep twice quickly and the LED will flash blue / purple, indicating that the reader is in Configuration mode and ready to accept new settings. October 2014 Page 28 of 30

29 11. Select Upgrade Firmware. 12. The Configuration Application will start the upload, displaying the progress of the upload. When complete the Configuration Application will return to the Launch screen. Bluetooth Communication Controller Firmware version (the current FW version) Upload file information Firmware Upgrade Button Upload Progress bar 13. Once the firmware has been successfully uploaded (approximately 1 minute) the application will return to the Launch screen and the reader will perform a soft reset. At this time the reader will not be operational until it beeps three times, and the LED returns to red (or default color). The audio visual indictors are controlled by the host if the LED and beeper lines are connected to the controller, and host control is enabled. 14. Repeat the scan/selection process and ensure that the reader firmware has been updated. See Section 7.2: Scan for Readers. Page 29 of 30 October 2014

30 10 Troubleshooting Error Message Meaning Issue Action There are no editable properties in the selected reader. The application could not get the reader properties. Changes are not allowed. User may have selected a Bluetooth device that is not compatible with HID Mobile Access, or the 2-minute timeout may have taken place with configuration changes still pending. The Bluetooth link is not strong enough (the reader is too far away). In order to change settings or upgrade firmware the Mobile Admin card must be presented. See Section 5.3: Mobile Admin Card. Go back to the Launch screen and re-scan for readers. Check the reader list and select the correct reader. Move closer to the reader and repeat the process. If there are multiple readers available, ensure that the correct one has been selected. Ensure that the Administrator card has been presented and valid for the reader that is being configured (Mobile Admin cards are specific to a given end-user organization). hidglobal.com