💚 fixes ci and repo structure (#5)

Author: acarrou

.github/workflows/ci.yml

@@ -17,6 +17,10 @@ name: ✅ CI
 on:
   workflow_dispatch:
   pull_request:
+  release:
+    types:
+      - published
+      - deleted
   push:
     branches:
       - main
@@ -25,26 +29,24 @@ on:
 
 jobs:
   ci:
-    uses: libhal/ci/.github/workflows/library.yml@3.0.3
-    with:
-      coverage: true
+    uses: libhal/ci/.github/workflows/library.yml@4.x.y
     secrets: inherit
   deploy:
-    uses: libhal/ci/.github/workflows/deploy.yml@3.0.3
+    uses: libhal/ci/.github/workflows/deploy.yml@4.x.y
     secrets: inherit
   build_lpc4074:
-    uses: libhal/ci/.github/workflows/demo_builder.yml@3.0.3
+    uses: libhal/ci/.github/workflows/demo_builder.yml@4.x.y
     with:
       profile: lpc4074
       processor_profile: https://github.com/libhal/libhal-armcortex.git
       platform_profile: https://github.com/libhal/libhal-lpc40.git
     secrets: inherit
   build_lpc4078:
-    uses: libhal/ci/.github/workflows/demo_builder.yml@3.0.3
+    uses: libhal/ci/.github/workflows/demo_builder.yml@4.x.y
     with:
       profile: lpc4078
       processor_profile: https://github.com/libhal/libhal-armcortex.git
       platform_profile: https://github.com/libhal/libhal-lpc40.git
     secrets: inherit
 
-  # Add more build_<platform> blocks below for each platform you support
+  # Add more build_<platform> blocks below for each platform you support

.gitignore

@@ -41,3 +41,4 @@ archives/
 # Artifacts
 build/
 CMakeUserPresets.json
+*.DS_Store

README.md

@@ -6,8 +6,6 @@
 [![GitHub stars](https://img.shields.io/github/stars/libhal/libhal-icm.svg)](https://github.com/libhal/libhal-icm/stargazers)
 [![GitHub forks](https://img.shields.io/github/forks/libhal/libhal-icm.svg)](https://github.com/libhal/libhal-icm/network)
 [![GitHub issues](https://img.shields.io/github/issues/libhal/libhal-icm.svg)](https://github.com/libhal/libhal-icm/issues)
-[![Latest Version](https://libhal.github.io/libhal-icm/latest_version.svg)](https://github.com/libhal/libhal-icm/blob/main/conanfile.py)
-[![ConanCenter Version](https://repology.org/badge/version-for-repo/conancenter/libhal-icm.svg)](https://conan.io/center/libhal-icm)
 
 libhal compatible device library for the icm device.
 
@@ -24,3 +22,80 @@ Apache 2.0; see [`LICENSE`](LICENSE) for details.
 This project is not an official Google project. It is not supported by
 Google and Google specifically disclaims all warranties as to its quality,
 merchantability, or fitness for a particular purpose.
+
+## About the libhal-device template
+
+The libhal-__device__ repository is a template for creating device libraries in
+the libhal ecosystem. It provides a structured layout and a set of files to help
+you get started with creating your own device library.
+
+## .github/workflows
+
+This directory contains GitHub Actions workflow files for continuous integration
+(CI) and other automated tasks. The workflows currently included are:
+
+- `ci.yml`: This workflow runs the CI pipeline, which includes
+  building the project, running tests, and deploying the library to the
+  `libhal-trunk` package repository.
+- `take.yml`: This workflow is responsible for the "take" action, which assigns
+  commits to
+- `update_name.yml`: This workflow updates the name of the repository when it's
+  used as a template for a new repository.
+
+## conanfile.py
+
+This is a [Conan](https://conan.io/) recipe file. Conan is a package manager for
+C and C++ that helps manage dependencies in your project. This file defines how
+Conan should build your project and its dependencies.
+
+## datasheets
+
+This directory is intended for storing datasheets related to the device that the
+library is being built for. It currently contains a placeholder file,
+`put_datasheets_here.md`.
+
+Many datasheets are subject to copyright and that must be considered when adding
+the datasheet to a libhal repo. If the datasheet cannot be redistributed on the
+repo for copyright and/or license reasons, then a markdown file with a link to
+the datasheet (and potentially mirrors of it) is an acceptable alternative.
+
+## demos
+
+This directory contains demonstration applications showing how to use the device
+library. It includes:
+
+- `applications/icm20948.cpp`: A sample application demonstrating usage of the
+  device library.
+- `hardware_map.hpp`: A header file defining the hardware map for the demo
+  applications.
+- `main.cpp`: The main entry point for the demo applications.
+- `platforms/lpc4074.cpp` and `platforms/lpc4078.cpp`: Platform-specific
+  implementations for the demo applications.
+
+## include/libhal-mpl
+
+This directory contains the header files for the device library. It currently
+includes `icm.hpp`, which is a placeholder for the main header file of
+your device library.
+
+## src
+
+This directory contains the source files for the device library. It currently
+includes `icm.cpp`, which is a placeholder for the main source file of
+your device library.
+
+## test_package
+
+This directory contains a test package for the Conan recipe. It includes a
+simple application that uses the device library, which helps verify that the
+Conan recipe is working correctly.
+
+## tests
+
+This directory contains tests for the device library. It includes:
+
+- `icm.test.cpp`: A placeholder for tests for the device library.
+- `main.test.cpp`: The main entry point for the tests.
+
+Remember to replace all instances of `icm` with the actual name of the
+device that your library is being built for.

conanfile.py

@@ -20,7 +20,7 @@
 import os
 
 
-required_conan_version = ">=1.50.0"
+required_conan_version = ">=2.0.6"
 
 
 class libhal_icm_conan(ConanFile):
@@ -29,7 +29,7 @@ class libhal_icm_conan(ConanFile):
     license = "Apache-2.0"
     url = "https://github.com/conan-io/conan-center-index"
     homepage = "https://github.com/libhal/libhal-icm"
-    description = ("A collection of drivers for the icm")
+    description = ("A collection of drivers for the icm series IMU devices")
     topics = ("icm", "libhal", "driver")
     settings = "compiler", "build_type", "os", "arch"
     exports_sources = ("include/*", "tests/*", "LICENSE", "CMakeLists.txt",
@@ -58,7 +58,7 @@ def validate(self):
 
     def build_requirements(self):
         self.tool_requires("cmake/3.27.1")
-        self.tool_requires("libhal-cmake-util/1.0.0")
+        self.tool_requires("libhal-cmake-util/3.0.0")
         self.test_requires("libhal-mock/[^2.0.0]")
         self.test_requires("boost-ext-ut/1.1.9")
 

datasheets/DS-000189-ICM-20948-v1.3.pdf

@@ -12,11 +12,26 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "../hardware_map.hpp"
+#include <cmath>
+
 #include <libhal-icm/icm20948.hpp>
 #include <libhal-util/serial.hpp>
 #include <libhal-util/steady_clock.hpp>
 
+#include "../hardware_map.hpp"
+
+float compute_heading(float x, float y, float offset = 0.0)
+{
+  float angle = 360 - (atan2(y, x) * (180.0 / std::numbers::pi));
+  angle += offset;  // Apply offset
+  if (angle < 0) {
+    angle += 360;
+  } else if (angle >= 360) {
+    angle -= 360;
+  }
+  return angle;
+}
+
 hal::status application(hardware_map& p_map)
 {
   using namespace std::chrono_literals;
@@ -27,32 +42,33 @@ hal::status application(hardware_map& p_map)
   auto& i2c = *p_map.i2c;
 
   hal::print(console, "icm Application Starting...\n\n");
-  (void)hal::delay(clock, 200ms);
-  auto icm_device = HAL_CHECK(hal::icm::icm20948::create(i2c, 0x69));
-  (void)hal::delay(clock, 200ms);
-  icm_device.auto_offsets();
-  (void)hal::delay(clock, 100ms);
+  hal::delay(clock, 200ms);
+  auto icm_device = HAL_CHECK(hal::icm::icm20948::create(i2c));
 
+  hal::delay(clock, 200ms);
+  icm_device.init_mag();
+  hal::delay(clock, 100ms);
+
+  icm_device.auto_offsets();
 
   while (true) {
-    hal::print(console, "\n\n================Reading IMU================\n");
 
-    (void)hal::delay(clock, 500ms);
     auto accel = HAL_CHECK(icm_device.read_acceleration());
-    (void)hal::delay(clock, 10ms);
+    hal::delay(clock, 10ms);
     auto gyro = HAL_CHECK(icm_device.read_gyroscope());
-    (void)hal::delay(clock, 10ms);
+    hal::delay(clock, 10ms);
     auto temp = HAL_CHECK(icm_device.read_temperature());
-    (void)hal::delay(clock, 10ms);
-
+    hal::delay(clock, 10ms);
+    auto mag = HAL_CHECK(icm_device.read_magnetometer());
+    hal::delay(clock, 10ms);
+    hal::print(console, "\n\n================Reading IMU================\n");
 
     hal::print<128>(console,
                     "\n\nG-Accel Values:    x = %fg, y = %fg, z = %fg",
                     accel.x,
                     accel.y,
                     accel.z);
 
-
     hal::print<128>(console,
                     "\n\nGyro Values:       x = %f,  y = %f,  z = %f",
                     gyro.x,
@@ -61,6 +77,15 @@ hal::status application(hardware_map& p_map)
 
     hal::print<128>(console, "\n\nCurrent Temperature: %f°C", temp.temp);
 
+    hal::print<128>(console,
+                    "\n\nMagnetometer Values: x = %f, y = %f, z = %f",
+                    mag.x,
+                    mag.y,
+                    mag.z);
+
+    float heading = compute_heading(mag.x, mag.y, 0.0);
+    hal::print<128>(console, "\n\nHeading: %f°", heading);
+
     hal::print(console, "\n\n===========================================\n");
   }
   return hal::success();

datasheets/put_datasheets_here.md

@@ -24,7 +24,7 @@ class demos(ConanFile):
 
     def build_requirements(self):
         self.tool_requires("cmake/3.27.1")
-        self.tool_requires("libhal-cmake-util/1.0.0")
+        self.tool_requires("libhal-cmake-util/3.0.0")
 
     def requirements(self):
         if str(self.options.platform).startswith("lpc40"):