View source for Component: Rx/Tx Flasher (Advanced Shapes)

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 2.0
|-
| width="20%" style="color:gray;" | Category
| Advanced Shapes
|}


==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 to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Comms_indicators.fcfx FC_Comp_Source_Comms_indicators.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Comms_indicators.fcfx FC_Comp_Source_Comms_indicators.fcfx]

==Detailed description==

















''No detailed description exists yet for this component''

==Examples==


















''<span style="color:red;">No additional examples</span>''












==Macro reference==

===FlashRx===
{| 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;" | '''FlashRx'''
|-
| colspan="2" | 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.&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''
|}


===FlashTx===
{| 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;" | '''FlashTx'''
|-
| colspan="2" | 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.&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''
|}


===SetConsole===
{| 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;" | '''SetConsole'''
|-
| colspan="2" | 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).&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" | Handle
|-
| colspan="2" | Handle of the console to call up.&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''
|}


==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" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | Text for the label at the top of the component.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | Icon
|-
| colspan="2" | 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.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Flash Time (ms)
|-
| colspan="2" | How long each LED should remain lit following a trigger event.&nbsp;
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colors
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Tx On
|-
| colspan="2" | LED colour when the transmit LED (right) is lit.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Tx Off
|-
| colspan="2" | LED colour when the transmit LED (right) is unlit&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Rx On
|-
| colspan="2" | LED colour when the receive LED (left) is lit.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Rx Off
|-
| colspan="2" | LED colour when the receive LED (left) is unlit.&nbsp;
|}