removed unused constant

Cargo.toml

@@ -2,12 +2,19 @@
 name = "mmc56x3"
 version = "0.1.0"
 edition = "2024"
+license = "Apache-2.0"
+description = "Driver for the MMC56x3"
+readme = "README.md"
+repository = "https://git.kapelle.org/niklas/mmc56x3-rust"
+homepage = "https://git.kapelle.org/niklas/mmc56x3-rust"
+keywords = ["no_std", "embedded"]
+
 
 [dependencies]
 embedded-hal-async = { version = "1.0.0" }
 maybe-async = { version = "0.2.10" }
 embedded-hal = { version = "1.0.0", optional = true }
-bitflags = { version = "2.10.0", default-features = false }
+bitflags = { version = "2.10.0" }
 
 
 [features]

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -5,3 +5,4 @@ Based on the [arduino driver](https://github.com/adafruit/Adafruit_MMC56x3).
 # Usage 
 
 See [examples](./example). Also make sure to check the [datasheet](https://cdn-learn.adafruit.com/assets/assets/000/113/957/original/MMC5603NJ_RevB_7-12-18.pdf).
+If you want to use the synchronous version then enable the sync feature flag.

examples/rp2040_embassy/src/main.rs

@@ -13,11 +13,7 @@ use log::{error, info};
 use mmc56x3::MMC56X3;
 
 #[panic_handler]
-fn panic(info: &core::panic::PanicInfo) -> ! {
-    for _ in 0..20 {
-        error!("PANIC: {info}");
-    }
-    info!("Doing cold boot from panic");
+fn panic(_info: &core::panic::PanicInfo) -> ! {
     embassy_rp::rom_data::reset_to_usb_boot(0, 0);
 
     loop {}
@@ -43,33 +39,44 @@ async fn main(spawner: Spawner) {
     let sda = p.PIN_4;
     let scl = p.PIN_5;
 
-    let i2c = I2c::new_async(p.I2C0, scl, sda, Irqs, i2c::Config::default());
+    let i2c = I2c::new_blocking(p.I2C0, scl, sda, i2c::Config::default());
 
     let mut device = MMC56X3::new(i2c, Delay);
-    device.init().await.expect("Failed to init");
+    if let Err(e) = device.init() {
+        error!("Failed to init {:?}", e);
+        reboot().await;
+    };
 
-    device
-        .set_data_rate(mmc56x3::DataRate::Hz(100))
-        .await
-        .expect("Failed to set data rate");
+    if let Err(e) = device.set_data_rate(mmc56x3::DataRate::Max1000Hz) {
+        error!("Failed to set data rate {:?}", e);
+        reboot().await;
+    }
 
-    device
-        .set_continuous_mode(true)
-        .await
-        .expect("Failed to set continuous mode");
+    if let Err(e) = device.set_continuous_mode(true) {
+        error!("Failed to set_continuous_mode {:?}", e);
+        reboot().await;
+    }
 
-    for _ in 0..20 {
-        Timer::after_secs(1).await;
+    for _ in 0..200 {
+        Timer::after_millis(50).await;
 
         // let result = device.read_temperature().await;
-        // device.trigger_messurement().await.expect("Failed to trigger trigger_messurement");
+        // info!("T: {:?}", result);
+        // device
+        //     .trigger_messurement()
+        //     .await
+        //     .expect("Failed to trigger trigger_messurement");
 
-        match device.read_messurement().await {
+        match device.read_messurement() {
             Ok(d) => info!("Got: {:?}", d),
             Err(e) => error!("Error: {:?}", e),
         }
     }
 
+    reboot().await;
+}
+
+async fn reboot() {
     info!("Doing cold boot");
     Timer::after_secs(1).await;
     embassy_rp::rom_data::reset_to_usb_boot(0, 0);

src/lib.rs

@@ -1,13 +1,19 @@
 #![no_std]
 
 #[cfg(feature = "sync")]
-use embedded_hal::i2c::{self};
+use embedded_hal::{
+    delay::DelayNs,
+    i2c::{self},
+};
 
-use embedded_hal_async::delay::DelayNs;
 #[cfg(not(feature = "sync"))]
-use embedded_hal_async::i2c::{self};
+use embedded_hal_async::{
+    delay::DelayNs,
+    i2c::{self},
+};
 
 use bitflags::bitflags;
+use maybe_async::maybe_async;
 
 const REG_OUT_START: u8 = 0x00;
 
@@ -21,8 +27,6 @@ const REG_PRODUCT_ID: u8 = 0x39;
 
 const DEFAULT_ADDRESS: u8 = 0x30;
 
-const DEVICE_ID: u8 = 0x10;
-
 bitflags! {
     /// Flags for status_1 register
     #[derive(Debug, Clone, Copy, PartialEq, Eq)]
@@ -168,6 +172,13 @@ pub struct MagneticMessurement {
     pub z: f32,
 }
 
+impl MagneticMessurement {
+    /// Convert the µT from the measurement to Gaus. It's just x0.01.
+    pub fn convert_micro_tesla_to_gaus(tesla: f32) -> f32 {
+        tesla * 0.01
+    }
+}
+
 /// At what rate to output data
 pub enum DataRate {
     Unset,
@@ -234,6 +245,7 @@ where
     data_rate: DataRate,
 }
 
+#[maybe_async]
 impl<I, D> MMC56X3<I, D>
 where
     I: i2c::I2c,
@@ -250,6 +262,7 @@ where
         }
     }
 
+    #[maybe_async]
     pub async fn init(&mut self) -> Result<(), Error<I::Error>> {
         self.reset().await?;
 
@@ -257,6 +270,7 @@ where
     }
 
     /// Resets the sensor to an initial state
+    #[maybe_async]
     pub async fn reset(&mut self) -> Result<(), Error<I::Error>> {
         self.write_reg_controll_1(Control1RegisterFlags::SW_RESET)
             .await?;
@@ -269,10 +283,15 @@ where
         self.magnet_set_reset().await?;
         self.set_continuous_mode(false).await?;
 
+        // According to the datasheet this is recommended to
+        // be set to true
+        self.set_auto_set_reset(true).await?;
+
         Ok(())
     }
 
     /// Pulse large currents through the sense coils to clear any offset
+    #[maybe_async]
     pub async fn magnet_set_reset(&mut self) -> Result<(), Error<I::Error>> {
         self.write_reg_controll_0(self.ctrl0 | Control0RegisterFlags::DO_SET)
             .await?;
@@ -289,12 +308,12 @@ where
         Ok(())
     }
 
+    #[maybe_async]
     pub async fn set_continuous_mode(&mut self, enable: bool) -> Result<(), Error<I::Error>> {
-        if matches!(self.data_rate, DataRate::Unset) {
-            return Err(Error::NoDataRateSet);
-        }
-
         if enable {
+            if matches!(self.data_rate, DataRate::Unset) {
+                return Err(Error::NoDataRateSet);
+            }
             self.write_reg_controll_0(self.ctrl0 | Control0RegisterFlags::CMM_FRE_EN)
                 .await?;
 
@@ -313,6 +332,7 @@ where
         self.ctrl2.contains(Control2RegisterFlags::CMM_EN)
     }
 
+    #[maybe_async]
     pub async fn set_data_rate(&mut self, rate: DataRate) -> Result<(), Error<I::Error>> {
         match rate {
             DataRate::Hz(hz) => {
@@ -342,11 +362,22 @@ where
     /// Set the bandwidth selection bits to adjust the length of the decimation filter. They control the duration
     /// of each measurement. They also impacts the maximum data rate.
     #[inline]
+    #[maybe_async]
     pub async fn set_bandwidth(&mut self, bandwidth: Bandwidth) -> Result<(), Error<I::Error>> {
         self.write_reg_controll_1(bandwidth.to_flags()).await
     }
 
+    /// Enable or disable the automatic set/reset. This also impacts the maximum data rate.
+    #[maybe_async]
+    pub async fn set_auto_set_reset(&mut self, enable: bool) -> Result<(), Error<I::Error>> {
+        self.ctrl0
+            .set(Control0RegisterFlags::AUTO_SET_RESET_EN, enable);
+        self.write_reg_controll_0(self.ctrl0).await?;
+        Ok(())
+    }
+
     /// Read temperature in Celcius with steps of 0.8 C
+    #[maybe_async]
     pub async fn read_temperature(&mut self) -> Result<f32, Error<I::Error>> {
         if self.is_continuous_mode() {
             return Err(Error::NotAvailableInContinuousMode);
@@ -367,6 +398,7 @@ where
     }
 
     /// Read the last measurement
+    #[maybe_async]
     pub async fn read_messurement(&mut self) -> Result<MagneticMessurement, Error<I::Error>> {
         let mut data = [0u8; 9];
         self.read_registers(REG_OUT_START, &mut data).await?;
@@ -393,6 +425,7 @@ where
 
     /// Trigger a new measurement if not in continuous mode.
     /// Waits for the measurement to complete.
+    #[maybe_async]
     pub async fn trigger_messurement(&mut self) -> Result<(), Error<I::Error>> {
         self.write_reg_controll_0(self.ctrl0 | Control0RegisterFlags::TAKE_MESSUREMENT_M)
             .await?;
@@ -402,10 +435,12 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     pub async fn read_product_id(&mut self) -> Result<u8, Error<I::Error>> {
         self.read_register(REG_PRODUCT_ID).await
     }
 
+    #[maybe_async]
     async fn wait_for_status_flag(
         &mut self,
         flag: StatusRegisterFlags,
@@ -422,11 +457,13 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn read_reg_temperature(&mut self) -> Result<u8, Error<I::Error>> {
         self.read_register(REG_TOUT).await
     }
 
     #[inline]
+    #[maybe_async]
     async fn read_reg_status(&mut self) -> Result<StatusRegisterFlags, Error<I::Error>> {
         Ok(StatusRegisterFlags::from_bits_truncate(
             self.read_register(REG_STATUS1).await?,
@@ -434,11 +471,13 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn write_reg_odr(&mut self, data: u8) -> Result<(), Error<I::Error>> {
         self.write_register(REG_ODR, data).await
     }
 
     #[inline]
+    #[maybe_async]
     async fn write_reg_controll_0(
         &mut self,
         value: Control0RegisterFlags,
@@ -447,6 +486,7 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn write_reg_controll_1(
         &mut self,
         value: Control1RegisterFlags,
@@ -455,6 +495,7 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn write_reg_controll_2(
         &mut self,
         value: Control2RegisterFlags,
@@ -463,11 +504,13 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn write_register(&mut self, reg: u8, value: u8) -> Result<(), Error<I::Error>> {
         self.i2c.write(DEFAULT_ADDRESS, &[reg, value]).await?;
         Ok(())
     }
 
+    #[maybe_async]
     async fn read_register(&mut self, reg: u8) -> Result<u8, Error<I::Error>> {
         let mut data = [0u8; 1];
         self.i2c
@@ -477,6 +520,7 @@ where
     }
 
     #[inline]
+    #[maybe_async]
     async fn read_registers(&mut self, reg: u8, buffer: &mut [u8]) -> Result<(), Error<I::Error>> {
         self.i2c.write_read(DEFAULT_ADDRESS, &[reg], buffer).await?;
         Ok(())