Difference between revisions of "Component: RMT (Internal) (Misc)"

From Flowcode Help
Jump to navigationJump to search
(Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray...")
 
Line 16: Line 16:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
 
''No detailed description exists yet for this component''
 
''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 94: Line 98:
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
 
|-
 
|-
| colspan="2" | Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD) &nbsp;
+
| colspan="2" | Sets the component to the specified value.&nbsp;
 
|-
 
|-
 
|-
 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" | [[File:]] -
| width="90%" | Name
+
| width="90%" | value
 +
|-
 +
| colspan="2" | A new value for the component.&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;"
 
|-
 
|-
| colspan="2" | &nbsp;
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RefreshChart'''
 
|-
 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| colspan="2" | Redraws the chart.&nbsp;
| width="90%" | Value
 
 
|-
 
|-
| colspan="2" | &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-void-icon.png]] - VOID
Line 115: Line 127:
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDuty10Bit'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetData'''
 +
|-
 +
| colspan="2" | Gets a data point from the specified series.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Series
 +
|-
 +
| colspan="2" | Which series to add to (1-8)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | The data point index (1 - 32767)&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| 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;" | '''AddDataCXYY1'''
 +
|-
 +
| colspan="2" | Adds a data point to a bubble chart.&nbsp;
 
|-
 
|-
| colspan="2" | Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535&nbsp;
 
 
|-
 
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Series
 
|-
 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| colspan="2" | Which series to add to (1-8)&nbsp;
| width="90%" | duty
+
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Category
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Value
 
|-
 
|-
| colspan="2" | Duty value 0 - 1023&nbsp;
+
| colspan="2" | The value of the data point&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-void-icon.png]] - VOID

Revision as of 10:34, 17 November 2021

Author Matrix TSL
Version 2.0
Category Misc


RMT (Internal) component

Provides access to the onboard remote control (RMT) peripheral allowing for high speed data input / output without requiring bit banging from the ESP32 processor.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

Fc9-comp-macro.png SetBuffer
Writes data to the RMT buffer 
Fc9-u16-icon.png - UINT Index
Array index, Range: 0 - (BufferSize - 1) 
[[File:]] - State0
The first state to output 
Fc9-u16-icon.png - UINT Length0
The length of the first output state in divided clock periods 
[[File:]] - State1
The second state to output 
Fc9-u16-icon.png - UINT Length1
The length of the second output state in divided clock periods 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Transmit
Sends out the RMT data buffer. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Initialises the RMT module ready for data to be sent or received. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetValue
Sets the component to the specified value. 
[[File:]] - value
A new value for the component. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png RefreshChart
Redraws the chart. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetData
Gets a data point from the specified series. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
[[File:]] - Index
The data point index (1 - 32767) 
[[File:]] - Return


Fc9-comp-macro.png AddDataCXYY1
Adds a data point to a bubble chart. 
Fc9-u8-icon.png - BYTE Series
Which series to add to (1-8) 
Fc9-string-icon.png - STRING Category
 
[[File:]] - Y
Y coordinate 
[[File:]] - X
X coordinate 
[[File:]] - Value
The value of the data point 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png InitRXConfig
Initialization setting for RX Buffer Config 
Fc9-u8-icon.png - BYTE Buffer
Buffer Number (0 or 1) 
Fc9-u8-icon.png - BYTE Value
Config data byte 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Uninit
Uninitialises the CAN, freeing its connections for general use  
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetList
Get the Filter List of the Named Property 
Fc9-string-icon.png - STRING Name
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png GetRxIdent
Generic function to get the received message Identifier.  
Fc9-u8-icon.png - BYTE buffer
 
Fc9-u32-icon.png - ULONG Return


Fc9-comp-macro.png SetRxFilterStd
Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter  
Fc9-u8-icon.png - BYTE Filter
Filter number 
Fc9-u8-icon.png - BYTE Hi
The high byte (bits 8-15) of the ID 
Fc9-u8-icon.png - BYTE Lo
The low byte (bits 0-7) of the ID 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetRxFilterExd
Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter  
Fc9-u8-icon.png - BYTE Filter
Send filter: 0 to 3 
Fc9-u8-icon.png - BYTE ID3
The high byte (bits 24-31) of the ID 
Fc9-u8-icon.png - BYTE ID2
The mid-high byte (bits 16-23) of the ID 
Fc9-u8-icon.png - BYTE ID1
The mid-low byte (bits 8-15) of the ID 
Fc9-u8-icon.png - BYTE ID0
The low byte (bits 0-7) of the ID 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Mode
Controls if we are transmitting or receiving data 
Fc9-type-5-icon.png Pin
Pin to assign the RMT functionality 
Fc9-type-21-icon.png Clock Divider
Base Clock speed is 80MHz. Div by 1 = 80MHz Div by 2 = 40MHz Div by 4 = 20MHz Div by 8 = 10MHz 
Fc9-type-16-icon.png Mem Block Num
Starting RMT memory block 
Fc9-type-21-icon.png Buffer Size
Number of values inside the data buffer, 64 = 1 Block A buffer size of 128 would consume two sequential blocks of memory. If starting at block 1 then you can have a maximum buffer size of 512 consuming all 8 blocks.  
Fc9-type-7-icon.png TX Loop Enable
Allows the transmit buffer to be constantly looped. 
Fc9-type-7-icon.png TX Carrier Enable
Enables a carrier frequency to be overlaid on the transmitted data 
Fc9-type-7-icon.png TX Idle Output
When not transmitting should the Transmit pin be an active output? 
Fc9-type-16-icon.png TX Idle Level
Sets the output state when idle. 
Fc9-type-7-icon.png RX Filter Enable
Allows the receive data to be filtered. 
Fc9-type-21-icon.png RX Idle Threshold
Sets the number of divided clock periods to detect when the receiver is idle. Pulses longer then this period will not be received. 
Fc9-conn-icon.png Connections
Fc9-conn-icon.png Simulations