Jump to content

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

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import
 
No edit summary
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.
==Detailed description==


==[[File:Component Icon ca60c1d2_fb77_4e3e_9d01_c4496d35db1e.png|Image]] Barometer (DPS310) component==
''No detailed description exists yet for this 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.


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


Line 25: Line 27:
==Downloadable macro reference==
==Downloadable macro reference==


===<span style="font-weight: normal;"><u><tt>ReadTemperature</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Reads the temperature measurement from the last SampleSensor macro
|-
| 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:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:''This macro has no parameters''
{| 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;" | '''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''
|}




'''Return value'''
{| 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;" | '''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''
|}


:[[Variable Types|FLOAT]]


{| 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;" | '''ReadPressure'''
|-
| colspan="2" | Reads the pressure measurement from the last SampleSensor macro&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


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


'''Parameters'''
{| 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'''
|-
| 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''
|}


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


:[[Variable Types|BYTE]] ''Oversample''
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc
|-
| 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:]] -  
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
{| 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;" | '''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''
|}


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


{| 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'''
|-
| 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><tt>ConfigureTemperature</tt></u></span>===
Configures the temperature sensor sample rate and over sampling count


'''Parameters'''
{| 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;" | '''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''
|}


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


:[[Variable Types|BYTE]] ''Oversample''
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
::Range: 0-7, 0=1Samples, 1=2Samples, 2=4Samples etc
|-
| 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:]] -  
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
:''This call does not return a value''
===<span style="font-weight: normal;"><u><tt>ReadPressure</tt></u></span>===
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'''
:''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'''
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
==Simulation macro reference==
''This component does not contain any simulation macros''




==Property reference==
==Property reference==
<span style="font-weight: normal;"><u>Device Address</u></span>


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

Revision as of 20:47, 16 November 2021

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.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

ReadTemperature
Reads the temperature measurement from the last SampleSensor macro 
[[File:]] - Return


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
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


ReadPressure
Reads the pressure measurement from the last SampleSensor macro 
[[File:]] - Return


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


ReadAltitude
Reads the pressure measurement from the last SampleSensor macro and converts the pressure reading into an altitude reading. 
[[File:]] - Return


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


ReadRegister
Reads a byte from a register 
- BYTE Address
 
- BYTE Return


WriteRegister
Writes a byte to a register 
- BYTE Address
 
- BYTE Data
 
- VOID Return


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. 
[[File:]] - Return



Property reference

Properties
Device Address
 
Measurement Rate
 
Oversample Rate
 
Operational Mode
 
Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. 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. 
Console Data
Selects if the console data is automatically generated or not 
API
Specifies the API component on the panel to interact with to provide comms simulation. 
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.  
Simulations
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=25510"