Differences

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

--- rest_client [2021/09/29 13:28]
wikiadmin created
+++ rest_client [2021/09/29 14:32] (current)
wikiadmin
@@ Line 6: / Line 6: @@
 then browse to the file.  TransSECS will install the module.  You then need to restart the TransSECS application.
+You need to be running the "TransSECSDevices" executable, not the main "TransSECS" application.
+{{:pasted:20210929-140552.png}}
 ===== Adding REST servers =====
@@ Line 38: / Line 42: @@
 ===== Populate the Recipe from a REST Services =====
- When the "LotLoaded" report is received, we call a REST endpoint to get the correct recipe for the tool. This recipe is then set to the PP-SELECT remote command and that message is sent to the tool.
+When the "LotLoaded" report is received, we call a REST endpoint to get the correct recipe for the tool. This recipe is then set to the PP-SELECT remote command and that message is sent to the tool.
 The format of the URL we are calling is:
@@ Line 53: / Line 57: @@
 Change this to match your service URL.  In this case, the return is a JSON map.  The script then parses the returned JSON and uses the recipe to populate the PP-SELECT remote host command.
+The REST call is on this line:
+<code>
+    resultJSON = /Devices/UtilityServers_Servers/GetRecipe->callRestServer("http://localhost:7000/Recipe/"+toolName+"/" + lotId, "GET", null);
+</code>
+GetRecipe is the name of the REST server defined in the Devices/UtilityServers node:
+{{:pasted:20210929-133044.png}}
+<code>callRestServer</code> takes three arguments.  The URL, the method ("GET", "PUT", etc.) and the data for the message.  For "PUT", "POST" and similar methods, the data is placed in the body of the message.  For "GET" methods (here) the data is ignored and can be null.
 <code>
@@ Line 104: / Line 121: @@
 }
 </code>
+===== Saving Data to a REST Services =====
+When the "LotCompleted" report is received, we call a REST endpoint to save data.  In this case, just the "wafercount" but any JSON (or any other string expected by the REST endpoint) can be sent.
+Similar to the recipe request, the, REST call is on this line:
+<code>
+    /Devices/UtilityServers_Servers/StoreData->callRestServer(url, "PUT", jsonString);
+</code>
+StoreData is the name of the REST server defined in the Devices/UtilityServers node:
+{{:pasted:20210929-133044.png}}
+The first and second arguments to <code>callRestServer</code> are the url and the method, as with the "GET" request.   The third argument is now the JSON string, the data that is placed in the body of the message.
+<code>
+// whenever this report is received, get the lotid, use the REST Service to read the recipe and then set it to the PP-SELECT S2F41 message and send it to the tool
+var TransSecsController = Java.type("com.ergotech.transsecs.secs.TransSecsController");
+toolName = "GEMHost";
+print ("Lot Completed Event");
+try{
+	host=TransSecsController.findController(toolName);
+	waferCount = incomingValue.getProperty("MAP").get("WaferCount");  // the name must match exactly.  It is case sensitive
+    // demo URL http://hostname/StoreData/{toolname}
+    // the body is a JSON-encoded string
+    jsonString =  '{"WaferCount":' + waferCount.getIntValue() +'}'; // any required values...
+    url = "http://localhost:7000/StoreData/"+toolName;
+    print ("Storing data \"" + jsonString + "\" to url \"" + url + "\"");
+    /Devices/UtilityServers_Servers/StoreData->callRestServer(url, "PUT", jsonString);
+} catch (e) {
+    print("Error in Lot Completed Script: \n"+e.stack);
+    print(e);
+}
+</code>
+===== Testing =====
+You can test the sample REST project with the StandAloneGEMTool application that is part of TransSECS, or with the TransSECS [[runningthegeneratedequipmentsimulator|Equipment Simulator]] created from your host project.
+For testing, you can use the [[https://github.com/jacopofar/demo-REST-server|Demo REST Server]] from Jacopo Farina on GitHub.  Full documentation on how to run the demo is on the GitHub page.  Possibly the simplest option is just to run the Docker image:
+<code>
+docker run -p 7000:7000 --name restdemo  jacopofar/demo-rest-server
+</code>
+Using the "curl" application you can then add recipes.  Here we add a recipe, "recipe1", for the lot id "Lot123":
+<code>
+curl -X PUT -H "Content-Type: application/json" -d '{"Recipe":"recipe1"}' "http://localhost:7000/Recipe/GEMHost/Lot123"
+</code>
+With the StandAloneGEMTool you can make the connection from your TransSECS host as normal.  Build with the "hammer-and-star"{{:pasted:20210929-134003.png}} button then press the SIM/LIVE {{:pasted:20210929-134032.png}} to go LIVE. If you don't see the host connect to the tool, check your configuration and correct any mismatch and rebuild.
+{{:pasted:20210929-134337.png}}
+Once you're connected set the Lot ID field to "Lot123" to match the value in the REST server, then select the "LOADED" event and press the "Send Selected Event" message.
+{{:pasted:20210929-133901.png?400}}
+Select the "LOADED" event and press the "Send Selected Event" message.
+{{:pasted:20210929-135449.png?400}}
+You will see the event sent to the host, with the recipe "Lot123" and the PP-SELECT command sent from the host with the recipe and the lot id.
+Choose the "COMPLETED" event and send that event.  You should see the event, and if you check the value in the REST server it should have the value of "1"
+<code>
+curl -X GET -w "\n" -H "Content-Type: application/json" "http://localhost:7000/StoreData/GEMHost"
+</code>
+(If you want to change the value in the REST server to be sure that it's actually chaning on the COMPLETED event, this command will set it to 22:
+<code>
+curl -X PUT -H "Content-Type: application/json" -d '{"WaferCount":22}' http://localhost:7000/StoreData/GEMHost
+</code>
+)