Component: RxTx Flasher (Advanced Shapes)
| Author | Matrix Ltd |
| Version | 2.0 (Release) |
| Category | Advanced Shapes |
Contents
RxTx 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.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation 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.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
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.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
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).
Parameters
- HANDLE Handle
- Handle of the console to call up.
Return value
- This call does not return a value
Property reference
Label
This property is of type Line of text and can be referenced with the variable name label.
Text for the label at the top of the component.
Icon
This property is of type Filename and can be referenced with the variable name icon_image.
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)
This property is of type Signed integer and can be referenced with the variable name flash_time.
How long each LED should remain lit following a trigger event.
Tx On
This property is of type Color picker and can be referenced with the variable name Tx_on_color.
LED colour when the transmit LED (right) is lit.
Tx Off
This property is of type Color picker and can be referenced with the variable name Tx_off_color.
LED colour when the transmit LED (right) is unlit
Rx On
This property is of type Color picker and can be referenced with the variable name Rx_on_color.
LED colour when the receive LED (left) is lit.
Rx Off
This property is of type Color picker and can be referenced with the variable name Rx_off_color.
LED colour when the receive LED (left) is unlit.
