Click or drag to resize

Wrapper Class

Simplified wrapper around FX3 connection object
Inheritance Hierarchy
SystemObject
  FX3ApiWrapperWrapper

Namespace:  FX3ApiWrapper
Assembly:  FX3ApiWrapper (in FX3ApiWrapper.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class Wrapper

The Wrapper type exposes the following members.

Constructors
  NameDescription
Public methodWrapper
Wrapper constructor. Loads resources and connects to FX3
Top
Properties
  NameDescription
Public propertyRegNumBytes
Get or set number of bytes per register. Used when directly addressing registers (not using RegMap)
Top
Methods
  NameDescription
Public methodConvertBufferDataToU32
Converted buffered stream data packet to 32-bit array, based on the size of the registers read
Public methodDisconnect
Disconnect FX3 board
Public methodDutSupplyOff
Turn off DUT supply
Public methodDutSupplyOn3_3
Turn on 3.3V DUT supply
Public methodDutSupplyOn5_0
Turn on 5V DUT supply
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Class destructor. Disconnects FX3
(Overrides ObjectFinalize.)
Public methodGetBufferedStreamDataPacket
Get a buffered stream data packet
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMeasurePinFreq
Measure frequency at which a pin toggles
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrintRegMap
Print a list of all registers in provided regmap CSV
Public methodReadPin
Read the level on a DIO pin
Public methodReadSigned(String)
Read single signed register
Public methodReadSigned(String)
Read multiple signed registers
Public methodReadSigned(String, UInt32)
Read set of multiple signed registers, numCaptures times
Public methodReadSigned(UInt32, UInt32)
Read single signed register based on page/address
Public methodReadSigned(UInt32, UInt32)
Read signed registers based on page/address
Public methodReadSigned(String, UInt32, UInt32)
Read set of multiple signed registers, numCaptures times per data ready, numBuffers total captures
Public methodReadSigned(UInt32, UInt32, UInt32)
Read signed registers based on page/address
Public methodReadSigned(UInt32, UInt32, UInt32, UInt32)
Read signed registers based on page/address
Public methodReadUnsigned(String)
Read single unsigned register
Public methodReadUnsigned(String)
Read multiple unsigned registers
Public methodReadUnsigned(String, UInt32)
Read set of multiple unsigned registers, numCaptures times
Public methodReadUnsigned(UInt32, UInt32)
Read single unsigned register based on page/address
Public methodReadUnsigned(UInt32, UInt32)
Read unsigned registers based on page/address
Public methodReadUnsigned(String, UInt32, UInt32)
Read set of multiple unsigned registers, numCaptures times per data ready, numBuffers total captures
Public methodReadUnsigned(UInt32, UInt32, UInt32)
Read unsigned registers based on page/address
Public methodReadUnsigned(UInt32, UInt32, UInt32, UInt32)
Read unsigned registers based on page/address
Public methodResetDut
Reset DUT via reset pin
Public methodSetDrActive
Enable/disable data ready triggering for register reads
Public methodSetDrPin
Configure which DIO pin acts as a data ready signal
Public methodSetDrPolarity
Set data ready triggering polarity. True -> trigger on posedge, false -> trigger on negedge
Public methodSetPin
Set pin to a level
Public methodSetRegWordOrder
Set the word order for a 32-bit register which is comprised of multiple 16-bit registers
Public methodSetSCLKFreq
Set SPI clock freq
Public methodSetSpiStallTime
Sets the stall time between SPI words
Public methodStartBufferedStream(String, UInt32, UInt32, Int32)
Start an asynchronous buffered register read stream
Public methodStartBufferedStream(UInt32, UInt32, UInt32, UInt32, Int32)
Start an asynchronous buffered register read stream based on register address/page
Public methodStartPWM
Start a PWM signal output
Public methodStopPWM
Stop PWM signal being driven
Public methodStopStream
Stop an active buffered stream
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateDutType
Update the IDutInterface type based on the current FX3 setting. For SensorType of ADcmXL will use the appropriate ADcmXL Interface (ADcmXLx021) For SensorType of AutomotiveSpi will use ZeusInterface (ADIS1655x) For SensorType of IMU, PartType LegacyIMU will use aducInterface (ADIS1644x) For SensorType of IMU, PartType IMU, will use adbfInterface (ADIS1647x, ADIS1649x, ADIS1650x)
Public methodUpdateRegMap
Reload the regmap based on provided CSV path
Public methodUserLEDBlink
Blink user LED
Public methodUserLEDOff
Turn off user LED
Public methodUserLEDOn
Turn on user LED
Public methodWriteSigned(String, Int32)
Write a signed value to a single register in the RegMap
Public methodWriteSigned(String, Int32)
Write signed values to multiple registers in the RegMap
Public methodWriteSigned(UInt32, UInt32, Int32)
Write a single signed register, based on register addr/page
Public methodWriteSigned(UInt32, UInt32, Int32)
Write signed data based on register addr/page
Public methodWriteUnsigned(String, UInt32)
Write an unsigned value to a single register in the RegMap
Public methodWriteUnsigned(String, UInt32)
Write unsigned values to multiple registers in the RegMap
Public methodWriteUnsigned(UInt32, UInt32, UInt32)
Write a single unsigned register, based on register addr/page
Public methodWriteUnsigned(UInt32, UInt32, UInt32)
Write unsigned data based on register addr/page
Top
Fields
  NameDescription
Public fieldDut
Underlying DUT interface object
Public fieldFX3
Underlying FX3 connection object
Top
See Also