Installation
Overview
Section titled “Overview”The BMC C++ SDK Windows installer sets up the necessary components for the SDK on the system. This includes:
- A dynamic library:
bmc_sdk.dllon Windowslibbmc_sdk.dylibon macOSlibbmc_sdk.soon Linux
- A static library:
bmc_sdk_static.libon Windowslibbmc_sdk_static.aon macOSlibbmc_sdk_static.aon Linux
- Example applications to test the SDK
- Header files for integration (
includedirectory)
Prerequisite
Section titled “Prerequisite”As a prerequisite, the C++ SDK requires having the BinhoMissionControl Bridge (bmcbridge) utility installed and added to the PATH environment variable.
The BinhoMissionControl Bridge, which connects high-level interfaces such as Binho Mission Control to the host adapters, is released separately from the BMC C++ SDK, so that each can be updated on its own.
Windows
Section titled “Windows”- Download BMC Bridge installers:
- BMC Bridge for Windows 32-bit
- BMC Bridge for Windows 64-bit - Once installed, proceed with the following setup instructions:
- The bridge is typically installed in
C:\Program Files (x86)\BinhoMissionControlBridge - Add this path to the system’s PATH environment variable.
- Press
Win + R, typesysdm.cpl, and press Enter. - Go to the Advanced tab, and click on Environment Variables.
- In the System variables section, find the PATH variable, select it, and click Edit.
- Click New and add
C:\Program Files (x86)\BinhoMissionControlBridge
- Press
- To verify the installation, open Command Prompt and execute:
bmcbridge --version
Linux and macOS
Section titled “Linux and macOS”- Download Linux or macOS binaries:
- Bridge macOS binaries for ARM
- Bridge macOS binaries for Intel
- Bridge Linux binaries - Extract the binaries and place the extracted folder in any location.
- Open a Terminal window and navigate to the directory where the binaries were extracted.
- Add the directory to the PATH environment variable so the binaries are found. Edit
~/.zshrc(Zsh) or~/.bashrc(bash on Linux or macOS):
nano ~/.zshrc
or, for Bash:
~/.bashrc - Add the following line at the end of the file:
export PATH=/path/to/your/extracted/folder:$PATH
Replace/path/to/your/extracted/folderwith the actual path to the extracted folder. - Save the file and apply the changes by running:
source ~/.zshrc
or, for Bash users:
source ~/.bashrc - To verify the installation, run the following command in Terminal:
bmcbridge --version
Installation of the C++ SDK
Section titled “Installation of the C++ SDK”Windows
Section titled “Windows”Setup instructions
Section titled “Setup instructions”- Add
C:\Program Files (x86)\BinhoMissionControlSDKto the system’s PATH environment variable.
- Download the Installer:
- BMC C++ SDK for Windows 32-bit
- BMC C++ SDK for Windows 64-bit - Run the Installer: Double-click on the installer and follow the on-screen prompts.
- Installation Directories: By default, the SDK will be installed into the
c:\Program Files (x86)\BinhoMissionControlSDKdirectory. The directory contains:bmc_sdk.dll: The SDK dynamic link library.bmc_sdk_static.lib: The SDK static library.README.md: Read-me file in markdown format for users.examples: A directory containing example applications.include: A directory containing various header files necessary for SDK integration.
- Add to PATH Environment Variable. For the applications to function correctly:
Both thebmcbridgeand the BMC C++ SDK installation directories must be added to the system’s PATH environment variable. - Integration: To integrate the BMC C++ SDK into a project:
- Reference the SDK library using the static or dynamic library files.
- Include necessary headers from the
includedirectory.
- Test the Example Applications: After setting up the PATH, run the example applications in the examples directory.
Linux and macOS
Section titled “Linux and macOS”- Download Linux or macOS binaries:
- BMC C++ Linux binaries
- BMC C++ macOS binaries for ARM
- BMC C++ macOS binaries for Intel - Extract the binaries and place the extracted folder in any location.
- To verify the installation, run the example applications in the examples directory.
Installation Directory Structure
Section titled “Installation Directory Structure”└── BinhoMissionControlSDK ├── bmc_sdk.dll (or lib/libbmc_sdk.dylib on macOS, lib/libbmc_sdk.so on Linux) ├── bmc_sdk_static.lib (or lib/libbmc_sdk_static.a on macOS and Linux) ├── README.md ├── examples │ ├── list_devices │ ├── nova_breathing_leds │ ├── sample_app_using_sample_library │ ├── sample_library │ ├── supernova_101 │ ├── supernova_i2c │ ├── supernova_i2c_benchmark │ ├── i3c_cccs │ ├── i3c_ibis │ ├── i3c_ICM42605 │ ├── ... └── include ├── bridge_reader.h ├── BridgeReader_windows.h ├── CommandDispatcher.h ├── CommandManager.h ├── CommandRequest.h ├── CommandResponse.h └── definitions.h
