Component: RMT (Internal) (Misc)

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

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

	Transmit
Sends out the RMT data buffer.
- VOID	Return

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

	SetValue
Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)
- STRING	Name
- STRING	Value
- VOID	Return

	SetDuty10Bit
Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535
- UINT	duty
Duty value 0 - 1023
- VOID	Return

	GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property
- STRING	Name
- STRING	Return

	InitRXConfig
Initialization setting for RX Buffer Config
- BYTE	Buffer
Buffer Number (0 or 1)
- BYTE	Value
Config data byte
- VOID	Return

	Uninit
Uninitialises the CAN, freeing its connections for general use
- VOID	Return

	GetList
Get the Filter List of the Named Property
- STRING	Name
- STRING	Return

	GetRxIdent
Generic function to get the received message Identifier.
- BYTE	buffer
- ULONG	Return

	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
- BYTE	Filter
Filter number
- BYTE	Hi
The high byte (bits 8-15) of the ID
- BYTE	Lo
The low byte (bits 0-7) of the ID
- VOID	Return

	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
- BYTE	Filter
Send filter: 0 to 3
- BYTE	ID3
The high byte (bits 24-31) of the ID
- BYTE	ID2
The mid-high byte (bits 16-23) of the ID
- BYTE	ID1
The mid-low byte (bits 8-15) of the ID
- BYTE	ID0
The low byte (bits 0-7) of the ID
- VOID	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 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.
	RX Filter Enable
Allows the receive data to be filtered.
	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.
	Connections
	Simulations