Added Super /Mega Linter

.github/workflows/mega-linter.yml

@@ -0,0 +1,175 @@
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+---
+  name: MegaLinter
+
+  # Trigger mega-linter at every push. Action will also be visible from Pull
+  # Requests to main
+  on: # yamllint disable-line rule:truthy - false positive
+    # Comment this line to trigger action only on pull-requests
+    # (not recommended if you don't pay for GH Actions)
+    push:
+
+    pull_request:
+      branches:
+        - main
+        - master
+
+  # Comment env block if you do not want to apply fixes
+  env:
+    # Apply linter fixes configuration
+    #
+    # When active, APPLY_FIXES must also be defined as environment variable
+    # (in github/workflows/mega-linter.yml or other CI tool)
+    APPLY_FIXES: all
+
+    # Decide which event triggers application of fixes in a commit or a PR
+    # (pull_request, push, all)
+    APPLY_FIXES_EVENT: pull_request
+
+    # If APPLY_FIXES is used, defines if the fixes are directly committed (commit)
+    # or posted in a PR (pull_request)
+    APPLY_FIXES_MODE: commit
+
+  concurrency:
+    group: ${{ github.ref }}-${{ github.workflow }}
+    cancel-in-progress: true
+
+  permissions: {}
+
+  jobs:
+    megalinter:
+      name: MegaLinter
+      runs-on: ubuntu-latest
+
+      # Give the default GITHUB_TOKEN write permission to commit and push, comment
+      # issues & post new PR; remove the ones you do not need
+      permissions:
+        contents: write
+        issues: write
+        pull-requests: write
+
+      steps:
+        # Git Checkout
+        - name: Checkout Code
+          uses: actions/checkout@v4
+          with:
+            token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+            # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to
+            # improve performance
+            fetch-depth: 0
+
+        # MegaLinter
+        - name: MegaLinter
+
+          # You can override MegaLinter flavor used to have faster performances
+          # More info at https://megalinter.io/latest/flavors/
+          uses: oxsecurity/megalinter@v8
+
+          id: ml
+
+          # All available variables are described in documentation
+          # https://megalinter.io/latest/configuration/
+          env:
+            # Validates all source when push on main, else just the git diff with
+            # main. Override with true if you always want to lint all sources
+            #
+            # To validate the entire codebase, set to:
+            # VALIDATE_ALL_CODEBASE: true
+            #
+            # To validate only diff with main, set to:
+            # VALIDATE_ALL_CODEBASE: >-
+            #   ${{
+            #     github.event_name == 'push' &&
+            #     contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
+            #   }}
+            VALIDATE_ALL_CODEBASE: >-
+              ${{
+                github.event_name == 'push' &&
+                contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref)
+              }}
+
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+            # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE
+            # .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
+
+            # Uncomment to disable copy-paste and spell checks
+            # DISABLE: COPYPASTE,SPELL
+
+        # Upload MegaLinter artifacts
+        - name: Archive production artifacts
+          if: success() || failure()
+          uses: actions/upload-artifact@v4
+          with:
+            name: MegaLinter reports
+            path: |
+              megalinter-reports
+              mega-linter.log
+
+        # Set APPLY_FIXES_IF var for use in future steps
+        - name: Set APPLY_FIXES_IF var
+          run: |
+            printf 'APPLY_FIXES_IF=%s\n' "${{
+              steps.ml.outputs.has_updated_sources == 1 &&
+              (
+                env.APPLY_FIXES_EVENT == 'all' ||
+                env.APPLY_FIXES_EVENT == github.event_name
+              ) &&
+              (
+                github.event_name == 'push' ||
+                github.event.pull_request.head.repo.full_name == github.repository
+              )
+            }}" >> "${GITHUB_ENV}"
+
+        # Set APPLY_FIXES_IF_* vars for use in future steps
+        - name: Set APPLY_FIXES_IF_* vars
+          run: |
+            printf 'APPLY_FIXES_IF_PR=%s\n' "${{
+              env.APPLY_FIXES_IF == 'true' &&
+              env.APPLY_FIXES_MODE == 'pull_request'
+            }}" >> "${GITHUB_ENV}"
+            printf 'APPLY_FIXES_IF_COMMIT=%s\n' "${{
+              env.APPLY_FIXES_IF == 'true' &&
+              env.APPLY_FIXES_MODE == 'commit' &&
+              (!contains(fromJSON('["refs/heads/main", "refs/heads/master"]'), github.ref))
+            }}" >> "${GITHUB_ENV}"
+
+        # Create pull request if applicable
+        # (for now works only on PR from same repository, not from forks)
+        - name: Create Pull Request with applied fixes
+          uses: peter-evans/create-pull-request@v6
+          id: cpr
+          if: env.APPLY_FIXES_IF_PR == 'true'
+          with:
+            token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+            commit-message: "[MegaLinter] Apply linters automatic fixes"
+            title: "[MegaLinter] Apply linters automatic fixes"
+            labels: bot
+
+        - name: Create PR output
+          if: env.APPLY_FIXES_IF_PR == 'true'
+          run: |
+            echo "PR Number - ${{ steps.cpr.outputs.pull-request-number }}"
+            echo "PR URL - ${{ steps.cpr.outputs.pull-request-url }}"
+
+        # Push new commit if applicable
+        # (for now works only on PR from same repository, not from forks)
+        - name: Prepare commit
+          if: env.APPLY_FIXES_IF_COMMIT == 'true'
+          run: sudo chown -Rc $UID .git/
+
+        - name: Commit and push applied linter fixes
+          uses: stefanzweifel/git-auto-commit-action@v4
+          if: env.APPLY_FIXES_IF_COMMIT == 'true'
+          with:
+            branch: >-
+              ${{
+                github.event.pull_request.head.ref ||
+                github.head_ref ||
+                github.ref
+              }}
+            commit_message: "[MegaLinter] Apply linters fixes"
+            commit_user_name: megalinter-bot
+            commit_user_email: nicolas.vuillamy@ox.security

