added keywords to cargo toml

Cargo.lock

@@ -3,10 +3,12 @@
 version = 4
 
 [[package]]
-name = "as7265x-rust"
+name = "as7265x"
 version = "0.1.0"
 dependencies = [
  "embedded-hal",
+ "embedded-hal-async",
+ "maybe-async",
 ]
 
 [[package]]
@@ -14,3 +16,58 @@ name = "embedded-hal"
 version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "361a90feb7004eca4019fb28352a9465666b24f840f5c3cddf0ff13920590b89"
+
+[[package]]
+name = "embedded-hal-async"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c4c685bbef7fe13c3c6dd4da26841ed3980ef33e841cddfa15ce8a8fb3f1884"
+dependencies = [
+ "embedded-hal",
+]
+
+[[package]]
+name = "maybe-async"
+version = "0.2.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5cf92c10c7e361d6b99666ec1c6f9805b0bea2c3bd8c78dc6fe98ac5bd78db11"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.103"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.42"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a338cc41d27e6cc6dce6cefc13a0729dfbb81c262b1f519331575dd80ef3067f"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.111"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "390cc9a294ab71bdb1aa2e99d13be9c753cd2d7bd6560c77118597410c4d2e87"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5"

Cargo.toml

@@ -1,7 +1,18 @@
 [package]
-name = "as7265x-rust"
+name = "as7265x"
 version = "0.1.0"
 edition = "2024"
+license = "Apache-2.0"
+description = "Driver for the AS7265x"
+readme = "README.md"
+repository = "https://git.kapelle.org/niklas/as7265x-rust"
+homepage = "https://git.kapelle.org/niklas/as7265x-rust"
+keywords = ["no_std", "embedded"]
 
 [dependencies]
-embedded-hal = "1.0.0"
+embedded-hal-async = { version = "1.0.0" }
+maybe-async = { version = "0.2.10" }
+embedded-hal = { version = "1.0.0", optional = true }
+
+[features]
+sync = ["embedded-hal", "maybe-async/is_sync"]

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

