GenericBoard Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A generic board class. Uses generic implementations for GPIO, I2C etc
public class GenericBoard : Iot.Device.Board.Board
type GenericBoard = class
inherit Board
Public Class GenericBoard
Inherits Board
- Inheritance
- Derived
Constructors
GenericBoard() |
Creates a generic board instance with auto-detection of the best drivers for GPIO, I2c, SPI, etc. The drivers are late-bound however, so whether it works or not can only be determined after pins are opened. |
Properties
DefaultPinNumberingScheme |
The default pin numbering scheme for this board. (Inherited from Board) |
Disposed |
True if this instance is disposed. Any attempt to use it after this becomes true results in undefined behavior. (Inherited from Board) |
Initialized |
True if the board instance is initialized (Inherited from Board) |
Methods
ActivatePinMode(Int32, PinUsage) |
Override this method if something special needs to be done to use the pin for the given device. Many devices support multiple functions per Pin, but not at the same time, so that some kind of multiplexer needs to be set accordingly. (Inherited from Board) |
CreateGpioController() |
Return an instance of a GpioController for the current board (Inherited from Board) |
CreateI2cBusCore(Int32, Int32[]) |
Create an instance of an I2C bus in a derived class |
CreateI2cDevice(I2cConnectionSettings) |
Create an I2C device instance on a default bus. (Inherited from Board) |
CreateOrGetI2cBus(Int32, Int32[]) |
Create an I2C bus instance or return the existing instance for this bus (Inherited from Board) |
CreateOrGetI2cBus(Int32) |
Create an I2C bus instance or return the existing instance for this bus (Inherited from Board) |
CreatePwmChannel(Int32, Int32, Int32, Double, Int32, PinNumberingScheme) |
Creates a PWM channel (Inherited from Board) |
CreatePwmChannel(Int32, Int32, Int32, Double) |
Creates a PWM channel for the default pin assignment (Inherited from Board) |
CreateSimplePwmChannel(Int32, Int32, Int32, Double) |
Overriden by derived implementations to provide the PWM device |
CreateSimpleSpiDevice(SpiConnectionSettings, Int32[]) |
Overriden by derived implementations to create the base SPI device. |
CreateSpiDevice(SpiConnectionSettings, Int32[], PinNumberingScheme) |
Create an SPI device instance (Inherited from Board) |
CreateSpiDevice(SpiConnectionSettings) |
Create an SPI device instance (Inherited from Board) |
DetermineCurrentPinUsage(Int32) |
Returns the current usage of a pin (Inherited from Board) |
Dispose() | (Inherited from Board) |
Dispose(Boolean) | (Inherited from Board) |
GetDefaultI2cBusNumber() |
Creates the default I2C bus for this board or returns the existing bus |
GetDefaultPinAssignmentForI2c(Int32) |
Overriden by derived classes: Provides the default pin assignment for the given I2C bus |
GetDefaultPinAssignmentForPwm(Int32, Int32) |
Overriden by derived class. Provides the default pin for a given channel. |
GetDefaultPinAssignmentForSpi(SpiConnectionSettings) |
Overriden by derived classes: Provides the default pin assignment for the given SPI bus |
Initialize() |
Initialize the board and test whether it works on the current hardware. (Inherited from Board) |
QueryComponentInformation() |
Query information about a component and its children. (Inherited from Board) |
ReleasePin(Int32, PinUsage, Object) |
Removes the reservation for a pin. See ReservePin(Int32, PinUsage, Object) for details. (Inherited from Board) |
ReservePin(Int32, PinUsage, Object) |
Reserves a pin for a specific usage. This is done automatically if a known interface (i.e. GpioController) is used to open the pin, but may be used to block a pin explicitly, i.e. for UART. (Inherited from Board) |
TryCreateBestGpioDriver() |
Tries to create the best possible GPIO driver for this hardware. (Inherited from Board) |