Click or drag to resize

I2CPreamble Class

I2C pre-amble class.
Inheritance Hierarchy
SystemObject
  FX3ApiI2CPreamble

Namespace:  FX3Api
Assembly:  FX3Api (in FX3Api.dll) Version: 2.9.4.0 (2.9.4)
Syntax
public class I2CPreamble

The I2CPreamble type exposes the following members.

Constructors
  NameDescription
Public methodI2CPreamble
I2C Preamble constructor. Initializes all fields to zero
Top
Properties
  NameDescription
Public propertyDeviceAddress
This is the 7-bit slave address for the device to access on the I2C bus. The address value must be left justified, with a zero in the least significant bit. The address bits (starting at DeviceAddress bit 7) are the first data transmitted by the FX3 when starting an I2C transaction. A R/W bit (generated by the firmware) follows the seven device address bits to complete the first byte.
Public propertyStartMask
This field controls the start condition sent after every byte of preamble data. The device address is the first byte of data, following by up to seven additional bytes in PreAmbleData. For example, setting StartMask to 0x04 will cause a start condition to be generated after sending PreambleData[1], while setting StartMask to 0x08 will cause a start condition to be generated after sending PreambleData[2], and so on. Note, setting a bit in StartMask will cause the corresponding bit in StopMask to be cleared, if it is also set.
Public propertyStopMask
This field controls the stop condition sent after every byte of preamble data. The device address is the first byte of data, following by up to seven additional bytes in PreAmbleData. For example, setting StopMask to 0x01 will cause a stop condition to be generated after sending DeviceAddress, while setting StopMask to 0x02 will cause a stop condition to be generated after sending PreambleData[0], and so on. Note, setting a bit in StopMask will cause the corresponding bit in StartMask to be cleared, if it is also set.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldPreambleData
The bytes to transmit following the device address and R/W bit. The maximum size of this list is 7 bytes, giving 8 total bytes transmitted as part of the pre-amble.
Top
See Also