added keywords to cargo toml

Cargo.toml

@@ -2,13 +2,17 @@
 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"
-maybe-async = { version = "0.2.10", features=["is_sync"]}
-
-embedded-hal-async = { version = "1.0.0", optional = true }
+embedded-hal-async = { version = "1.0.0" }
+maybe-async = { version = "0.2.10" }
+embedded-hal = { version = "1.0.0", optional = true }
 
 [features]
-async = [ "embedded-hal-async" ]
-
+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.lock

@@ -6,7 +6,6 @@ version = 4
 name = "as7265x"
 version = "0.1.0"
 dependencies = [
- "embedded-hal 1.0.0",
  "embedded-hal-async",
  "maybe-async",
 ]

examples/esp32c6-async/Cargo.toml

@@ -1,8 +1,8 @@
 [package]
-edition      = "2024"
-name         = "esp32c6-async"
+edition = "2024"
+name = "esp32c6-async"
 rust-version = "1.88"
-version      = "0.1.0"
+version = "0.1.0"
 
 [[bin]]
 name = "esp32c6-async"
@@ -16,12 +16,12 @@ 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"
+embassy-time = "0.5.0"
 
 critical-section = "1.2.0"
-static_cell      = "2.1.1"
+static_cell = "2.1.1"
 
-as7265x = { path = "../..", features = ["async"] }
+as7265x = { path = "../.." }
 esp-println = { version = "0.16.1", features = ["esp32c6"] }
 
 [profile.dev]
@@ -30,10 +30,10 @@ esp-println = { version = "0.16.1", features = ["esp32c6"] }
 opt-level = "s"
 
 [profile.release]
-codegen-units    = 1     # LLVM can perform better optimizations using a single thread
-debug            = 2
+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
+incremental = false
+lto = 'fat'
+opt-level = 's'
+overflow-checks = false

examples/esp32c6-sync/Cargo.lock

@@ -7,6 +7,7 @@ name = "as7265x"
 version = "0.1.0"
 dependencies = [
  "embedded-hal 1.0.0",
+ "embedded-hal-async",
  "maybe-async",
 ]
 

examples/esp32c6-sync/Cargo.toml

@@ -1,21 +1,21 @@
 [package]
-edition      = "2024"
-name         = "esp32c6-sync"
+edition = "2024"
+name = "esp32c6-sync"
 rust-version = "1.88"
-version      = "0.1.0"
+version = "0.1.0"
 
 [[bin]]
 name = "esp32c6-sync"
 path = "./src/bin/main.rs"
 
 [dependencies]
-esp-hal = { version = "1.0.0", features = ["esp32c6","unstable"] }
+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="../.." }
+as7265x = { path = "../..", features = ["sync"] }
 esp-println = { version = "0.16.1", features = ["esp32c6"] }
 
 
@@ -25,10 +25,10 @@ esp-println = { version = "0.16.1", features = ["esp32c6"] }
 opt-level = "s"
 
 [profile.release]
-codegen-units    = 1     # LLVM can perform better optimizations using a single thread
-debug            = 2
+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
+incremental = false
+lto = 'fat'
+opt-level = 's'
+overflow-checks = false

src/lib.rs

@@ -1,12 +1,12 @@
 #![no_std]
 
-#[cfg(not(feature = "async"))]
+#[cfg(feature = "sync")]
 use embedded_hal::{
     delay::DelayNs,
     i2c::{self},
 };
 
-#[cfg(feature = "async")]
+#[cfg(not(feature = "sync"))]
 use embedded_hal_async::{
     delay::DelayNs,
     i2c::{self},
@@ -88,6 +88,7 @@ pub enum Channel {
 }
 
 impl Channel {
+    /// 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 => {
@@ -102,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,
@@ -113,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,
@@ -126,6 +130,7 @@ pub enum Device {
     Uv = 0x02,
 }
 
+/// The three main LEDs on the device
 #[derive(Debug, Clone, Copy)]
 pub enum Led {
     White,
@@ -134,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,
@@ -159,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,
@@ -169,7 +176,6 @@ impl GainConfig {
     }
 }
 
-/// Measurement mode options
 #[derive(Debug, Clone, Copy)]
 pub enum MeasurementMode {
     /// 4 channels
@@ -186,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,
@@ -198,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.measurement_mode.to_bits() << CONFIG_BANK_SHIFT) & CONFIG_BANK_MASK;
+        byte |= (self.gain.to_byte() << CONFIG_GAIN_SHIFT) & CONFIG_GAIN_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,
-            LedCurrent::Ma25 => 0b01,
-            LedCurrent::Ma50 => 0b10,
-            LedCurrent::Ma100 => 0b11,
+            LedDriverCurrent::Ma12_5 => 0b00,
+            LedDriverCurrent::Ma25 => 0b01,
+            LedDriverCurrent::Ma50 => 0b10,
+            LedDriverCurrent::Ma100 => 0b11,
         }
     }
 }
@@ -282,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 {
@@ -309,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,
         }
@@ -328,6 +336,7 @@ impl<E> From<E> for Error<E> {
     }
 }
 
+/// The AS7265X device
 pub struct AS7265X<I, D>
 where
     I: i2c::I2c,
@@ -344,6 +353,7 @@ where
     I: i2c::I2c,
     D: DelayNs,
 {
+    /// Create a new AS7265X device
     pub fn new(device: I, config: AS7265XConfig, delay: D) -> Self {
         Self {
             device,
@@ -352,6 +362,9 @@ 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?;
@@ -386,6 +399,7 @@ 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?;
@@ -393,59 +407,66 @@ where
         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
     }
 
-    #[maybe_async]
-    pub async fn get_firmware_version(&mut self) -> Result<(u8, u8), Error<I::Error>> {
-        let high = self.read_virtual_register(FW_VERSION_HIGH_ADDR).await?;
-        let low = self.read_virtual_register(FW_VERSION_LOW_ADDR).await?;
-        Ok((high, low))
-    }
-
+    /// Alot of function only work if you have the correct device selected
     #[maybe_async]
     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?;
@@ -454,6 +475,7 @@ where
         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(
@@ -512,6 +534,7 @@ 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_channel();
@@ -519,6 +542,7 @@ where
         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,
@@ -531,6 +555,31 @@ where
             .await
     }
 
+    /// Read u16 value from address
+    #[maybe_async]
+    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?;
+
+        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,
+    ) -> Result<f32, Error<I::Error>> {
+        let b0 = self.read_virtual_register(high_byte_addr).await?;
+        let b1 = self.read_virtual_register(high_byte_addr + 1).await?;
+        let b2 = self.read_virtual_register(high_byte_addr + 2).await?;
+        let b3 = self.read_virtual_register(high_byte_addr + 3).await?;
+
+        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,
@@ -570,6 +619,7 @@ where
         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;
@@ -607,26 +657,4 @@ where
 
         Ok(data[0])
     }
-
-    #[maybe_async]
-    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?;
-
-        Ok(((high as u16) << 8) | (low as u16))
-    }
-
-    #[maybe_async]
-    async fn read_calibrated_channel(
-        &mut self,
-        high_byte_addr: u8,
-    ) -> Result<f32, Error<I::Error>> {
-        let b0 = self.read_virtual_register(high_byte_addr).await?;
-        let b1 = self.read_virtual_register(high_byte_addr + 1).await?;
-        let b2 = self.read_virtual_register(high_byte_addr + 2).await?;
-        let b3 = self.read_virtual_register(high_byte_addr + 3).await?;
-
-        let bits = u32::from_be_bytes([b0, b1, b2, b3]);
-        Ok(f32::from_bits(bits))
-    }
 }