Tutorials

1. Open a command prompt.
2. Navigate to the simulator in <FairCom Folder>/server/modbus/test/<OS folder>/diagslave.<#.##>/<OS version folder>/.
3. Run the following command at the command prompt to start the Modbus simulator that will answer Modbus requests.
   1. diagslave -m tcp -p 502
4. Connect to the "diagslave" and set the defined Modbus data item.
   1. Open another command prompt.
   2. Navigate to <FairCom Folder>/server/modbus/test/<OS folder>/modpoll-<#.##>/<OS version folder>/.
   3. Run modpoll to create data.
      1. You can run it multiple times with different parameters to change the Modbus data.
      2. modpoll -m tcp -p 502 -a 5 -r 1200 -c 1 localhost 65
      3. modpoll -m tcp -p 502 -a 5 -r 1200 -t 0 -c 1 localhost 1
      4. modpoll -m tcp -p 502 -a 5 -r 1300 -c 2 localhost 0x47F1 0x2000
   4. The Modbus simulator will answer the Modbus TCP requests with the following data items:
      1. "temperature"
         1. Temperature is a register containing an integer number.
      2. "volume"
         1. Volume is a register containing a floating point number.
      3. "status"
         1. Status is a coil containing a Boolean.

1. Start the FairCom browser-based tools.
   1. The tools icons appear.
2. Select and log into Data Explorer.
   1. The Data Explorer interface window appears.
3. Click the API Explorer tab.
   1. The API Explorer interface opens and the Server navigation window shows that you are connected to the FairCom database and the FairCom server. Use the FairCom database or another database you create to store the "customer tables".

1. Select Hub API from the Select API dropdown menu.
2. Select createInput from the JSON Actions dropdown menu.
3. Replace the JSON in the API Request editor with the following JSON:

   1. {
        "api": "hub",
        "action": "createInput",
        "params": {
          "inputName": "modbusTCP",
          "serviceName": "modbus",
          "settings": {
            "modbusProtocol": "TCP",
            "modbusServer": "127.0.0.1",
            "modbusServerPort": 502,
            "modbusDataCollectionIntervalMilliseconds": 15000,
            "propertyMapList": [
              {
                "propertyPath": "temperature",
                "modbusDataAddress": 1199,
                "modbusDataAccess": "inputRegister",
                "modbusUnitId": 5,
                "modbusDataLen": 1
              },
              {
                "propertyPath": "volume",
                "modbusDataAddress": 1299,
                "modbusDataAccess": "inputRegister",
                "modbusUnitId": 5,
                "modbusDataLen": 2
              },
              {
                "propertyPath": "status",
                "modbusDataAddress": 1199,
                "modbusDataAccess": "coil",
                "modbusUnitId": 5,
                "modbusDataLen": 1
              }
            ]
          },
          "schemaName": "admin",
          "tableName": "modbusTableTCP",
          "databaseName": "faircom",
          "retentionPolicy": "autoPurge",
          "retentionPeriod": 30,
          "retentionUnit": "day",
          "metadata": {
          }
        },
        "authToken": "replaceWithAuthTokenFromCreateSession"
      }

4. Click Apply defaults to JSON request to replace the "authToken" value with the valid one from your session.
5. Click Send request to issue the JSON-based request.
6. Observe the response and ensure the action is completed successfully.

1. Start the FairCom Data Explorer.
2. Navigate to and select modbustabletcp in the Server navigation window through faircom>admin>Tables.
3. Click the Table Records tab.
   1. The table records are displayed as one record per row.
4. Select a record and click the source_payload field.
5. Observe the JSON contents of the field. Click the "edit" icon of the source_payload field to see the content formatted as JSON.

Note If the table has no records, look at <faircom>/data/CTSTATUS.FCS to see errors related to the connector.

1. Select Hub API from the Select API dropdown menu.
2. Select "createTransform" from the JSON Actions dropdown menu.
3. Replace the JSON in the API Request editor with the following JSON:

   1. {
        "api":"hub",
        "action":"createTransform",
        "params":
        {
          "transformName":"transform_modbus1",
          "transformActions":[
            {
              "inputFields":["source_payload"],
              "transformStepMethod":"jsonToDifferentTableFields",
              "outputFields":[
                "temperature",
                "volume",
                "status"
              ],
              "transformParams":
              {
                "targetTableName":"modbus1",
                "mapOfPropertiesToFields":[
                  {
                    "propertyPath":"temperature",
                    "name":"temperature",
                    "type":"integer"
                  },
                  {
                    "propertyPath":"volume",
                    "name":"volume",
                    "type":"float"
                  },
                  {
                    "propertyPath": "status",
                    "name": "status",
                    "type": "bit"
                  }
                ]
              }
            }
          ]
        },
        "authToken": "replaceWithAuthTokenFromCreateSession"
      }

4. Click Send request.
5. Observe the response and ensure the action is completed successfully.

1. Select Hub API from the Select API dropdown menu.
2. Select alterInput from the JSON Actions dropdown menu.
3. Replace the JSON in the API Request editor with the following JSON:

   1. {
         "api": "hub",
         "action": "alterInput",
         "params": {
             "inputName": "modbusTCP",
             "transformName": "transform_modbus1"
         },
         "authToken": "replaceWithAuthTokenFromCreateSession"
      }

4. Click Send request.
5. Observe the response and ensure the action is completed successfully.

1. Select MQ API from the Select API dropdown menu.
2. Select configureTopic from the JSON Actions dropdown menu.
3. Replace the JSON in the API Request editor with the following JSON:

   1. {
        "api": "mq",
        "action": "configureTopic",
        "params":
        {
          "topic": "modbusForward",
          "databaseName": "faircom",
          "tableName": "modbusTableTCP"
        },
        "authToken": "replaceWithAuthTokenFromCreateSession"
      }

4. Click Send request.
5. Observe the response and ensure the action is completed successfully.

1. Start the FairCom Browser-Based tools.
2. Select and connect to MQ Explorer.
3. Select MQTT Management from the Control menu.
4. Click Subscribe to open the Manage Subscriptions window.
5. Select the topic you subscribed to from the Topic dropdown menu.
6. Click + Subscribe.
7. Close the Manage Subscriptions window.
8. Observe your message, displayed under Incoming Messages every 10 seconds.
9. Click Subscribe.
10. Delete your subscription from the list.

1. Select DB API from the Select API dropdown menu.
2. Select the getRecordsByIndex from the JSON Actions dropdown menu.
3. Replace the JSON in the API Request editor with the following JSON:

   1. {
        "api": "db",
        "action": "getRecordsByIndex",
        "params": {
          "databaseName": "faircom",
          "tableName": "modbus1",
          "indexName": "ts_index"
        },
        "authToken": "replaceWithAuthTokenFromCreateSession"
      }

4. Click Send request.
5. Observe the API Response response and ensure the action is completed successfully.