Class ArduinoWS281XDeviceDefinition

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

Inheritance

object

ArduinoWS281XDeviceDefinition

Implements

IWS281XDeviceDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: RGB.NET.Devices.WS281X.Arduino

Assembly: RGB.NET.Devices.WS281X.dll

Syntax

public sealed class ArduinoWS281XDeviceDefinition : IWS281XDeviceDefinition

Constructors

ArduinoWS281XDeviceDefinition(ISerialConnection)

Initializes a new instance of the ArduinoWS281XDeviceDefinition class.

Declaration

public ArduinoWS281XDeviceDefinition(ISerialConnection serialConnection)

Parameters

Type	Name	Description
ISerialConnection	serialConnection	The serial connection used for the device.

ArduinoWS281XDeviceDefinition(string, int)

Initializes a new instance of the ArduinoWS281XDeviceDefinition class.

Declaration

public ArduinoWS281XDeviceDefinition(string port, int baudRate = 115200)

Parameters

Type	Name	Description
string	port	The name of the serial-port to connect to.
int	baudRate	The baud-rate of the serial-connection.

Properties

BaudRate

Gets the baud-rate used by the serial-connection.

Declaration

public int BaudRate { get; }

Property Value

Type	Description
int

Name

Gets or sets the name used by this device. This allows to use {0} as a placeholder for a incrementing number if multiple devices are created.

Declaration

public string? Name { get; set; }

Property Value

Type	Description
string

Port

Gets the name of the serial-port to connect to.

Declaration

public string Port { get; }

Property Value

Type	Description
string

SerialConnection

Gets the serial-connection used for the device.

Declaration

public ISerialConnection SerialConnection { get; }

Property Value

Type	Description
ISerialConnection

Methods

CreateDevices(IDeviceUpdateTrigger)

Gets the devices defined by this definition.

Declaration

public IEnumerable<IRGBDevice> CreateDevices(IDeviceUpdateTrigger updateTrigger)

Parameters

Type	Name	Description
IDeviceUpdateTrigger	updateTrigger

Returns

Type	Description
IEnumerable<IRGBDevice>	The initialized devices defined by this definition.

Implements

IWS281XDeviceDefinition