Skip to content

SDK directories

The SDK contains the following directories:

  • /appnotes: Source code of working example implementations including demo configurations where needed

    • /appnotes/autoread: Use Autoread via BRP to detect card presented to the reader and get its content.
    • /appnotes/brpdriver: Legacy wrapper for the SDK's deprecated predecessor BRPDriver.dll
    • /appnotes/c_sharp: Use BRP Communication Library via C#
    • /appnotes/mempool: Use the memory pool (mempool) object of the BALTECH SDK.
    • /appnotes/reader_update: Implement your own wired upload application to deploy a configuration and/or firmware update via wired USB or RS-232/UART.
    • /appnotes/secure_communication: Set up authenticated and encrypted host-reader communication using AES 128
    • /appnotes/usb_cdc: Access a reader via RS-232/UART or USB-CDC (i.e. virtual COM port)
    • /appnotes/usb_hid: Enumerate and access readers via USB HID
    • /appnotes/vhl_autoread: Access a card in VHL & Autoread operation mode

    Here's how you can try the app notes to get started using the SDK.

  • /bindings: Generated language bindings and code generators for the wrapper functions

    • /bindings/c: C language bindings with the central header file baltech_api.h and Doxygen configuration for wrapper function reference
    • /bindings/python: Python language bindings
      • /bindings/python/baltech_sdk: Python package for the wrapper functions
      • /bindings/python/brp_lib: Python package for the BRP Communication Library
      • /bindings/python/tests: Tests for the Python bindings
    • /bindings/code_generator: Code generators for creating language bindings from the reference manual XML sources

    These files are generated by a code generator. Don't change them manually!

  • /brp_lib: Source code and header files of the (language-agnostic) BRP Communication Library

    • /brp_lib/inc: Header files (/brp_lib/inc/brp_lib.h is the main file to include)
    • /brp_lib/src: Source code
    • /brp_lib/tests: Unit tests for the modules of BRP Communication Library
    • /brp_lib/thirdparty: Third-party open-source code libraries needed to build BRP Communication Library

  • /legacy_wrapper: Windows DLL that wraps brp_lib so it provides a compatible interface to the SDK predecessor BrpDriver.dll (learn more)

    • /legacy_wrapper/inc: Header files of the wrapper. They're the same as in the original BrpDriver package.
    • /legacy_wrapper/src: Wrapper source code that maps the BrpDriver API to the brp_lib API
Title