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

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==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_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]
 
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==
 
==Detailed description==
 +
 +
  
  
Line 30: Line 34:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 40: Line 46:
  
 
==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;" | '''SetHumidity'''
 +
|-
 +
| colspan="2" | Sends the given Humidity 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%" | Humidity
 +
|-
 +
| colspan="2" | Relative Humidity from 0  to 100 % 
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| 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" | Temperature value in Celcius, 
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Command
 +
|-
 +
| colspan="2" | The address of the byte to return. 
 +
|-
 +
| 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Sub Label
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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 15:21, 20 January 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

Fc9-comp-macro.png SetHumidity
Sends the given Humidity to the display, and calculates the internal values used by the simulated read macros. 
Fc9-f32-icon.png - FLOAT Humidity
Relative Humidity from 0 to 100 % 
Fc9-void-icon.png - VOID Return


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


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
Temperature value in Celcius, 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Command
The address of the byte to return. 
Fc9-u16-icon.png - UINT 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-10-icon.png Sub Label
 
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. 

==Macro reference==

Fc9-comp-macro.png SetHumidity
Sends the given Humidity to the display, and calculates the internal values used by the simulated read macros. 
Fc9-f32-icon.png - FLOAT Humidity
Relative Humidity from 0 to 100 % 
Fc9-void-icon.png - VOID Return


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


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
Temperature value in Celcius, 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Command
The address of the byte to return. 
Fc9-u16-icon.png - UINT 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-10-icon.png Sub Label
 
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. 

==Macro reference==

Fc9-comp-macro.png SetHumidity
Sends the given Humidity to the display, and calculates the internal values used by the simulated read macros. 
Fc9-f32-icon.png - FLOAT Humidity
Relative Humidity from 0 to 100 % 
Fc9-void-icon.png - VOID Return


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


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
Temperature value in Celcius, 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE Command
The address of the byte to return. 
Fc9-u16-icon.png - UINT 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-10-icon.png Sub Label
 
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:_EBM0016_GUI_(Misc)&oldid=33254"