Component: Simulation LED Template (Indicators)

From Flowcode Help
Jump to: navigation, search


Author Matrix Ltd
Version 1.4 (Release)
Category Indicators


Contents

Image Simulation LED Template component

Base for creating simulation LEDs and other on/off visual indicators. Choose a 'Target Object' that will change colour when the pin changes; if multiple objects must change color, group them, and target the group. When 'Auto off color" is selected, changing the 'on color' will automatically choose an off color by reducing the intensity of the on color.

This component can be used as a base to create child components

The following components all inherit the traits of Simulation LED Template:

-
Image Simulation LED (SMD) A simple LED suitable for simulation that does not require a pin connection
Image Simulation LED (LES, Panel) Panel lamp for a LES bulb.

Colour can be changed in component properties.

Image Simulation LED (3mm, PCB) An industry standard 3mm diameter LED.

Any color may be chosen, and the leads trimmed to length.

Image Simulation LED (5mm, PCB) An industry standard 5mm diameter LED.

Any color may be chosen, and the leads trimmed to length.

Examples

No additional examples


Downloadable macro reference

TurnOn

Turn the LED off.

Parameters

This macro has no parameters


Return value

This call does not return a value


TurnOff

Turn the LED on.

Parameters

This macro has no parameters


Return value

This call does not return a value


Simulation macro reference

This component does not contain any simulation macros


Property reference

Target Object

This property is of type Panel object and can be referenced with the variable name target_object.

Set a target object to be the illuminating part of the LED.

To change the colour of multiple objects, group them first, then target the group.

Label

This property is of type Fixed list of ints and can be referenced with the variable name component_label1::show_label.

Decide what label to show...

None - no labels are displayed

Name - shows the component's name

Property - shows a property value of the component (a field for the property name will appear below)

On Color

This property is of type Color picker and can be referenced with the variable name on_color.

The color of the LED when it is turned on.

Off Color

This property is of type Color picker and can be referenced with the variable name off_color.

The color of the LED when it is turned off.

Auto Off Color

This property is of type True or false and can be referenced with the variable name auto_off.

When this is selected, the off color is automatically set to a reduced intensity version of the on color.

Startup State

This property is of type Fixed list of ints and can be referenced with the variable name StartupState.

Default state of the indicator when loading the project or starting the simulation runtime.

Personal tools