Installation

This guide covers how to obtain and integrate the MAX22200 driver library into your project.

Prerequisites

Before installing the driver, ensure you have:

• C++20 Compiler: GCC 10+, Clang 12+, or MSVC 2019+
• Build System: Make, CMake, or ESP-IDF (depending on your platform)
• Platform SDK: ESP-IDF, STM32 HAL, Arduino, or your platform’s SPI driver

Obtaining the Source

Option 1: Git Clone

git clone https://github.com/n3b3x/hf-max22200-driver.git
cd hf-max22200-driver

Option 2: Copy Files

Copy the following files into your project:

inc/
  ├── max22200.hpp
  ├── max22200_spi_interface.hpp
  ├── max22200_registers.hpp
  └── max22200_types.hpp
src/
  └── max22200.cpp

Integration Methods

Using CMake

Add the driver as a subdirectory in your CMakeLists.txt:

add_subdirectory(external/hf-max22200-driver)
target_link_libraries(your_target PRIVATE hf_max22200)
target_include_directories(your_target PRIVATE 
    ${CMAKE_CURRENT_SOURCE_DIR}/external/hf-max22200-driver/inc
)

Using ESP-IDF Component

The driver can be used as an ESP-IDF component. Add it to your components directory:

# In your main CMakeLists.txt
idf_component_register(
    SRCS "your_code.cpp"
    INCLUDE_DIRS "."
    REQUIRES hf_max22200
)

Manual Integration

1. Copy the driver files to your project
2. Add the inc/ directory to your include path
3. Include the header:

   #include "max22200.hpp"
   

4. Compile with C++20 support:

   g++ -std=c++20 -I inc/ your_code.cpp src/max22200.cpp
   

Verification

To verify the installation:

1. Include the header in a test file:

   #include "max22200.hpp"
   

2. Compile a simple test:

   g++ -std=c++20 -I inc/ -c src/max22200.cpp -o test.o
   

3. If compilation succeeds, the library is properly installed.

Next Steps

• Follow the Quick Start guide to create your first application
• Review Hardware Setup for wiring instructions
• Check Platform Integration to implement the SPI interface

---

Navigation ⬅️ Back to Index | Next: Quick Start ➡️