@@ -0,0 +1,10 @@
+A rust driver for the [AS7265x](https://www.sparkfun.com/sparkfun-triad-spectroscopy-sensor-as7265x-qwiic.html) spectral sensor.
+
+Mostly based on the [aurduino driver](https://github.com/sparkfun/SparkFun_AS7265x_Arduino_Library) from SparkFun.
+
+# Usage
+
+See [examples](./examples/).
+Also the [datasheet](https://cdn.sparkfun.com/assets/c/2/9/0/a/AS7265x_Datasheet.pdf) can give some info.
+
+The driver requires a `I2c` device and a `DelayNs` from `embedded-hal-async`. If you want to use the synchronous version then enable the `sync` feature flag. 

examples/esp32c6-async/.cargo/config.toml

@@ -0,0 +1,16 @@
+[target.riscv32imac-unknown-none-elf]
+runner = "espflash flash --monitor --chip esp32c6"
+
+[env]
+
+[build]
+rustflags = [
+  # Required to obtain backtraces (e.g. when using the "esp-backtrace" crate.)
+  # NOTE: May negatively impact performance of produced code
+  "-C", "force-frame-pointers",
+]
+
+target = "riscv32imac-unknown-none-elf"
+
+[unstable]
+build-std = ["core"]

examples/esp32c6-async/.gitignore

@@ -0,0 +1,22 @@
+# will have compiled files and executables
+debug/
+target/
+
+# Editor configuration
+.vscode/
+.zed/
+.helix/
+.nvim.lua
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

examples/esp32c6-async/Cargo.toml

@@ -0,0 +1,39 @@
+[package]
+edition = "2024"
+name = "esp32c6-async"
+rust-version = "1.88"
+version = "0.1.0"
+
+[[bin]]
+name = "esp32c6-async"
+path = "./src/bin/main.rs"
+
+[dependencies]
+esp-hal = { version = "1.0.0", features = ["esp32c6", "unstable"] }
+
+esp-rtos = { version = "0.2.0", features = ["embassy", "esp32c6"] }
+
+esp-bootloader-esp-idf = { version = "0.4.0", features = ["esp32c6"] }
+
+embassy-executor = { version = "0.9.1", features = [] }
+embassy-time = "0.5.0"
+
+critical-section = "1.2.0"
+static_cell = "2.1.1"
+
+as7265x = { path = "../.." }
+esp-println = { version = "0.16.1", features = ["esp32c6"] }
+
+[profile.dev]
+# Rust debug is too slow.
+# For debug builds always builds with some optimization
+opt-level = "s"
+
+[profile.release]
+codegen-units = 1        # LLVM can perform better optimizations using a single thread
+debug = 2
+debug-assertions = false
+incremental = false
+lto = 'fat'
+opt-level = 's'
+overflow-checks = false

examples/esp32c6-async/build.rs

@@ -0,0 +1,56 @@
+fn main() {
+    linker_be_nice();
+    // make sure linkall.x is the last linker script (otherwise might cause problems with flip-link)
+    println!("cargo:rustc-link-arg=-Tlinkall.x");
+}
+
+fn linker_be_nice() {
+    let args: Vec<String> = std::env::args().collect();
+    if args.len() > 1 {
+        let kind = &args[1];
+        let what = &args[2];
+
+        match kind.as_str() {
+            "undefined-symbol" => match what.as_str() {
+                "_defmt_timestamp" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `defmt` not found - make sure `defmt.x` is added as a linker script and you have included `use defmt_rtt as _;`"
+                    );
+                    eprintln!();
+                }
+                "_stack_start" => {
+                    eprintln!();
+                    eprintln!("💡 Is the linker script `linkall.x` missing?");
+                    eprintln!();
+                }
+                "esp_rtos_initialized" | "esp_rtos_yield_task" | "esp_rtos_task_create" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `esp-radio` has no scheduler enabled. Make sure you have initialized `esp-rtos` or provided an external scheduler."
+                    );
+                    eprintln!();
+                }
+                "embedded_test_linker_file_not_added_to_rustflags" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `embedded-test` not found - make sure `embedded-test.x` is added as a linker script for tests"
+                    );
+                    eprintln!();
+                }
+                _ => (),
+            },
+            // we don't have anything helpful for "missing-lib" yet
+            _ => {
+                std::process::exit(1);
+            }
+        }
+
+        std::process::exit(0);
+    }
+
+    println!(
+        "cargo:rustc-link-arg=--error-handling-script={}",
+        std::env::current_exe().unwrap().display()
+    );
+}

examples/esp32c6-async/rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel    = "stable"
+components = ["rust-src"]
+targets = ["riscv32imac-unknown-none-elf"]

examples/esp32c6-async/src/bin/main.rs

@@ -0,0 +1,77 @@
+#![no_std]
+#![no_main]
+#![deny(
+    clippy::mem_forget,
+    reason = "mem::forget is generally not safe to do with esp_hal types, especially those \
+    holding buffers for the duration of a data transfer."
+)]
+
+use as7265x::{AS7265X, AS7265XConfig, Channel};
+use embassy_executor::Spawner;
+use embassy_time::{Delay, Duration, Timer};
+use esp_hal::clock::CpuClock;
+use esp_hal::i2c::master::I2c;
+use esp_hal::timer::timg::TimerGroup;
+use esp_println::println;
+
+#[panic_handler]
+fn panic(_: &core::panic::PanicInfo) -> ! {
+    loop {}
+}
+
+esp_bootloader_esp_idf::esp_app_desc!();
+
+#[esp_rtos::main]
+async fn main(_spawner: Spawner) -> ! {
+    let config = esp_hal::Config::default().with_cpu_clock(CpuClock::max());
+    let peripherals = esp_hal::init(config);
+
+    let timg0 = TimerGroup::new(peripherals.TIMG0);
+    let sw_interrupt =
+        esp_hal::interrupt::software::SoftwareInterruptControl::new(peripherals.SW_INTERRUPT);
+    esp_rtos::start(timg0.timer0, sw_interrupt.software_interrupt0);
+
+    let i2c_config = esp_hal::i2c::master::Config::default();
+    let device: I2c<'_, esp_hal::Async> =
+        esp_hal::i2c::master::I2c::new(peripherals.I2C0, i2c_config)
+            .unwrap()
+            .with_sda(peripherals.GPIO22)
+            .with_scl(peripherals.GPIO23)
+            .into_async();
+
+    let mut as7265x_device = AS7265X::new(device, AS7265XConfig::default(), Delay);
+
+    as7265x_device.init().await.expect("Failed to init device");
+
+    loop {
+        println!("Taking messurment...");
+
+        as7265x_device.mesure_with_bulb().await.unwrap();
+
+        println!(
+            "Channel A: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::A)
+                .await
+                .expect("Failed to read value")
+        );
+
+        println!(
+            "Channel B: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::B)
+                .await
+                .expect("Failed to read value")
+        );
+
+        println!(
+            "Channel F: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::F)
+                .await
+                .expect("Failed to read value")
+        );
+
+        Timer::after(Duration::from_secs(1)).await;
+    }
+}

