Class Pin

Namespace

Pamoja.Gpio

Assembly

Pamoja.Gpio.dll

The GPIO pin model: levels, interrupt edges, and active polarity.

public static class Pin

Inheritance

object

Pin

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Active-low wiring is everywhere in cheap hardware: a button to ground with a pull-up reads low when pressed, and many relay boards energize when driven low. PinPolarity maps between "asserted" and the physical level so that mapping lives in one place instead of in scattered inversions.

Methods

Invert(PinLevel)

Returns the opposite level.

public static PinLevel Invert(PinLevel level)

Parameters

level PinLevel

The level to invert.

Returns

PinLevel

The other level.

Exceptions

ArgumentOutOfRangeException

level is not one of the PinLevel values.

IsAsserted(PinPolarity, PinLevel)

Reports whether a physical level means the signal is asserted.

public static bool IsAsserted(PinPolarity polarity, PinLevel level)

Parameters

polarity PinPolarity

How the signal is wired.

level PinLevel

The level read on the pin.

Returns

bool

Whether the signal is asserted.

Exceptions

ArgumentOutOfRangeException

polarity or level is not one of its type's values.

LevelFor(PinPolarity, bool)

Returns the physical level that represents a logical state.

public static PinLevel LevelFor(PinPolarity polarity, bool asserted)

Parameters

polarity PinPolarity

How the signal is wired.

asserted bool

Whether the signal should be asserted.

Returns

PinLevel

The level to drive, inverted for active-low wiring.

Exceptions

ArgumentOutOfRangeException

polarity is not one of the PinPolarity values.

LevelFrom(bool)

Returns the level a boolean names.

public static PinLevel LevelFrom(bool high)

Parameters

high bool

true for high, false for low.

Returns

PinLevel

The level.

Triggers(PinEdge, PinLevel, PinLevel)

Reports whether a transition fires an interrupt trigger.

public static bool Triggers(PinEdge edge, PinLevel from, PinLevel to)

Parameters

edge PinEdge

The trigger configured on the pin.

from PinLevel

The level before the change.

to PinLevel

The level after it.

Returns

bool

Whether the trigger fires.

Exceptions

ArgumentOutOfRangeException

edge, from, or to is not one of its type's values.