Jump to content

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

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,426 edits
XML import
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| style="width:50%"
{| width="50%"
|-
|-
| width="20%" style="color: gray;" | Author
| width="20%" style="color:gray;" | Author
| Matrix TSL
| Matrix TSL
|-
|-
| width="20%" style="color: gray;" | Version
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
| 1.0
|-
|-
| width="20%" style="color: gray;" | Category
| width="20%" style="color:gray;" | Category
| Environmental
| 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.


==[[File:Component Icon ca60c1d2_fb77_4e3e_9d01_c4496d35db1e.png|Image]] Barometer (DPS310) component==
==Component Source Code==
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.


==Examples==
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]
''<span style="color:red;">No additional examples</span>''


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]


==Downloadable macro reference==
==Detailed description==


===<span style="font-weight: normal;"><u><tt>ReadTemperature</tt></u></span>===
Reads the temperature measurement from the last SampleSensor macro


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|FLOAT]]




===<span style="font-weight: normal;"><u><tt>ConfigurePressure</tt></u></span>===
Configures the pressure sensor sample rate and over sampling count


'''Parameters'''


:[[Variable Types|BYTE]] ''Rate''
::Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc


:[[Variable Types|BYTE]] ''Oversample''
::Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ConfigureTemperature</tt></u></span>===
Configures the temperature sensor sample rate and over sampling count


'''Parameters'''


:[[Variable Types|BYTE]] ''Rate''
::Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc


:[[Variable Types|BYTE]] ''Oversample''
::Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc




'''Return value'''


:''This call does not return a value''


''No detailed description exists yet for this component''


===<span style="font-weight: normal;"><u><tt>ReadPressure</tt></u></span>===
==Examples==
Reads the pressure measurement from the last SampleSensor macro


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|FLOAT]]




===<span style="font-weight: normal;"><u><tt>SetMode</tt></u></span>===
Sets the operational mode of the sensor to be continous or one shot


'''Parameters'''


:[[Variable Types|BYTE]] ''Mode''




'''Return value'''


:''This call does not return a value''




===<span style="font-weight: normal;"><u><tt>ReadAltitude</tt></u></span>===
Reads the pressure measurement from the last SampleSensor macro and converts the pressure reading into an altitude reading.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|FLOAT]]




===<span style="font-weight: normal;"><u><tt>SampleSensor</tt></u></span>===
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.


'''Parameters'''
''<span style="color:red;">No additional examples</span>''


:''This macro has no parameters''




'''Return value'''


:[[Variable Types|BYTE]]




===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
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.


'''Parameters'''


:''This macro has no parameters''




'''Return value'''
==Macro reference==


:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
===ConfigurePressure===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConfigurePressure'''
|-
| colspan="2" | Configures the pressure sensor sample rate and over sampling count&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Rate
|-
| colspan="2" | Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Oversample
|-
| colspan="2" | Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc&nbsp;
|-
| 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''
|}




===ConfigureTemperature===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ConfigureTemperature'''
|-
| colspan="2" | Configures the temperature sensor sample rate and over sampling count&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Rate
|-
| colspan="2" | Range: 0-7, 0=1Hz, 1=2Hz, 2=4Hz etc&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Oversample
|-
| colspan="2" | Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc&nbsp;
|-
| 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''
|}


==Simulation macro reference==


''This component does not contain any simulation macros''
===Initialise===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}




==Property reference==
===ReadAltitude===
<span style="font-weight: normal;"><u>Device Address</u></span>
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DeviceAddress''.


''<span style="color:red;">No additional information</span>''
===ReadPressure===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadPressure'''
|-
| colspan="2" | Reads the pressure 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''
|}




===ReadRegister===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadRegister'''
|-
| colspan="2" | Reads a byte from a register&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


<span style="font-weight: normal;"><u>Measurement Rate</u></span>


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MeasurementRate''.
===ReadTemperature===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''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''
|}


''<span style="color:red;">No additional information</span>''


===SampleSensor===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SampleSensor'''
|-
| colspan="2" | 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.&nbsp;
|-
|-
| 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''
|}




<span style="font-weight: normal;"><u>Oversample Rate</u></span>
===SetMode===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''SetMode'''
|-
| 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%" | Mode
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OversampleRate''.


''<span style="color:red;">No additional information</span>''
===WriteRegister===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''WriteRegister'''
|-
| colspan="2" | Writes a byte to a register&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | &nbsp;
|-
| 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''
|}




==Property reference==


<span style="font-weight: normal;"><u>Operational Mode</u></span>
{| class="mtx-class-macrotable wikitable"
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''OpMode''.
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
 
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
''<span style="color:red;">No additional information</span>''
|-
 
|-
 
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Device Settings
<span style="font-weight: normal;"><u>Channel</u></span>
|-
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::CHANNEL''.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Device Address
Channel selection
|-
 
| colspan="2" | &nbsp;
<span style="font-weight: normal;"><u>Baud Select</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::BAUD_LIST''.
| width="90%" | Measurement Rate
 
|-
Baud rate option selector
| colspan="2" | &nbsp;
 
|-
<span style="font-weight: normal;"><u>Baud Rate</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Oversample Rate
This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''.
|-
 
| colspan="2" | &nbsp;
Baud rate to be used
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
<span style="font-weight: normal;"><u>SDA</u></span>
| width="90%" | Operational Mode
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SDA''.
| colspan="2" | &nbsp;
 
|-
Pin used for SDA (data signal)
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Connections
<span style="font-weight: normal;"><u>SCL</u></span>
|-
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SCL''.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Channel
Pin used for SCL (clock signal)
|-
 
| colspan="2" | Channel selection&nbsp;
<span style="font-weight: normal;"><u>Stop Delay</u></span>
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::StopDel''.
| width="90%" | Baud Select
 
|-
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  
| colspan="2" | Baud rate option selector&nbsp;
 
|-
a 10ms delay between an I2C stop event and the next I2C start event.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Baud Rate
 
|-
 
| colspan="2" | Baud rate to be used&nbsp;
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
I2C communications.
| width="90%" | SDA
 
|-
<span style="font-weight: normal;"><u>Simulate Comms</u></span>
| colspan="2" | Pin used for SDA (data signal)&nbsp;
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''SimComms''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | SCL
No: Provides simulation using the panel component sliders.
|-
 
| colspan="2" | Pin used for SCL (clock signal)&nbsp;
Yes: Communicates via an API Slave device to real world hardware, shows the results using the panel component sliders.
|-
 
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
<span style="font-weight: normal;"><u>Scope Traces</u></span>
| width="90%" | Stop Delay
 
|-
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ScopeTraces''.
| colspan="2" | 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. &nbsp;
 
|-
Selects if the component pin connections are automatically generated on the data recorder window or not.
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
 
| width="90%" class="mtx-class-propfolder" | Simulation
Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion.
|-
 
|-
No: Do not show the pin signals on the data recorder window.
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
| width="90%" | Simulate Comms
<span style="font-weight: normal;"><u>Console Data</u></span>
|-
 
| colspan="2" | 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.&nbsp;
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ConsoleData''.
|}
 
Selects if the console data is automatically generated or not
 
<span style="font-weight: normal;"><u>API</u></span>
 
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::Injector''.
 
Specifies the API component on the panel to interact with to provide comms simulation.

Latest revision as of 14:37, 13 July 2026

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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Barometer_(DPS310)_(Environmental)&oldid=48136"