Microsoft.SPOT.Hardware

Provides access to CPU-specific functionality.

Gets the frequency of the system clock.

The frequency of the system clock, in Hz.

Gets the frequency of the Slow Clock.

The Slow Clock is a slower and more precise clock than the system clock. It is used for the timing of the GPIO pins. The frequency of the Slow Clock, in Hz.

Gets and sets the time of the glitch filter for the debounce circuitry for all GPIO pins.

This setting affects all of the GPIO pins in the system. The default value for this property is 7.68 ms. The time of the glitch filter for the debounce circuitry for all GPIO pins.

Indentifies the General Purpose Input/Output (GPIO) pins.

A value indicating that no GPIO pin is specified.

Provides methods for querying the state of the device's battery.

Gets a voltage reading for the battery.

The battery's voltage, in millivolts.

Gets a current temperature reading for the battery.

The current temperature of the battery.

Returns a value that indicates whether the hardware is connected to a battery charger.

true if the hardware is connected to a battery charger; otherwise, false.

Gets the amount of battery life remaining, as a percentage.

true only if the battery is fully charged; otherwise, false.

Gets the battery's current recharging status.

The battery's current recharging status.

Pauses execution for a specified amount of time and waits for a battery event.

true if a battery event occurs within the specified amount of time; otherwise, false. The amount of time you want the system to wait for a battery event, in clocks ticks.

Retrieves an object that describes the battery charger model.

The description of the battery charger model.

Constructs and initializes a object.

Not documented yet.

Contains an integer indicating the percentage that the battery needs to be charged to be considered at the minimum requisite level for continued device operation.

Contains an integer indicating the percentage that the battery needs to be charged to be considered low.

Contains an integer indicating the percentage that the battery needs to be charged to be considered approximately half full.

A typical value for this field is 30, indicating that the battery is 30 percent charged.

Contains an integer indicating the percentage that the battery needs to be charged to be considered full.

Contains an integer indicating the minimum percentage that the battery needs to be charged to be considered full.

When the battery's charge level drops below this value, the device should automatically begin taking action to conserve power. A typical value for this field is 40, indicating that the battery is 40 percent charged.

Specifies the delay that is required to keep the battery in idle charging mode.

A battery's hysteresis comparator senses a charging current flowing through the battery pack and turns off the charge when the current reaches an upper limit (maximum voltage level). Because the charging current may fluctuate slightly, it is possible for the comparator to detect that the voltage level has reached the maximum when a transitory spike occurs. Therefore, chargers use a hysteresis delay. After the comparator detects the maximum voltage level, the charger waits the number of milliseconds specified in this field before turning off the charging current. If the voltage level drops below the maximum during the hysteresis delay, the charger does not turn off the charging voltage.

Specifies the minimum amount of time that the backlight is to remain on when the device is connected to the battery charger.

Represents an instance of the I2C interface for an I2C device.

The I2C interface is a synchronous serial communications protocol in which multiple devices can be connected with one another by way of a single two-wire system. The two-wire system includes the serial data signal (SDA) and the serial clock (SCA). This two-wire interface has the ability to send 8-bit data, 7-bit addresses, and control bits.

Executes a transaction by scheduling the transfer of the data involved.

The number of bytes of data transferred in the transaction. The object that contains the transaction data. The amount of time the system will wait before resuming execution of the transaction.

Creates an object that can be passed to the method.

An object that can be passed to the method. The array of bytes that will contain the data read from the device.

Creates an object that can be passed to the method.

The object that can be passed to the method. The array of bytes that will be sent to the device.

Initializes a new instance of the class.

The configuration data for the new device.

Contains the device's configuration data.

Represents an I2C transaction.

Represents an I2C transaction that reads from the addressed device.

Represents an I2C transaction that writes to the addressed device.

Represents a configuration for an I2C interface object.

Represents an I2C transaction.

Contains the buffer associated with the current transaction.

Represents an I2C transaction that reads from the addressed device.

