Differences

This shows you the differences between two versions of the page.

--- runningthegeneratedequipmentsimulator [2021/08/28 14:26]
wikiadmin
+++ runningthegeneratedequipmentsimulator [2021/09/02 12:38] (current)
wikiadmin
@@ Line 36: / Line 36: @@
 ==== Using a JSON Configuration for the Simulator =====
-The TransSECS Host software can go online with a process tool and "characterize" it - obtain existing vids, ceids, and rptids, as well as alids. This "characterization" is encapsulated in a JSON file, with the name ToolName.json, where ToolName is the name of the host project. After characterization this file will be in the userfiles of the project.
+The TransSECS Host software can go online with a process tool and "characterize" it - obtain existing VIDs, CEIDs, and RPTIDs. This "characterization" is encapsulated in a JSON file, with the name ToolName.json, where ToolName is the name of the host project. After characterization this file will be in the userfiles of the project.
 For example when you build the GEMHost project from the TransSECS distribution, you will see a file
@@ Line 44: / Line 44: @@
 In the project folder (or in the userfiles folder for MIStudio).
-<note>You must replace the backslashes (\) with forward slashes (/) in the path name before using this in the .conf file.  In the example above, this would then be
+Any file generated by TransSECS GEM Host will work. This file describes the tool and so can be used as a basis to reproduce the behavior of the tool.
-C:/Users/Public/ErgoTech/TransSECSDevices/Projects/GEMHost/GEMHostModel.json </note>
-This JSON file can be loaded into a bare simulator
+This JSON file can be loaded into a bare simulator.  You can use the GEMTool example for this, or download the SimulatorTool from [[https://ergotech.com/files/examples/SimlatorTool.zip|here]] (this is just the GEMTool example with CEIDs and the simulation specific VIDs removed).
 Edit the ToolSimulator.conf file in the MIStudioSuite\TransSECS\resources\ToolSimulator folder
@@ Line 55: / Line 52: @@
 {{:pasted:20210828-142204.png}}
-You will need to change the section.  You can replace the whole section with this code, or download this file and replace the existing file.
+You will need to change the section in the .conf file that adds the parameters to point to your file.  You can replace the whole section with this code, or download [[https://ergotech.com/files/examples/ToolSimulator.conf|this configuration file]] and replace the existing file.
 <code>
@@ Line 85: / Line 82: @@
 </code>
+Add the path to your JSON file:
+<note>You must replace the backslashes (\) with forward slashes (/) in the path name before using this in the .conf file.  In the example above, this would then be
+C:/Users/Public/ErgoTech/TransSECSDevices/Projects/GEMHost/GEMHostModel.json
+</note>
+<code>
+wrapper.app.parameter.5=C:/Users/Public/ErgoTech/TransSECSDevices/Projects/GEMHost/GEMHostModel.json
+</code>
+Change the //Device ID// and //Port// in the file to match the values in your host.  You can see what you've set in your host by clicking on the root of the tree.
+{{:pasted:20210828-145027.png?0x100}}
+Modify and uncomment the appropriate lines in the .conf file:
+<code>
+wrapper.app.parameter.6=-p
+wrapper.app.parameter.7=5010
+wrapper.app.parameter.8=-deviceid
+wrapper.app.parameter.9=1
+</code>
+Be sure that the numbering is consecutive.  That is, if you've made other changes, the numbers following the //wrapper.app.parameter.// must start a zero and increment without any missing numbers.  Lines that start with a # don't count.
+After making these changes, double-click the ToolSimulator executable:
+{{:pasted:20210828-144232.png}}
+The simulator should start and you should see your variables and events in the "VID" and "Send Event" dropdown.
+{{:pasted:20210828-144312.png}}
+Change your "Tool IP Addr" to be //localhost// (or the IP Address of the system on which you are running the simulator).
+{{:pasted:20210828-145027.png}}
+Build your host application, click the SIM/LIVE button and click on a message.  You'll see it connect to the simulator:
+{{:pasted:20210828-150432.png}}
+Choose an event and press the "Send Event" button.  If you have reports attached to the event, choose a VID, change the value, send the event again and you'll see the updated value.
+To improve the simulator you will probably need to add some of the tool's host commands and other special messages such as those for recipe handling.  Simply open the SimulatorTool project,add the messages and rebuild.
-and used as a basis to reproduce the behavior of the tool. To improve the simulator you will probably need to add some of the tool's host commands and other special messages such as those for recipe handling.
+GEM requires that certain variables be available from the tool.  The SimulatorTool (or the GEMTool) provide this set of variables.  If these variable names are not in your JSON file you should leave them in the tool simulator, otherwise, they can be removed (It does no harm to leave them in the simulator - the variables from the JSON file will be used if available).
 To use a pre-defined ToolName.json for the simulator, prepare a TransSECS tool project with any number of messages (such as host commands and/or recipe messages), and include only two VIDs (OnlineOfflineState and LocalRemoteState) if not already defined by these names in the JSON file. These two parameters are needed for the base simulator software to be able to enable online/remote.
@@ Line 92: / Line 134: @@
-To use the JSON file for the simulator, copy this file into the generated simulator directory and edit the Simulator.config file as described in the section above to expose the .8 and .9 properties (-j and the name of the JSON file). Be sure that the numbering is consecutive.
+To use the JSON file for the simulator, copy this file into the generated simulator directory and edit the Simulator.config file as described in the section above to expose the .8 and .9 properties (-j and the name of the JSON file).