Guide to Integrate Tap2iD Windows SDK

Prerequisites

• Visual Studio: 2022 (https://visualstudio.microsoft.com/downloads/)
• Minimum Framework : Net8.0
• Minimum OS Version : Windows 11
• Please ensure the PC is connected to Wi-Fi with active internet access.
• Make sure the network is not restricted by a firewall that could block downloads or installation processes.
• To ensure reliable Bluetooth connectivity and optimal range, we recommend using a Bluetooth dongle.

These are the Bluetooth dongles recommended and tested by Credence ID. They have been verified for compatibility and performance with our solutions. Mini BT540 Mini BT542

Step 1: Add setting xml file in Maven Local repository

Add the Nexus repository to the settings.xml file of your maven local repository.

You can create it or download it if it does not exist, you will need to add it in Users\(Username)\.m2\settings.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">

    <profiles>
        <profile>
            <id>nexus</id>
            <repositories>
                <repository>
                    <id>nexus</id>
 		    <name>Nexus Repository</name>
                    <url>https://nexus.credenceid.com/repository/credenceid-sdk-group</url>
                </repository>
            </repositories>
        </profile>
    </profiles>

    <activeProfiles>
        <!-- Activate the profile to use the Nexus repository -->
        <activeProfile>nexus</activeProfile>
    </activeProfiles>
</settings>

Step 2 : Configure Nexus Repository in Visual Studio

Launch a new or existing windows application in which Windows SDK needs to be integrated

Right Click on the project and select "Manage NuGet Packages"

Click on the Settings option

Click on "+" button Configure the NuGet package source in your project adding the path https://nexus.credenceid.com/repository/tap2id-sdk-nuget/.

Make sure to select all "Nuget.org" and "Microsoft Visual Studio Offline" Packages as per the screenshot below:

Select "All" package source.

Step 3: Add the Tap2iD SDK Dependency

• Before installing the Tap2iDSdk dependency, please ensure the device is connected to Wi-Fi with active internet access.
• Make sure the network is not restricted by a firewall that could block downloads or installation processes.

Browse for "Tap2iDSdk" and click on "Install".

Click on "Apply"

Click on " I Accept"

Installation on NuGet Package Tap2iDSdk will be finished

Check the added nuget package in reference of your project

• Tap2iDSdk.x.x.x.nupkg

The following package should automatically be downloaded:

• BluetoothWinUI.x.x.x.nupkg
• BluetoothBumble.x.x.x.nupkg
• Tap2idBluetoothCommon.x.x.x.nupkg
• Logging.x.x.x.nupkg

That's it. Sync the project and now you should be able to access Tap2iD Windows SDK APIs.

Important: If you plan to create and distribute your own installation package for your application, please ensure that the Tap2IdWinSdkSetup is installed prior to deploying your app. This step is critical, as it ensures that all necessary dependencies are properly installed. Omitting this installation may result in application malfunction or limited functionality.