Skip to content

Commit

Permalink
Merge pull request #594 from WildernessLabs/PMSA003I
Browse files Browse the repository at this point in the history 
Pmsa003i
  • Loading branch information
@jorgedevs
jorgedevs authored Apr 5, 2023
2 parents 4375169 + bf248b1 commit 058b400
Show file tree
Hide file tree
Showing 9 changed files with 457 additions and 0 deletions.
Binary file added ...ensors.Environmental.Pmsa003I/Datasheet/4505_PMSA003I_series_data_manual_English_V2.6.pdf
View file
Binary file not shown.
7 changes: 7 additions & 0 deletions ...Meadow.Foundation.Peripherals/Sensors.Environmental.Pmsa003I/Driver/Pmsa003i.Constants.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
namespace Meadow.Foundation.Sensors.Environmental
{
public partial class Pmsa003i
{ // This is reversed because we reverse the whole message because it is big-endian and it makes converting values easier
private static readonly byte[] Preamble = { 0x4d, 0x42 };
}
}
21 changes: 21 additions & 0 deletions Source/Meadow.Foundation.Peripherals/Sensors.Environmental.Pmsa003I/Driver/Pmsa003i.Enums.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
namespace Meadow.Foundation.Sensors.Environmental
{
public partial class Pmsa003i
{
/// <summary>
/// Valid I2C addresses for the sensor
/// </summary>
internal enum Addresses : byte
{
/// <summary>
/// Bus address 0x52
/// ADDR is low
/// </summary>
Address_0x12 = 0x12,
/// <summary>
/// Default bus address
/// </summary>
Default = Address_0x12
}
}
}
296 changes: 296 additions & 0 deletions Source/Meadow.Foundation.Peripherals/Sensors.Environmental.Pmsa003I/Driver/Pmsa003i.cs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,296 @@
using Meadow.Hardware;
using Meadow.Units;
using System;
using System.Linq;
using System.Threading.Tasks;

