C# Class GHIElectronics.UAP.Shields.FEZHAT

A helper class for the FEZ HAT.
Inheritance: IDisposable
Show file Open project: amykatenicho/IoTWorkshop Class Usage Examples

Public Methods

Method Description
CreateAsync ( ) : Task

Creates a new instance of the FEZ HAT.
Dispose ( ) : void

Disposes of the object releasing control the pins.
GetAcceleration ( double &x, double &y, double &z ) : void

Gets the acceleration in G's for each axis from the onboard sensor.
GetLightLevel ( ) : double

Gets the light level from the onboard sensor.
GetTemperature ( ) : double

Gets the temperature in celsius from the onboard sensor.
IsDIO18Pressed ( ) : bool

Whether or not the button labeled DIO18 is pressed.
IsDIO22Pressed ( ) : bool

Whether or not the button labeled DIO18 is pressed.
ReadAnalog ( AnalogPin pin ) : double

Reads the current voltage on the given pin.
ReadDigital ( DigitalPin pin ) : bool

Reads the current state of the given pin.
SetPwmDutyCycle ( PwmPin pin, double value ) : void

Sets the duty cycle of the given pwm pin.
WriteDigital ( DigitalPin pin, bool state ) : void

Write the given value to the given pin.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Disposes of the object releasing control the pins.

Private Methods

Method Description
FEZHAT ( ) : GHIElectronics.UAP.Drivers

Method Details

CreateAsync() public static method

Creates a new instance of the FEZ HAT.
public static CreateAsync ( ) : Task
return Task

Dispose() public method

Disposes of the object releasing control the pins.
public Dispose ( ) : void
return void

Dispose() protected method

Disposes of the object releasing control the pins.
protected Dispose ( bool disposing ) : void
disposing bool Whether or not this method is called from Dispose().
return void

GetAcceleration() public method

Gets the acceleration in G's for each axis from the onboard sensor.
public GetAcceleration ( double &x, double &y, double &z ) : void
x double The current X-axis acceleration.
y double The current Y-axis acceleration.
z double The current Z-axis acceleration.
return void

GetLightLevel() public method

Gets the light level from the onboard sensor.
public GetLightLevel ( ) : double
return double

GetTemperature() public method

Gets the temperature in celsius from the onboard sensor.
public GetTemperature ( ) : double
return double

IsDIO18Pressed() public method

Whether or not the button labeled DIO18 is pressed.
public IsDIO18Pressed ( ) : bool
return bool

IsDIO22Pressed() public method

Whether or not the button labeled DIO18 is pressed.
public IsDIO22Pressed ( ) : bool
return bool

ReadAnalog() public method

Reads the current voltage on the given pin.
public ReadAnalog ( AnalogPin pin ) : double
pin AnalogPin The pin to read.
return double

ReadDigital() public method

Reads the current state of the given pin.
public ReadDigital ( DigitalPin pin ) : bool
pin DigitalPin The pin to read.
return bool

SetPwmDutyCycle() public method

Sets the duty cycle of the given pwm pin.
public SetPwmDutyCycle ( PwmPin pin, double value ) : void
pin PwmPin The pin to set the duty cycle for.
value double The new duty cycle between 0 (off) and 1 (on).
return void

WriteDigital() public method

Write the given value to the given pin.
public WriteDigital ( DigitalPin pin, bool state ) : void
pin DigitalPin The pin to set.
state bool The new state of the pin.
return void