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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
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
 
|}
 
|}
  
  
 +
==Input Digital Pin component==
 +
Allows the values from a buffer to be assigned from a digital input pin.  The input values for high and low state can be assigned using properties.
 +
 +
==Component Pack==
 +
 +
DSP
 +
 +
==Detailed description==
  
==[[File:Component Icon 8d6ffd33_4087_46b5_8dfd_f43513748755.png|Image]] Input Digital Pin component==
 
Allows the values from a buffer to be assigned from a digital input pin.
 
The input values for high and low state can be assigned using properties.
 
  
==Examples==
 
''<span style="color:red;">No additional examples</span>''
 
  
  
==Downloadable macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>SamplePin</tt></u></span>===
 
Reads the value on the selected pin and based on the state outputs a value to the DSP buffer.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
 +
''No detailed description exists yet for this component''
  
 +
==Examples==
  
==Simulation macro reference==
 
  
''This component does not contain any simulation macros''
 
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Buffer Size</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BuffSize''.
 
  
Number of individual elements the buffer can store, default 1.
 
  
<span style="font-weight: normal;"><u>Buffer Type</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''BuffType''.
 
  
Sets the buffer data type, data is automatically scaled to fit and make full use of the data type.
 
  
<span style="font-weight: normal;"><u>Pin Connection</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin''.
 
  
Pin which is sampled to provide the DSP input to the buffer.
+
''<span style="color:red;">No additional examples</span>''
  
<span style="font-weight: normal;"><u>High Value</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''HighVal''.
+
==Downloadable macro reference==
  
Value to write to the buffer when the pin is in the high state.
+
{| 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;" | '''SamplePin'''
 +
|-
 +
| colspan="2" | Reads the value on the selected pin and based on the state outputs a value to the DSP buffer.&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''
 +
|}
  
<span style="font-weight: normal;"><u>Low Value</u></span>
 
  
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''LowVal''.
 
  
Value to write to the buffer when the pin is in the low state.
+
 
 +
==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-21-icon.png]]
 +
| width="90%" | Buffer Size
 +
|-
 +
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Buffer Type
 +
|-
 +
| colspan="2" | Sets the buffer data type, data is automatically scaled to fit and make full use of the data type.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Pin Connection
 +
|-
 +
| colspan="2" | Pin which is sampled to provide the DSP input to the buffer.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | High Value
 +
|-
 +
| colspan="2" | Value to write to the buffer when the pin is in the high state.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Low Value
 +
|-
 +
| colspan="2" | Value to write to the buffer when the pin is in the low state.&nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.2
Category DSP


Input Digital Pin component

Allows the values from a buffer to be assigned from a digital input pin. The input values for high and low state can be assigned using properties.

Component Pack

DSP

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png SamplePin
Reads the value on the selected pin and based on the state outputs a value to the DSP buffer. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type, data is automatically scaled to fit and make full use of the data type. 
Fc9-type-5-icon.png Pin Connection
Pin which is sampled to provide the DSP input to the buffer. 
Fc9-type-21-icon.png High Value
Value to write to the buffer when the pin is in the high state. 
Fc9-type-21-icon.png Low Value
Value to write to the buffer when the pin is in the low state.