Difference between revisions of "Component: Output Digital Pin (DSP)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.2 (Release)
+
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| DSP
 
|}
 
|}
  
  
 +
==Output Digital Pin component==
 +
Allows the values from a buffer to be passed directly to a digital output pin based on a defined threshold.
  
−
==[[File:Component Icon 0d048c7d_18d5_4bce_83f1_7e429c0d86b6.png|Image]] Output Digital Pin component==
+
==Detailed description==
−
Allows the values from a buffer to be passed directly to a digital output pin based on a defined threshold.
+
 
 +
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 24: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>SetPin</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Takes the value from the connected DSP buffer and outputs to the selected pin based on the selected threshold values.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPin'''
 +
|-
 +
| colspan="2" | Takes the value from the connected DSP buffer and outputs to the selected pin based on the selected threshold values.&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''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| 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;" | '''GetInt'''
 +
|-
 +
| colspan="2" | Returns a value from the specified buffer and scales it appropriatley if required. Auto increments the read location.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:''This call does not return a value''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByteArray'''
 +
|-
 +
| colspan="2" | Returns an array of values from the specified buffer and scales it appropriatley if required. Auto increments the read location.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Count
 +
|-
 +
| 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''
 +
|}
  
  
 +
{| 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;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Returns a value from the specified buffer and scales it appropriatley if required. Auto increments the read location.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Connect To</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Output Pin</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
−
 
+
| width="90%" | Connect To
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''OutputPin''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Output Pin
−
 
+
|-
−
<span style="font-weight: normal;"><u>Threshold Value</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Threshold''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Threshold Value
−
Sets the level at which the pin goes into the active state.
+
|-
−
 
+
| colspan="2" | Sets the level at which the pin goes into the active state. >= the threshold the pin will be in the active state. < the threshold the pin will be in the none active state.&nbsp;
−
>= the threshold the pin will be in the active state.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
< the threshold the pin will be in the none active state.
+
| width="90%" | Pin State
−
 
+
|-
−
<span style="font-weight: normal;"><u>Pin State</u></span>
+
| colspan="2" | Selects the output level to use when the pin is in the active state. Active High - Pin will pull to VCC (high) when active and pull to VSS (low) when none active. Active Low - Pin will pull to VSS (low) when active and pull to VCC (high) when none active.&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PinState''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
−
Selects the output level to use when the pin is in the active state.
+
|-
−
 
+
|-
−
Active High - Pin will pull to VCC (high) when active and pull to VSS (low) when none active.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
−
Active Low - Pin will pull to VSS (low) when active and pull to VCC (high) when none active.
+
|-
 +
|}

Revision as of 18:58, 16 November 2021

Author Matrix Ltd
Version 1.2
Category DSP


Output Digital Pin component

Allows the values from a buffer to be passed directly to a digital output pin based on a defined threshold.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SetPin
Takes the value from the connected DSP buffer and outputs to the selected pin based on the selected threshold values. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetInt
Returns a value from the specified buffer and scales it appropriatley if required. Auto increments the read location. 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png GetByteArray
Returns an array of values from the specified buffer and scales it appropriatley if required. Auto increments the read location. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-u16-icon.png - UINT Count
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetByte
Returns a value from the specified buffer and scales it appropriatley if required. Auto increments the read location. 
Fc9-u8-icon.png - BYTE Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Connect To
 
Fc9-type-5-icon.png Output Pin
 
Fc9-type-21-icon.png Threshold Value
Sets the level at which the pin goes into the active state. >= the threshold the pin will be in the active state. < the threshold the pin will be in the none active state. 
Fc9-type-16-icon.png Pin State
Selects the output level to use when the pin is in the active state. Active High - Pin will pull to VCC (high) when active and pull to VSS (low) when none active. Active Low - Pin will pull to VSS (low) when active and pull to VCC (high) when none active. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Output_Digital_Pin_(DSP)&oldid=25188"