IZU2020 / SPS30

Dependents:   IZU2021_SPS30 Hybrid_IZU2021_MISSION_v2 Hybrid_IZU2021_MISSION

Embed: (wiki syntax)

« Back to documentation index

Sps30 Class Reference

Sps30 Class Reference

Create SPS30 controller class. More...

#include <sps30.h>

Public Member Functions

 Sps30 (PinName sda, PinName scl, int i2c_frequency)
 Create a SPS30 object using the specified I2C object.
 ~Sps30 ()
 Destructor.
uint8_t InitSPS30 ()
 Initialise SPS30.
uint8_t PollSPS30 ()
 Poll SPS30 Data.
uint8_t StartFanClean ()
 Perform manual Fan Cleaning.

Data Fields

uint16_t sps_ready
 1 = ready, 0 = busy
float mass_1p0_f
 32 unsigned bit in seconds
float mass_2p5_f
 float of Mass Conc of PM2.5
float mass_4p0_f
 float of Mass Conc of PM4.0
float mass_10p0_f
 float of Mass Conc of PM10
float num_0p5_f
 float of Number Conc of PM0.5
float num_1p0_f
 float of Number Conc of PM1.0
float num_2p5_f
 float of Number Conc of PM2.5
float num_4p0_f
 float of Number Conc of PM4.0
float num_10p0_f
 float of Number Conc of PM10
float typ_pm_size_f
 float of Typical Particle Size
uint8_t sn [33]
 ASCII Serial Number.

Detailed Description

Create SPS30 controller class.

Parameters:
sps30class

Definition at line 45 of file sps30.h.


Constructor & Destructor Documentation

Sps30 ( PinName  sda,
PinName  scl,
int  i2c_frequency 
)

Create a SPS30 object using the specified I2C object.

Parameters:
sda- mbed I2C interface pin
scl- mbed I2C interface pin
I2CFrequency (in Hz)
Returns:
none

Definition at line 7 of file sps30.cpp.

~Sps30 (  )

Destructor.

Parameters:
--none--
Returns:
none

Definition at line 14 of file sps30.cpp.


Member Function Documentation

uint8_t InitSPS30 (  )

Initialise SPS30.

Parameters:
--none--
Returns:
enum SPSStatus

Definition at line 382 of file sps30.cpp.

uint8_t PollSPS30 (  )

Poll SPS30 Data.

Parameters:
--none--
Returns:
enum SPSStatus

Definition at line 396 of file sps30.cpp.

uint8_t StartFanClean (  )

Perform manual Fan Cleaning.

Parameters:
--none--
Returns:
enum SPSerror

Definition at line 356 of file sps30.cpp.


Field Documentation

float mass_10p0_f

float of Mass Conc of PM10

Definition at line 64 of file sps30.h.

float mass_1p0_f

32 unsigned bit in seconds

float of Mass Conc of PM1.0

Definition at line 61 of file sps30.h.

float mass_2p5_f

float of Mass Conc of PM2.5

Definition at line 62 of file sps30.h.

float mass_4p0_f

float of Mass Conc of PM4.0

Definition at line 63 of file sps30.h.

float num_0p5_f

float of Number Conc of PM0.5

Definition at line 66 of file sps30.h.

float num_10p0_f

float of Number Conc of PM10

Definition at line 70 of file sps30.h.

float num_1p0_f

float of Number Conc of PM1.0

Definition at line 67 of file sps30.h.

float num_2p5_f

float of Number Conc of PM2.5

Definition at line 68 of file sps30.h.

float num_4p0_f

float of Number Conc of PM4.0

Definition at line 69 of file sps30.h.

uint8_t sn[33]

ASCII Serial Number.

Definition at line 74 of file sps30.h.

uint16_t sps_ready

1 = ready, 0 = busy

Definition at line 58 of file sps30.h.

float of Typical Particle Size

Definition at line 72 of file sps30.h.