Added further documentation

plantineers · Jun 10, 2023 · fa723d0 · fa723d0
1 parent 7ef36d4
commit fa723d0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/hw390.rs b/src/hw390.rs
@@ -7,6 +7,7 @@ use hal::gpio::{
     Analog, Bank0GpioRegisterAccess, Gpio2Signals, GpioPin, InputOutputAnalogPinType,
     SingleCoreInteruptStatusRegisterAccessBank0,
 };
+/// A struct containing the hardware(via pointers to the right addresses of course) for the hw390 moisture sensor
 pub struct Hw390<'a> {
     pub adc: ADC<'a, ADC1>,
     pub pin: AdcPin<
@@ -23,6 +24,7 @@ pub struct Hw390<'a> {
 }
 
 impl<'a> Hw390<'a> {
+    /// Read out moisture data from the hw390 sensor and normalise it
     pub fn read(&mut self) -> Data {
         let readout = hal::prelude::nb::block!(self.adc.read(&mut self.pin)).unwrap();
         Data {

diff --git a/src/utils.rs b/src/utils.rs
@@ -9,7 +9,8 @@ where
     }
     array
 }
-
+/// Convert an array of chars into an array of u8s. Useful for storing the uuid in flash and more
+/// efficient than storing the intermediate result in a vector
 pub(crate) fn convert_to_u8s<const N: usize>(array: [char; N]) -> [u8; N] {
     let mut u8_array = [0; N];
     for (i, c) in array.iter().enumerate() {