Difference between revisions of "Component: EBM004 GUI (Misc)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | 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 46: | Line 48: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 72: | Line 76: | ||
==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" | Get the complete 16bit integer value of the sensor's temperature register. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | 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="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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Min | ||
| + | |- | ||
| + | | colspan="2" | Minimum Value | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Max | ||
| + | |- | ||
| + | | colspan="2" | Maximum Value | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Address | ||
| + | |- | ||
| + | | colspan="2" | The address of the byte to return. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | Handle of the console | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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" | Choose whether the I2C data is shown as decimal or hexadecimal values. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:55, 27 January 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
|
ReadInt |
| Get the complete 16bit integer value of the sensor's temperature register. | |
 - BYTE
|
Address |
| The address of the byte to return. | |
 - INT
|
Return |
|
|
ReadFloat |
| Get the temperature register value converted into an actual floating point temperature readng in Celcius. | |
 - FLOAT
|
Return |
|
|
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 |
|
|
ReadByte |
| Get the data from the MSB of a sensor register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - BYTE
|
Return |
|
|
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 |
|
|
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. | |
==Macro reference==
|
|
ReadInt |
| Get the complete 16bit integer value of the sensor's temperature register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - INT
|
Return |
|
|
ReadFloat |
| Get the temperature register value converted into an actual floating point temperature readng in Celcius. | |
| - FLOAT
|
Return |
|
|
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 |
|
|
ReadByte |
| Get the data from the MSB of a sensor register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - BYTE
|
Return |
|
|
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 |
|
|
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. | |
==Macro reference==
|
|
ReadInt |
| Get the complete 16bit integer value of the sensor's temperature register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - INT
|
Return |
|
|
ReadFloat |
| Get the temperature register value converted into an actual floating point temperature readng in Celcius. | |
| - FLOAT
|
Return |
|
|
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 |
|
|
ReadByte |
| Get the data from the MSB of a sensor register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - BYTE
|
Return |
|
|
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 |
|
|
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. | |
==Macro reference==
|
|
ReadInt |
| Get the complete 16bit integer value of the sensor's temperature register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - INT
|
Return |
|
|
ReadFloat |
| Get the temperature register value converted into an actual floating point temperature readng in Celcius. | |
| - FLOAT
|
Return |
|
|
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 |
|
|
ReadByte |
| Get the data from the MSB of a sensor register. | |
| - BYTE
|
Address |
| The address of the byte to return. | |
| - BYTE
|
Return |
|
|
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 |
|
|
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. | |
