SystemI2cBus

Description

The SystemI2cBus object is an I2cBus implementation providing access to devices on an I2C bus on the local system.

This object was introduced in InCore 2.5.

› Inherits:: I2cBus

Overview

Properties

Methods

Signals

Enumerations

Error

Properties

error

This property holds the most recently occurred error or SystemI2cBus.NoError if no error occurred. If the same error occurs multiple times this property does not change. Use the errorOccurred() signal to detect multiple occurrences of the same error.

› Type:: Error
› Signal:: errorChanged()
› Attributes:: Readonly

errorString

This property holds the current human readable error string corresponding to the current value in the error property. It may include additional information such as failure reasons or locations.

› Type:: String
› Signal:: errorStringChanged()
› Attributes:: Readonly

index

This property holds the I2C bus number.

› Type:: UnsignedInteger
› Default:: 4294967295
› Signal:: indexChanged()
› Attributes:: Writable

Signals

errorOccurred()

This signal is emitted whenever an error has occurred, regardless of whether the error property has changed or not. In contrast to the change notification signal of the error property this signal is also emitted several times if a certain error occurs several times in succession.

Enumerations

Error

This enumeration describes all errors which can occur in SystemI2cBus objects. The most recently occurred error is stored in the error property.

Name	Value	Description
`SystemI2cBus.NoError`	`0`	No error occurred or was detected.
`SystemI2cBus.DeviceOpenError`	`1`	Device could not be opened.
`SystemI2cBus.ReadError`	`2`	Failed to read the specified number of bytes from configured address.
`SystemI2cBus.WriteError`	`3`	Failed to write the specified number of bytes to configured address.