Represents an I2C transaction that writes to the addressed device.

Represents a configuration for an I2C interface object.

Initializes an instance of the I2CDevice.Configuration class.

The address of the I2C device. The clock rate used when communicating with the I2C device, in kHz.

Contains the address of the I2C device.

The address is used to uniquely identify the I2C device on the I2C bus.

Contains the clock rate used when communicating with the I2C device, in kHz.

For the clock rate, the device uses an approximate value that it supports.

Constitutes the input/output (I/O) port base class for managing General Purpose Input/Output (GPIO) pins, containing the necessary logic to handle read and write requests.

This class cannot be created directly.

Disables the pin for a port and marks it as available for reuse.

Reads a Boolean value at the port input.

The current value of the port (either 0 or 1).

Gets the indentifier (ID) for a port.

The ID for the port.

Specifies the various port resistor modes.

A value that disables the resistor functionality.

A value that enables the resistor functionality in pull-down mode.

A value that enables the resistor functionality in pull-up mode.

Contains the values you use to set the port interrupt mode. There are six port interrupt modes to choose from.

A level interrupt, which is either an or interrupt, is dispatched when the value on a pin matches the specified high or low value, respectively. The system dispatches only the first occurrence of a level interrupt until it is cleared by means of the method. With a nonlevel interrupt, every specified edge is dispatched, and the method has no effect."

A value that sets the port not to generate an interrupt.

A value that sets the port so that its interrupt is triggered on the falling edge.

A value that sets the port so that its interrupt is triggered on the rising edge.

A value that sets the port so that its interrupt is triggered on both the rising and falling edges.

A value that sets the port so that its interrupt is triggered when the input level is high. The system dispatches only the first occurrence of a level interrupt until it is cleared by means of the method.

A value that sets the port so that its interrupt is triggered when the input level is low. The system dispatches only the first occurrence of a level interrupt until it is cleared by means of the method.

Represents an instance of an input port that can be used to read the value of a GPIO pin.

Initializes a new instance of the class.

The indentifier for the input port. If the port with the specified identifier is already in use, an exception is thrown. true if the glitch filter is currently enabled; otherwise, false. The resistor mode that establishes a default state for the port.

Initializes a new instance of the class.

The indentifier for the input port. If the port with the specified identifier is already in use, an exception is thrown. true if the glitch filter is currently enabled; otherwise, false. The resistor mode that establishes a default state for the port. The interrupt mode that establishes the requisite conditions for the port to generate an interrupt.

Gets or sets the resistor mode of the input port. You set the initial resistor mode value in the constructor.

The resistor mode of the input port.

Gets or sets the state of the input port's glitch filter.

true if the glitch filter is currently enabled; otherwise, false.

Writes a value to the port output.

The value that is written to the port output.

Initializes a new instance of the class.

Not documented yet. Not documented yet.

Gets the initial value for the output port after it is activated. This initial value is provided by the initialState parameter in the OutputPort constructor.

The initial value for the output port after it is activated.

Represents an instance of the class.

The class is for use with GPIO pins that can be both input and output pins. It has nothing to do with tristate voltage levels in hardware. A pin is considered "active" when it is an output pin. It is an input pin when it is in the "inactive" state. Your application can use the class to control and monitor whether a particular GPIO pin is currently an input pin or an output pin. Note that tristate ports can share pins with other tristate ports, for both reading and writing. This class cannot be inherited.

Initializes a new instance of the class.

A tristate port is initially an input port. The indentifier (ID) for the tristate port. If the port with the specified ID is already in use, an exception is thrown. The initial value forced on the tristate port when it is created; this value becomes effective as soon as the port is enabled as an output port. A Boolean value that indicates the state of the glitch filter. If true, the glitch filter is enabled; if false, the glitch filter is disabled. The resistor mode that establishes a default state for the port.

Gets or sets the current state of a particular tristate port — that is, active or inactive.

