SystemSpiBus

Description

The SystemSpiBus object is an SpiBus implementation providing access to devices on an SPI bus on the local system.

This object was introduced in InCore 2.8.

› Inherits:: SpiBus

Overview

Properties

Methods

Signals

Enumerations

Properties

error

This property holds the most recently occurred error or SystemSpiBus.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 SPI 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 SystemSpiBus objects. The most recently occurred error is stored in the error property.

Name	Value	Description
`SystemSpiBus.NoError`	`0`	No error occurred or was detected.
`SystemSpiBus.DeviceOpenError`	`1`	Device could not be opened.
`SystemSpiBus.TransferError`	`2`	Failed to transfered the specified number of bytes from/to configured address.