Difference between revisions of "Component: Digital Temperature (EBM004) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(16 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
−
| 2.0 (Release)
+
| 2.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| EBM Modules
 
| EBM Modules
 
|}
 
|}
  
  
−
 
+
==Digital Temperature component==
−
==[[File:Component Icon e3fdcca6_1408_4389_8e2d_e741b06b3463.png|Image]] Digital Temperature (EBM004) component==
 
 
A digital temperature sensor based around the LM75B chip.
 
A digital temperature sensor based around the LM75B chip.
  
−
==Examples==
+
==Component Source Code==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM004v1.fcfx FC_Comp_Source_EBM004v1.fcfx]
  
−
==Downloadable macro reference==
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM004v1.fcfx FC_Comp_Source_EBM004v1.fcfx]
  
−
===<span style="font-weight: normal;"><u><tt>ReadInt</tt></u></span>===
+
==Detailed description==
−
Read double byte data from register at address
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''address''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|INT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadFloat</tt></u></span>===
 
−
Reads the temperature value as a float
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>WriteByte</tt></u></span>===
 
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''address''
 
  
−
:[[Variable Types|BYTE]] ''data''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
 +
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>WriteInt</tt></u></span>===
+
==Examples==
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''address''
 
  
−
:[[Variable Types|UINT]] ''data''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadByte</tt></u></span>===
 
−
Read a single byte at a specific address  from the chip's internal memory.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''address''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Uninit</tt></u></span>===
 
−
Uninitialise and release resources
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Initialise to default of 11 bit resolution
 
  
−
'''Parameters'''
+
This example simply reads the value from the digital temperature sensor and outputs the value to an LCD as a temperature in degrees C.
  
−
:''This macro has no parameters''
+
{{Fcfile|EBM004 - Test Program.fcfx|EBM004 Example}}
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<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''.
 
  
−
Channel selection
 
  
−
<span style="font-weight: normal;"><u>SDA</u></span>
+
==Macro reference==
  
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SDA''.
+
===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" | Initialise to default of 11 bit resolution&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''
 +
|}
  
