Difference between revisions of "Component: EBM004 GUI (Misc)"

From Flowcode Help
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBM004_GUI.fcfx FC_Comp_Source_EBM004_GUI.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM004_GUI.fcfx FC_Comp_Source_EBM004_GUI.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM004_GUI.fcfx FC_Comp_Source_EBM004_GUI.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM004_GUI.fcfx FC_Comp_Source_EBM004_GUI.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
  
  
Line 68: Line 72:
  
  
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==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" | Get the complete 16bit integer value of the sensor's temperature register.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address of the byte to return.&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''
 
−
|}
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
{| 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" | Get the temperature register value converted into an actual floating point temperature readng in Celcius.&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''
 
−
|}
 
  
  
−
{| 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;" | '''SetMinMax'''
 
−
|-
 
−
| colspan="2" | Set the minimum and maximum temperature values that can be shown and set on the thermometer readout.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Min
 
−
|-
 
−
| colspan="2" | Minimum Value&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Max
 
−
|-
 
−
| colspan="2" | Maximum Value&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''
 
−
|}
 
  
  
−
{| 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" | Get the data from the MSB of a sensor register.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address of the byte to return.&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''
 
−
|}
 
  
  
−
{| 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;" | '''SetConsoleHandle'''
 
−
|-
 
−
| colspan="2" | Pass the parent sensor's console handle to the GUI to allow opening of the console from the 'Console' button.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
−
| width="90%" | Handle
 
−
|-
 
−
| colspan="2" | Handle of the console&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''
 
−
|}
 
  
  
−
{| 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;" | '''SetTemperature'''
 
−
|-
 
−
| colspan="2" | Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Temperature
 
−
|-
 
−
| colspan="2" | Zero to one value - representing min-max of the sensor.&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''
 
−
|}
 
  
  
  
 +
==Macro reference==
  
−
==Property reference==
+
===ReadByte===
−
 
 
−
{| 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" 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-10-icon.png]]
 
−
| width="90%" | Label
 
−
|-
 
−
| colspan="2" | A text label to help you identify the component on the panel.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | I2C Data
 
−
|-
 
−
| colspan="2" | Choose whether the I2C data is shown as decimal or hexadecimal values.&nbsp;
 
−
|}==Macro reference==
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte'''
 
|-
 
|-
−
| colspan="2" | Get the complete 16bit integer value of the sensor's temperature register.&nbsp;
+
| colspan="2" | Get the data from the MSB of a sensor register.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 234: Line 105:
 
| colspan="2" | The address of the byte to return.&nbsp;
 
| colspan="2" | The address of the byte to return.&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===ReadFloat===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 252: Line 124:
  
  
 +
===ReadInt===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMinMax'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadInt'''
 
|-
 
|-
−
| colspan="2" | Set the minimum and maximum temperature values that can be shown and set on the thermometer readout.&nbsp;
+
| colspan="2" | Get the complete 16bit integer value of the sensor's temperature register.&nbsp;
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Min
 
−
|-
 
−
| colspan="2" | Minimum Value&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Max
 
−
|-
 
−
| colspan="2" | Maximum Value&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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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" | Get the data from the MSB of a sensor register.&nbsp;
 
 
|-
 
|-
 
|-
 
|-
Line 288: Line 138:
 
| colspan="2" | The address of the byte to return.&nbsp;
 
| colspan="2" | The address of the byte to return.&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-s16-icon.png]] - INT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===SetConsoleHandle===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 311: Line 162:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===SetMinMax===
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTemperature'''
 
−
|-
 
−
| colspan="2" | Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Temperature
 
−
|-
 
−
| colspan="2" | Zero to one value - representing min-max of the sensor.&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==
 
−
 
 
−
{| 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" 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-10-icon.png]]
 
−
| width="90%" | Label
 
−
|-
 
−
| colspan="2" | A text label to help you identify the component on the panel.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | I2C Data
 
−
|-
 
−
| colspan="2" | Choose whether the I2C data is shown as decimal or hexadecimal values.&nbsp;
 
−
|}==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" | Get the complete 16bit integer value of the sensor's temperature register.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address of the byte to return.&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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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" | Get the temperature register value converted into an actual floating point temperature readng in Celcius.&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''
 
−
|}
 
−
 
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 423: Line 186:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===SetTemperature===
−
|-
 
−
| 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" | Get the data from the MSB of a sensor register.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Address
 
−
|-
 
−
| colspan="2" | The address of the byte to return.&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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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;" | '''SetConsoleHandle'''
 
−
|-
 
−
| colspan="2" | Pass the parent sensor's console handle to the GUI to allow opening of the console from the 'Console' button.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
−
| width="90%" | Handle
 
−
|-
 
−
| colspan="2" | Handle of the console&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''
 
−
|}
 
−
 
 
−
 
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 475: Line 203:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 13:09, 7 February 2023

Author Matrix
Version 1.0
Category Misc


EBM004_GUI component

Private non-release sub-component for the EBM004 digital temperature sensor.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

ReadByte

Fc9-comp-macro.png ReadByte
Get the data from the MSB of a sensor register. 
Fc9-u8-icon.png - BYTE Address
The address of the byte to return. 
Fc9-u8-icon.png - BYTE Return


ReadFloat

Fc9-comp-macro.png ReadFloat
Get the temperature register value converted into an actual floating point temperature readng in Celcius. 
Fc9-f32-icon.png - FLOAT Return


ReadInt

Fc9-comp-macro.png ReadInt
Get the complete 16bit integer value of the sensor's temperature register. 
Fc9-u8-icon.png - BYTE Address
The address of the byte to return. 
Fc9-s16-icon.png - INT Return


SetConsoleHandle

Fc9-comp-macro.png SetConsoleHandle
Pass the parent sensor's console handle to the GUI to allow opening of the console from the 'Console' button. 
Fc9-h32-icon.png - HANDLE Handle
Handle of the console 
Fc9-void-icon.png - VOID Return


SetMinMax

Fc9-comp-macro.png SetMinMax
Set the minimum and maximum temperature values that can be shown and set on the thermometer readout. 
Fc9-f32-icon.png - FLOAT Min
Minimum Value 
Fc9-f32-icon.png - FLOAT Max
Maximum Value 
Fc9-void-icon.png - VOID Return


SetTemperature

Fc9-comp-macro.png SetTemperature
Sends the given temperature to the display, and calculates the internal values used by the simulated read macros. 
Fc9-f32-icon.png - FLOAT Temperature
Zero to one value - representing min-max of the sensor. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Simulation
Fc9-type-10-icon.png Label
A text label to help you identify the component on the panel. 
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
Choose whether the I2C data is shown as decimal or hexadecimal values. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_EBM004_GUI_(Misc)&oldid=37930"