C# Class CyrusBuilt.MonoPi.IO.GpioBase

Abstract base class for the GPIO connector on the Pi (P1) (as found next to the yellow RCA video socket on the Rpi circuit board).

Inheritance: IRaspiGpio

Mostra file Open project: cyrusbuilt/MonoPi Class Usage Examples

Protected Properties

Property	Type	Description
_initValue	PinState
_mode	PinMode

Public Methods

Method	Description
ChangeBoardRevision ( BoardRevision revision ) : void	Changes the board revision.
Dispose ( ) : void	Releases all resource used by the CyrusBuilt.MonoPi.IO.GpioBase object. Call Dispose when you are finished using the CyrusBuilt.MonoPi.IO.GpioBase.The Dispose method leaves the CyrusBuilt.MonoPi.IO.GpioBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.IO.GpioBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.IO.GpioBase was occupying.
Provision ( ) : void	Provisions the pin (initialize to specified mode and make active).
Pulse ( Int32 millis ) : void	Pulse the pin output for the specified number of milliseconds.
Read ( ) : PinState	Read a value from the pin.
Write ( PinState value ) : void	Write the specified value to the pin.

Protected Methods

Method	Description
GetGpioPinNumber ( GpioPins pin ) : String	Gets the GPIO pin number.
GpioBase ( GpioPins pin ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 pin.
GpioBase ( GpioPins pin, PinMode mode ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 pin and the pin direction.
GpioBase ( GpioPins pin, PinMode mode, PinState value ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 GPIO pin, the pin mode, and the initial pin value.
OnStateChanged ( PinStateChangeEventArgs e ) : void	Raises the state changed event.

Method Details

ChangeBoardRevision() public method

Changes the board revision.

public ChangeBoardRevision ( BoardRevision revision ) : void
revision	BoardRevision	/// The board revision. Default is . ///
return	void

Dispose() public method

Releases all resource used by the CyrusBuilt.MonoPi.IO.GpioBase object.

Call Dispose when you are finished using the CyrusBuilt.MonoPi.IO.GpioBase.The Dispose method leaves the CyrusBuilt.MonoPi.IO.GpioBase in an unusable state. After calling Dispose, you must release all references to the CyrusBuilt.MonoPi.IO.GpioBase so the garbage collector can reclaim the memory that the CyrusBuilt.MonoPi.IO.GpioBase was occupying.

public Dispose ( ) : void
return	void

GetGpioPinNumber() protected static method

Gets the GPIO pin number.

protected static GetGpioPinNumber ( GpioPins pin ) : String
pin	GpioPins	/// The GPIO pin. ///
return	String

GpioBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 pin.

protected GpioBase ( GpioPins pin ) : System
pin	GpioPins	/// The GPIO pin. ///
return	System

GpioBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 pin and the pin direction.

protected GpioBase ( GpioPins pin, PinMode mode ) : System
pin	GpioPins	/// The GPIO pin. ///
mode	PinMode	/// The I/O pin mode. ///
return	System

GpioBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.IO.GpioBase class with a board Revision 1.0 GPIO pin, the pin mode, and the initial pin value.

protected GpioBase ( GpioPins pin, PinMode mode, PinState value ) : System
pin	GpioPins	/// The GPIO pin. ///
mode	PinMode	/// The I/O pin mode. ///
value	PinState	/// The initial pin value. ///
return	System

OnStateChanged() protected method

Raises the state changed event.

protected OnStateChanged ( PinStateChangeEventArgs e ) : void
e	PinStateChangeEventArgs	/// The event arguments. ///
return	void

Provision() public abstract method

Provisions the pin (initialize to specified mode and make active).

public abstract Provision ( ) : void
return	void

Pulse() public method

Pulse the pin output for the specified number of milliseconds.

public Pulse ( Int32 millis ) : void
millis	System.Int32	/// The number of milliseconds to wait between states. ///
return	void

Read() public abstract method

Read a value from the pin.

public abstract Read ( ) : PinState
return	PinState

Write() public method

Write the specified value to the pin.

public Write ( PinState value ) : void
value	PinState	/// If set to true value. ///
return	void

Property Details

_initValue protected_oe property

protected PinState _initValue
return	PinState

_mode protected_oe property

protected PinMode _mode
return	PinMode