Cybus::Connection
A connection provides connectivity to some other things over some protocol (see also Industry Protocol Details) and implements connect and disconnect functionality.
Properties
Property | Type | Required |
---|---|---|
| Required | |
| Optional | |
| Optional | |
| Required |
protocol
Identifies the protocol for which a connection should be established
is required
type:
enum
The value of this property must be equal to one of the following values:
Ads
Bacnet
EthernetIp
Focas
GenericVrpc
Hbmdaq
Heidenhain
Http
InfluxDB
Kafka
Modbus
Mqtt
Mssql
Opcda
Opcua
S7
Shdr
Sinumerik
Sopas
Sql
Systemstate
Werma
targetState
The state this resource should be in, after start-up.
is optional
type:
enum
, must be one ofconnected
,disconnected
default:
connected
agentName
Only set this property if your protocol-mapper runs as in a distributed mode, i.e. on an agent instance separated from the Connectware. If this is the case, specify the corresponding agent name here.
is optional
type:
string
default:
protocol-mapper
connection
is required
type:
object
Depending on the protocol type the connection provides the following properties:
Bacnet
Connection PropertiesEthernetIp
Connection PropertiesGenericVrpc
Connection PropertiesFocas
Connection PropertiesHbmdaq
Connection PropertiesHeidenhain
Connection PropertiesInfluxDB
Connection PropertiesKafka
Connection PropertiesModbus
Connection PropertiesMssql
Connection PropertiesOpcda
Connection PropertiesOpcua
Connection PropertiesSinumerik
Connection PropertiesSopas
Connection PropertiesSystemstate
Connection PropertiesWerma
Connection Properties
Most protocols expose a property connectionStrategy
which allows configuring the incremental delays between re-connection attempts. Each protocol provides defaults for this configuration which is documented on each of them. In general an initialDelay
property determines how many milliseconds to wait before the first attempt to re-connect is executed and then this value is multiplied by the configured incrementFactor
, replacing the original initialDelay
, up to a maximum configured maxDelay
that once reached causes all subsequent re-connection attempts to occur after that many milliseconds. Once the connection is restablished the initialDelay
is reset to its original value. The procotols Mqtt, Opcua, S7 and Sinumerik use their own strategy described in each of them.
Examples
MQTT
OPC UA
Modbus
Last updated