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

Latest revision as of 14:37, 13 July 2026

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

Macro reference

Initialise

	Initialise
Initialises the RMT module ready for data to be sent or received.
- VOID	Return

SetBuffer

	SetBuffer
Writes data to the RMT buffer
- UINT	Index
Array index, Range: 0 - (BufferSize - 1)
- BOOL	State0
The first state to output
- UINT	Length0
The length of the first output state in divided clock periods
- BOOL	State1
The second state to output
- UINT	Length1
The length of the second output state in divided clock periods
- VOID	Return

Transmit

	Transmit
Sends out the RMT data buffer.
- BYTE	WaitWhileComplete
0=Dont Wait, 1=Wait for TX to complete
- VOID	Return

TransmitBusy

	TransmitBusy
Checks to see if the RMT channel is currently transmitting. Returns 1 if transmitting and 0 if transmission is complete.
- INT	Timeout
Timeout delay in ms, 0 for no delay, -1 for wait forever
- BYTE	Return

Property reference

	Properties
	Mode
Controls if we are transmitting or receiving data
	Pin
Pin to assign the RMT functionality
	Clock Divider
Base Clock speed is 80MHz. Div by 1 = 80MHz Div by 2 = 40MHz Div by 4 = 20MHz Div by 8 = 10MHz
	Mem Block Num
Starting RMT memory block
	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.
	Tx Properties
	TX Loop Enable
Allows the transmit buffer to be constantly looped.
	TX Carrier Enable
Enables a carrier frequency to be overlaid on the transmitted data
	TX Idle Output
When not transmitting should the Transmit pin be an active output?
	TX Idle Level
Sets the output state when idle.

Component Source Code

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

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

@@ Line 26: / Line 26: @@
 ===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Initialises the RMT module ready for data to be sent or received.&nbsp;
@@ Line 40: / Line 40: @@
 ===SetBuffer===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBuffer'''
+| width="90%" class="mtx-class-macrohead" | '''SetBuffer'''
 |-
 | colspan="2" | Writes data to the RMT buffer&nbsp;
@@ Line 79: / Line 79: @@
 ===Transmit===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Transmit'''
+| width="90%" class="mtx-class-macrohead" | '''Transmit'''
 |-
 | colspan="2" | Sends out the RMT data buffer.&nbsp;
@@ Line 98: / Line 98: @@
 ===TransmitBusy===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TransmitBusy'''
+| width="90%" class="mtx-class-macrohead" | '''TransmitBusy'''
 |-
 | colspan="2" | Checks to see if the RMT channel is currently transmitting. Returns 1 if transmitting and 0 if transmission is complete.&nbsp;
@@ Line 118: / Line 118: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 149: / Line 149: @@
 | colspan="2" | 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. &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Tx Properties
+| width="90%" class="mtx-class-propfolder" | Tx Properties
 |-
 |-

SteveT (talk | contribs)