Tutorial: Configuring a FactoryTX Device

This article contains the following sections:

Introduction

After you deploy FactoryTX , you can edit the configuration, which involves the following procedures:

  • Connecting to a data source and confirming the authentication credentials and how to request the data
  • Creating a new data receiver in the FTX configuration file
  • Running the new data receiver and looking at the output
  • Creating a new transmit with an API key

Connecting to a Data Source

Before you can pull data from a data source, you need to look at the machine and gather some information, including which protocol is being used (file-based, SQL, OPC UA, etc.) and the machine/asset name.

Before you can configure FactoryTX, make sure to test each data source to which you want to connect. You may need to use different software applications for each source. The following is a list of free tools that you can use:

What to Test?

  • IP address or hostname of the target data source
  • Authentication information
  • Location of the data in folder/table/tag path
  • List of fields/tags/files that you want to retrieve

In each case, you should be able to access the data that you want to use FactoryTX to transmit to Sight Machine before configuring each data receiver. This will make the connection process as straightforward as possible.


Creating a New Data Receiver in the FTX Configuration File

When you open the FactoryTX tool for the first time, the skeleton of the configuration will be available. You will need to fill in the missing parameters for the new data receiver.

To create a new data receiver in the FTX configuration file:

  1. In a Web browser, navigate to the IP address of the NUC device or Virtual Machine. This information is available in the Resin.io interface. You want to connect to port 8090. For example: http://IP_ADDRESS:8090
  2. On the Configuration tab, view the current configuration.
  3. For each data source you will need to add a new element to the data_receiver list in the JSON configuration.
    For more details on parameters, see Configuring a Data Receiver.

Running the New Data Receiver and Looking at the Output

After you have a data receiver connected, you need to test the connection and look at the output. To do this, click the Play button on the left side of the interface.

Creating a New Transmit

You must set up the transmit information for the particular customer so the data flows to Sight Machine properly. For more information, see the Data Transmit section in Configurations in FactoryTX.

To create a new transmit:

  1. In FTX, on the Configuration tab, in the Source Code window, open the data_transmit section.
    HINT:You can expand any condensed code section by clicking the arrow to the left of it.

    Collapsed:
    Expanded:
  1. In the “base_url” field, type your Sight Machine URL.
  2. Paste the FactoryTX Username into API_key_ID parameter, and the FactoryTX API Key into the API_key parameter. If you need an API Key, open the Sight Machine platform, go to the AI Data Pipeline, and then on the Edge tab, click API Keys. For more details, see the Managing Edge Devices section in Contextualizing Data Using the AI Data Pipeline.

    The following is sample code that you can copy and paste:

<span class="c16">"data_transmit" = [</span>
      {
          "API_key_ID": "factory_<your API key ID>@sightmachine_ftx.com",
          "max_request_records": "3000",
          "poll_interval": "30",
          "base_url": "https://<your URL>.sightmachine.io",
          "timeout": "120",
          "max_request_size_bytes": "6000000",
          "API_key": "<your API key>",
          "transmit_name": "remotedatapost"
      }
]