I2CPreamble Class |
Namespace: FX3Api
The I2CPreamble type exposes the following members.
Name | Description | |
---|---|---|
![]() | I2CPreamble |
I2C Preamble constructor. Initializes all fields to zero
|
Name | Description | |
---|---|---|
![]() | DeviceAddress |
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.
|
![]() | StartMask |
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.
|
![]() | StopMask |
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.
|
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
![]() | PreambleData |
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.
|