Installation of HID Crescendo® SDK

System Requirements

Supported Platforms

  • Windows: Windows 10 or later

  • macOS: macOS 12 (Monterey) or later

Hardware Requirements

  • A minimum of 4 GB of RAM

  • A built-in or external smart card reader (for HID Crescendo smart card devices)

  • An available USB-A or USB-C port (for HID Crescendo Key devices)

Software Requirements

Windows

  • .NET 8.0 Runtime (for CLI Tool) or SDK (for API integration)

    Click here to download .NET 8.0.

macOS

  • No additional runtime is required. The macOS distribution includes all necessary .NET runtime components.

    For API integration, install .NET 8.0 SDK separately if needed.

Install HID Crescendo® SDK

Installing the tool is straightforward and does not require any executable installer or administrative user rights to run.

Windows Installation

To install Crescendo SDK:

  1. Download the Crescendo SDK.

  2. After downloading, copy the compressed folder (.zip) to your preferred location.

  3. Extract ("unzip", or "decompress") the folder using the Windows Explorer by right-clicking on the file and choosing "Extract All…" or by using the decompression tool of your choice.

  4. The extracted folder contains:

    • CLI Tool: Command-line interface executable

    • SDK API: DLL files for C# API integration

    • Examples: Sample code demonstrating the usage of the SDK

    • LEGAL: License and legal documentation

macOS Installation

  1. Download the Crescendo SDK.

  2. After downloading, copy the compressed folder (.zip) to your preferred location.

  3. The extracted folder contains:

    • A .pkg installer (recommended)

    • A folder structure identical to Windows (alternative manual installation) with:

      • CLI Tool: Command-line interface executable

      • -SDK API: DLL files for C# API integration

      • Examples: Sample code demonstrating the usage of the SDK

      • LEGAL: License and legal documentation

You can now choose to use the CLI Tool in the same way as on Windows, or run the .pkg installer for a more integrated setup.

Package Installer (Recommended)

  1. Double-click the .pkg file to launch the installer,

    • Or use Terminal: sudo installer -pkg Crescendo_SDK_x.x.x-macos.pkg -target /.

  2. Follow the on-screen prompts and enter your password when requested.

The installer:

  • Installs all SDK components to /usr/local/crescendo-sdk/.

  • Creates a symlink to make the crescendo-cli command available system-wide.

  • Verifies code signatures and sets proper permissions.

Uninstall HID Crescendo® SDK

Windows

  1. Delete the extracted SDK folder.

  2. If you added the CLI Tool to PATH, remove the entry from your environment variables.

macOS

Manual Installation

  1. Delete the extracted SDK folder.

  2. If you created a symlink for the CLI Tool, remove it.

Installation Using the Package Installer

Run the uninstallation script with administrative privileges:

Copy 
sudo /usr/local/crescendo-sdk/uninstall.sh

This script removes all installed files and symlinks created during installation.