namespace Meadow.Foundation.Sensors.Environmental
{
/// <summary>
/// Represents a Pmsa003i AQI particulate matter sensor
/// </summary>
public partial class Pmsa003i :
ByteCommsSensorBase<(
Density? StandardParticulateMatter_1micron, //Particulate Matter 1 micron or less
Density? StandardParticulateMatter_2_5micron, //Particulate Matter 2.5 micron or less
Density? StandardParticulateMatter_10micron, //Particulate Matter 10 micron or less
Density? EnvironmentalParticulateMatter_1micron,
Density? EnvironmentalParticulateMatter_2_5micron,
Density? EnvironmentalParticulateMatter_10micron,
int? particles_0_3microns,
int? particles_0_5microns,
int? particles_10microns,
int? particles_25microns,
int? particles_50microns,
int? particles_100microns)>
{
public Concentration? Concentration { get; }

/// <summary>
/// Raised when the Standard particulate matter PM2.5 density changes
/// </summary>
public event EventHandler<IChangeResult<Concentration>> ConcentrationUpdated;

/// <summary>
/// Raised when the Standard particulate matter PM1.0 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> StandardPM_1micronUpdated = delegate { };

/// <summary>
/// Raised when the Standard particulate matter PM2.5 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> StandardPM_2_5micronUpdated = delegate { };

/// <summary>
/// Raised when the Standard particulate matter PM10.0 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> StandardPM_10micronUpdated = delegate { };

/// <summary>
/// Raised when the Environment particulate matter PM1.0 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> EnvironmentalPM_1micronUpdated = delegate { };

/// <summary>
/// Raised when the Environment particulate matter PM2.5 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> EnvironmentalPM_2_5micronUpdated = delegate { };

/// <summary>
/// Raised when the Environment particulate matter PM10.0 density changes
/// </summary>
public event EventHandler<IChangeResult<Density>> EnvironmentalPM_10micronUpdated = delegate { };

/// <summary>
/// Raised when the number of of 0-0.3 micron particles (in 0.1 liters of air) changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf0_3micronParticlesUpdated = delegate { };

/// <summary>
/// Raised when the number of of 0.3-0.5 micron particles (in 0.1 liters of air) changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf0_5micronParticlesUpdated = delegate { };

/// <summary>
/// Raised when the number of of 0.5-10 micron particles changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf10micronParticlesUpdated = delegate { };

/// <summary>
/// Raised when the number of of 10-25 micron particles (in 0.1 liters of air) changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf25micronParticlesUpdated = delegate { };

/// <summary>
/// Raised when the number of of 25-50 micron particles (in 0.1 liters of air) changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf50micronParticlesUpdated = delegate { };

/// <summary>
/// Raised when the number of 50-100 micron particles (in 0.1 liters of air) changes
/// </summary>
public event EventHandler<IChangeResult<int>> CountOf100micronParticlesUpdated = delegate { };

/// <summary>
/// Standard particulate matter PM1.0 density
/// </summary>
public Density? PM1_0Std => Conditions.StandardParticulateMatter_1micron;

/// <summary>
/// Standard particulate matter PM2.5 density
/// </summary>
public Density? PM2_5Std => Conditions.StandardParticulateMatter_2_5micron;

/// <summary>
/// Standard particulate matter PM10 density
/// </summary>
public Density? PM10_0Std => Conditions.StandardParticulateMatter_10micron;

/// <summary>
/// Standard particulate matter PM1.0 density
/// </summary>
public Density? PM1_0Env => Conditions.EnvironmentalParticulateMatter_1micron;

/// <summary>
/// Standard particulate matter PM2.5 density
/// </summary>
public Density? PM2_5Env => Conditions.EnvironmentalParticulateMatter_2_5micron;

/// <summary>
/// Standard particulate matter PM10 density
/// </summary>
public Density? PM10_0Env => Conditions.EnvironmentalParticulateMatter_10micron;

/// <summary>
/// Number of 0 - 0.3 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf0_3micronParticles => Conditions.particles_0_3microns;
/// <summary>
/// Number of of 0.3 - 0.5 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf0_5micronParticles => Conditions.particles_0_5microns;
/// <summary>
/// Number of of 0.5 - 10 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf10micronParticles => Conditions.particles_10microns;
/// <summary>
/// Number of of 0.5 - 10 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf25micronParticles => Conditions.particles_25microns;
/// <summary>
/// Number of of 10 - 50 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf50micronParticles => Conditions.particles_50microns;
/// <summary>
/// Number of of 50 - 100 micron particles in 0.1 liters of air
/// </summary>
public int? CountOf100micronParticles => Conditions.particles_100microns;

/// <summary>
/// Create a new PMSA003I sensor object
/// </summary>
/// <remarks></remarks>
/// <param name="i2cBus">The I2C bus</param>
public Pmsa003i(II2cBus i2cBus)
: base(i2cBus, (byte)Addresses.Address_0x12)
{ }

/// <summary>
/// Starts updating the sensor on the updateInterval frequency specified
/// </summary>
public override void StartUpdating(TimeSpan? updateInterval = null)
{
base.StartUpdating(updateInterval);
}

/// <summary>
/// Stop updating the sensor
/// The sensor will not respond to commands for 500ms
/// The call will delay the calling thread for 500ms
/// </summary>
public override void StopUpdating()
{
base.StopUpdating();
}

protected override Task<(
Density? StandardParticulateMatter_1micron,
Density? StandardParticulateMatter_2_5micron,
Density? StandardParticulateMatter_10micron,
Density? EnvironmentalParticulateMatter_1micron,
Density? EnvironmentalParticulateMatter_2_5micron,
Density? EnvironmentalParticulateMatter_10micron,
int? particles_0_3microns,
int? particles_0_5microns,
int? particles_10microns,
int? particles_25microns,
int? particles_50microns,
int? particles_100microns)> ReadSensor()
{
var buffer = new byte[32];
Peripheral.Read(buffer);
var span = buffer.AsSpan();
span.Reverse();
if (buffer[30..32].SequenceEqual(Preamble) == false)
{
throw new Exception("Preamble mismatch!");
}
var messageLength = BitConverter.ToUInt16(span[28..30]);
if (messageLength != 28)
{
throw new Exception("Message is corrupt or has invalid length");
}

var checksum = BitConverter.ToUInt16(buffer[2..4]);
// this is in big-endian format, so we need to reverse things...
var pm10Standard = new Density(BitConverter.ToUInt16(span[26..28]), Density.UnitType.MicroGramsPerMetersCubed);
var pm25Standard = new Density(BitConverter.ToUInt16(span[24..26]), Density.UnitType.MicroGramsPerMetersCubed);
var pm100Standard = new Density(BitConverter.ToUInt16(span[22..24]), Density.UnitType.MicroGramsPerMetersCubed);
var pm10Environmental = new Density(BitConverter.ToUInt16(span[20..22]), Density.UnitType.MicroGramsPerMetersCubed);
var pm25Environmental = new Density(BitConverter.ToUInt16(span[18..20]), Density.UnitType.MicroGramsPerMetersCubed);
var pm100Environmental = new Density(BitConverter.ToUInt16(span[16..18]), Density.UnitType.MicroGramsPerMetersCubed);
var p03um = BitConverter.ToUInt16(span[14..16]);
var p05um = BitConverter.ToUInt16(span[12..14]);
var p10um = BitConverter.ToUInt16(span[10..12]);
var p25um = BitConverter.ToUInt16(span[8..10]);
var p50um = BitConverter.ToUInt16(span[6..8]);
var p100um = BitConverter.ToUInt16(span[4..6]);

Conditions = (pm10Standard, pm25Standard, pm100Standard, pm10Environmental, pm25Environmental,
pm100Environmental, p03um, p05um, p10um, p25um, p50um, p100um);

return Task.FromResult(Conditions);
}

/// <summary>
/// Raise change events for subscribers
/// </summary>
/// <param name="changeResult">The change result with the current sensor data</param>
protected override void RaiseEventsAndNotify(
IChangeResult<(Density? StandardParticulateMatter_1micron,
Density? StandardParticulateMatter_2_5micron,
Density? StandardParticulateMatter_10micron,
Density? EnvironmentalParticulateMatter_1micron,
Density? EnvironmentalParticulateMatter_2_5micron,
Density? EnvironmentalParticulateMatter_10micron,
int? particles_0_3microns,
int? particles_0_5microns,
int? particles_10microns,
int? particles_25microns,
int? particles_50microns,
int? particles_100microns)> changeResult)
{
if (changeResult.New.StandardParticulateMatter_1micron is { } SPM0_1)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(SPM0_1, changeResult.Old.Value.StandardParticulateMatter_1micron));
}
if (changeResult.New.StandardParticulateMatter_2_5micron is { } SPM0_2_5)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(SPM0_2_5, changeResult.Old.Value.StandardParticulateMatter_2_5micron));
}
if (changeResult.New.StandardParticulateMatter_10micron is { } SPM0_10)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(SPM0_10, changeResult.Old.Value.StandardParticulateMatter_10micron));
}
if (changeResult.New.EnvironmentalParticulateMatter_1micron is { } EM0_1)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(EM0_1, changeResult.Old.Value.EnvironmentalParticulateMatter_1micron));
}
if (changeResult.New.EnvironmentalParticulateMatter_2_5micron is { } EM0_2_5)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(EM0_2_5, changeResult.Old.Value.EnvironmentalParticulateMatter_2_5micron));
}
if (changeResult.New.EnvironmentalParticulateMatter_10micron is { } EM0_10)
{
StandardPM_1micronUpdated?.Invoke(this, new ChangeResult<Density>(EM0_10, changeResult.Old.Value.EnvironmentalParticulateMatter_10micron));
}

