Using Custom Connectors

You can use your custom connectors via service commissioning files, just like you use agents.

Code Example of a Service Commissioning File Template

In this example, you establish the connection via the agent and use the endpoints to fill in the required parameters for the corresponding protocol. Make sure that the agent name matches the agent name that you have specified in the docker-compose.yml file in the Deploying Custom Connectors topic.

Now, you can develop your data model on the MQTT broker in Connectware like any other service, for example, via mappings.

parameters:
  agentName:
    type: string
    description: Agent Name
    default: custom-connectware-agent # make sure it matches CYBUS_AGENT_NAME

resources:
  customConnection:
    type: Cybus::Connection
    properties:
      protocol: custom-protocol
      agentName: !ref agentName
      connection:
        host: localhost
        port: 50001

  ReadStatus:
    type: Cybus::Endpoint
    properties:
      protocol: custom-connector
      connection: !ref customConnection
      subscribe:
        function: read_status
        interval: 1000