A pin is considered "active" when it is an output pin. It is an input pin when it is in the "inactive" state. Your application can use the class to control and monitor whether a particular GPIO pin is currently an input pin or an output pin. true if the tristate port is currently an output port; otherwise, false.

Gets or sets the resistor mode value for the current tristate port. The initial resistor mode value is set in the constructor when the port is created.

The resistor mode of the current tristate port.

Gets a value that indicates whether the glitch filter is currently enabled.

true if the glitch filter is currently enabled; otherwise, false.

Represents an interrupt port.

This class cannot be inherited. When configuring an interrupt port, note the differences between level and nonlevel interrupts. Level interrupts, which are either or interrupts, are dispatched when the value on a pin matches the specified high value or low value, respectively. The system dispatches only the first occurrence of a level interrupt until it is cleared by means of the ClearInterrupt method. With nonlevel interrupts, every specified edge is dispatched, and the ClearInterrupt method has no effect. In practice, it is best to use level interrupts when the interrupt condition needs to be checked only periodically. It is possible to configure an object into an invalid state. In such cases, your program may not generate an exception until it actually uses the object. For example, suppose you create an object with its resistor mode set to , the interrupt mode set to , and the glitch filter set to true. This configuration does not generate an exception when you instantiate an object. If you then add an interrupt handler, the .NET Micro Framework throws an exception.

Clears the current interrupt on the interrupt port.

Initializes a new instance of the class.

The identifier for the interrupt port. If the port with the specified identifier is already in use, an exception is thrown. true if the glitch filter is currently enabled; otherwise, false. The resistor mode that establishes a default state for the port. The interrupt mode that establishes the requisite conditions for the port to generate an interrupt.

Gets or sets the interrupt mode of the interrupt port.

The interrupt mode of the port.

Adds or removes callback methods for capture events. Note: If an or interrupt event occurs, an application must call the ClearInterrupt method to re-enable this event."

Applications can subscribe to this event to be notified whenever an interrupt event occurs.

Contains the values with which you set the serial communications port (COM port) you want to use.

A value that selects COM1 as the communications port.

A value that selects COM2 as the communications port.

A value that selects COM3 as the communications port.

Specifies the baud rates of serial ports, in bits per second (bps).

A baud rate of 4800 bps.

A baud rate of 9600 bps.

A baud rate of 19,200 bps.

A baud rate of 38,400 bps.

A baud rate of 57,600 bps.

A baud rate of 115,200 bps.

A baud rate of 230,400 bps.

Represents an instance of the Microwire/SPI interface for a Microwire/SPI device.

The Microwire/SPI interface is a synchronous serial communications protocol in which multiple devices can be connected with one another by means of a single three-wire system. This three-wire system includes the serial data in signal, the serial data out signal, and the serial clock. You must use an additional GPIO pin as a chip select for each device that will communicate on the Microwire/SPI interface. There are both 8-bit and 16-bit modes of operation using the overloaded read and write methods that have byte (8-bit) arguments or unsigned short (16-bit) arguments. Note that you can configure both 8-bit and 16-bit devices and have them share the SPI interface.

Writes an array of unsigned values to the interface, and reads an array of unsigned values from the interface into a specified location in the read buffer.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 16-bit mode. The buffer that will write to the interface. The buffer that will store the data that is read from the interface. The read offset, which is the number of write transactions that will occur before the first read transaction starts.

Writes an array of bytes to the interface, and reads an array of bytes from the interface into the read buffer.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 16-bit mode. The buffer that will write to the interface. The buffer that will store the data that is read from the interface.

Writes an array of unsigned short arguments to the interface.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 16-bit mode. The buffer that will write to the interface.

Writes an array of bytes to the interface, and reads an array of bytes from the interface into a specified location in the read buffer.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 8-bit mode. The buffer that will write to the interface. The buffer that will store the data that is read from the interface. The read offset, which is the number of write transactions that will occur before the first read transaction starts.