.gitignore

@@ -1,5 +1,6 @@
 # Compiled files
 /target/
+utils/target/
 
 # Dependency directories
 Cargo.lock
@@ -13,4 +14,5 @@ Cargo.toml.bkp
 *.rs.bk
 
 # Editor-specific files
-.idea/
+.idea/
+megalinter-reports/

.mega-linter.yml

@@ -0,0 +1,34 @@
+# Configuration file for MegaLinter
+#
+# See all available variables at https://megalinter.io/latest/config-file/ and in
+# linters documentation
+
+# all, none, or list of linter keys
+APPLY_FIXES: all
+
+# If you use ENABLE variable, all other languages/formats/tooling-formats will
+# be disabled by default
+# ENABLE:
+
+# If you use ENABLE_LINTERS variable, all other linters will be disabled by
+# default
+ENABLE_LINTERS:
+- ACTION_ACTIONLINT
+- RUST_CLIPPY
+- MARKDOWN_MARKDOWNLINT
+- MARKDOWN_MARKDOWN_LINK_CHECK
+- MARKDOWN_MARKDOWN_TABLE_FORMATTER
+- YAML_YAMLLINT
+- COPYPASTE_JSCPD
+# DISABLE:
+# - COPYPASTE # Uncomment to disable checks of excessive copy-pastes
+# - SPELL # Uncomment to disable checks of spelling mistakes
+
+SHOW_ELAPSED_TIME: true
+
+FILEIO_REPORTER: false
+
+# Uncomment if you want MegaLinter to detect errors but not block CI to pass
+DISABLE_ERRORS: false
+GITHUB_COMMENT_REPORTER: true
+GITHUB_STATUS_REPORTER: true

README.md

@@ -0,0 +1,81 @@
+# TMAG5273 Rust Driver
+
+[![Linting](https://github.com/dysonltd/tmag5273/actions/workflows/Linting.yaml/badge.svg)](https://github.com/dysonltd/tmag5273/actions/workflows/Linting.yaml)
+
+## Summary
+This is a platform agnostic Rust Driver for the TMAG52732 3 Axis I2C
+Hall effect Sensor by Texas Instruments. The driver is based on the
+[embedded-hal](https://github.com/rust-embedded/embedded-hal) traits.
+For more information it is recommended to look at the docs using `cargo doc`
+## The Device
+
+An extract taken from the [Texas Instruments Datasheet](./docs/tmag5273.pdf):
+
+>The TMAG5273 is a low-power linear 3D Hall-effect
+sensor designed for a wide range of industrial
+and personal electronics applications. This device
+integrates three independent Hall-effect sensors in
+the X, Y, and Z axes. A precision analog signal-chain
+along with an integrated 12-bit ADC digitizes
+the measured analog magnetic field values. The
+I2C interface, while supporting multiple operating
+VCC ranges, ensures seamless data communication
+with low-voltage microcontrollers. The device has an
+integrated temperature sensor available for multiple
+system functions, such as thermal budget check or
+temperature compensation calculation for a given
+magnetic field.The TMAG5273 can be configured through the I2C
+interface to enable any combination of magnetic
+axes and temperature measurements. Additionally,
+the device can be configured to various power
+options (including wake-up and sleep mode) allowing
+designers to optimize system power consumption
+based on their system-level needs. Multiple sensor
+conversion schemes and I2C read frames help
+optimize throughput and accuracy. A dedicated
+INT pin can act as a system interrupt during
+low power wake-up and sleep mode, and can also be used by a
+microcontroller to trigger a new sensor conversion.An integrated
+angle calculation engine (CORDIC)
+provides full 360° angular position information for both
+on-axis and off-axis angle measurement topologies.
+The angle calculation is performed using two
+user-selected magnetic axes. The device features
+magnetic gain and offset correction to mitigate the
+impact of system mechanical error sources.The TMAG5273 is
+offered in four different factory-programmed I2C addresses.
+The device also supports additional I2C addresses through the modification
+of a user-configurable I2C address register. Each
+orderable part can be configured to select one of two
+magnetic field ranges that suits the magnet strength
+and component placement during system calibration.
+
+## Examples
+
+Examples on how to use the driver across multiple platforms can be found [here](./examples/README.md)
+
+## Architecture Diagrams
+
+The rough architecture of the files and directories of the project can be seen in
+the following plantUML diagram.
+
+![System Architecture](./docs/architecture.png)
+
+As an application developer, you will spend most of your time working with the
+TMAG5273 struct outlined in [lib.rs](./src/lib.rs). The device can initialised
+by the `init_default` method and configuration can be done using the methods
+outlined in [config.rs](./src/config.rs). However for fine grained control
+of the device you can set and configure the raw registers outlined in the
+folder [registers](./src/registers/). More information around the code can
+be found using `cargo doc`.
+
+## Helper Utilities
+
+In this repository we also have an internal crate called [utils](./utils/) which contains some simple rust code for using the library on either Raspberry Pi or a Desktop Linux/Mac Machine.
+For more information, please look at the following [README](./utils/README.md).
+
+## Useful Links
+
+- [Embedded Hal](https://docs.rs/embedded-hal/latest/embedded_hal/)
+- [TMAG5273 Breakout Board](https://www.sparkfun.com/products/23880)
+- [FT232H Breakout Board](https://www.adafruit.com/product/2264)