Skip to content

Raspberry.IO.GeneralPurpose.GpioConnection

Jump to bottom
raspberry-sharp edited this page Oct 14, 2012 · 23 revisions

The GpioConnection class is used in conjunction with PinConfiguration in order to manage connection to a consistent set of pins (either input or output). Please refer to PinConfiguration documentation for detailed information concerning configuration of GPIO pins.

Since GpioConnection implements the IDisposable interface, it must be closed once used, by calling either IDisposable.Dispose or Close.

Initializers

The following initializers may be used to create an instance of GpioConnection:

GpioConnection(params PinConfiguration[] pins);
GpioConnection(IEnumerable<PinConfiguration> pins);
GpioConnection(IConnectionDriver driver, params PinConfiguration[] pins);
GpioConnection(IConnectionDriver driver, IEnumerable<PinConfiguration> pins);
GpioConnection(bool open, params PinConfiguration[] pins);
GpioConnection(bool open, IEnumerable<PinConfiguration> pins);
GpioConnection(bool open, IConnectionDriver driver, params PinConfiguration[] pins);
GpioConnection(bool open, IConnectionDriver driver, IEnumerable<PinConfiguration> pins);

Parameters

  • pins: configurations of pins that must be allocated when connection is established.
  • driver: the driver that must be used. If omitted or set to null, a default driver is chosen, depending on .config file.
  • open: a boolean value indicating whether connection must be opened on initialization or not. Default is true.

Properties

The following properties are available on GpioConnection.

Driver

IConnectionDriver Driver { get; }

The active driver. Should not be used for normal operations.

IsOpened

bool IsOpened { get; }

A boolean value indicating whether the connection is opened.

Pins

ConnectedPins Pins { get; }

A container of connected pins, providing access to each pin status and event registration. See ConnectedPin for additional information.

this (Indexers)

bool this[ProcessorPin processorPin] { get; set; }
bool this[ConnectorPin connectorPin] { get; set; }
bool this[PinConfiguration pinConfiguration] { get; set; }
bool this[string pinName] { get; set; }

Gets or sets the state of a pin. An exception is thrown if attempt is made to set the value of an input pin.

Parameters

  • processorPin: a pin, as numbered on processor
  • connectorPin: a pin, as numbered on Raspberry Pi P1 or P5 connector
  • pinConfiguration: a pin configuration, as defined by PinConfiguration
  • pinName: a pin name, if defined in pin configuration

Methods

The following methods are available on GpioConnection.

Add

void Add(PinConfiguration configuration);

Adds a pin to the connection.

Parameters

  • configuration: the pin configuration.

Blink

void Blink(ProcessorPin processorPin, int duration = DefaultBlinkDuration);
void Blink(ConnectorPin connectorPin, int duration = DefaultBlinkDuration);
void Blink(PinConfiguration pinConfiguration, int duration = DefaultBlinkDuration);
void Blink(string pinName, int duration = DefaultBlinkDuration);

Blinks (toogle, wait a specified amount of time, then toggle again) a specified pin.

Parameters

  • processorPin: a pin, as numbered on processor
  • connectorPin: a pin, as numbered on Raspberry Pi P1 or P5 connector
  • pinConfiguration: a pin configuration, as defined by PinConfiguration
  • pinName: a pin name, if defined in pin configuration
  • duration: the blink duration, in milliseconds. Default is DefaultBlinkDuration (250ms).

Clear

void Clear();

Clears the connection; that is, remove all pins.

Close

void Close();

Closes the connection and release all pins.

Contains

bool Contains(ProcessorPin processorPin);
bool Contains(ConnectorPin connectorPin);
bool Contains(PinConfiguration pinConfiguration);
bool Contains(string pinName);

Indicates whether the connection contains the specified pin.

Parameters

  • processorPin: a pin, as numbered on processor
  • connectorPin: a pin, as numbered on Raspberry Pi P1 or P5 connector
  • pinConfiguration: a pin configuration, as defined by PinConfiguration
  • pinName: a pin name, if defined in pin configuration

Open

void Open();

Opens a connection.

Remove

void Remove(ProcessorPin processorPin);
void Remove(ConnectorPin connectorPin);
void Remove(PinConfiguration pinConfiguration);
void Remove(string pinName);

Removes a pin from the connection, and releases related resources.

Parameters

  • processorPin: a pin, as numbered on processor
  • connectorPin: a pin, as numbered on Raspberry Pi P1 or P5 connector
  • pinConfiguration: a pin configuration, as defined by PinConfiguration
  • pinName: a pin name, if defined in pin configuration

Toggle

void Toggle(ProcessorPin processorPin);
void Toggle(ConnectorPin connectorPin);
void Toggle(PinConfiguration pinConfiguration);
void Toggle(string pinName);

Toggles (inverts) the state of a pin.

Parameters

  • processorPin: a pin, as numbered on processor
  • connectorPin: a pin, as numbered on Raspberry Pi P1 or P5 connector
  • pinConfiguration: a pin configuration, as defined by PinConfiguration
  • pinName: a pin name, if defined in pin configuration
Clone this wiki locally