Writes an array of bytes to the interface, and reads an array of bytes from the interface.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 8-bit mode The buffer that will write to the interface. The buffer that will store the data that is read from the interface.

Writes an array of bytes to the interface.

You must size the buffer correctly, according to the specific protocol for the hardware device. Note that this protocol varies from one device to another. This method uses the interface in 8-bit mode. The buffer that will write to the interface.

Releases the pin associated with an object.

Initializes a new instance of the class.

The configuration you want to use with the SPI interface.

Returns the configuration object for the current object.

The configuration object for the current SPI object.

Selects the SPI bus to use for a transaction.

Selects bus 0.

Selects bus 1.

Selects bus 2.

Selects bus 3.

Represents the configuration for an interface.

Initializes a new instance of the class for a interface.

Not documented yet. Not documented yet. Not documented yet. Not documented yet. Not documented yet. Not documented yet. Not documented yet. Not documented yet.

The chip select port.

The active state for the chip select port. If true, the chip select port will be set to high when accessing the chip; if false, the chip select port will be set to low when accessing the chip.

The setup time for the chip select port, in milliseconds.

After after the SPI device is selected, the common language runtime (CLR) waits for the number of milliseconds specified in this field. This gives the data transfer clock time to start.

The hold time for the chip select port. In other words, this parameter specifies the amount of time that the chip select port must remain in the active state before the device is unselected, or the amount of time that the chip select will remain in the active state after the data read/write transaction has been completed.

The idle state of the clock. If true, the SPI clock signal will be set to high while the device is idle; if false, the SPI clock signal will be set to low while the device is idle. The idle state occurs whenever the chip is not selected.

The sampling clock edge. If true, data is sampled on the SPI clock rising edge; if false, the data is sampled on the SPI clock falling edge.

The SPI clock rate.

Selects the SPI bus for the transaction.

This field is ignored by the emulator. It is only used on actual hardware.

Provides access to information about pin assignments for serial communications devices.

Instantiates a static variable that stores information about how the serial communications GPIO pins are used.

A object that contains information about how the serial communications GPIO pins are used.

Gets the GPIO pin assignments for the specified communications port (COM port).

A value of the enumeration that specifies the COM port. A value of the enumeration that identifies the GPIO pin that is assigned to the COM port's data-received signal. A value of the enumeration that identifies the GPIO pin that is assigned to the COM port's data-transmitted signal.

Gets the GPIO pin assignments for the SPI device.

Not documented yet. A value of the enumeration that identifies the GPIO pin that is assigned to the SPI clock. A value of the enumeration that identifies the GPIO pin that is assigned to the SPI master-data-in/slave-data-out signal. A value of the enumeration that identifies the GPIO pin that is assigned to the SPI master-data-out/slave-data-in signal.

Gets the GPIO pin assignments for the I2C device.

A value of the enumeration that identifies the GPIO pin that is assigned to the I2C serial clock signal. A value of the enumeration that identifies the GPIO pin that is assigned to the I2C serial data signal.

Constructs and initializes an instance of the class.

Add/RemoveEventFilter/Listener/Processor today supports only one listener and one filter to reduce complexity, but this will certainly be not the case in future when multiple parties will want to listent or filter same EventCategory. This was one of the request from SideShow team, we will have to look into that.

Writes specified number of bytes from writeBuffer to SPI bus. Reads data from SPI bus and places into readBuffer. writeBuffer - array with data to be written to SPI bus. writeElemCount - number of elements to write to SPI bus. If writeElemCount is -1, then all data is array is written to bus. readBuffer - buffer to place data read from SPI bus readOffset - Number of elements to skip before starting to read.

Last in the standard MF buttons enumeration

Indicates what type of sleep event occurred. Invalid - Invalid event ChangeRequested - A managed thread has requested the system to go into a sleep state WakeUp - The sytem woke up from the a sleep state

Indicates what type of power event occurred. Invalid - Invalid event PreNotify - A notification that the indicated power event is about to happen PostNotify - A notification that the current power state just changed

