Click or drag to resize

FX3Api Namespace

Documentation for the iSensor FX3 Demonstartion Platform public .NET API
Classes
  ClassDescription
Public classBitBangSpiConfig
This class stores all the relevant information about a given bit bang SPI connection.
Public classFX3ApiInfo
This class provides a collection of information about the FX3 API. All the fields are hard-coded into the DLL at compile time. To retrieve the FX3ApiInfo set during compile time, use the GetFX3ApiInfo call within FX3 connection.
Public classFX3BadStatusException
This exception is used when the status returned from the FX3 board is not success (0). This typically indicates some sort of failure in the FX3 application firmware, which may require a board reset. The status codes are defined in the Cypress FX3 SDK.
Public classFX3Board
This class contains information about the connected FX3 board
Public classFX3CommunicationException
This exception is used when there is a communication failure with the FX3 board during a data transfer.
Public classFX3ConfigurationException
This exception is used when the FX3 is configured with an invalid setting. Typically, these exceptions will not cause the board or interface to enter an invalid state, since they are caught before the setting is applied.
Public classFX3Connection
This is the primary class for interfacing with the FX3 based eval platform. Implements IRegInterface, ISpi32Interface, and IPinFcns, in addition to a superset of extra interfacing functions specific to the FX3 platform.
Public classFX3ErrorLog
FX3 flash error log class. These are generated and stored on the FX3 board
Public classFX3Exception
This exception is used for general faults which do not fit with the other defined exception types. These exceptions are still generated within the FX3 interface, and are not system exceptions.
Public classFX3PinObject
Object to store configuration information for a Cypress FX3 GPIO pin.
Public classFX3ProgrammingException
This exception is used when the FX3 board enumeration and programming process fails. This typically indicates a flash failure at the cypress driver level, or a timeout when re-enumerating a programmed board.
Public classFX3SPIConfig
Class for all the programmable SPI configuration options on the FX3.
Public classI2CPreamble
I2C pre-amble class.
Public classPinList
Custom list class with some extra ease of use functions added.
Public classPinPWMInfo
Structure which contains all the info about the PWM status of a given pin
Delegates
Enumerations
  EnumerationDescription
Public enumerationDeviceType
Enum for determining the default device settings to be initialized
Public enumerationDUTType
Enum of the possible iSensors DUT types
Public enumerationDutVoltage
Enum for DUT power supply modes. These power supply modes are only available on the ADI in-house FX3 Demonstration platform.
Public enumerationEndpointAddresses
This enum lists all USB endpoints generated and used by the application firmware.
Public enumerationFX3BoardType
Possible FX3 board types. Used to differentiate iSensors FX3 board from Cypress Explorer kit. This list enumerates all possible hardware ID's provided by the FX3 ID pins. Most are not used.
Public enumerationFX3PinResistorSetting
Setting for pull up / pull down resistors on FX3 GPIO input stage.
Public enumerationSpiChipselectControl
Enum for the possible chip select modes
Public enumerationSpiLagLeadTime
Enum for the possible chip select lag/lead times, in SPI clock cycles
Public enumerationStreamCommands
This enum lists all the available streaming commands which can be sent to the FX3 (in the endpoint index)
Public enumerationStreamType
Enum of all possible stream types which can be running
Public enumerationUSBCommands
This enum lists all supported vendor commands for the FX3 firmware. The LED commands can only be used with the ADI bootloader firmware.