This example shows an entire BAZ setup expressed within a single commissioning file, using explicit topics and involving an agent for providing the connection and endpoint resources.
The name of the agent must be specified in the agentName parameter, for example connectware-agent or whatever other name has been given to the agent instance.
Download:
The example below uses an additional Docker image provided by Cybus that requires a suitable license. You can check the current capabilities and permissions of your Connectware license in the Cybus Portal (https://portal.cybus.io). If your license is not eligible to use the example Docker image, please contact Cybus Sales (sales@cybus.io).
description:> Entire simulated machining involving a protocol-mapper agentmetadata:name:Simulated Machining Centericon:https://www.cybus.io/wp-content/themes/cybus/img/product-slide-img.pngprovider:cybushomepage:https://www.cybus.ioversion:2.0.0parameters:agentName:type:stringdescription:Agent Namedefault:connectware-agentmodbusPort:type:integerdefault:10502dockerBridgeNetworkIp:type:stringdefault:172.17.0.1description:The IP address of the docker bridge network gateway, see "docker network inspect bridge"definitions:CYBUS_MQTT_ROOT:cybus/baz-simulatordefaultModbusAddress:fc:3length:2interval:1000dataType:uint16BEresources:machineSimulator:type:Cybus::Containerproperties:image:registry.cybus.io/cybus-services/baz-machine-simulator:0.0.1ports: - !sub'${modbusPort}:10502/tcp'modbusConnection:type:Cybus::Connectionproperties:agentName:!refagentNameprotocol:ModbustargetState:connectedconnection:host:!refdockerBridgeNetworkIpport:!refmodbusPortcurrentState:type:Cybus::Endpointproperties:protocol:Modbusconnection:!refmodbusConnectiontopic:current-statesubscribe:!mergedefaultModbusAddress:address:0currentTool:type:Cybus::Endpointproperties:protocol:Modbusconnection:!refmodbusConnectiontopic:current-toolsubscribe:!mergedefaultModbusAddress:address:2coolantLevel:type:Cybus::Endpointproperties:protocol:Modbusconnection:!refmodbusConnectiontopic:coolant-levelsubscribe:!mergedefaultModbusAddress:address:4spindleSpeed:type:Cybus::Endpointproperties:protocol:Modbusconnection:!refmodbusConnectiontopic:spindle-speedsubscribe:!mergedefaultModbusAddress:address:6dashboard:type:Cybus::Containerproperties:image:registry.cybus.io/cybus-services/baz-dashboard:0.2.3volumes: - !sub'${dashboardData}:/root/.node-red'environment:MQTT_HOST:!refCybus::MqttHostMQTT_USER:!refCybus::MqttUserMQTT_PASS:!refCybus::MqttPasswordMQTT_PORT:!refCybus::MqttPortHTTP_ROOT:/dashboardData:type:Cybus::VolumedashboardRoute:type:Cybus::IngressRouteproperties:container:!refdashboardtype:httpslug:dashboardtarget:path:/port:1880dashboardLink:type:Cybus::Linkproperties:ingressRoute:!refdashboardRoutehref:ui/name:Dashboard
How to deploy the agent
To run the above example, you must also deploy and run an agent, which is a container using the Connectware’s image protocol-mapper with some special environment variables (see also Agent Installation).
The first thing you need to set is the image and image tag (i.e. version) you are going to use. The agent’s container must use the protocol-mapper image of the exact same version as the Connectware, otherwise the system may run into unspecified behaviour. For the subsequent command the image tag (version) is stored as IMAGE_TAG= 1.6.2
Using the IMAGE_TAG environment variable, the following command will run the agent directly (but with the comment lines removed):
# The docker run commanddocker run --rm \# Attach a volume so the agent can store data across restarts-v /tmp/cybus:/data \# Set the name of the agent. This must match the agentName used in the commissioning file.-e CYBUS_AGENT_NAME=connectware-agent \# The IP address where the Connectware is running.-e CYBUS_MQTT_HOST=10.11.12.13 \# Make it run as an agent-e CYBUS_AGENT_MODE=distributed \# Some suitable hostname of the container.--hostname=${HOSTNAME} \# Run it in host mode networking--net=host \# The image to useregistry.cybus.io/cybus/protocol-mapper:${IMAGE_TAG}
Then, complete the set up by registering the new agent’s user in the Connectware using the “Client Registry” process, see Agent Registration and Client Registry