BackplaneBus

Description

The BackplaneBus object represents the backplane bus and is used for device discovery.

› Inherits:: Object

Overview

Properties

communicationTimeout
connectionTimeout
devices
error
errorString

Methods

Signals

busReady()
devicesDataChanged()
errorOccurred()
Object.completed()

Enumerations

Error
State

Properties

communicationTimeout

This property holds the timeout for communicating with the backplane bus server. If the backplane bus server does not respond to a message within the specified time, the bus is reset.

This property was introduced in InCore 1.1.

› Type:: SignedInteger
› Default:: 5000
› Signal:: communicationTimeoutChanged()
› Attributes:: Writable

connectionTimeout

This property holds the timeout for connecting to the backplane bus server. If the backplane bus server does not respond within the specified time, the connection is retried.

› Type:: SignedInteger
› Default:: 1000
› Signal:: connectionTimeoutChanged()
› Attributes:: Writable

devices

This property holds the list of devices on the bus to communicate with.

› Type:: List<BackplaneBusDevice>
› Signal:: devicesChanged()
› Attributes:: Readonly

error

This property holds the most recently occurred error or BackplaneBus.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

setupTimeout

This property holds the timeout for the bus setup operation in milliseconds. If the connected devices can’t be detected within this time out, the backplane bus is reset and device discovery is started again.

› Type:: SignedInteger
› Default:: 15000
› Signal:: setupTimeoutChanged()
› Attributes:: Writable

state

This property holds the current state of the backplane bus. See the State enumeration for details.

› Type:: State
› Default:: BackplaneBus.Unconnected
› Signal:: stateChanged()
› Attributes:: Readonly

Methods

reset()

This method Restarts the backplane bus server, resets the connection to it and restarts the device discovery process.

Signals

busReady()

This signal is emitted when the bus enters the BackplaneBus.Ready state, i.e. all devices have been discovered and assigned to according BackplaneBusDevice objects.

devicesDataChanged(SignedInteger index)

This signal is emitted whenever the List.dataChanged() signal is emitted, i.e. the item at index in the devices list itself emitted the dataChanged() signal.

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 BackplaneBus objects. The most recently occurred error is stored in the error property.

Name	Value	Description
`BackplaneBus.NoError`	`0`	No error occurred or was detected.
`BackplaneBus.ServerError`	`1`	Backplane bus server not running.
`BackplaneBus.SocketError`	`2`	Socket error: Unknown error.

State

This enumeration describes the current state of the backplane bus.

Name	Value	Description
`BackplaneBus.Unconnected`	`0`	No connection to the backplane bus server has been established.
`BackplaneBus.Connecting`	`1`	A connection to the backplane bus server is being established.
`BackplaneBus.Discovering`	`2`	Devices are being discovered on the backplane bus.
`BackplaneBus.Ready`	`3`	All devices on the backplane bus have been discovered and assigned.

Example

See EnergyAddonEN100 example on how to use BackplaneBus.