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
protocol	enum	Required
targetState	enum	Optional
agentName	string	Optional
connection	object	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 below

• Ads

• Bacnet

• EthernetIp

• Focas

• GenericVrpc

• Hbmdaq

• Heidenhain

• Http

• InfluxDB

• Kafka

• Modbus

• Mqtt

• Mssql

• Opcda

• Opcua

• Profinet

• 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 of connected, 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:

• Ads Connection Properties

• Bacnet Connection Properties

• EthernetIp Connection Properties

• GenericVrpc Connection Properties

• Focas Connection Properties

• Hbmdaq Connection Properties

• Heidenhain Connection Properties

• Http Connection Properties

• InfluxDB Connection Properties

• Kafka Connection Properties

• Modbus Connection Properties

• Mqtt Connection Properties

• Mssql Connection Properties

• Opcda Connection Properties

• Opcua Connection Properties

• Profinet Connection Properties

• S7 Connection Properties

• Shdr Connection Properties

• Sinumerik Sinumerik

• Sopas Connection Properties

• Sql Connection Properties

• Systemstate Connection Properties

• Werma 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

mqttConnection:
  type: Cybus::Connection
  properties:
    protocol: Mqtt
    connection:
      host: broker

OPC UA

opcuaConnection:
  type: Cybus::Connection
  properties:
    protocol: Opcua
    connection:
      host: 127.17.0.1
      port: 50000
      username: user
      password: user

Modbus

modbusConnection:
  type: Cybus::Connection
  properties:
    agentName: edge-mapper # uses the protocol-mapper agent 'edge-mapper'
    protocol: Modbus
    connection:
      host: 172.17.0.1
      port: 10502