examples/esp32c6-async/src/lib.rs

@@ -0,0 +1 @@
+#![no_std]

examples/esp32c6-sync/.cargo/config.toml

@@ -0,0 +1,16 @@
+[target.riscv32imac-unknown-none-elf]
+runner = "espflash flash --monitor --chip esp32c6"
+
+[env]
+
+[build]
+rustflags = [
+  # Required to obtain backtraces (e.g. when using the "esp-backtrace" crate.)
+  # NOTE: May negatively impact performance of produced code
+  "-C", "force-frame-pointers",
+]
+
+target = "riscv32imac-unknown-none-elf"
+
+[unstable]
+build-std = ["core"]

examples/esp32c6-sync/.gitignore

@@ -0,0 +1,22 @@
+# will have compiled files and executables
+debug/
+target/
+
+# Editor configuration
+.vscode/
+.zed/
+.helix/
+.nvim.lua
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

examples/esp32c6-sync/Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+edition = "2024"
+name = "esp32c6-sync"
+rust-version = "1.88"
+version = "0.1.0"
+
+[[bin]]
+name = "esp32c6-sync"
+path = "./src/bin/main.rs"
+
+[dependencies]
+esp-hal = { version = "1.0.0", features = ["esp32c6", "unstable"] }
+
+esp-bootloader-esp-idf = { version = "0.4.0", features = ["esp32c6"] }
+
+critical-section = "1.2.0"
+
+as7265x = { path = "../..", features = ["sync"] }
+esp-println = { version = "0.16.1", features = ["esp32c6"] }
+
+
+[profile.dev]
+# Rust debug is too slow.
+# For debug builds always builds with some optimization
+opt-level = "s"
+
+[profile.release]
+codegen-units = 1        # LLVM can perform better optimizations using a single thread
+debug = 2
+debug-assertions = false
+incremental = false
+lto = 'fat'
+opt-level = 's'
+overflow-checks = false

examples/esp32c6-sync/build.rs

@@ -0,0 +1,56 @@
+fn main() {
+    linker_be_nice();
+    // make sure linkall.x is the last linker script (otherwise might cause problems with flip-link)
+    println!("cargo:rustc-link-arg=-Tlinkall.x");
+}
+
+fn linker_be_nice() {
+    let args: Vec<String> = std::env::args().collect();
+    if args.len() > 1 {
+        let kind = &args[1];
+        let what = &args[2];
+
+        match kind.as_str() {
+            "undefined-symbol" => match what.as_str() {
+                "_defmt_timestamp" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `defmt` not found - make sure `defmt.x` is added as a linker script and you have included `use defmt_rtt as _;`"
+                    );
+                    eprintln!();
+                }
+                "_stack_start" => {
+                    eprintln!();
+                    eprintln!("💡 Is the linker script `linkall.x` missing?");
+                    eprintln!();
+                }
+                "esp_rtos_initialized" | "esp_rtos_yield_task" | "esp_rtos_task_create" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `esp-radio` has no scheduler enabled. Make sure you have initialized `esp-rtos` or provided an external scheduler."
+                    );
+                    eprintln!();
+                }
+                "embedded_test_linker_file_not_added_to_rustflags" => {
+                    eprintln!();
+                    eprintln!(
+                        "💡 `embedded-test` not found - make sure `embedded-test.x` is added as a linker script for tests"
+                    );
+                    eprintln!();
+                }
+                _ => (),
+            },
+            // we don't have anything helpful for "missing-lib" yet
+            _ => {
+                std::process::exit(1);
+            }
+        }
+
+        std::process::exit(0);
+    }
+
+    println!(
+        "cargo:rustc-link-arg=--error-handling-script={}",
+        std::env::current_exe().unwrap().display()
+    );
+}

