Difference between revisions of "Component: Barometer (DPS310) (Environmental)"

Latest revision as of 13:12, 7 February 2023

Author	Matrix TSL
Version	1.0
Category	Environmental

Barometer (DPS310) component

A barometric air pressure sensor with high accuracy and low current consumption. Capable of sensing air pressure and temperature. Based on an I2C bus connection.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Pressure_Sensor_DPS310.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Pressure_Sensor_DPS310.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ConfigurePressure

	ConfigurePressure
Configures the pressure sensor sample rate and over sampling count
- BYTE	Rate
Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc
- BYTE	Oversample
Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc
- VOID	Return

ConfigureTemperature

	ConfigureTemperature
Configures the temperature sensor sample rate and over sampling count
- BYTE	Rate
Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc
- BYTE	Oversample
Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc
- VOID	Return

Initialise

	Initialise
Starts up the I2C ready to communicate with the sensor. Sets the selected rates and operational mode. Returns 1 if the sensor has been found and initialised.
- BOOL	Return

ReadAltitude

	ReadAltitude
Reads the pressure measurement from the last SampleSensor macro and converts the pressure reading into an altitude reading.
- FLOAT	Return

ReadPressure

	ReadPressure
Reads the pressure measurement from the last SampleSensor macro
- FLOAT	Return

ReadRegister

	ReadRegister
Reads a byte from a register
- BYTE	Address

- BYTE	Return

ReadTemperature

	ReadTemperature
Reads the temperature measurement from the last SampleSensor macro
- FLOAT	Return

SampleSensor

	SampleSensor
Checks to see if new data is available for temperature or pressure and collects it. Returns 0 if no new data is available Returns 1 for pressure, 2 for temperature and 3 for both.
- BYTE	Return

SetMode

	SetMode
Sets the operational mode of the sensor to be continous or one shot
- BYTE	Mode

- VOID	Return

WriteRegister

	WriteRegister
Writes a byte to a register
- BYTE	Address

- BYTE	Data

- VOID	Return

Property reference

	Properties
	Device Settings
	Device Address

	Measurement Rate

	Oversample Rate

	Operational Mode

	Connections
	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Simulation
	Simulate Comms
No: Provides simulation using the panel component sliders. Yes: Communicates via an API Slave device to real world hardware, shows the results using the panel component sliders.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_Pressure_Sensor_DPS310.fcfx FC_Comp_Source_Pressure_Sensor_DPS310.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Pressure_Sensor_DPS310.fcfx FC_Comp_Source_Pressure_Sensor_DPS310.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Pressure_Sensor_DPS310.fcfx FC_Comp_Source_Pressure_Sensor_DPS310.fcfx]
 ==Detailed description==
@@ Line 36: / Line 48: @@
 ==Examples==
@@ Line 53: / Line 75: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTemperature'''
-|-
-| colspan="2" | Reads the temperature measurement from the last SampleSensor macro&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+==Macro reference==
+===ConfigurePressure===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 91: / Line 111: @@
+===ConfigureTemperature===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 114: / Line 135: @@
+===Initialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+|-
+| colspan="2" | Starts up the I2C ready to communicate with the sensor. Sets the selected rates and operational mode. Returns 1 if the sensor has been found and initialised.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ReadAltitude===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAltitude'''
+|-
+| colspan="2" | Reads the pressure measurement from the last SampleSensor macro and converts the pressure reading into an altitude reading.&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ReadPressure===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 127: / Line 177: @@
+===ReadRegister===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
 |-
-| colspan="2" | Sets the operational mode of the sensor to be continous or one shot&nbsp;
+| colspan="2" | Reads a byte from a register&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Mode
+| width="90%" | Address
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadTemperature===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAltitude'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadTemperature'''
 |-
-| colspan="2" | Reads the pressure measurement from the last SampleSensor macro and converts the pressure reading into an altitude reading.&nbsp;
+| colspan="2" | Reads the temperature measurement from the last SampleSensor macro&nbsp;
 |-
 |-
@@ Line 158: / Line 210: @@
+===SampleSensor===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 171: / Line 224: @@
+===SetMode===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadRegister'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMode'''
 |-
-| colspan="2" | Reads a byte from a register&nbsp;
+| colspan="2" | Sets the operational mode of the sensor to be continous or one shot&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Address
+| width="90%" | Mode
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===WriteRegister===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 210: / Line 265: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Starts up the I2C ready to communicate with the sensor. Sets the selected rates and operational mode. Returns 1 if the sensor has been found and initialised.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}