Impact Acquire SDK .NET
Public Member Functions | Public Attributes | List of all members
mvI2cInterfaceControl Class Reference
GenICam Interface Layout » GenICam Interface Layout (Device)

Contains features to control the I2C interface. More...

Public Member Functions

 mvI2cInterfaceControl (mv.impact.acquire.Device device)
 Constructs a new mv.impact.acquire.GenICam.mvI2cInterfaceControl object.
 
 mvI2cInterfaceControl (mv.impact.acquire.Device device, System.String settingName)
 Constructs a new mv.impact.acquire.GenICam.mvI2cInterfaceControl object.
 

Public Attributes

readonly mv.impact.acquire.PropertyS mvI2cInterfaceASCIIBuffer = new mv.impact.acquire.PropertyS()
 A string property. Buffer for exchanging ASCII data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceBinaryBuffer'.
 
readonly mv.impact.acquire.PropertyS mvI2cInterfaceBinaryBuffer = new mv.impact.acquire.PropertyS()
 A string property. Buffer for exchanging binary data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceASCIIBuffer'.
 
readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceBytesToRead = new mv.impact.acquire.PropertyI64()
 An integer property. Number of bytes to read from I2C device.
 
readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceBytesToWrite = new mv.impact.acquire.PropertyI64()
 An integer property. Number of bytes from mvI2cInterfaceBuffer to write to I2C device.
 
readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceDeviceAddress = new mv.impact.acquire.PropertyI64()
 An integer property. I2C device address, must be even.
 
readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceDeviceSubAddress = new mv.impact.acquire.PropertyI64()
 An integer property. I2C device sub address ignored when set to -1, 2 byte address if bit 0x10000 is set, else 1 Byte.
 
readonly mv.impact.acquire.PropertyIBoolean mvI2cInterfaceEnable = new mv.impact.acquire.PropertyIBoolean()
 A boolean property. Controls whether the I2C interface is enabled or not.
 
readonly mv.impact.acquire.Method mvI2cInterfaceRead = new mv.impact.acquire.Method()
 A method object. Command to read data from I2C device.
 
readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceSpeed = new mv.impact.acquire.PropertyI64()
 An enumerated integer property. I2C interface clock frequency.
 
readonly mv.impact.acquire.Method mvI2cInterfaceWrite = new mv.impact.acquire.Method()
 A method object. Command to write data to I2C device.
 

Detailed Description

Contains features to control the I2C interface.

Contains features to control the I2C interface.

Constructor & Destructor Documentation

◆ mvI2cInterfaceControl() [1/2]

mvI2cInterfaceControl ( mv::impact::acquire::Device device)
inline

Constructs a new mv.impact.acquire.GenICam.mvI2cInterfaceControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

◆ mvI2cInterfaceControl() [2/2]

mvI2cInterfaceControl ( mv::impact::acquire::Device device,
System::String settingName )
inline

Constructs a new mv.impact.acquire.GenICam.mvI2cInterfaceControl object.

Parameters
[in]deviceA pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]settingNameThe name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Data Documentation

◆ mvI2cInterfaceASCIIBuffer

readonly mv.impact.acquire.PropertyS mvI2cInterfaceASCIIBuffer = new mv.impact.acquire.PropertyS()

A string property. Buffer for exchanging ASCII data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceBinaryBuffer'.

Buffer for exchanging ASCII data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceBinaryBuffer'.

◆ mvI2cInterfaceBinaryBuffer

readonly mv.impact.acquire.PropertyS mvI2cInterfaceBinaryBuffer = new mv.impact.acquire.PropertyS()

A string property. Buffer for exchanging binary data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceASCIIBuffer'.

Buffer for exchanging binary data over the I2C interface. This buffer uses the same memory as 'mvI2cInterfaceASCIIBuffer'.

◆ mvI2cInterfaceBytesToRead

readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceBytesToRead = new mv.impact.acquire.PropertyI64()

An integer property. Number of bytes to read from I2C device.

Number of bytes to read from I2C device.

◆ mvI2cInterfaceBytesToWrite

readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceBytesToWrite = new mv.impact.acquire.PropertyI64()

An integer property. Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

◆ mvI2cInterfaceDeviceAddress

readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceDeviceAddress = new mv.impact.acquire.PropertyI64()

An integer property. I2C device address, must be even.

I2C device address, must be even, blocked addresses: 0x20, 0x30 (Test), 0x32, 0x34, 0x36, 0x3E, 0x60, 0x62, 0x64, 0x66, 0x6E, 0x90, 0x92, 0xA0, 0xA2, 0xA4, 0xA6, 0xAE, 0xB0, 0xB2, 0xB4, 0xB6, 0xB8, 0xBA, 0xBC, 0xBE.

◆ mvI2cInterfaceDeviceSubAddress

readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceDeviceSubAddress = new mv.impact.acquire.PropertyI64()

An integer property. I2C device sub address ignored when set to -1, 2 byte address if bit 0x10000 is set, else 1 Byte.

I2C device sub address ignored when set to -1, 2 byte address if bit 0x10000 is set, else 1 Byte.

◆ mvI2cInterfaceEnable

readonly mv.impact.acquire.PropertyIBoolean mvI2cInterfaceEnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Controls whether the I2C interface is enabled or not.

Controls whether the I2C interface is enabled or not.

◆ mvI2cInterfaceRead

readonly mv.impact.acquire.Method mvI2cInterfaceRead = new mv.impact.acquire.Method()

A method object. Command to read data from I2C device.

Command to read data from I2C device.

◆ mvI2cInterfaceSpeed

readonly mv.impact.acquire.PropertyI64 mvI2cInterfaceSpeed = new mv.impact.acquire.PropertyI64()

An enumerated integer property. I2C interface clock frequency.

I2C interface clock frequency.

The following string values might be valid for this feature:

  • kHz_100 (Display string: '100 kHz'): default speed
  • kHz_400 (Display string: '400 kHz'): fast speed
Note
Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvI2cInterfaceWrite

readonly mv.impact.acquire.Method mvI2cInterfaceWrite = new mv.impact.acquire.Method()

A method object. Command to write data to I2C device.

Command to write data to I2C device