About This GuideThis guide provides step-by-step instructions to help customer using the AirID ID on Windows and iOS and contains also all the necessary information for application developers needed to use certgate's AirID Bluetooth reader with their apps. Who Should Read This GuideThe guide is intended for users of the AirID on Windows and for app developers who want to integrate AirID in their smart card aware environment or software. Typographical ConventionsThe following kinds of text formatting and icons identify special information in the document: Warning |
---|
| Warnings mark situations where loss of data or misconfiguration of the device is possible if the instructions are not obeyed |
Note |
---|
| Notes provide additional information on a topic and emphasize important facts and considerations |
Tip |
---|
| Tips provide best practices and recommendations |
Code Block |
---|
language | actionscript3 |
---|
theme | Confluence |
---|
title | Code |
---|
| Code and or command line examples |
Panel |
---|
borderColor | grey |
---|
borderStyle | solid |
---|
title | Menu, Buttons |
---|
| Items you must select, such as menu options, command buttons, or items in a list. Example: Go to the System tab. |
Panel |
---|
borderColor | grey |
---|
borderStyle | solid |
---|
title | Parameters |
---|
| Parameter and attribute names |
Device LayoutOverviewDevice Description AirID is a wireless smart card reader that you can carry with you at all times. The AirID reader communicates via a secure Bluetooth Low Energy (BLE) connection with your device and makes the inserted smart card available for cryptographical operations such as data encryption or authentication. AirID is powered by a rechargeable Li-Po battery. The battery is charged by plugging the AirID into either a computer or external USB wall adapter using the USB cable provided. The LCD display shows all setting information and status of the reader. The user-friendly jog-dial control element helps you to navigate through the settings of the device. Bluetooth Connected Mode Usage With the AirID is it possible to protect Apps with smart card based-security via Bluetooth Low Energy (BLE). Note: Because of the sandbox architecture of iOS and Android, the AirID driver needs to be integrated into an app to use AirID with this specific app. Examples of apps with AirID integration: *contact your company administrator! If you would like to integrate AirID into your app, contact our support at [email protected] and get our AirID SDK for iOS. USB Connected Mode Usage AirID can be used as a standard USB CCID reader on all most all PCs with an common operanting system (Windows, OS X and Linux). Package ContentsCheck the product box for the following items: Before start-up,ensure that the two safety seals are undameged. If the safety seals are damaged, it is suspected that your device has been altered inadmissibly. In this case, please contact your distributor and do not use the device. Hardware FeaturesDevice Features Section |
---|
Column |
---|
|
|
Column |
---|
| 1 Low Power LCD Display 2 LED indicator 3 Jog dial control element 4 USB interface 5 Smart card internal slot |
|
Section |
---|
Column |
---|
|
|
Column |
---|
| 6 Double Header
Insert and remove a smart card Insert the card chip first. The double header of the AirID reader can read the chip regardless of which side the chip is on. To remove the card, simply slide it with the finger through the cut-out. |
|
Section |
---|
Column |
---|
| Control Element AirID is designed for easy menu navigation using a 3-way version of jog dial control element. Action | Function |
---|
up and down scrolling | navigation | press | select |
Status Indicator Following status indicators exists on AirID Status | Status Indicator | Meaning |
---|
Smart card status |
| card inserted, card not supported or damaged |
|
| card inserted and card supported |
|
| card access blocked (coverage) | Connection status |
| Bluetooth and advertising activated |
|
| Bluetooth activated and connected | Battery status |
| remaining battery capacity |
LED Indicator AirID 2 Color | Meaning |
---|
red | on while battery charging, off when battery charging is done | blue | on while smart card activities |
AirID 1 Color | Meaning |
---|
red | battery low, please charge AirID | red and blue | battery charging | blue and green | battery is fully charged |
|
Column |
---|
|
|
|
In the AirID device menu you can make various settings. You can access the different setting menus by navigating with the jog dial. AirIDThe AirID menu is diplayed in the main window and shows the smart card status. Setting | Display | Meaning |
---|
Initialize | | AirID initialized the smart card. This message appears only very shortly | Card OK | | The smart card is inserted and it is recognized.
When AirID is paired with a device, the device name is displayed here. | Card unreadable | | The inserted smart card is not readable. Please ensure that the card is properly inserted and the smart card is supported |
ConnectionThe Connection menu is the second setting when you scroll down. This is used to activate the Bluetooth connection or to terminate the connection. Setting | Display | Meaning |
|
---|
Initializing | | AirID initializes Bluetooth and activates the advertising mode. This message appears only very shortly.
|
Info |
---|
In the advertising mode, the AirID sends a Bluetooth signal making it detectable by devices. Requests must be checked and confirmed. |
| ON/ waiting | | AirID has activated Bluetooth and the advertising mode and is waiting for the connection to be established. When the jog dial is pressed, Bluetooth and the advertising mode are disabled. |
| Bonding | | AirID has successfully connected to a device. This message appears only very shortly. |
| Connected | | AirID is connected to a device. |
| Disconnecting | | When the jog dial is pressed, the connection is terminated. |
| OFF | | Bluetooth and the advertising mode are disabled. Pressing the jog dial activates Bluetooth and the advertising mode. |
|
Pairing CodeThis item is only shown during the first connection setup with a device and is used to display the pairing code and connection status. Setting | Display | Meaning |
|
---|
Pairing Code | | This menu is only shown the first time a connection is established with a device and is used to display the connection key. |
| Pairing success | | Verbindungsaufbau erfolgreich |
Infotip |
---|
Pairing defines the successful Bluetooth establishment of a connection between a an Bluetooth device and the AirID Bluetooth reader. Since the pairing information is retained even if the devices are turned off, it is not necessary to pair the same devices may only be paired once. The device will ask you to enter (Windows 7, 8.1) or compare (Windows 10, iOS, Android) the pairing again. To pair, the device prompts you to read a code from the AirID and enter it into the connected device or compare it with the code displayed on the AirIDdevice. |
|
Image Removed successImage RemovedImage Added |
Image RemovedConnection failed. The following errors may occur: Pairing fail 1: Pairing canceled Pairing fail 4: Pairing code wrong Pairing fail 23: Time out
|
|
Settings Under the menu Settings, you can configure settings for your AirID . Use the jog dial to select and confirm the settings. Setting | Display | Meaning |
|
---|
Settings | Image Added | Main window |
| Sig Strenght |
Following settings are possible: Image Removedlow (~3-
AirID 2 Image Added
AirID 1 Image Added
| Select the signal strenght of the AirID. Possible configurations: AirID 2 1-4 bars and AirID 1 Low (~ 3-5m, EcoModus, 1 bar)
|
Image Removedmiddle ~5 mhigh ~710 mImage Removed permanent or Image Removed eco mode so that the display switches off after a certain period of time. Backlight 10m, 3 bars) |
| Advertising | AirID 2 Image Added Image Added AirID 1 Image Added
Image Added | Use the jog dial to set the advertising mode (Connection via Bluetooth) to Image Modified permanent or Image Modified EcoMode |
Note |
---|
If during the active advertising mode (EcoMode) no connection to a device is established, the advertising mode switches off automatically to save battery power. Therefore, a manual reconnection is necessary afterwards. |
Note |
---|
To save energy, a work schedule can be created via AirID Central APP. If the working hours are exceeded, the advertising mode remains deactivated. |
| Display |
| AirID 2 Image Added Image Added
AirID 1 Image Added Image Added
| Indicates the lenght of time the display will remain on. Select whether the display is on permanently or turns off after a while. |
| Backlight | AirID 2 Image Added Image Added
AirID 1 Image Added Image Added
|
Select whether the backlight is Image Modified activated or Image Modified deactivated. |
| Contrast | Image Added Image Added | Increase display contrast (adjustable in 4 levels) |
Image Removed , Image Removed.Image RemovedActivate or Image RemovedAirID 2 Image Added Image Added AirID 1 Image Added Image Added | Activate or deactivate the acoustic feedback of the AirID. |
| Force 256bit |
| Select if you want to encrypt the connection between AirID and the work device with AES-256. |
| USB Card Reader | AirID 2 Image Added Image Added Image Added
AirID 1 Image Added Image Added
| If the AirID is connected via USB to the work device, you can select whether the AirID should be used as a USB card reader |
Image Removed Image Removed (NEUE BILDER sind notwendig) . If the AirID is not used as USB reader, the AirID is supplied with power via USB and thus charged. With AirID 1, the query disappears ater 15 seconds and the AirID is automatically used as a USB card reader. |
| Reset Keys |
Image RemovedThis setting deletes all | AirID 2 Image Added
Image Added Image Added AirID 1 Image Added
| This setting deletes all pairing keys. This is recommended |
if you pass on othersthird parties. After a reset, a new key exchange is necessary to re-established a connection. |
| Factory Reset |
Image Removed Image Added | This setting reset the AirID to factory settings. All pairing keys are also deleted. |
|
| Distance Sensor oder Coverage | AirID 2 Image Added Image Added Image Added Image Added Image Added Image Added Image Added Image Added
Image Added
AirID 1 Image Added Image Added Image Added Image Added Image Added Image Added Image Added Image Added Image Added | |
Update Firmware The AirID firmware can be updated with this setting. Coverage (not ready) The AirID reader can log you out and locks WINDOWS or mobile (iOS or Android) apps |
automaticallyautomatically, if a (preset) distance between your computer and your AirID has been exceeded. The "Distance Log-Out" is managed in AirID settings using "Distance Sensor" (with AirID 2) or "Coverage" (with AirID 1). This setting is optional and can only be configured if there is an active Bluetooth connection to the a device. You can use pressetings |
Image Removed or set the distance manually. Following pressetings are available: |
Image Removed ~65 Image Removed ~75 Image Removed ~80 Back Image Removed Select Back to return to the main menu. AirID InfoUnder AirID Info you will find further information about the AIrID. Image Removed Serial number of the AirID Image Removed Bluetooth address of the AirID Image Removed The received signal strength Image Removed Battery percentage indicator Image Removed Current time and day Image Removed Version of the AirID board Image Removed Version of the AIrID bootloader Image Removed Version of the AirID firmware version Image Removed Select Back to return to the main menu Card InfoImage Removed Displays information about the inserted smart card. These information is only displayed if the smart card is correctly inserted and recognized/ supported. Prefered DeviceUnder "Prefer Device" the pairing information of the AirID with the before connected devices are stored. From these information you can select to which device the AirID should preferably be connected in the future. All other devices will be ignored. Image Removed Image Removed Select the option New to connect AirID to a new device if the already connected devices are nearby. All other devices connected to AirID will be ignored. Image Removed In comparasion to the possible pressetings, the manual setting allows an individual fine adjustment. If the manual setting is selected, the curent RSSI value is shown in the display. Slowly walk over the area you want your device to remain unlocked. Press the jog dial at the preferred distance to confirm the coverage area and activate the Distance Sensor function. |
Note |
---|
Settings can only be changed with an active Bluetooth connection between your computer and AirID reader. |
Tip |
---|
To avoid unintended disconnects, keep in mind that the minimum distance for the automated log-out is about three meters between your computer and AirID reader. |
Tip |
---|
The distance value for the "Distance Sensor" feature represents a relative value. It depends on the signal strength of the AirID, on the environment and on other interferencing signals. |
| Update Firmware only with AirID 2 | Image Added Image Added Image Added | The AirID firmware can be updated with this setting. An USB connection to your Windows PC or Mac is required. |
| Back | Image Added | Select Back to return to the main menu. |
|
AirID InfoUnder AirID Info you will find further information about the AIrID. Setting | Dispaly | Meaning |
---|
Serial Number | Image Added | Serial number of the AirID | IEEE Adress | Image Added | Bluetooth address of the AirID | Received | Image Added | The received signal strength | Battery | Image Added | Battery percentage indicator | Time | Image Added | Current time and day | Board | Image Added | Version of the AirID board | Bootloader | Image Added | Version of the AIrID bootloader | Firmware | Image Added | Version of the AirID firmware version | Build | Image Added | Dte and time the firmware version was created. | Back | Image Added | Select Back to return to the main menu |
Card InfoSetting | Display | Meaning |
---|
Card Info only on AirID 1 | Image Added | Displays information about the inserted smart card. These information is only displayed if the smart card is correctly inserted and recognized/ supported. |
Prefered DeviceUnder "Prefer Device" the pairing information of the AirID with the before connected devices are stored. From these information you can select to which device the AirID should preferably be connected in the future. All other devices will be ignored. Text | Anzeige | Bedeutung |
---|
None | Image Added
| If no device is selected, a BLE connection to one of the surrounding devices is possible. | New | Image Added | Select the option New to connect AirID to a new device if the already connected devices are nearby. All other devices connected to AirID will be ignored. | "Gerät Name" | Image Added | If your AirID was already connected to several devices, you can use the stored pairing information to select which device the AirID should preferably be connected to in the future. All other devices will be ignored. |
Info |
---|
The pairing information with up to 10 different devices can be stored at the same time. |
Firmware Updatecertgate is constantly working to make AirID even more reliable and faster. Therefore we provide firmware updates for our wireless smartcard readers under AirID Software, Driver & SDK from time to time. Please install a firmware update as soon as it is available as it improves the reliability of the reader. The AirID firmware can be updated via USB on Windows or MacOS Pcs. Download the latest firmware from our website and unzip the file. Below you will find the necessary steps for the update. Update AirID 2 - Under Settings, select Update Firmware and navigate to Confirm: Yes and select it
- Connect your AirID with USB-cable to a Windows computer or Mac.
- The AirID should display: "Send update or unpower to exit"
On a PC running WINDOWS operating system - Open the folder with the firmware and click on "flash_gecko.bat" file
On a MacOS - Open the folder with the firmware and click on the "flash-gecko.command" file
- After the update the AirID will reboot automatically.
The AirID has been updatet and you can use it with your smart card. Update AirID 1 - Remove the smart card from your AirID
- While pressing the jog dial control element, connect your AirID with USB-cable to a Windows computer or Mac.
- The AirID should display: Image Added
On a PC running WINDOWS operating system - Open the folder with the firmware and click on "AirID_FW_CC2540.bat" file
On a MacOS - Open the folder with the firmware and click on the "AirID_FW_CC2540.command" file
- After the update the AirID will reboot automatically.
The AirID has been updatet and you can use it with your smart card. Tip |
---|
If the update fails, the update process is intrerrupted or the AirID doesn't start anymore, go to Step 2 and repeat the process. Image Added |
Tip |
---|
In rare cases, especially when updating from a very old firmware version it is possible that all Bluetooth pairing information is lost. In this case it could be necessary to remove the AirID® from all devices and pair them again. Our recommended steps: - Turn off the Bluetooth connection on your AirID Connection → OFF
- Remove the AirID from the Bluetooth connected device list on your device Bluetooth- > AirID "SerialNumber" - > Remove device
- Turn on the Bluetooth connection on your AirID
- Pair the AirID with your device
| Info |
---|
The pairing information with up to 10 different devices can be stored at the same time.
|
Using AirIDAirID supports various operating systems like Windows, MacOS, Linux, iOS and Android. The basic requirement is the Bluetooth Low Energy functionality of the device. When AirID is successfully paired and the driver is installed, the inserted smart card is available to be used for cryptographical operations such as authentication or data encryption. This requires an applet on the smar card and the corresponding middleware for the operating system used. The AirID software consists of two components: - AirID Central App - a management software for your AirID forming the basis for usage of the device. The tool provides you with information and setting options for your AirID when your reader is connected to your device.
- AirID drivers, which ensures the communication between the AirID and the operating system, must be installed additionally depending on the platform or is already integrated in the Apps and solutions of third party vendors.
AirID can be used with different terminals and platforms is possible, but not in parallel operation. WindowsThe use of AirID under Windows is only possible as of Windows 8.1 due to the Bluetooth Low Energy functionality required. For use under Windows 7, an ONEKEY BRIDGE is additionally required. Installation and Pairing- Download the latest installer (zipped .msi file) for Windows at AirID - Software, Driver & SDK.
- Unzip and double click on the .msi installer file.
- Follow the instructions in the installation wizard.
- The AirID Windows driver and the AirID Central App are now installed.
- Insert your smart card to power on the AirID reader and activate Bluetooth at the AirID reader by navigating to the connection menu and pressing the jog dial control element. The AirID should display:
- Open Windows "Settings→ Devices→ Bluetooth". Your AirID should be listed with its serial number. Press "Pair"
- Enter 6 digit pairing key shown on AirID display
- After successful pairing "Pairing successful" will be displayed on AirIDImage Removed
- After successful connection establishment, the AirID should display the name of your device
The AirID can now be used.- After successful pairing "Pairing successful" will be displayed on AirIDImage Added
- After successful connection establishment, the AirID should display the name of your device
The AirID can now be used. Tip |
---|
If there are any problems with the pairing process, restart the process. If necessary, delete the stored pairing information (see 5.1.2 "Deleting the Connection") |
Tip |
---|
After the driver has been succesfully installed and paired, AirID is displayed as follows under Device Manager. AirID is detected as "Microsoft USBCCID Smartcard Reader" if it is connected via USB. Image Added |
Deleting the ConnectionThe pairing information are stored on both the Windows system and AirID. To terminate the connection completely, the information on both sides must be deleted. On Windows - Open the Bluetooth settings on Windows (Settings- Devices - Bluetooth)
- Select the corresponding AirID using the displayed serial number and click on "Remove Device"
- Click "Yes" to confirm the removal of the device.
On AirID Delete All Pairing Information To delete all stored pairing information from AirID a "Reset Keys" (verlinkung) can be performed in the Settings menu. Delete Specific Pairing Information To delete specific pairing information from AirID a "Reset Keys" of the Windows workstation can be performed in the Settings menu. The pairing information can also be deleted via AirID Central App. To do this, go to the paired devices view, select the corresponding device from the list and click Delete. AirID Central App AirID Central provides information and setting options for your AirID once your AirID is connected to your Windows device. If there is no connection, "No device" is displayed in the AirID Central. ( muss erneuert werden) AirID Central as an AirID management software, provides an overview of: - Serial Number - Displays the Serial Number of the connected AirID
- Card Status - Displays the status of the inserted smart card. This can be readable , unreadable or no card inserted
- Coverage Feature - Displays if the coverage feature is activated or not
- Encryption - Displays if the AES encryption is set to 128 or 256-bit
- Refresh - Checks if there is an older firmware and offers a firmware update if necessary.
- AirID Change - Displays the list of the connected AirID readers from which you can select one.
- Battery Status - Displays the battery charge in percent. The green flash symbol indicates an active charging process.
In the AirID Central, the following settings can also be made on the AirID: - Signal Strenght - Select the signal strength of the AirID:
- low (~3-5m)
middle (~5-7 m) high (~7,5-10 m)
- Backlight - Select if a display backlight is required
- Buzzer - Select if an acustic feedback is required
- Display - Select if the display should always be on or only for a certain time.
- Advertising - Select if the Bluetooth signal for the connection to a device should always be on or only for a certain time.An individual work schedule to save energy can also be created with AirID Central. The advertising mode remains deactivated after the defined working hours.
Note |
---|
If during the active advertising mode (EcoMode) no connection to a device is established, the advertising mode switches off automatically to save battery power. Therefore, a manual reconnection is necessary afterwards. |
The following information is displayed when clicking on the AirID device displayed in the AirID Central App:
- Serial Number
- MAC Address
- Hardware - Board Version of the AirID
- Bootloader Version
- Firmware Version
- Card OS of the inserted smart card
- Build version of the firmware
- Connected devices - shows a list of devices for which AirID stores connection information. The connection information can be deleted by deleting the device from the list.
A right click on the AirID Central icon in the Windows notification area opens a menu with the following application functions: Screenshot - Reestablish - opens the AirID Central App window in the foreground.
- Settings -
- System Log - displays a log of the system log entries that you can use to track activities and processes.
- Bridge - Displays the ONEKEY Bridge and the settings you can do.
- Change PIN - PIN change function for the inserted smart card
- About - Shows the AirID Central version and the developer information
- Close - Closes the AirID Central App
iOSUnder iOS system-wide support of smart cards and card readers is not possible. Therefore, the AirID driver needs to be integrated into an app to use AirID with this specific app. These apps usually interact with the available AirID Central App via extension or keychain. Note |
---|
The AirID Central App is available in the App Store. |
The connection to the the iOS device is only active when the app in foreground is open. As soon as the app goes into the background, the Bluetooth connection to the AirID is released again. Pairing- Go to the App Store on your iOS device and search for AirID Central
- Install the AirID Central App on your iOS device
- Insert your smart card to power on the AirID reader
- Activate Bluetooth at the AirID reader by navigating to the connection menu and pressing the jog dial control element. The AirID should display:
- Make sure that Bluetooth is activated on your iOS device (Settings > Bluetooth > On)
- Open the AirID Central App
- Select the AirID (serial number) in the shown device list
- Compare the 6 digit pairing code shown on AirID display and confirm it to connect
- After a successful pairing, the AirID shows:
Note |
---|
If you already paired AirID with another device, please navigate to "Prefer Device" in the AirID menu press the jog-dial and choose "New". Then press the jog-dial again to confirm. |
Technical SpecificationItem | AirID2 | AirID 1 |
---|
First Release | September 2018 | November 2014 | Certification | RoHS, CE, FCC | RoHS, CE, FCC | Enclosure |
---|
Shape | rectangular plus Bumper | rectangular | Dimension | 90 x 60 x 9 mm (plus Bumper) | 90 x 60 x 9 mm
| Bumper | utilizable | n/a | Weight in g | 48 | 48 | Orientation of hanger | 4 (with bumper) | 1 | Human interface |
---|
Display type | LCD, 132x32 | LCD, 132x32 | Display size | ca. 9 x 30 mm | ca. 9 x 30 mm | Control element | Jog Dial (up/down/enter) | Jog Dial (up/down/enter) | USB port | USB-2.0-Micro-B | USB-2.0-Micro-B | LED visible | 2 LEDs red: on while charging blue: on while smart card powered on | 3 LEDs red battery low, please charge AirID red and blue battery is charging blue and green battery is fully charged | Acoustic feedback | Buzzer | Buzzer | Bluetooth |
---|
Bluetooth Version | 4.2 | 4.0 LE (Low Energy)
| Battery |
---|
Battery type | Built-in rechargeable lithium-polymer battery | Built-in rechargeable lithium-polymer battery | Battery size and weight | 4.5 x 24.0 x 41.5 mm, 8g | 4.5 x 24.0 x 41.5 mm, 8g | Capacity | 340mAh | 325 mAh | Battery charging | via USB | via USB | Smart card interface |
|
|
---|
smart card size | ID1, contact interface (ISO7816) | ID1, contact interface (ISO7816) | smart card type | 3V | 5V, 3V, 1,8V
| Smart chip protocol | T=0, T=1 | T=0, T=1 | Smart chip header number | 2 | 1 | Smart chip header type | 8 pins (MCD-7A6SC01-R), 6 pins (2286237-1,TE Connectivity) ;5 pins connected | 8 pins (MCD-7A6SC01-R), 6 pins (2286237-1,TE Connectivity) ;5 pins connected | Using chip-backsided printed cards | X | X | Using chip-sided printed cards | X | _ | NFC function of card usable | X | X | Update |
---|
Firmware update | via USB | via USB |
Warranty/ License/ Technical SupportPlease note our regulations at Terms and Conditions & Legal Documents Please note that only customer with a valid support and maintance agreement are authorized to get free support services.
|