mvI2cInterfaceControl Class Reference

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

Inheritance diagram for mvI2cInterfaceControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.

Properties
	mvI2cInterfaceASCIIBuffer = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceASCIIBuffer_get, doc=)
	A string property.
	mvI2cInterfaceBinaryBuffer = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBinaryBuffer_get, doc=)
	A string property.
	mvI2cInterfaceBytesToRead = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBytesToRead_get, doc=)
	An integer property.
	mvI2cInterfaceBytesToWrite = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBytesToWrite_get, doc=)
	An integer property.
	mvI2cInterfaceDeviceAddress = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceDeviceAddress_get, doc=)
	An integer property.
	mvI2cInterfaceDeviceSubAddress = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceDeviceSubAddress_get, doc=)
	An integer property.
	mvI2cInterfaceEnable = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceEnable_get, doc=)
	A boolean property.
	mvI2cInterfaceRead = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceRead_get, doc=)
	A method object.
	mvI2cInterfaceSpeed = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceSpeed_get, doc=)
	An enumerated integer property.
	mvI2cInterfaceWrite = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceWrite_get, doc=)
	A method object.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Contains features to control the I2C interface.

Contains features to control the I2C interface.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.mvI2cInterfaceControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The 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

Property Documentation

mvI2cInterfaceASCIIBuffer

mvI2cInterfaceASCIIBuffer = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceASCIIBuffer_get, doc=)

static

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

mvI2cInterfaceBinaryBuffer = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBinaryBuffer_get, doc=)

static

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

mvI2cInterfaceBytesToRead = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBytesToRead_get, doc=)

static

An integer property.

Number of bytes to read from I2C device.

Number of bytes to read from I2C device.

mvI2cInterfaceBytesToWrite

mvI2cInterfaceBytesToWrite = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceBytesToWrite_get, doc=)

static

An integer property.

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

Number of bytes from mvI2cInterfaceBuffer to write to I2C device.

mvI2cInterfaceDeviceAddress

mvI2cInterfaceDeviceAddress = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceDeviceAddress_get, doc=)

static

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

mvI2cInterfaceDeviceSubAddress = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceDeviceSubAddress_get, doc=)

static

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

mvI2cInterfaceEnable = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceEnable_get, doc=)

static

A boolean property.

Controls whether the I2C interface is enabled or not.

Controls whether the I2C interface is enabled or not.

mvI2cInterfaceRead

mvI2cInterfaceRead = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceRead_get, doc=)

static

A method object.

Command to read data from I2C device.

Command to read data from I2C device.

mvI2cInterfaceSpeed

mvI2cInterfaceSpeed = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceSpeed_get, doc=)

static

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

mvI2cInterfaceWrite

mvI2cInterfaceWrite = property(lib_mvIMPACT_acquire.mvI2cInterfaceControl_mvI2cInterfaceWrite_get, doc=)

static

A method object.

Command to write data to I2C device

Command to write data to I2C device

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static