Merge pull request #464 from WildernessLabs/feature/ISamplingSensor

Updates for ISamplingSensor

Source/Meadow.Foundation.Core.Samples/Sensors.Light.AnalogLightSensor_Sample/MeadowApp.cs

@@ -54,7 +54,7 @@ public override Task Initialize()
         protected async Task ReadIlluminance()
         {
             var illuminance = await analogLightSensor.Read();
-            Console.WriteLine($"Initial lux: {illuminance.Lux:N2} lux");
+            Console.WriteLine($"Initial lux: {illuminance.Value.Lux:N2} lux");
         }
 
         //<!=SNOP=>

Source/Meadow.Foundation.Core.Samples/Sensors.Temperature.AnalogTemperature_Sample/MeadowApp.cs

@@ -57,7 +57,7 @@ public override Task Initialize()
         protected async Task ReadTemp()
         {
             var temperature = await analogTemperature.Read();
-            Console.WriteLine($"Initial temp: {temperature.Celsius:N2}C");
+            Console.WriteLine($"Initial temp: {temperature.Value.Celsius:N2}C");
         }
 
         //<!=SNOP=>

Source/Meadow.Foundation.Core/SamplingSensorBase.cs

@@ -1,5 +1,5 @@
-using System;
-using System.Collections.Generic;
+using Meadow.Peripherals.Sensors;
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -10,7 +10,7 @@ namespace Meadow.Foundation
     /// </summary>
     /// <typeparam name="UNIT"></typeparam>
     public abstract class SamplingSensorBase<UNIT>
-        : SensorBase<UNIT>
+        : SensorBase<UNIT>, ISamplingSensor<UNIT>
         where UNIT : struct
     {
         /// <summary>

Source/Meadow.Foundation.Core/SensorBase.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
 

Source/Meadow.Foundation.Core/Sensors/Light/AnalogLightSensor.cs

@@ -92,21 +92,22 @@ public AnalogLightSensor(IAnalogInputPort analogInputPort,
                 )
            );
         }
-
+
+        /// <summary>
+        /// Convenience method to get the current sensor readings. For frequent reads, use
+        /// StartSampling() and StopSampling() in conjunction with the SampleBuffer.
+        /// </summary>
+        public async Task<Illuminance?> Read()
+            => new Illuminance?(await ReadSensor());
+
         /// <summary>
         /// Convenience method to get the current luminance. For frequent reads, use
         /// StartSampling() and StopSampling() in conjunction with the SampleBuffer.
         /// </summary>
         protected override async Task<Illuminance> ReadSensor()
         {
-            // read the voltage
             Voltage voltage = await AnalogInputPort.Read();
-
-            // convert and save to our temp property for later retreival
-            illuminance = VoltageToLuminance(voltage);
-
-            // return
-            return illuminance;
+            return illuminance = VoltageToLuminance(voltage);
         }
 
         /// <summary>

Source/Meadow.Foundation.Core/Sensors/Temperature/AnalogTemperature.cs

@@ -198,6 +198,13 @@ public AnalogTemperature(IAnalogInputPort analogInputPort,
            );
         }
 
+        /// <summary>
+        /// Convenience method to get the current sensor readings. For frequent reads, use
+        /// StartSampling() and StopSampling() in conjunction with the SampleBuffer.
+        /// </summary>
+        public async Task<Units.Temperature?> Read()
+            => new Units.Temperature?(await ReadSensor());
+
         /// <summary>
         /// Convenience method to get the current temperature. For frequent reads, use
         /// StartSampling() and StopSampling() in conjunction with the SampleBuffer.

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.AdafruitMPRLS/Driver/AdafruitMPRLS.cs

@@ -135,5 +135,8 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Pressure? Pressure,
                 return conditions;
             });
         }
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await ReadSensor()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Bme280/Driver/Bme280.cs

@@ -439,5 +439,14 @@ public override void StartUpdating(TimeSpan? updateInterval = null)
 
             base.StartUpdating(updateInterval);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Bme68x/Driver/Bme68x.cs

@@ -582,5 +582,14 @@ byte CalculateHeaterDuration(TimeSpan duration)
             }
             return durationValue;
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Bmp085/Driver/Bmp085.cs

@@ -224,5 +224,11 @@ private short ReadShort(byte address)
 
             return (short)((ReadBuffer.Span[0] << 8) | ReadBuffer.Span[1]);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Bmp180/Driver/Bmp180.cs

@@ -231,5 +231,11 @@ private short ReadShort(byte address)
 
             return (short)((ReadBuffer.Span[0] << 8) | ReadBuffer.Span[1]);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Ccs811/Driver/Ccs811.cs

@@ -185,5 +185,8 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Concentration? Co2,
 
             base.RaiseEventsAndNotify(changeResult);
         }
+
+        async Task<Concentration> ISamplingSensor<Concentration>.Read()
+            => (await Read()).Voc.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Dhtxx/Driver/DhtBase.cs

@@ -149,5 +149,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
 
             return Task.FromResult(conditions);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Hih6130/Driver/Hih6130.cs

@@ -94,5 +94,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
 
             return conditions;
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Htu2xd/Driver/Htux1dBase.cs

@@ -2,6 +2,7 @@
 using Meadow.Peripherals.Sensors;
 using Meadow.Units;
 using System;
