Cybus::Connection

The Cybus::Connection resource enables connectivity to external systems or devices using various protocols. This following describes its properties, supported protocols, and configuration examples.

Properties

Property	Type	Required
protocol	enum	Required
targetState	enum	Optional
agentName	string	Optional
connection	object	Required

protocol

Specifies the protocol to be used for establishing the connection.

• Required

• Type: enum

The value of this property must be equal to one of the following values:

• Ads

• Bacnet

• EthernetIp

• Focas

• Hbmdaq

• Heidenhain

• Http

• InfluxDB

• Kafka

• Modbus

• Mqtt

• Mssql

• Opcda

• Opcua

• S7

• Shdr

• Sinumerik

• Sopas

• Sql

• Systemstate

• Werma

targetState

Defines the desired state of the resource after start-up.

• Optional

• Type: enum

• Allowed values: connected, disconnected

• Default: connected

agentName

Specifies the agent name if the protocol-mapper operates in distributed mode (i.e., on a separate agent instance from the Connectware). Use this property to identify the corresponding agent.

• Optional

• Type: string

• Default: protocol-mapper

connection

Defines the connection details required for the specified protocol.

• Required

• Type: object

Each protocol has its own set of connection properties:

• Ads Connection Properties

• Bacnet Connection Properties

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

• S7 Connection Properties

• Shdr Connection Properties

• Sinumerik Connection Properties

• Sopas Connection Properties

• Sql Connection Properties

• Systemstate Connection Properties

• Werma Connection Properties

Most protocols include a connectionStrategy property to configure incremental delays between reconnection attempts. This typically includes:

• initialDelay: Time in milliseconds before the first reconnection attempt.

• incrementFactor: Multiplier applied to the delay after each attempt.

• maxDelay: Maximum delay in milliseconds for subsequent attempts.

Once the connection is re-established, the initialDelay resets to its original value. Note that MQTT, OPC UA, S7, and Sinumerik protocols use their own reconnection strategies, detailed in their respective documentation.

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