−
Pin used for SDA (data signal)
 
  
−
<span style="font-weight: normal;"><u>SCL</u></span>
+
===ReadByte===
 +
{| 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;" | '''ReadByte'''
 +
|-
 +
| colspan="2" | Read a single byte at a specific address  from the chip's internal memory.&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''
 +
|}
  
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c1::SCL''.
 
  
−
Pin used for SCL (clock signal)
+
===ReadFloat===
 +
{| 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;" | '''ReadFloat'''
 +
|-
 +
| colspan="2" | Reads the temperature value as a float&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="font-weight: normal;"><u>Baud Select</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::BAUD_LIST''.
+
===ReadInt===
 +
{| 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;" | '''ReadInt'''
 +
|-
 +
| colspan="2" | Read double byte data from register at address&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-s16-icon.png]] - INT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
Baud rate option selector
 
  
−
<span style="font-weight: normal;"><u>Baud Rate</u></span>
+
===Uninit===
 +
{| 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;" | '''Uninit'''
 +
|-
 +
| colspan="2" | Uninitialise and release resources&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 ''Signed integer'' and can be referenced with the variable name ''cal_i2c1::BAUD''.
 
  
−
Baud rate to be used
+
===WriteByte===
 +
{| 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;" | '''WriteByte'''
 +
|-
 +
| colspan="2" | &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-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<span style="font-weight: normal;"><u>Stop Delay</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::StopDel''.
+
===WriteInt===
 +
{| 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;" | '''WriteInt'''
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | data
 +
|-
 +
| 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''
 +
|}
  
−
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.
+
==Property reference==
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
−
I2C communications.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Simulation Type</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Channel
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimType''.
+
|-
−
 
+
| colspan="2" | Channel selection&nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | SDA
−
 
+
|-
−
<span style="font-weight: normal;"><u>Label</u></span>
+
| colspan="2" | Pin used for SDA (data signal)&nbsp;
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | SCL
−
A text label to help you identify the component on the panel.
+
|-
−
 
+
| colspan="2" | Pin used for SCL (clock signal)&nbsp;
−
<span style="font-weight: normal;"><u>Min. Temp.</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Floating point'' and can be referenced with the variable name ''min_temp''.
+
| width="90%" | Baud Select
−
 
+
|-
−
Minimum termperature that can be set or displayed on the thermometer slider.
+
| colspan="2" | Baud rate option selector&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Max. Temp.</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Baud Rate
−
This property is of type ''Floating point'' and can be referenced with the variable name ''max_temp''.
+
|-
−
 
+
| colspan="2" | Baud rate to be used&nbsp;
−
Maximum termperature that can be set or displayed on the thermometer slider.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Scale divisions</u></span>
+
| width="90%" | Stop Delay
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''scale_divisions''.
+
| 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;
−
 
+
|-
−
Number of numbered divisions shown on the thermometer scale.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
<span style="font-weight: normal;"><u>I2C Data</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''number_base''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Simulation Comms
−
Set whether the I2C data is displayed as decimal or hexadecimal numbers.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ScopeTraces''.
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation GUI
−
 
+
|-
−
Selects if the component pin connections are automatically generated on the data recorder window or not.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion.
+
| width="90%" | Min. Temp.
−
 
+
|-
−
No: Do not show the pin signals on the data recorder window.
+
| colspan="2" | Minimum termperature that can be set or displayed on the thermometer slider.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Console Data</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Max. Temp.
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c1::ConsoleData''.
+
|-
−
 
+
| colspan="2" | Maximum termperature that can be set or displayed on the thermometer slider.&nbsp;
−
Selects if the console data is automatically generated or not
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
<span style="font-weight: normal;"><u>Injector</u></span>
+
| width="90%" | Scale divisions
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c1::Injector''.
+
| colspan="2" | Number of numbered divisions shown on the thermometer scale.&nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | I2C Data
 +
|-
 +
| colspan="2" | Set whether the I2C data is displayed as decimal or hexadecimal numbers.&nbsp;
 +
|}

Latest revision as of 13:09, 7 February 2023

Author Matrix TSL
Version 2.0
Category EBM Modules


Digital Temperature component

A digital temperature sensor based around the LM75B chip.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

This example simply reads the value from the digital temperature sensor and outputs the value to an LCD as a temperature in degrees C.

FC6 Icon.png EBM004 Example







Macro reference

Initialise

Fc9-comp-macro.png Initialise
Initialise to default of 11 bit resolution 
Fc9-u8-icon.png - BYTE Return


ReadByte

Fc9-comp-macro.png ReadByte
Read a single byte at a specific address from the chip's internal memory. 
Fc9-u8-icon.png - BYTE address
 
Fc9-u8-icon.png - BYTE Return


ReadFloat

Fc9-comp-macro.png ReadFloat
Reads the temperature value as a float 
Fc9-f32-icon.png - FLOAT Return


ReadInt

Fc9-comp-macro.png ReadInt
Read double byte data from register at address 
Fc9-u8-icon.png - BYTE address
 
Fc9-s16-icon.png - INT Return


Uninit

Fc9-comp-macro.png Uninit
Uninitialise and release resources 
Fc9-void-icon.png - VOID Return


WriteByte

Fc9-comp-macro.png WriteByte
 
Fc9-u8-icon.png - BYTE address
 
Fc9-u8-icon.png - BYTE data
 
Fc9-u8-icon.png - BYTE Return


WriteInt

Fc9-comp-macro.png WriteInt
 
Fc9-u8-icon.png - BYTE address
 
Fc9-u16-icon.png - UINT data
 
Fc9-u8-icon.png - BYTE Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-7-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulation Comms
 
Fc9-conn-icon.png Simulation GUI
Fc9-type-15-icon.png Min. Temp.
Minimum termperature that can be set or displayed on the thermometer slider. 
Fc9-type-15-icon.png Max. Temp.
Maximum termperature that can be set or displayed on the thermometer slider. 
Fc9-type-21-icon.png Scale divisions
Number of numbered divisions shown on the thermometer scale. 
Fc9-type-16-icon.png I2C Data
Set whether the I2C data is displayed as decimal or hexadecimal numbers. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Digital_Temperature_(EBM004)_(EBM_Modules)&oldid=37931"