Class LedStrip

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about a configured LED strip

public class LedStrip : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged

Inheritance

object

ModelObject

LedStrip

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LedStrip()

public LedStrip()

Properties

Board

Board address of the corresponding pin

public int Board { get; set; }

Property Value

int

ColorOrder

Order in which colour components are sent to the strip

public LedStripColorOrder ColorOrder { get; set; }

Property Value

LedStripColorOrder

MaxLeds

Maximum number of LEDs that can be addressed on this strip

public uint MaxLeds { get; set; }

Property Value

uint

Pin

Name of the pin this LED strip is connected to

public string Pin { get; set; }

Property Value

string

StopMovement

Indicates if this strip is bit-banged and therefore requires motion to be stopped before sending a command

public bool StopMovement { get; set; }

Property Value

bool

Type

Type of this LED strip

public LedStripType Type { get; set; }

Property Value

LedStripType

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data