examples/esp32c6-sync/rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel    = "stable"
+components = ["rust-src"]
+targets = ["riscv32imac-unknown-none-elf"]

examples/esp32c6-sync/src/bin/main.rs

@@ -0,0 +1,67 @@
+#![no_std]
+#![no_main]
+#![deny(
+    clippy::mem_forget,
+    reason = "mem::forget is generally not safe to do with esp_hal types, especially those \
+    holding buffers for the duration of a data transfer."
+)]
+
+use esp_println::println;
+use as7265x::{AS7265XConfig, Channel, AS7265X};
+use esp_hal::clock::CpuClock;
+use esp_hal::{i2c, main};
+
+#[panic_handler]
+fn panic(_: &core::panic::PanicInfo) -> ! {
+    loop {}
+}
+
+esp_bootloader_esp_idf::esp_app_desc!();
+
+#[main]
+fn main() -> ! {
+    let config = esp_hal::Config::default().with_cpu_clock(CpuClock::max());
+    let peripherals = esp_hal::init(config);
+
+    let device = esp_hal::i2c::master::I2c::new(peripherals.I2C0, i2c::master::Config::default())
+        .unwrap()
+        .with_sda(peripherals.GPIO22)
+        .with_scl(peripherals.GPIO23);
+
+    let delay = esp_hal::delay::Delay::new();
+
+    let mut as7265x_device = AS7265X::new(device, AS7265XConfig::default(), delay);
+
+    as7265x_device.init().expect("Failed to init");
+
+    loop {
+        println!("Taking messurment...");
+
+        as7265x_device
+            .mesure_with_bulb()
+            .expect("Failed to run messurment");
+
+        println!(
+            "Channel A: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::A)
+                .expect("Failed to read value")
+        );
+
+        println!(
+            "Channel B: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::B)
+                .expect("Failed to read value")
+        );
+
+        println!(
+            "Channel F: {}",
+            as7265x_device
+                .read_calibrated_messurement(Channel::F)
+                .expect("Failed to read value")
+        );
+
+        delay.delay_millis(1000);
+    }
+}

examples/esp32c6-sync/src/lib.rs

@@ -0,0 +1 @@
+#![no_std]

src/lib.rs

@@ -1,10 +1,18 @@
 #![no_std]
 
+#[cfg(feature = "sync")]
 use embedded_hal::{
     delay::DelayNs,
     i2c::{self},
 };
 
+#[cfg(not(feature = "sync"))]
+use embedded_hal_async::{
+    delay::DelayNs,
+    i2c::{self},
+};
+use maybe_async::maybe_async;
+
 const AS7265X_ADDR: u8 = 0x49;
 const STATUS_REG: u8 = 0x00;
 const WRITE_REG: u8 = 0x01;
