Table of Contents

Class TransmitChannelSettings

Namespace
nanoFramework.Hardware.Esp32.Rmt
Assembly
nanoFramework.Hardware.Esp32.Rmt.dll

TransmitterChannel's settings class.

public sealed class TransmitChannelSettings : RmtChannelSettings
Inheritance
TransmitChannelSettings
Inherited Members
Extension Methods

Remarks

All changes made to properties of this class are ignored after the TransmitterChannel is initialized. The equivalent properties in the channel instance can be used to make on-the-fly changes to the configurations.

Constructors

TransmitChannelSettings(int)

Initializes a new instance of the TransmitChannelSettings class.

public TransmitChannelSettings(int pinNumber)

Parameters

pinNumber int

The GPIO Pin number to use with the channel.

Remarks

This constructor will use the next available RMT channel starting from channel 0 and up to channel 7.

TransmitChannelSettings(int, int)

Initializes a new instance of the TransmitChannelSettings class.

public TransmitChannelSettings(int channel, int pinNumber)

Parameters

channel int

The channel number to use. Valid value range is 0 to 7 (inclusive).

pinNumber int

The GPIO Pin number to use with the channel.

Exceptions

ArgumentOutOfRangeException

channel must be between 0 and 7.

Properties

CarrierLevel

Gets or sets a value indicating at which level of RMT output is the carrier wave applied. true = HIGH.

public bool CarrierLevel { get; set; }

Property Value

bool

CarrierWaveDutyPercentage

Gets or sets the carrier wave duty cycle percentage.

public byte CarrierWaveDutyPercentage { get; set; }

Property Value

byte

Exceptions

ArgumentOutOfRangeException

Value cannot be less that 1 or greater than 100.

CarrierWaveFrequency

Gets or sets the carrier wave frequency.

public int CarrierWaveFrequency { get; set; }

Property Value

int

EnableCarrierWave

Enables or disables the carrier wave generator in the RMT Hardware.

public bool EnableCarrierWave { get; set; }

Property Value

bool

EnableIdleLevelOutput

Gets or sets a value indicating whether to enable or disable the idle level output.

public bool EnableIdleLevelOutput { get; set; }

Property Value

bool

EnableLooping

Gets or sets a value indicating whether to enable or disable looping through the ring buffer when transmitting RmtCommands.

public bool EnableLooping { get; set; }

Property Value

bool

IdleLevel

Gets or sets a value indicating the RMT idle level. true = HIGH.

public bool IdleLevel { get; set; }

Property Value

bool

LoopCount

Gets or sets the maximum transmission loop count. Only applicable if EnableLooping is set to true.

public int LoopCount { get; set; }

Property Value

int

Remarks

This configuration is not available on the base ESP32 target and will be ignored. Please refer to the ESP32 IDF docs for more information on feature availability for the various ESP32 targets.

Exceptions

ArgumentOutOfRangeException

Value cannot be less that 1 or greater than 1023.