Guide to Integrate Tap2iD Windows SDK
Step-by-step instructions to add the Tap2iD SDK to your Windows application using NuGet and the Credence ID Nexus repository. From prerequisites to first build in minutes.
Prerequisites
Ensure your development environment meets the following requirements before proceeding with the integration.
- VS Visual Studio 2022 β When launching for the first time, install the Windows App SDK workload.
- π§ Minimum Framework: .NET 8.0
- π₯ Minimum OS Version: Windows 11
- πΆ Active internet connection: The network must not be restricted by a firewall that could block downloads or installation.
Recommended Bluetooth Hardware
For reliable Bluetooth connectivity and optimal range, use a compatible USB Bluetooth dongle. The following have been tested and verified by Credence ID:
Add Settings XML to Maven Local Repository
Add the Credence ID Nexus repository to the settings.xml file of your Maven local repository. This enables the SDK packages to be resolved during installation.
Users\(Username)\.m2\settings.xml. If it doesn't exist, download the template or create it manually with the content below.
<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>
Configure Nexus Repository in Visual Studio
Open your existing Windows application (or create a new one) in Visual Studio and configure the Credence ID NuGet package source.
Open NuGet Package Manager
Right-click on your project in the Solution Explorer and select "Manage NuGet Packagesβ¦"
Open Package Source Settings
In the NuGet Package Manager, click the Settings (β) gear icon in the top-right corner.
Add the Credence ID Package Source
Click the "+" button and add the following URL. Keep NuGet.org and Microsoft Visual Studio Offline packages selected too.
https://nexus.credenceid.com/repository/tap2id-sdk-nuget/
Select "All" as Package Source
In the NuGet Package Manager dropdown, select "All" as the active package source so all sources are searched simultaneously.
Add the Tap2iD SDK Dependency
With the Credence ID package source configured, search for and install the Tap2iDSdk package.
Search and Install
In the NuGet Package Manager Browse tab, search for "Tap2iDSdk" and click "Install".
Apply Changes
Review the list of changes in the preview window and click "Apply" to confirm installation.
Accept License
When prompted with the license agreement dialog, click "I Accept" to proceed.
Installation Complete
Wait for the installation to finish. The output window will confirm when the package is successfully installed.
Installed packages
After installation, verify the following packages appear in your project's references: