Difference between revisions of "Component: EBM004 GUI (Misc)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;" |...") |
|||
| (9 intermediate revisions by the same user not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | 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] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 36: | Line 50: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 53: | Line 79: | ||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===ReadByte=== | ||
{| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadByte''' |
|- | |- | ||
| − | | colspan="2" | Get the | + | | colspan="2" | Get the data from the MSB of a sensor register. |
|- | |- | ||
|- | |- | ||
| Line 68: | Line 105: | ||
| colspan="2" | The address of the byte to return. | | colspan="2" | The address of the byte to return. | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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 86: | 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadInt''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Get the complete 16bit integer value of the sensor's temperature register. |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| − | | width="90%" | | + | | width="90%" | Address |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | The address of the byte to return. |
|- | |- | ||
| − | + | | 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- | ||
| 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;" | ||
|- | |- | ||
| 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;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetConsoleHandle''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Pass the parent sensor's console handle to the GUI to allow opening of the console from the 'Console' button. |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | | width="90%" | | + | | width="90%" | Handle |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Handle of the console |
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| + | ===SetMinMax=== | ||
{| 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;" | ''' | + | | 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. | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| + | | width="90%" | Min | ||
|- | |- | ||
| + | | colspan="2" | Minimum Value | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| − | | width="90%" | | + | | width="90%" | Max |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Maximum Value |
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| Line 145: | Line 186: | ||
| + | ===SetTemperature=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 161: | 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 |
Contents
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
|
ReadByte |
| Get the data from the MSB of a sensor register. | |
 - BYTE
|
Address |
| The address of the byte to return. | |
| - BYTE
|
Return |
ReadFloat
|
|
ReadFloat |
| Get the temperature register value converted into an actual floating point temperature readng in Celcius. | |
 - FLOAT
|
Return |
ReadInt
|
|
ReadInt |
| Get the complete 16bit integer value of the sensor's temperature register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
 - INT
|
Return |
SetConsoleHandle
|
|
SetConsoleHandle |
| Pass the parent sensor's console handle to the GUI to allow opening of the console from the 'Console' button. | |
 - HANDLE
|
Handle |
| Handle of the console | |
 - VOID
|
Return |
SetMinMax
|
|
SetMinMax |
| Set the minimum and maximum temperature values that can be shown and set on the thermometer readout. | |
| - FLOAT
|
Min |
| Minimum Value | |
| - FLOAT
|
Max |
| Maximum Value | |
| - VOID
|
Return |
SetTemperature
|
|
SetTemperature |
| Sends the given temperature to the display, and calculates the internal values used by the simulated read macros. | |
| - FLOAT
|
Temperature |
| Zero to one value - representing min-max of the sensor. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Simulation |
|
Label |
| A text label to help you identify the component on the panel. | |
|
Min. Temp. |
| Minimum termperature that can be set or displayed on the thermometer slider. | |
|
|
Max. Temp. |
| Maximum termperature that can be set or displayed on the thermometer slider. | |
|
Scale divisions |
| Number of numbered divisions shown on the thermometer scale. | |
|
I2C Data |
| Choose whether the I2C data is shown as decimal or hexadecimal values. | |
