Difference between revisions of "Component: Rx/Tx Flasher (Advanced Shapes)"
From Flowcode Help
Jump to navigationJump to search| Line 20: | Line 20: | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 28: | Line 30: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 37: | Line 41: | ||
| − | == | + | ==Macro reference== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 14:10, 20 January 2023
| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Advanced Shapes |
Contents
Rx/Tx Flasher component
Simple indicator panel intended as a sub-component of communications components. The two arrow shapes can be set to flash by the host component to represent incoming and outgoing data packets. The panel can be labelled and use a custom icon for easy identification. The icon area can be set to open a pre-defined console window when clicked. LEDs can also be flashed by sending the component a User Notify event. Event 'Message ID' is ignored. Data should be: 1, to flash to Rx LED or 2 to flash the Tx LED.
Component Source Code
Please click here for the component source code: FC_Comp_Source_Comms_indicators.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
FlashRx |
| Lights the Rx LED - the arrow on the left of the component. It will turn off again automatically when the time set by the Flash Time property has expired. Intended to be called when a comm's component has received a packet of data. | |
 - VOID
|
Return |
|
|
FlashTx |
| Lights the Tx LED - the arrow on the right of the component. It will turn off again automatically when the time set by the Flash Time property has expired. Intended to be called when a comm's component has sent a packet of data. | |
| - VOID
|
Return |
|
|
SetConsole |
| Register the handle of a console window. This console will be opened when the icon on the component is clicked (the area between the two arrows). | |
 - HANDLE
|
Handle |
| Handle of the console to call up. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Label |
| Text for the label at the top of the component. | |
|
Icon |
| Path to a bitmap image to be displayed in the icon area between the two arrows. The image will be resized to fit the area - it should ideally be a square image, and must be less than 128 pixels along each side. To ensure that the icon displays reliably, it should be stored as one of the host component's resources. | |
|
Flash Time (ms) |
| How long each LED should remain lit following a trigger event. | |
|
Colors |
|
Tx On |
| LED colour when the transmit LED (right) is lit. | |
|
|
Tx Off |
| LED colour when the transmit LED (right) is unlit | |
|
|
Rx On |
| LED colour when the receive LED (left) is lit. | |
|
|
Rx Off |
| LED colour when the receive LED (left) is unlit. | |
