FX3Connection Properties |
The FX3Connection type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActiveFX3 |
Property which returns the active FX3 board. Returns nothing if there is not a board connected.
|
![]() | ActiveFX3SerialNumber |
Property which returns the serial number of the active FX3 board.
|
![]() | AvailableFX3s |
Property which returns a list of the serial numbers of all FX3 boards running the ADI bootloader
|
![]() | BitBangSpiConfig |
Property to get or set the bit bang SPI configuration. Can select pins, timings, etc
|
![]() | BootloaderPath |
Set/get the blink USB bootloader firmware .img file used for multi-board identification
|
![]() | BufferAvailable |
Checks if a streaming frame is available, or will be available soon in thread safe queue. If there is no data in the queue
and the streaming thread is not currently running, it will return false.
|
![]() | BurstByteCount |
Get or set the burst word length, in bytes. Is the total count of bytes transfered, including trigger
|
![]() | BurstMode |
Switches burstMode on and off. Set burstMode to the number of burst read registers.
|
![]() | BurstMOSIData |
Data to transmit on the MOSI line during a burst read operation. This value is over written
if you set the trigger reg, since trigger reg is given priority.
|
![]() | BusyFX3s |
Property which returns a list of the serial numbers of all FX3 boards currently in use, running the application firmware.
|
![]() | ChipSelectControl |
Property to get or set the FX3 SPI controller chip select setting. Should be left on hardware control, changing modes will likely cause unexpected behavior.
Reqcode: B2
Value: Desired setting (as SpiChipselectControl )
Index: 4
Length: 4
Data: None
|
![]() | ChipSelectLagTime |
The number of SPI clock cycles after the transaction ends that chip select is toggled to idle.
Reqcode: B2
Value: Desired Setting (as SpiLagLeadTime )
Index: 6
Length: 4
Data: None
|
![]() | ChipSelectLeadTime |
The number of SPI clock cycles before the SPI transaction that chip select is toggled to active.
Reqcode: B2
Value: Desired Setting (as SpiLagLeadTime )
Index: 5
Length: 4
Data: None
|
![]() | ChipSelectPolarity |
Property to get or set the FX3 SPI chip select polarity (True - Active High, False - Active Low)
Reqcode: B2
Value: Polarity (0 active low, 1 active high)
Index: 3
Length: 4
Data: None
|
![]() | Cpha |
Property to get or set the FX3 SPI controller chip select phase
Reqcode: B2
Value: Polarity (0 active low, 1 active high)
Index: 2
Length: 4
Data: None
|
![]() | Cpol |
Property to get or set the FX3 SPI controller clock polarity setting (True - Idles High, False - Idles Low)
Reqcode: B2
Value: Polarity (0 active low, 1 active high)
'Index: 1
Length: 4
Data: None
|
![]() | CrcFirstIndex |
Gets or sets the index of the first burst data word used in CRC calculations.
|
![]() | CrcLastIndex |
Gets or sets the index of the last burst data word used in CRC calculations.
|
![]() | CrcResultIndex |
Gets or sets the index of the word that contains the CRC result.
|
![]() | DIO1 |
Read-only property to get the DIO1 pin
|
![]() | DIO2 |
Read-only property to get the DIO2 pin
|
![]() | DIO3 |
Read-only property to get the DIO3 pin
|
![]() | DIO4 |
Read-only property to get the DIO4 pin
|
![]() | DrActive |
If the data ready is used for register reads
|
![]() | DrPin |
This property is used to get or set the data ready pin. Is tied to the ReadyPin property
|
![]() | DrPolarity |
The Data Ready polarity for streaming mode (index 11)
|
![]() | DutSupplyMode |
Get or set the DUT supply mode on the FX3. Available options are regulated 3.3V, USB 5V, and off. This feature is only available on the
ADI in-house iSensor FX3 eval platform, not the platform based on the Cypress Explorer kit. If a Cypress Explorer kit is connected, the
setter for this property will be disabled.
|
![]() | FirmwarePath |
The path to the firmware .img file. Needs to be set before the FX3 can be programmed
|
![]() | FlashProgrammerPath |
Path to the programmer firmware which is loaded in RAM to allow flashing the EEPROM with the bootloader.
|
![]() | FX3_GPIO1 |
Read-only property to get the FX3_GPIO1 pin. This pin does not map to the standard iSensor breakout,
and should be used for other general purpose interfacing.
|
![]() | FX3_GPIO2 |
Read-only property to get the FX3_GPIO2 pin. This pin does not map to the standard iSensor breakout,
and should be used for other general purpose interfacing.
|
![]() | FX3_GPIO3 |
Read-only property to get the FX3_GPIO3 pin. This pin does not map to the standard iSensor breakout,
and should be used for other general purpose interfacing.
|
![]() | FX3_GPIO4 |
Read-only property to get the FX3_GPIO4 pin. This pin does not map to the standard iSensor breakout,
and should be used for other general purpose interfacing. This pin shares a complex GPIO block with DIO1. If DIO1 is being used
as a clock source, via the StartPWM function, then this pin cannot be used as a clock source.
|
![]() | FX3_LOOPBACK1 |
Read-only property to get loop back pin 1. This pin (CTL8) is wired directly to
loop back pin 2 (CTL9) on the iSensor FX3 Board, Revision C or newer. These loop
back pins allow for fixed transaction timing on "asynchronous" SPI/I2C reads. One
of the loop back pins can be configured as a PWM output using the "StartPWM" API,
and the other loop back pin can be set as the DrPin, allowing the FX3 to trigger
itself at a known rate.
|
![]() | FX3_LOOPBACK2 |
Read-only property to get loop back pin 2. This pin (CTL9) is wired directly to
loop back pin 1 (CTL8) on the iSensor FX3 Board, Revision C or newer. These loop
back pins allow for fixed transaction timing on "asynchronous" SPI/I2C reads. One
of the loop back pins can be configured as a PWM output using the "StartPWM" API,
and the other loop back pin can be set as the DrPin, allowing the FX3 to trigger
itself at a known rate.
|
![]() | FX3BoardAttached |
Checks if there is a Cypress FX3 USB device connected to the system
|
![]() | GetBootStatus |
Checks the boot status of the FX3 board by sending a vendor request
|
![]() | GetFirmwareVersion |
Property which reads the firmware version from the FX3
|
![]() | GetFX3ApiInfo |
This property returns a class containing some useful information about the current FX3 Dll. Some of the
information is available as a attribute of the DLL, while others (build date/time and git revision) are
generated at compile time using a pre-build batch file script.
|
![]() | GetNumBuffersRead |
Read-only property to get the number of buffers read in from the DUT in buffered streaming mode
|
![]() | GetTargetSerialNumber |
Read-only property to get the serial number of the active FX3 board
|
![]() | I2CBitRate |
Get/Set the FX3 I2C bit rate. Valid range 100KHz - 1MHz. Defaults to 100KHz
|
![]() | I2CRetryCount |
Get/Set the FX3 I2C retry count. This is the number of times the FX3
will retry a read/write when a NAK is received from the slave device
being addressed.
|
![]() | IsLSBFirst |
The FX3 SPI Controller LSB setting. The controller flips the bits depending on this setting.
Reqcode: B2
Value: Polarity (0 MSB first, 1 LSB first)
Index: 7
Length: 4
Data: None
|
![]() | NumFramesPurged |
Read-only property to get the number of bad frames purged with a call to PurgeBadFrameData. Frames are purged when the CRC appended to the end of
the frame does not match the expected CRC.
|
![]() | NumFramesSkipped |
Property to get the number of frame skips in an ADcmXL real time stream
|
![]() | PartType |
The DUT type connected to the board.
Reqcode: B2
Value: Part type to set
Index: 10
Length: 4
Data: None
|
![]() | PinExit |
Gets and sets the sync pin exit configuration for exiting real-time stream mode on ADcmXL DUT's.
|
![]() | PinStart |
Gets and sets the sync pin start configuration for starting real-time stream mode on ADcmXL DUT's.
|
![]() | ReadyPin |
Property to get or set the DUT data ready pin.
|
![]() | ResetPin |
Read-only property to get the reset pin
|
![]() | SclkFrequency |
Property to get or set the FX3 SPI clock frequency setting.
Reqcode: B2
Value: Don't Care
Index: 0
Length: 4
Data: Clock Frequency to be set
|
![]() | SensorType |
Property to get the device family type the FX3 was initialized for. Setting this property restores all SPI settings to the
default for the selected device family.
|
![]() | StallTime |
Property to get/set the number of microseconds between words
Reqcode: B2
Value: Stall time in microseconds (as int16)
Index: 9
Length: 4
Data: None
|
![]() | StreamTimeoutSeconds |
Sets the timeout for the Bulk Endpoint used in real time streaming modes.
|
![]() | StripBurstTriggerWord |
Property to choose if the readback from the 16 bit trigger word at the start of each burst is discarded or not
|
![]() | TimerTickScaleFactor |
Read only property to get the timer tick scale factor used for converting ticks to ms.
|
![]() | TriggerReg |
Gets or sets register that is used to trigger burst operation.
|
![]() | WatchdogEnable |
Enable or disable the FX3 firmware watchdog.
|
![]() | WatchdogTimeoutSeconds |
Set the FX3 firmware watchdog timeout period (in seconds). If the watchdog is triggered the FX3 will reset.
|
![]() | WordCount |
Gets or sets the number of 16 bit words that are read during the burst. Does not include trigger, real transfer will be 2 bytes larger.
|
![]() | WordLength |
The FX3 SPI controller word length. Default is 8 (1 byte per word)
Reqcode: B2
Value: Word length (as int8)
Index: 8
Length: 4
Data: None
|
Name | Description | |
---|---|---|
![]() ![]() | ISpi32Interface.DrActive | |
![]() ![]() | ISpi32Interface.DrPolarity | |
![]() ![]() | ISpi32Interface.StreamTimeoutSeconds |