Difference between revisions of "Component: Injector (Human Interface) (Test Injectors)"
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_InjectorHI.fcfx FC_Comp_Source_InjectorHI.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorHI.fcfx FC_Comp_Source_InjectorHI.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_InjectorHI.fcfx FC_Comp_Source_InjectorHI.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 46: | Line 48: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 85: | Line 89: | ||
==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;" | '''UARTBaud''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Rate | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''IOGetInputPin''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the selected digital pin to an input and reads the input state. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Pin | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-19 | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | 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;" | '''UARTCheckRX''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''UARTInitialise''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''GetConsoleHandle''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | 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;" | '''UARTReceive''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''IOSetOutputPin''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the selected digital pin to an output and assigns the output state. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Pin | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-53 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | State | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-1 | ||
| + | |- | ||
| + | | 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;" | '''UARTSend''' | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Channel | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Data | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Sets up the injector ready to receive commands or send data | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | HI Injector Settings | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Buffer Size | ||
| + | |- | ||
| + | | colspan="2" | Max number of bytes that can be stored in the components circular buffer | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Data Mode | ||
| + | |- | ||
| + | | colspan="2" | Sets the console data to interperete the data as ASCII or as Numbers 0-255 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | label | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Show Console | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Test Injectors |
Contents
Injector (Human Interface) component
Comms data injector to allow typed data values to be inserted into a component. Allows data to be input in raw ASCII form or as numeric byte data 0-255.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_InjectorHI.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_InjectorHI.fcfx
Detailed description
No detailed description exists yet for this component
Examples
This example receives a character via the RS232 component and outputs it to the LCD, an injector has been added to allow you to type data into the console.
Human Interface Injector Example
The Console window has tabs for the human interface data injector allowing you to type in data that will be received by the component.
Again the RS232 console tabs reflect the data as it is sent and received.
LCD showing received data.
Macro reference
|
UARTBaud |
 - BYTE
|
Channel |
| - BYTE
|
Rate |
 - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-19 | |
 - BOOL
|
Return |
|
|
UARTCheckRX |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
UARTInitialise |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
 - HANDLE
|
Return |
|
|
UARTReceive |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-53 | |
| - BOOL
|
State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
UARTSend |
| - BYTE
|
Channel |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the injector ready to receive commands or send data | |
| - VOID
|
Return |
Property reference
|
Properties |
|
HI Injector Settings |
|
Buffer Size |
| Max number of bytes that can be stored in the components circular buffer | |
|
Data Mode |
| Sets the console data to interperete the data as ASCII or as Numbers 0-255 | |
|
label |
|
Show Console |
==Macro reference==
|
|
UARTBaud |
| - BYTE
|
Channel |
| - BYTE
|
Rate |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-19 | |
| - BOOL
|
Return |
|
|
UARTCheckRX |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
UARTInitialise |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
| - HANDLE
|
Return |
|
|
UARTReceive |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-53 | |
| - BOOL
|
State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
UARTSend |
| - BYTE
|
Channel |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the injector ready to receive commands or send data | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
HI Injector Settings |
|
|
Buffer Size |
| Max number of bytes that can be stored in the components circular buffer | |
|
|
Data Mode |
| Sets the console data to interperete the data as ASCII or as Numbers 0-255 | |
|
|
label |
|
|
Show Console |
==Macro reference==
|
|
UARTBaud |
| - BYTE
|
Channel |
| - BYTE
|
Rate |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-19 | |
| - BOOL
|
Return |
|
|
UARTCheckRX |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
UARTInitialise |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
| - HANDLE
|
Return |
|
|
UARTReceive |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-53 | |
| - BOOL
|
State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
UARTSend |
| - BYTE
|
Channel |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the injector ready to receive commands or send data | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
HI Injector Settings |
|
|
Buffer Size |
| Max number of bytes that can be stored in the components circular buffer | |
|
|
Data Mode |
| Sets the console data to interperete the data as ASCII or as Numbers 0-255 | |
|
|
label |
|
|
Show Console |
==Macro reference==
|
|
UARTBaud |
| - BYTE
|
Channel |
| - BYTE
|
Rate |
| - VOID
|
Return |
|
|
IOGetInputPin |
| Sets the selected digital pin to an input and reads the input state. | |
| - BYTE
|
Pin |
| Range: 0-19 | |
| - BOOL
|
Return |
|
|
UARTCheckRX |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
UARTInitialise |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
| - HANDLE
|
Return |
|
|
UARTReceive |
| - BYTE
|
Channel |
| - BYTE
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-53 | |
| - BOOL
|
State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
UARTSend |
| - BYTE
|
Channel |
| - BYTE
|
Data |
| - VOID
|
Return |
|
|
Initialise |
| Sets up the injector ready to receive commands or send data | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
HI Injector Settings |
|
|
Buffer Size |
| Max number of bytes that can be stored in the components circular buffer | |
|
|
Data Mode |
| Sets the console data to interperete the data as ASCII or as Numbers 0-255 | |
|
|
label |
|
|
Show Console |