The SleepEvent object contains information about a sleep event. It is passed to PowerState.OnSleepChange event handlers. EventType - Indicates the type of this event (ChangeRequested or WakeUp) Level - The new sleep level for this event WakeUpEvents - The events (if any) that caused this event. This is only used on the WakeUp event. Time - The timestamp of when this event occurred

The PowerEvent object contains information about a power event. It is passed to PowerState.OnPowerLevelChange event handlers. EventType - Indicates the type of this event (PreNotify or PostNotify) Level - The new power level introduced by this event Time - The timestamp of when this event occurred

The event handler delegate for the PowerState.OnSleepChange event.

The SleepEvent object that contains details about the sleep event

The event handler delegate for the PowerState.OnPowerLevelChange event.

The PowerEvent object that contains information about the power level change event

The event handler delegate for the PowerState.OnReboot event.

The SleepLevel enumeration contains the default sleep levels for the .Net Micro Framework. The behavior for each of these states is determined by the hardware vendor. The general guideline is that each increased value indicates a deeper sleep. Therefore, SelectiveOff might simply dim the display backlight, where as Sleep may turn off the display, and DeepSleep may go into a hibernation state.

The PowerLevel enumeration contains the default power state levels for a .Net Micro Framework device. The behavior for each of the levels is determined by the hardware vendor. The general guideline is that each increased value indicates a lower power consumption state. This enumeration may also be extended by hardware vendors to include additional PowerLevels.

The HardwareEvent flags allow users to choose which events cause the system to awake from a sleep state. These event can be bitwise OR'ed together to produce a set of events. The SystemTimer event is a timer which is responsible for waking sleeping threads and eventing managed timers. If this event is not included in the WakeupEvents property or the wakeupEvents parameter in the Sleep method, then the system will will not wakeup for managed timers or thread sleeps. The GeneralPurpose event flag represents General Purpose Input/Output (GPIO) ports and any number of peripherals that use a GPIO pin as an eventing mechanism. These peripherals may include storage devices, touch panels, network devices, etc. The OEMReserved events can be defined by the Device Manufacturer.

The PowerState class encapsulates the power management functionality of the .Net Micro Framework. It enables the managed application to adjust power settings for the device.

The Sleep method puts the device into a sleeps state that is only woken by the events described in the paramter wakeUpEvents. Please note that if the event SystemTimer is not used, the system will not be woken up by any managed timers. In addition, other threads will not be executed until this sleep call exits. This method raises the OnSleepChange event. The MaximumTimeToActive property contains the timeout value for this call.

Determines what level of sleep the system should enter. The behavior of the level is determined by the hardware vendor. Determines the events that will cause the system to exit the given sleep level

The ChangePowerLevel method enables the caller to adjust the current power level of the device. The behavior of the power levels are determined by the hardware vendor. This method raises the OnPowerLevelChange event.

Describes the power level for which the system should enter

The RebootDevice method enables the caller to force a soft or hard reboot of the device. This method raises the OnRebootEvent. With this method, there are no execution constraints placed on the event handlers, so the reboot will only happen after each handler finishes.

Determines whether the reboot request is for a soft or hard reboot. Note, some devices may not support soft reboot.

The RebootDevice method enables the caller to force a soft or hard reboot of the device. This method raises the OnRebootEvent.

Determines whether the reboot request is for a soft or hard reboot. Note, some devices may not support soft reboot. Execution constraint timeout (in milliseconds) for the event handlers. If the event handlers take longer than the given value, then the handlers will be aborted and the reboot will be executed.

The WaitForIdleCPU method waits for the system to enter an idle state (no active threads). The call will return either when the timeout has expired or when the current idle time is greater than or equal to the expectedWorkItemDuration parameter (in milliseconds).

The amount of idle time required to run the task The timeout in milliseconds for the system to wait for the appropriate idle time Returns true if the current idle time is greater than or equal to the time indicated by exeConstraintTimeout_ms. Returns false otherwise.

