mvIMPACT Acquire SDK C++
mvI2cInterfaceControl Class Reference

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

#include <mvIMPACT_acquire_GenICam.h>

Public Member Functions

 mvI2cInterfaceControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvI2cInterfaceControl object.
 

Public Attributes

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

Examples
GenICamI2cUsage.cpp.

Constructor & Destructor Documentation

◆ mvI2cInterfaceControl()

mvI2cInterfaceControl ( mvIMPACT::acquire::Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvI2cInterfaceControl object.

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::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 mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

Member Data Documentation

◆ mvI2cInterfaceASCIIBuffer

PropertyS mvI2cInterfaceASCIIBuffer

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

PropertyS mvI2cInterfaceBinaryBuffer

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

PropertyI64 mvI2cInterfaceBytesToRead

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

Number of bytes to read from I2C device.

◆ mvI2cInterfaceBytesToWrite

PropertyI64 mvI2cInterfaceBytesToWrite

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

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

◆ mvI2cInterfaceDeviceAddress

PropertyI64 mvI2cInterfaceDeviceAddress

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

PropertyI64 mvI2cInterfaceDeviceSubAddress

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

PropertyIBoolean mvI2cInterfaceEnable

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

Controls whether the I2C interface is enabled or not.

◆ mvI2cInterfaceRead

Method mvI2cInterfaceRead

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

Command to read data from I2C device.

◆ mvI2cInterfaceSpeed

PropertyI64 mvI2cInterfaceSpeed

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 mvIMPACT::acquire::EnumPropertyI::getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

◆ mvI2cInterfaceWrite

Method mvI2cInterfaceWrite

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

Command to write data to I2C device