Class DigitalInputsConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Configs related to the CANdi™ branded device's digital I/O settings

Contains float-state settings and when to assert the S1/S2 inputs.

public class DigitalInputsConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

DigitalInputsConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

S1CloseState

What value the Signal 1 input (S1IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S1 input as a remote limit switch will treat the switch as closed when the S1 input is this state.

public S1CloseStateValue S1CloseState

Field Value

S1CloseStateValue

S1FloatState

The floating state of the Signal 1 input (S1IN).

public S1FloatStateValue S1FloatState

Field Value

S1FloatStateValue

S2CloseState

What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

public S2CloseStateValue S2CloseState

Field Value

S2CloseStateValue

S2FloatState

The floating state of the Signal 2 input (S2IN).

public S2FloatStateValue S2FloatState

Field Value

S2FloatStateValue

Methods

Clone()

Creates a copy of this config group.

public DigitalInputsConfigs Clone()

Returns

DigitalInputsConfigs

Deserialize(string)

Deserialize string and put values into this object

public StatusCode Deserialize(string to_deserialize)

Parameters

to_deserialize string

String to deserialize

Returns

StatusCode

OK if deserialization is OK

Serialize()

Serialize this object into a string

public string Serialize()

Returns

string

This object's data serialized into a string

ToString()

Provides the string representation of this object

public override string ToString()

Returns

string

WithS1CloseState(S1CloseStateValue)

Modifies this configuration's S1CloseState parameter and returns itself for method-chaining and easier to use config API.

What value the Signal 1 input (S1IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S1 input as a remote limit switch will treat the switch as closed when the S1 input is this state.

public DigitalInputsConfigs WithS1CloseState(S1CloseStateValue newS1CloseState)

Parameters

newS1CloseState S1CloseStateValue

Parameter to modify

Returns

DigitalInputsConfigs

Itself

WithS1FloatState(S1FloatStateValue)

Modifies this configuration's S1FloatState parameter and returns itself for method-chaining and easier to use config API.

The floating state of the Signal 1 input (S1IN).

public DigitalInputsConfigs WithS1FloatState(S1FloatStateValue newS1FloatState)

Parameters

newS1FloatState S1FloatStateValue

Parameter to modify

Returns

DigitalInputsConfigs

Itself

WithS2CloseState(S2CloseStateValue)

Modifies this configuration's S2CloseState parameter and returns itself for method-chaining and easier to use config API.

What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' CANdi™ to detect as Closed.

Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.

public DigitalInputsConfigs WithS2CloseState(S2CloseStateValue newS2CloseState)

Parameters

newS2CloseState S2CloseStateValue

Parameter to modify

Returns

DigitalInputsConfigs

Itself

WithS2FloatState(S2FloatStateValue)

Modifies this configuration's S2FloatState parameter and returns itself for method-chaining and easier to use config API.

The floating state of the Signal 2 input (S2IN).

public DigitalInputsConfigs WithS2FloatState(S2FloatStateValue newS2FloatState)

Parameters

newS2FloatState S2FloatStateValue

Parameter to modify

Returns

DigitalInputsConfigs

Itself