Skip to content
STAGING SERVER
DEVELOPMENT SERVER

Using the JSON Test Files with Industrial Edge Flow Creator#

In this section, Basler delivers JSON test files you can use to get started with sending messages to the the Basler Vision Connector via Flow Creator. Alternatively, you can also configure your system with the Basler Vision Connector Web UI.

To use the JSON test files:

  1. For the next steps (opening the camera, setting parameters, etc.), download the following JSON test files to your computer. These files are only available via the Basler Product Documentation:
  2. Make sure that the following apps are installed on your Edge Device in addition to the Basler Vision Connector:

    For the MQTT test you need:

    • the Flow Creator app
    • the Data Flow Monitoring app (to find out the IP address of the Basler Vision Connector)
    • the Databus app (= MQTT Broker)

    For the ZeroMQ test you need:

    • the Flow Creator app
    • the Data Flow Monitoring app (to find out the IP address of the Basler Vision Connector)

Instructions for MQTT#

These instructions apply to both MQTT test files:

A connection to the MQTT broker must be established and the root topics must be subscribed. To ensure that:

  1. Go to Data Connections in your Industrial Edge Management platform.
  2. Select the device where the Databus and the Basler Vision Connector app are installed and add a new user by clicking the Add User button.

    Siemens Databus: Add a New User

  3. Enter your username and password and select the permission Public and Subscribe.

  4. Subscribe to the root topic: Click the Add Topics button Add Topic Button.
  5. In the Add Topic dialog, add the topic BaslerVisionConnector/#, select the permission Publish and Subscribe and click Save.

    Siemens Databus: Add a New Topic

  6. Click Deploy.

    Siemens Databus: Deploy

    The Deploy dialog opens up:

    Siemens Databus: Deploying a New User

  7. Select the Device on which the BVC is installed and click Deploy. The deployment process takes some seconds.

  8. In the Edge Management platform, open your Edge Device.

    Opening the Siemens Flow Creator App

  9. Go to Apps and click Flow Creator. The Flow Creator app opens up.

  10. From the menu, select Import. Import the MQTT JSON test file.

    Siemens Flow Creator: Importing the MQTT JSON Test File


    The Test JSON file is imported and displayed as topics in the Flow Creator app.

  11. Double-click the topic BaslerVisionConnector/request. The Edit mqtt out node dialog opens up. Click the pencil/edit button.

    Siemens Flow Creator: Editing the BaslerVisionConnector/request Topic

  12. Go to Security tab.

    Siemens Flow Creator: Editing User Credentials in MQTT Broker Topic

  13. Ensure that your user name and password are correct. Click Update and Done.

  14. Double-click the topic BaslerVisionConnector/response. The Edit mqtt out node dialog opens up. Click the pencil/edit button.
  15. Go to Security tab.
  16. Ensure that your user name and password are correct. Click Update and Done.
  17. Click Deploy. The connection to the MQTT broker is established. If the connection is established correctly, the topics BaslerVisionConnector/request and BaslerVisionConnector/response are shown as connected:

    Siemens Flow Creator: Connection to the MQTT Broker Established

  18. Now you can send messages by clicking the available topics.

  19. Adapt the serial number of your camera in the relevant topics/messages.
  20. You can add new messages by adding a new inject node. See Messaging for information about available messages.

    Siemens Flow Creator: Adding New Nodes

Instructions for ZeroMQ#

Note

The following instructions are valid for working with a virtual IE device. If you have a physical IED, you must build a NodeRed application with the node-red-contrib-zeromq node. See the Siemens Documentation: Develop an Application for instructions.

  1. In the Edge Management platform, open your Edge Device.

    Opening the Siemens Flow Creator App

  2. Go to Apps and click Flow Creator. The Flow Creator app opens up.

  3. From the menu, select Manage palette.

    Siemens Flow Creator: Manage Palette

  4. The User Settings menu opens up. On the Install tab, type zmq into the search filed and click Install for the node-red-contrib-zeromq node.

    Siemens Flow Creator: Manage Palette

    The node-red-contrib-zeromq node is installed.

  5. From the menu, select Import. Import the ZeroMQ JSON test file.

    Siemens Flow Creator: Importing the ZeroMQ JSON Test File

  6. In the imported test file, connect the ZeroMQ topics, i.e. zeromq and {DeviceID}/stream, to the Basler Vision Connector app: Click the node and change the host name to baslervisionconnector-x86-64.

    Siemens Flow Creator: Connecting the ZeroMQ Topics

    If the connection is established correctly, the topics zeromq and {DeviceID}/stream are shown as connected:

    Siemens Flow Creator: Connection to the Basler Vision Connector Established

  7. Now you can send messages by clicking the available topics. To see the reply of the message, switch to the debug mode:

    Siemens Flow Creator: ZeroMQ Replies in Debug Mode

  8. You can add new messages by adding a new inject topic. See Messaging for information about available messages.

    Siemens Flow Creator: Adding New Nodes

Instructions for ZeroMQ with Image Viewer#

With the Image Viewer in the ZeroMQ JSON Test File with File Image Viewer you can preview the images of your camera.

Use the Web UI Instead

This section is only relevant, if you want to use create an image preview in the Flow Creator. The dafault way to get an image preivew, is to use the Basler Vision Connector Web UI.

Info

The following instructions are valid for working with a virtual IE device. If you have a physical IED, you must build a NodeRed application with the following nodes:

See the Siemens Documentation: Develop an Application for instructions.

To use the Image Viewer:

  1. In the Edge Management platform, open your Edge Device.

    Opening the Siemens Flow Creator App

  2. Go to Apps and click Flow Creator. The Flow Creator app opens up.

  3. From the menu, select Manage palette.

    Siemens Flow Creator: Manage Palette

  4. The User Settings menu opens up. On the Install tab, select the following nodes for installation:

  5. From the menu, select Import. Import the ZMQ JSON test file with Image Viewer.

    Siemens Flow Creator: Importing the ZeroMQ JSON Test File

  6. In the imported test file, connect the ZeroMQ topics, i.e. zeromq and {DeviceID}/stream, to the Basler Vision Connector app: Click the node and change the host name to baslervisionconnector-x86-64.

    Siemens Flow Creator: Connecting the ZeroMQ Topics

    If the connection is established correctly, the topics zeromq and {DeviceID}/stream are shown as connected:

    Siemens Flow Creator: Connection to the Basler Vision Connector Established

  7. Click the Enumerate Devices node. All discovered devices are listed.

  8. Copy the device ID of the camera you want to stream with.
  9. Click the Device ID node. Paste the copied device ID here.
  10. Click the Pixel Formats node and set the desired pixel formats.
  11. If required, configure more parameters.
  12. Click Start Streaming. A preview of your streamed image is displayed in the Flow Creator.

    Siemens Flow Creator: Previewing Image with Image Viewer