@@ -80,7 +88,8 @@ pub enum Channel {
 }
 
 impl Channel {
-    pub fn get_device_for_chanel(&self) -> Device {
+    /// Each channel is only read from one of three sensors
+    pub fn get_device_for_channel(&self) -> Device {
         match self {
             Channel::A | Channel::B | Channel::C | Channel::D | Channel::E | Channel::F => {
                 Device::Uv
@@ -94,6 +103,7 @@ impl Channel {
         }
     }
 
+    /// Get the virtual register address for the raw value of the channel
     fn get_raw_address(&self) -> u8 {
         match self {
             Channel::A | Channel::G | Channel::R => 0x08,
@@ -105,12 +115,14 @@ impl Channel {
         }
     }
 
+    /// Get the virtual register address for the calibrated value of the channel
     fn get_cal_address(&self) -> u8 {
         let raw = self.get_raw_address();
         ((raw - 0x08) / 2) * 4 + 0x14
     }
 }
 
+/// The AS7265X has three sensor devices
 #[derive(Debug, Clone, Copy)]
 pub enum Device {
     Visable = 0x00,
@@ -118,6 +130,7 @@ pub enum Device {
     Uv = 0x02,
 }
 
+/// The three main LEDs on the device
 #[derive(Debug, Clone, Copy)]
 pub enum Led {
     White,
@@ -126,6 +139,7 @@ pub enum Led {
 }
 
 impl Led {
+    /// Apparently the LEDs don't match the device the are for
     fn get_device(&self) -> Device {
         match self {
             Led::White => Device::Nir,
@@ -151,7 +165,8 @@ pub enum GainConfig {
 }
 
 impl GainConfig {
-    fn to_bits(self) -> u8 {
+    /// To byte that can be written to the virtual register
+    fn to_byte(self) -> u8 {
         match self {
             GainConfig::Gain1x => 0b00,
             GainConfig::Gain3_7x => 0b01,
@@ -161,7 +176,6 @@ impl GainConfig {
     }
 }
 
-/// Measurement mode options
 #[derive(Debug, Clone, Copy)]
 pub enum MeasurementMode {
     /// 4 channels
@@ -178,7 +192,8 @@ pub enum MeasurementMode {
 }
 
 impl MeasurementMode {
-    fn to_bits(self) -> u8 {
+    /// To byte that can be written to the virtual register
+    fn to_byte(self) -> u8 {
         match self {
             MeasurementMode::Mode0 => 0b00,
             MeasurementMode::Mode1 => 0b01,
@@ -190,60 +205,60 @@ impl MeasurementMode {
 
 #[derive(Debug, Clone)]
 pub struct AS7265XConfig {
+    /// Enable the onboard interrupt pin
     pub enable_interrupt: bool,
     pub gain: GainConfig,
     pub measurement_mode: MeasurementMode,
+    /// Integration time: value * 2.8ms
     pub integration_time: u8,
 }
 
 impl Default for AS7265XConfig {
     fn default() -> Self {
         Self {
-            enable_interrupt: false,
+            enable_interrupt: true,
             gain: GainConfig::Gain64x,
             measurement_mode: MeasurementMode::Mode3OneShot,
-            integration_time: 20,
+            integration_time: 49,
         }
     }
 }
 
 impl AS7265XConfig {
-    fn to_config_byte(&self) -> u8 {
+    /// Convert to byte to write to the config virtual register
+    fn to_byte(&self) -> u8 {
         let mut byte = 0u8;
 
         if self.enable_interrupt {
             byte |= ENABLE_INTERRUPT;
         }
 
-        byte |= (self.gain.to_bits() << CONFIG_GAIN_SHIFT) & CONFIG_GAIN_MASK;
+        byte |= (self.gain.to_byte() << CONFIG_GAIN_SHIFT) & CONFIG_GAIN_MASK;
-        byte |= (self.measurement_mode.to_bits() << CONFIG_BANK_SHIFT) & CONFIG_BANK_MASK;
+        byte |= (self.measurement_mode.to_byte() << CONFIG_BANK_SHIFT) & CONFIG_BANK_MASK;
 
         byte
     }
 }
 
 #[derive(Debug, Clone, Copy)]
-pub enum LedCurrent {
+pub enum LedDriverCurrent {
     /// 12.5 mA
     Ma12_5,
-
     /// 25 mA
     Ma25,
-
     /// 50 mA
     Ma50,
-
     /// 100 mA
     Ma100,
 }
 
-impl LedCurrent {
+impl LedDriverCurrent {
     fn to_bits(self) -> u8 {
         match self {
-            LedCurrent::Ma12_5 => 0b00,
+            LedDriverCurrent::Ma12_5 => 0b00,
-            LedCurrent::Ma25 => 0b01,
+            LedDriverCurrent::Ma25 => 0b01,
-            LedCurrent::Ma50 => 0b10,
+            LedDriverCurrent::Ma50 => 0b10,
-            LedCurrent::Ma100 => 0b11,
+            LedDriverCurrent::Ma100 => 0b11,
         }
     }
 }
@@ -274,13 +289,14 @@ impl LedIndicatorCurrent {
 #[derive(Debug, Clone, Copy)]
 pub struct LedConfig {
     pub drv_enabled: bool,
-    pub drv_current: LedCurrent,
+    pub drv_current: LedDriverCurrent,
     pub ind_enabled: bool,
     pub ind_current: LedIndicatorCurrent,
 }
 
 impl LedConfig {
-    fn config_byte(&self) -> u8 {
+    /// To byte that can be written to the virtual register
+    fn to_byte(self) -> u8 {
         let mut byte = 0u8;
 
         if self.drv_enabled {
@@ -301,7 +317,7 @@ impl Default for LedConfig {
     fn default() -> Self {
         Self {
             drv_enabled: false,
-            drv_current: LedCurrent::Ma12_5,
+            drv_current: LedDriverCurrent::Ma12_5,
             ind_enabled: false,
             ind_current: LedIndicatorCurrent::Ma8,
         }
@@ -320,6 +336,7 @@ impl<E> From<E> for Error<E> {
     }
 }
 
+/// The AS7265X device
 pub struct AS7265X<I, D>
 where
     I: i2c::I2c,
@@ -330,11 +347,13 @@ where
     config: AS7265XConfig,
 }
 
+#[maybe_async]
 impl<I, D> AS7265X<I, D>
 where
     I: i2c::I2c,
     D: DelayNs,
 {
+    /// Create a new AS7265X device
     pub fn new(device: I, config: AS7265XConfig, delay: D) -> Self {
         Self {
             device,
@@ -343,6 +362,10 @@ where
         }
     }
 
+    /// Initialize the device.
+    /// Writes config, integration time and led config.
+    /// Ok to call multiple times & most likly not need but the cpp driver also does this.
+    #[maybe_async]
     pub async fn init(&mut self) -> Result<(), Error<I::Error>> {
         self.write_config().await?;
 
@@ -376,63 +399,84 @@ where
         Ok(())
     }
 
+    /// Perform a soft reset
+    #[maybe_async]
     pub async fn soft_reset(&mut self) -> Result<(), Error<I::Error>> {
         self.write_virtual_register(CONFIG_ADDR, SOFT_RESET).await?;
-        self.delay.delay_ms(100);
+        self.delay.delay_ms(100).await;
         Ok(())
     }
 
+    /// Write the config to the device
+    /// Also need to fire the oneshot mode again
+    #[maybe_async]
     async fn write_config(&mut self) -> Result<(), Error<I::Error>> {
-        let config_byte = self.config.to_config_byte();
+        let config_byte = self.config.to_byte();
         self.write_virtual_register(CONFIG_ADDR, config_byte).await
     }
 
+    /// Sets the integration time value
+    /// value * 2.8ms
+    #[maybe_async]
     pub async fn set_integration_time(&mut self, time: u8) -> Result<(), Error<I::Error>> {
+        self.config.integration_time = time;
         self.write_virtual_register(INTEGRATION_ADDR, time).await
     }
 
+    /// Write the LED specific config
+    #[maybe_async]
     async fn set_led_config(&mut self, led: Led, config: LedConfig) -> Result<(), Error<I::Error>> {
         self.select_device(led.get_device()).await?;
-        let config_byte = config.config_byte();
+        let config_byte = config.to_byte();
         self.write_virtual_register(LED_ADDR, config_byte).await
     }
 
+    /// Get the hardware info from the hw version register
+    #[maybe_async]
     pub async fn get_device_type(&mut self) -> Result<u8, Error<I::Error>> {
         self.read_virtual_register(HW_VERSION_HIGH_ADDR).await
     }
 
+    /// Get the hardware info from the hw version register
+    #[maybe_async]
     pub async fn get_hardware_version(&mut self) -> Result<u8, Error<I::Error>> {
         self.read_virtual_register(HW_VERSION_LOW_ADDR).await
     }
 
-    pub async fn get_firmware_version(&mut self) -> Result<(u8, u8), Error<I::Error>> {
+    /// Alot of function only work if you have the correct device selected
-        let high = self.read_virtual_register(FW_VERSION_HIGH_ADDR).await?;
+    #[maybe_async]
-        let low = self.read_virtual_register(FW_VERSION_LOW_ADDR).await?;
-        Ok((high, low))
-    }
-
     async fn select_device(&mut self, device: Device) -> Result<(), Error<I::Error>> {
         self.write_virtual_register(DEV_SELECT_ADDR, device as u8)
             .await
     }
 
+    /// Read the integrated temperature sensor in °C
+    #[maybe_async]
     pub async fn read_temperature(&mut self) -> Result<i8, Error<I::Error>> {
         let temp = self.read_virtual_register(TEMP_ADDR).await?;
         Ok(temp as i8)
     }
 
+    /// Check if the internal register reports data ready
+    #[maybe_async]
     pub async fn is_data_ready(&mut self) -> Result<bool, Error<I::Error>> {
         let config = self.read_virtual_register(CONFIG_ADDR).await?;
         Ok((config & CONFIG_DATA_RDY) != 0)
     }
 
+    /// Run a messurement
+    /// Only needed if messurement mode is set to One-Shot
+    /// Basicly rewrites the config and waits the current integration time
+    #[maybe_async]
     pub async fn measure(&mut self) -> Result<(), Error<I::Error>> {
         self.write_config().await?;
         let wait_time = (self.config.integration_time as u32) * 28 / 10 * 2;
-        self.delay.delay_ms(wait_time);
+        self.delay.delay_ms(wait_time).await;
         Ok(())
     }
 
+    /// Same as measure but enable LED befor and disable after
+    #[maybe_async]
     pub async fn mesure_with_bulb(&mut self) -> Result<(), Error<I::Error>> {
         self.set_led_config(
             Led::White,
@@ -490,91 +534,29 @@ where
         Ok(())
     }
 
+    /// Read the raw value for a channel
+    #[maybe_async]
     pub async fn read_raw_measurement(&mut self, channel: Channel) -> Result<u16, Error<I::Error>> {
-        let dev = channel.get_device_for_chanel();
+        let dev = channel.get_device_for_channel();
         self.select_device(dev).await?;
         self.read_raw_channel(channel.get_raw_address()).await
     }
 
+    /// Read the calibrated value for a channel
+    #[maybe_async]
     pub async fn read_calibrated_messurement(
         &mut self,
         channel: Channel,
     ) -> Result<f32, Error<I::Error>> {
-        let dev = channel.get_device_for_chanel();
+        let dev = channel.get_device_for_channel();
         self.select_device(dev).await?;
 
         self.read_calibrated_channel(channel.get_cal_address())
             .await
     }
 
-    async fn write_virtual_register(
+    /// Read u16 value from address
-        &mut self,
+    #[maybe_async]
-        virtual_addr: u8,
-        data: u8,
-    ) -> Result<(), Error<I::Error>> {
-        const MAX_RETRIES: u8 = 100;
-
-        for _ in 0..MAX_RETRIES {
-            let mut status = [0u8; 1];
-            self.device
-                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)?;
-            if (status[0] & TX_VALID) == 0 {
-                break;
-            }
-            self.delay.delay_ms(5);
-        }
-
-        self.device
-            .write(AS7265X_ADDR, &[WRITE_REG, 0x80 | virtual_addr])?;
-
-        for _ in 0..MAX_RETRIES {
-            let mut status = [0u8; 1];
-            self.device
-                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)?;
-            if (status[0] & TX_VALID) == 0 {
-                break;
-            }
-            self.delay.delay_ms(5);
-        }
-
-        self.device.write(AS7265X_ADDR, &[WRITE_REG, data])?;
-
-        Ok(())
-    }
-
-    async fn read_virtual_register(&mut self, virtual_addr: u8) -> Result<u8, Error<I::Error>> {
-        const MAX_RETRIES: u8 = 100;
-
-        for _ in 0..MAX_RETRIES {
-            let mut status = [0u8; 1];
-            self.device
-                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)?;
-            if (status[0] & TX_VALID) == 0 {
-                break;
-            }
-            self.delay.delay_ms(5);
-        }
-
-        self.device
-            .write(AS7265X_ADDR, &[WRITE_REG, virtual_addr])?;
-
-        for _ in 0..MAX_RETRIES {
-            let mut status = [0u8; 1];
-            self.device
-                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)?;
-            if (status[0] & RX_VALID) != 0 {
-                break;
-            }
-            self.delay.delay_ms(5);
-        }
-
-        let mut data = [0u8; 1];
-        self.device
-            .write_read(AS7265X_ADDR, &[READ_REG], &mut data)?;
-
-        Ok(data[0])
-    }
-
     async fn read_raw_channel(&mut self, high_byte_addr: u8) -> Result<u16, Error<I::Error>> {
         let high = self.read_virtual_register(high_byte_addr).await?;
         let low = self.read_virtual_register(high_byte_addr + 1).await?;
@@ -582,6 +564,8 @@ where
         Ok(((high as u16) << 8) | (low as u16))
     }
 
+    /// Read f32 value from address
+    #[maybe_async]
     async fn read_calibrated_channel(
         &mut self,
         high_byte_addr: u8,
@@ -594,4 +578,83 @@ where
         let bits = u32::from_be_bytes([b0, b1, b2, b3]);
         Ok(f32::from_bits(bits))
     }
+
+    /// Write to a virtual register
+    #[maybe_async]
+    async fn write_virtual_register(
+        &mut self,
+        virtual_addr: u8,
+        data: u8,
+    ) -> Result<(), Error<I::Error>> {
+        const MAX_RETRIES: u8 = 100;
+
+        for _ in 0..MAX_RETRIES {
+            let mut status = [0u8; 1];
+            self.device
+                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)
+                .await?;
+            if (status[0] & TX_VALID) == 0 {
+                break;
+            }
+            self.delay.delay_ms(5).await;
+        }
+
+        self.device
+            .write(AS7265X_ADDR, &[WRITE_REG, 0x80 | virtual_addr])
+            .await?;
+
+        for _ in 0..MAX_RETRIES {
+            let mut status = [0u8; 1];
+            self.device
+                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)
+                .await?;
+            if (status[0] & TX_VALID) == 0 {
+                break;
+            }
+            self.delay.delay_ms(5).await;
+        }
+
+        self.device.write(AS7265X_ADDR, &[WRITE_REG, data]).await?;
+
+        Ok(())
+    }
+
+    /// Read from a virtual register
+    #[maybe_async]
+    async fn read_virtual_register(&mut self, virtual_addr: u8) -> Result<u8, Error<I::Error>> {
+        const MAX_RETRIES: u8 = 100;
+
+        for _ in 0..MAX_RETRIES {
+            let mut status = [0u8; 1];
+            self.device
+                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)
+                .await?;
+            if (status[0] & TX_VALID) == 0 {
+                break;
+            }
+            self.delay.delay_ms(5).await;
+        }
+
+        self.device
+            .write(AS7265X_ADDR, &[WRITE_REG, virtual_addr])
+            .await?;
+
+        for _ in 0..MAX_RETRIES {
+            let mut status = [0u8; 1];
+            self.device
+                .write_read(AS7265X_ADDR, &[STATUS_REG], &mut status)
+                .await?;
+            if (status[0] & RX_VALID) != 0 {
+                break;
+            }
+            self.delay.delay_ms(5).await;
+        }
+
+        let mut data = [0u8; 1];
+        self.device
+            .write_read(AS7265X_ADDR, &[READ_REG], &mut data)
+            .await?;
+
+        Ok(data[0])
+    }
 }