README.md

libhal-sensor

libhal compatible device library for the sensor family of devices.

🏗️ Building Demos

To build demos, start at the root of the repo and execute the following command:

conan build demos -pr lpc4078 -pr arm-gcc-12.3

or for the lpc4074

conan build demos -pr lpc4074 -pr arm-gcc-12.3

or for the stm32f103c8

conan build demos -pr stm32f103c8 -pr arm-gcc-12.3

📦 Building The Library Package Demos

To build demos, start at the root of the repo and execute the following command:

conan create . -pr lpc4078 -pr arm-gcc-12.3 --version=latest

To compile the package for the stm32f103c8 or lpc4074, simply replace the lpc4078 profile with the appropriate profile name. For example:

conan create . -pr stm32f103c8 -pr arm-gcc-12.3 --version=latest

Note

If you are developing the code, and simply need to test that it builds and that tests pass, use conan build . vs conan create .. This will build the package locally in the current directory. You'll find the contents in the build/ directory at the root of the repo. Now links will point to the code in the repo and NOT the conan package directory.

📋 Adding libhal-sensor to your project

Add the following to your requirements() method within your application or library's conanfile.py:

    def requirements(self):
        self.requires("libhal-sensor/[^1.0.0]")

Replace version 1.0.0 with the desired version of the library.

Assuming you are using CMake, you'll need to find and link the package to your executable:

find_package(libhal-sensor REQUIRED CONFIG)
target_link_libraries(app.elf PRIVATE libhal::sensor)

Replace app.elf with the name of your executable.

The available headers for your app or library will exist in the include/libhal-sensor/ directory.

Contributing

See CONTRIBUTING.md for details.

License

Apache 2.0; see LICENSE for details.