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

Latest revision as of 13:09, 7 February 2023

Author	Matrix
Version	1.0
Category	Misc

EBM0016_GUI component

Private non-release sub-component for the EBM0016 digital Humidity/temperature sensor.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetData

	GetData
Return a simulated register value for the given commands. Recognised commands are 0xF3 (Temperature register) and 0xF5 (Humidity Register). Note that a CRC checksum is not used in simulation.
- BYTE	Command
The address of the byte to return.
- UINT	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

SetHumidity

	SetHumidity
Sends the given Humidity to the display, and calculates the internal values used by the simulated read macros.
- FLOAT	Humidity
Relative Humidity from 0 to 100 %
- VOID	Return

SetTemperature

	SetTemperature
Sends the given temperature to the display, and calculates the internal values used by the simulated read macros.
- FLOAT	Temperature
Temperature value in Celcius,
- VOID	Return

Property reference

	Properties
	Simulation
	Label
A text label to help you identify the component on the panel.
	Sub Label

	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.

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

Latest revision as of 13:09, 7 February 2023

Contents

EBM0016_GUI component

Component Source Code

Detailed description

Examples

Macro reference

GetData

SetConsoleHandle

SetHumidity

SetTemperature

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EBM0016_GUI.fcfx FC_Comp_Source_EBM0016_GUI.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EBM0016_GUI.fcfx FC_Comp_Source_EBM0016_GUI.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EBM0016_GUI.fcfx FC_Comp_Source_EBM0016_GUI.fcfx]
 ==Detailed description==
@@ Line 34: / Line 38: @@
 ==Examples==
@@ Line 45: / Line 53: @@
 ''<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;" | '''SetHumidity'''
-|-
-| colspan="2" | Sends the given Humidity 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%" | Humidity
-|-
-| colspan="2" | Relative Humidity from 0  to 100 %&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;" | '''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" | Temperature value in Celcius,&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==
+===GetData===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 119: / Line 84: @@
+===SetConsoleHandle===
-==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-10-icon.png]]
-| width="90%" | Sub Label
-|-
-| colspan="2" | &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;" | '''SetHumidity'''
-|-
-| colspan="2" | Sends the given Humidity 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%" | Humidity
-|-
-| colspan="2" | Relative Humidity from 0  to 100 %&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;"
 |-
@@ Line 200: / Line 103: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetHumidity===
-|-
-| 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" | Temperature value in Celcius,&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;" | '''GetData'''
-|-
-| colspan="2" | Return a simulated register value for the given commands.  Recognised commands are 0xF3 (Temperature register) and 0xF5 (Humidity Register). Note that a CRC checksum is not used in simulation.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Command
-|-
-| colspan="2" | The address of the byte to return.&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| 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-10-icon.png]]
-| width="90%" | Sub Label
-|-
-| colspan="2" | &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;"
 |-
@@ Line 299: / Line 122: @@
-{| 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;" | '''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;"
 |-
@@ Line 333: / Line 139: @@
 | 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;" | '''GetData'''
-|-
-| colspan="2" | Return a simulated register value for the given commands.  Recognised commands are 0xF3 (Temperature register) and 0xF5 (Humidity Register). Note that a CRC checksum is not used in simulation.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Command
-|-
-| colspan="2" | The address of the byte to return.&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}