Difference between revisions of "Component: Port Matrix (Misc)"

Latest revision as of 13:12, 7 February 2023

Author	Matrix Ltd
Version	1.1
Category	Misc

Port Matrix component

Create an accurately spaced array of up to eight components, each corresponding to a pin of the chosen port. If the cloned component has a property called 'pin', this will be set the the corresponding pin of the matrix port, and the component will behave as if it were connected directly to that pin. If there are less than eight clones, the unused upper bits of the port will be masked out to allow them to be used by other components.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Port_Matrix.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Port_Matrix.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Industrial Tanks

A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.

Industrial Tanks

Macro reference

AllOff

	AllOff
Turn off all used pins of the port (unused port pins are unaffected)
- VOID	Return

AllOn

	AllOn
Turn on all of the pins in the array (unused port pins are unaffected)
- VOID	Return

BarGraph

	BarGraph
Turns on the first N pins of the array - for generating bar graph meters etc.
- BYTE	Length
How many pins to enable.
- VOID	Return

GetHandle

	GetHandle
Retrieves the object handle of the indexed clone. Returns zero for out of range indexes.
- BYTE	Index
Index of the object to get a handle for.
- HANDLE	Return

GetPin

	GetPin
Read the state of the selected pin of the port. Returns false if the index is out of range (0..7)
- BYTE	Index
Index of the pin to read.
- BOOL	Return

PinOff

	PinOff
Turn off the chosen pin of the port.
- BYTE	Index
Index of the pin to set within the port.
- VOID	Return

PinOn

	PinOn
Turn on the selected pin of the port.
- BYTE	Index
Index of the pin to set within the port.
- VOID	Return

PinToggle

	PinToggle
Toggles the state of the selected pin of the port.
- BYTE	Index

- VOID	Return

Property reference

	Properties
	Simulation
	Target Object
Choose an object that will be duplicated for each required pin of the chosen port. The object should have a property called 'pin' to which the pins of the port will automatically be attached.
	Count
Number of objects in the matrix. They will be assigned pins from the chosen port sequentially, beginning with pin0.
	Alignment
Which 3D axis the cloned objects will be arranged along.
	Spacing
The distance between cloned objects in the matrix.
	Connections
	Port
Choose a port to connect the matrix of objects to. Each will be assigned a single pin of the port automatically by the Port Matrix component.

Difference between revisions of "Component: Port Matrix (Misc)"

Latest revision as of 13:12, 7 February 2023

Contents

Port Matrix component

Component Source Code

Detailed description

Examples

Industrial Tanks

Macro reference

AllOff

AllOn

BarGraph

GetHandle

GetPin

PinOff

PinOn

PinToggle

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Port_Matrix.fcfx FC_Comp_Source_Port_Matrix.fcfx]
 Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Port_Matrix.fcfx FC_Comp_Source_Port_Matrix.fcfx]
 ==Detailed description==
@@ Line 34: / Line 42: @@
 ==Examples==
@@ Line 52: / Line 66: @@
 {{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
 ==Macro reference==
+===AllOff===
 {| 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;" | '''BarGraph'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AllOff'''
-|-
-| colspan="2" | Turns on the first N pins of the array - for generating bar graph meters etc.&nbsp;
 |-
+| colspan="2" | Turn off all used pins of the port (unused port pins are unaffected)&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Length
-|-
-| colspan="2" | How many pins to enable.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 73: / Line 93: @@
+===AllOn===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 86: / Line 107: @@
+===BarGraph===
 {| 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;" | '''PinOn'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BarGraph'''
 |-
-| colspan="2" | Turn on the selected pin of the port.&nbsp;
+| colspan="2" | Turns on the first N pins of the array - for generating bar graph meters etc.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
+| width="90%" | Length
 |-
-| colspan="2" | Index of the pin to set within the port.&nbsp;
+| colspan="2" | How many pins to enable.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 104: / Line 126: @@
+===GetHandle===
 {| 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;" | '''PinOff'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandle'''
 |-
-| colspan="2" | Turn off the chosen pin of the port.&nbsp;
+| colspan="2" | Retrieves the object handle of the indexed clone. Returns zero for out of range indexes.&nbsp;
 |-
 |-
@@ Line 115: / Line 138: @@
 | width="90%" | Index
 |-
-| colspan="2" | Index of the pin to set within the port.&nbsp;
+| colspan="2" | Index of the object to get a handle for.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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;" | '''PinToggle'''
-|-
-| colspan="2" | Toggles the state of the selected pin of the port.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | &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''
 |}
+===GetPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 158: / Line 164: @@
+===PinOff===
 {| 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;" | '''GetHandle'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PinOff'''
 |-
-| colspan="2" | Retrieves the object handle of the indexed clone. Returns zero for out of range indexes.&nbsp;
+| colspan="2" | Turn off the chosen pin of the port.&nbsp;
 |-
 |-
@@ Line 169: / Line 176: @@
 | width="90%" | Index
 |-
-| colspan="2" | Index of the object to get a handle for.&nbsp;
+| colspan="2" | Index of the pin to set within the port.&nbsp;
-|-
-| 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;" | '''AllOff'''
-|-
-| colspan="2" | Turn off all used pins of the port (unused port pins are unaffected)&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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
-| width="90%" | Target Object
-|-
-| colspan="2" | Choose an object that will be duplicated for each required pin of the chosen port. The object should have a property called 'pin' to which the pins of the port will automatically be attached.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
-| width="90%" | Count
-|-
-| colspan="2" | Number of objects in the matrix.  They will be assigned pins from the chosen port sequentially, beginning with pin0.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | Alignment
-|-
-| colspan="2" | Which 3D axis the cloned objects will be arranged along.&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
-| width="90%" | Spacing
-|-
-| colspan="2" | The distance between cloned objects in the matrix.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-type-4-icon.png]]
-| width="90%" | Port
-|-
-| colspan="2" | Choose a port to connect the matrix of objects to.  Each will be assigned a single pin of the port automatically by the Port Matrix component.&nbsp;
-|}==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;" | '''BarGraph'''
-|-
-| colspan="2" | Turns on the first N pins of the array - for generating bar graph meters etc.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Length
-|-
-| colspan="2" | How many pins to enable.&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''
-|}
-{| 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;" | '''AllOn'''
-|-
-| colspan="2" | Turn on all of the pins in the array (unused port pins are unaffected)&nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 264: / Line 183: @@
+===PinOn===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 282: / Line 202: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===PinToggle===
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PinOff'''
-|-
-| colspan="2" | Turn off the chosen pin of the port.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | Index of the pin to set within the port.&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''
-|}
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 316: / Line 219: @@
 | 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;" | '''GetPin'''
-|-
-| colspan="2" | Read the state of the selected pin of the port. Returns false if the index is out of range (0..7)&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | Index of the pin to read.&nbsp;
-|-
-| 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;" | '''GetHandle'''
-|-
-| colspan="2" | Retrieves the object handle of the indexed clone. Returns zero for out of range indexes.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Index
-|-
-| colspan="2" | Index of the object to get a handle for.&nbsp;
-|-
-| 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;" | '''AllOff'''
-|-
-| colspan="2" | Turn off all used pins of the port (unused port pins are unaffected)&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''
-|}