Installation
This guide covers how to obtain and integrate the TLE92466ED driver library into your project.
Prerequisites
Before installing the driver, ensure you have:
- C++23 Compiler: GCC 13+, Clang 16+, or MSVC 2022+ with
std::expectedsupport - 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
bash
git clone https://github.com/n3b3x/hf-tle92466ed-driver.git
cd hf-tle92466ed-driver
text
Option 2: Copy Files
Copy the following files into your project:
cpp
inc/
βββ tle92466ed.hpp
βββ tle92466ed_spi_interface.hpp
βββ tle92466ed_registers.hpp
src/
βββ tle92466ed.cpp
cpp
Integration Methods
Using CMake
Add the driver as a subdirectory in your CMakeLists.txt:
cmake
add_subdirectory(external/hf-tle92466ed-driver)
target_link_libraries(your_target PRIVATE hf_tle92466ed)
target_include_directories(your_target PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/external/hf-tle92466ed-driver/inc
)
cpp
Using ESP-IDF Component
The driver can be used as an ESP-IDF component. Add it to your components directory:
```cmake
In your main CMakeLists.txt
idf_component_register( SRCS βyour_code.cppβ INCLUDE_DIRS β.β REQUIRES hf_tle92466ed ) ```cpp
Manual Integration
- Copy the driver files to your project
- Add the
inc/directory to your include path -
Include the header:
cpp #include "tle92466ed.hpp"cpp -
Compile with C++23 support:
bash g++ -std=c++23 -I inc/ your_code.cpp src/tle92466ed.cppcpp
Verification
To verify the installation:
-
Include the header in a test file:
cpp #include "tle92466ed.hpp"cpp -
Compile a simple test:
bash g++ -std=c++23 -I inc/ -c src/tle92466ed.cpp -o test.ocpp -
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 β‘οΈ