This event notifies listeners when a sleep event occurs. The listeners will be notified prior to a sleep event and when the system wakes from a sleep.

This event notifies listeners when a power level event occurs.

This event notifies listeners prior to a device reboot (soft or hard). The event handlers may have an execution constraint placed on them by the caller of the Reboot method. Therefore, it is recommended that the event handlers be short atomic operations.

Gets the current power level of the system. The behavior of the power level is determined by the hardware vendor.

Gets and Sets the maximum timeout value for all system sleep calls (including internal system sleep calls). Set this property to determine the maximum time the system should sleep before processing non-masked events.

Gets or Sets the default wakeup events for all Thread.Sleep calls and internal system sleep calls. Please note that if SystemTimer is not specified for this property, then managed code timers and thread sleeps will not be handled until the system wakes up.

Gets the TimeSpan for which the system has been up and running.

The WatchdogBehavior enumeration lists the different ways in which the system can handle watchdog events. All behavior types will attempt to log a watchdog event that can be retrieved with LastOccurrence property on the Watchdog class. None - Continues execution (may leave the system in a stalled state) SoftReboot - Performs a software reboot of the CLR (if the device does not support soft reboot, a hard reboot will occur) HardReboot - Performs a hardware reboot of the device EnterBooter - Enters the bootloader and waits for commands. DebugBreak_Managed - Injects a Watchdog exception into the current managed thread. Note this will only work for native methods that take longer than the allotted watchdog timeout. If the system is truly hung then the exception will not be seen. DebugBreak_Native - Intended for native debugging (porting kit users). Stops execution at the native level.

The WatchdogEvent class is the object that is sent during Watchdog events.

The time stamp when the watchdog event occurred.

The watchdog timeout value when the watchdog event occured.

The offending managed call that was being executed when the watchdog occurred.

The static Watchdog class contains methods that enables managed code to determine the watchdog behavior.

Gets or sets the enabled state of the watchdog. The watchdog can be turned off if the inter-op method takes an indeterminate time. Note, the watchdog does not need to be turned off for managed code becuase the interpreter will make sure the watchdog is reset.

Gets or sets the timeout value of for the watchdog. Please note that some hardware vendors may set bounds and granularity on the timeout value for the watchdog. Please check with the hardware vendor for specifications.

Gets or sets the behavior of the watchdog event handler. See description for the WatchdogBehavior enumeration.

Gets the last occurrence of a watchdog event (if one exists).

Gets or sets the ILog interface for watchdog logging.

The LargeBufferMarshaller class enables marshalling of LargeBuffer objects to and from Native code. This class corresponds to the Native methods LargeBuffer_NativeToManaged, LargeBuffer_ManagedToNative, and LargeBuffer_GetNativeBufferSize.

Constructor for LargeBufferMarshaller objects

The marshal ID that will be passed to the Native code methods for sending and retreiving LargeBuffer objects

IEventListener method for initializing the event source

IEventListener method for handling GenericEvents

Marshals a LargeBuffer object from managed code to native code.

The LargeBuffer object to be marshalled

UnMarshals a LargeBuffer object from native to managed code. Note: The 'buffer' parameter's internal size maybe changed during the call.

The LargeBuffer object to be unmarshalled

Raises events when the Native code indicates a LargeBuffer object is ready for marshalling

Delegate method for the OnLargeBufferRequest event

The ID of the LargeBufferMarshaller object for which the event occurred

The LargeBuffer class allows you to create a byte array that is larger than the allowable size by the managed heap. The LargeBuffer item is allocated in a secondary heap (that must be supported by the device). This class can be used in conjunction with the LargeBufferMarshaller to transfer large data items to and from native code.

LargeBuffer construtor - creates a byte array buffer of the specified size.

Size in bytes of the buffer to be created

Disposes the LargeBuffer object and frees the internal buffer associated with it.

Gets the byte[] value associated with this LargeBuffer object