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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBM004v1.fcfx FC_Comp_Source_EBM004v1.fcfx]
+
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]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 38: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 61: Line 65:
  
 
==Macro reference==
 
==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;" | '''ReadInt'''
 +
|-
 +
| colspan="2" | Read double byte data from register at address 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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 
 +
|-
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | Channel selection 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SDA
 +
|-
 +
| colspan="2" | Pin used for SDA (data signal) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | SCL
 +
|-
 +
| colspan="2" | Pin used for SCL (clock signal) 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Baud Select
 +
|-
 +
| colspan="2" | Baud rate option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Baud Rate
 +
|-
 +
| colspan="2" | Baud rate to be used 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Stop Delay
 +
|-
 +
| 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.  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Simulation Comms
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation GUI
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Min. Temp.
 +
|-
 +
| colspan="2" | Minimum termperature that can be set or displayed on the thermometer slider. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Max. Temp.
 +
|-
 +
| colspan="2" | Maximum termperature that can be set or displayed on the thermometer slider. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Scale divisions
 +
|-
 +
| colspan="2" | Number of numbered divisions shown on the thermometer scale. 
 +
|-
 +
| 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. 
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:13, 20 January 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 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

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


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


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


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


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


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


Fc9-comp-macro.png Initialise
Initialise to default of 11 bit resolution 
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. 

==Macro reference==

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


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


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


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


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


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


Fc9-comp-macro.png Initialise
Initialise to default of 11 bit resolution 
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=32503"