if (changeResult.New.particles_0_3microns is { } P_0_3)
{
CountOf0_3micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_0_3, changeResult.Old.Value.particles_0_3microns));
}
if (changeResult.New.particles_0_5microns is { } P_0_5)
{
CountOf0_5micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_0_5, changeResult.Old.Value.particles_0_5microns));
}
if (changeResult.New.particles_10microns is { } P_10)
{
CountOf10micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_10, changeResult.Old.Value.particles_10microns));
}
if (changeResult.New.particles_25microns is { } P_25)
{
CountOf25micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_25, changeResult.Old.Value.particles_25microns));
}
if (changeResult.New.particles_50microns is { } P_50)
{
CountOf50micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_50, changeResult.Old.Value.particles_50microns));
}
if (changeResult.New.particles_100microns is { } P_100)
{
CountOf100micronParticlesUpdated?.Invoke(this, new ChangeResult<int>(P_100, changeResult.Old.Value.particles_100microns));
}

base.RaiseEventsAndNotify(changeResult);
}
}
}
22 changes: 22 additions & 0 deletions ...n.Peripherals/Sensors.Environmental.Pmsa003I/Driver/Sensors.Environmental.Pmsa003i.csproj
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<Project Sdk="Meadow.Sdk/1.1.0">
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageIcon>icon.png</PackageIcon>
<Authors>Wilderness Labs, Inc</Authors>
<TargetFramework>netstandard2.1</TargetFramework>
<OutputType>Library</OutputType>
<AssemblyName>Pmsa300i</AssemblyName>
<Company>Wilderness Labs, Inc</Company>
<PackageProjectUrl>http://developer.wildernesslabs.co/Meadow/Meadow.Foundation/</PackageProjectUrl>
<PackageId>Meadow.Foundation.Sensors.Environmental.Pmsa300i</PackageId>
<RepositoryUrl>https://github.com/WildernessLabs/Meadow.Foundation</RepositoryUrl>
<PackageTags>Meadow,Meadow.Foundation,Environmental,Pmsa300i,gas,particle,particulate,matter,AQI,air,quality</PackageTags>
<Version>0.1.0</Version>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Description>PMSA300I I2C particulate matter AQI sensor</Description>
</PropertyGroup>
<ItemGroup>
<None Include="..\..\..\icon.png" Pack="true" PackagePath="" />
<ProjectReference Include="..\..\..\Meadow.Foundation.Core\Meadow.Foundation.Core.csproj" />
</ItemGroup>
</Project>
Loading

0 comments on commit 058b400

Please sign in to comment.