+using System.Threading.Tasks;
 
 namespace Meadow.Foundation.Sensors.Atmospheric
 {
@@ -24,7 +25,7 @@ public enum Addresses : byte
     /// Abstract HTDx1D base class for HTU21D and HTU31D
     /// </summary>
     public abstract class Htux1dBase :
-        ByteCommsSensorBase<(Meadow.Units.Temperature? Temperature, RelativeHumidity? Humidity)>,
+        ByteCommsSensorBase<(Units.Temperature? Temperature, RelativeHumidity? Humidity)>,
         ITemperatureSensor, IHumiditySensor
     {
         /// <summary>
@@ -84,5 +85,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
             }
             base.RaiseEventsAndNotify(changeResult);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Mpl115A2/Driver/Mpl115a2.cs

@@ -163,5 +163,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
                 return conditions;
             });
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Mpl3115a2/Driver/Mpl3115a2.cs

@@ -211,5 +211,11 @@ public void Reset()
             data |= 0x04;
             Peripheral?.WriteRegister(Registers.Control1, data);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Ms5611/Driver/Ms5611.cs

@@ -131,5 +131,11 @@ int ReadPressure()
 
             return result;
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<Pressure> ISamplingSensor<Pressure>.Read()
+            => (await Read()).Pressure.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Sht31D/Driver/Sht31d.cs

@@ -84,5 +84,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
 
             return Task.FromResult<(Units.Temperature? Temperature, RelativeHumidity? Humidity)>(conditions);
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Sht4x/Driver/Sht4x.cs

@@ -127,5 +127,11 @@ protected int GetDelayForPrecision(Precision precision)
                 return conditions;
             });
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Si70xx/Driver/Si70xx.cs

@@ -214,5 +214,11 @@ void SetResolution(SensorResolution resolution)
             //Request a write to user register
             Peripheral?.WriteRegister((byte)Register.USER_REG_1, register); //Write the new resolution bits
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Atmospheric.Th02/Driver/Th02.cs

@@ -106,5 +106,11 @@ protected override void RaiseEventsAndNotify(IChangeResult<(Units.Temperature? T
                 return conditions;
             });
         }
+
+        async Task<Units.Temperature> ISamplingSensor<Units.Temperature>.Read()
+            => (await Read()).Temperature.Value;
+
+        async Task<RelativeHumidity> ISamplingSensor<RelativeHumidity>.Read()
+            => (await Read()).Humidity.Value;
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Distance.Hcsr04/Driver/Hcsr04.cs

@@ -8,7 +8,7 @@
 namespace Meadow.Foundation.Sensors.Distance
 {
     /// <summary>
-    /// HCSR04 Distance Sensor
+    /// HCSR04 Distance Sensor - driver not complete
     /// </summary>
     public class Hcsr04 : SensorBase<Length>, IRangeFinder
     {
@@ -142,5 +142,16 @@ protected override void RaiseEventsAndNotify(IChangeResult<Length> changeResult)
             DistanceUpdated?.Invoke(this, changeResult);
             base.RaiseEventsAndNotify(changeResult);
         }
+
+        public void StartUpdating(TimeSpan? updateInterval = null)
+        {
+            //ToDo
+            throw new NotImplementedException();
+        }
+
+        public void StopUpdating()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Distance.Hysrf05/Driver/Hysrf05.cs

@@ -8,7 +8,7 @@
 namespace Meadow.Foundation.Sensors.Distance
 {
     /// <summary>
-    /// HYSRF05 Distance Sensor
+    /// HYSRF05 Distance Sensor- driver not complete
     /// </summary>
     public class Hysrf05: SensorBase<Length>, IRangeFinder
     {
@@ -140,5 +140,16 @@ protected override void RaiseEventsAndNotify(IChangeResult<Length> changeResult)
             DistanceUpdated?.Invoke(this, changeResult);
             base.RaiseEventsAndNotify(changeResult);
         }
+
+        public void StartUpdating(TimeSpan? updateInterval = null)
+        {
+            //ToDo
+            throw new NotImplementedException();
+        }
+
+        public void StopUpdating()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Distance.Sfsr02/Driver/Sfsr02.cs

@@ -8,7 +8,7 @@
 namespace Meadow.Foundation.Sensors.Distance
 {
     /// <summary>
-    /// Sfsr02 Distance Sensor
+    /// Sfsr02 Distance Sensor- driver not complete
     /// </summary>
     public class Sfsr02: SensorBase<Length>, IRangeFinder
     {
@@ -136,5 +136,16 @@ protected override void RaiseEventsAndNotify(IChangeResult<Length> changeResult)
             DistanceUpdated?.Invoke(this, changeResult);
             base.RaiseEventsAndNotify(changeResult);
         }
+
+        public void StartUpdating(TimeSpan? updateInterval = null)
+        {
+            //ToDo
+            throw new NotImplementedException();
+        }
+
+        public void StopUpdating()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

Source/Meadow.Foundation.Peripherals/Sensors.Light.AnalogSolarGauge/Driver/AnalogSolarGauge.cs

@@ -12,7 +12,7 @@ namespace Meadow.Foundation.Sensors.Light
     /// Driver to measure solar panel input
     /// </summary>
     public class AnalogSolarGauge : SensorBase<float>,
-        ISolarIntensityGauge, ISensor
+        ISolarIntensityGauge
     {
         /// <summary>
         /// Raised when the solar intensity changes