This is an old revision of the document!

This GEM C++ example uses the code generated from TransSECS using the Native/C++ deployment option.

In the tool you update the variables with simple set/get methods take the name of the variable and the value. In the host, you subscribe to receive data. Complex types are passed as JSON.

Message notifications are received as JSON maps so that each of the published elements in the message are available directly.

Download the sample from: https://www.ergotech.com/docs/cppwrapper.tar.gz Extract the cppwrapper folder and change to that folder. On Linux:

mkdir build
cmake ..
make 

Copy the GEMToolRuntime.jar from the TransSECS GEMTool project into the build folder. Then run:

./transecswrapper_example
 
 
Started tool GEMTool on port 5010 device id 1
Publish Item id: "gemtool/vids/ppid"
Subscribe Item id: "gemtool/vids/ppid"
Publish Item id: "gemtool/vids/s5f1replybit"
Subscribe Item id: "gemtool/vids/s5f1replybit"
Subscribe Item id: "gemtool/configuration/port"
Subscribe Item id: "gemtool/configuration/deviceid"
Subscribe Item id: "gemtool/configuration/passivet1"
Subscribe Item id: "gemtool/configuration/passivet2"
Subscribe Item id: "gemtool/configuration/passivet3"
Subscribe Item id: "gemtool/configuration/passivet4"
Subscribe Item id: "gemtool/configuration/passivet5"
Subscribe Item id: "gemtool/configuration/passivet6"
Subscribe Item id: "gemtool/configuration/passivet7"
[...]
Subscribe Item id: "gemtool/vids/processtemperature"
Control state changed 3
Getting: gemtool/vids/controlstate
Control State 3
Getting: gemtool/vids/controlstate
Control State 3
New ppid InitialPPID

The tool is then running and ready for connections. You can use the TransSECS GEMHost sample project to test the tool.

For the host,copy the GEMHostRuntime.jar from the TransSECS GEMHost project into the build folder

The samples, even though simple, demonstrates all the features required of a tool and the ability to collect data from a host.

In the host code, publish variables you need to change in the interface, here the port, hostname, deviceid, etc. and subscribe to elements to receive data updates. Here an event (loaded) and to values (ppid and wafer count). The event is received as a JSON structure.

For example

    wrapper.publish_string("gemhost/configuration/equipmenthostname", "localhost").unwrap();

And Events (CEIDs) received as JSON Strings that contains the values configured in TransSECS. For example, a subscription to the “loaded” event might deliver a JSON string similar to this:

 { "LOADED": [  { "RPTID103": [ {"LOTID":"", "type":20 },{"PPID":"recipename", "type":20 },{"WaferCount":"1", "type":54 } ], "rptid":103} ], "ceid":7503, "timestamp":"2021-08-10 19:58:28.802"}

The sample code receives and unpacks that structure:

    wrapper.subscribe("gemhost/variables/ceid/loaded", |topic,value| {
        println!("Callback called on {}:", topic);
        if let Value::String(string_value) = value.value {
            // The ceid appears as a json object, which we can parse for example with serde_json
            let parsed:LoadedCeid = serde_json::from_str(&string_value).unwrap();
            // We'll just immediately reserialize the json to demonstrate that we have the fields
            println!("{}", serde_json::to_string_pretty(&parsed).unwrap());
        }
    }).unwrap();

The tool can subscribe to be notified of the change in value of any VID - used for ECIDs and GEM internal variables:

    wrapper.subscribe("gemhost/variables/vid/lotid", |topic,value| {
        println!("Callback called on {} with {:?}", topic, value)
    }).unwrap();

Here's the code sample from the rustwrapper archive:

//! Simple GEM host example showing how to start a host and subscribe to some variables
 
use transsecs::transsecs_wrapper::TransSecsWrapper;
use transsecs::value_object::{Value};
use std::{thread, time};
 
use serde::{Serialize, Deserialize};
 
#[derive(Serialize, Deserialize, Debug)]
struct LoadedCeid {
    #[serde(rename="LOADED")]
    reports:Vec<Report>
}
 
 
#[derive(Serialize, Deserialize, Debug)]
struct Report {
    #[serde(rename="RPTID103")]
    values:Vec<ReportValue>
}
 
#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
enum ReportValue {
    LotID{
        #[serde(rename="LOTID")]
        lot_id:String, 
        #[serde(rename="type")]
        type_int:i32
    },
    PPID{
        #[serde(rename="PPID")]
        ppid:String, 
        #[serde(rename="type")]
        type_int:i32
    },
    WaferCount{
        #[serde(rename="WaferCount")]
        wafer_count:String, 
        #[serde(rename="type")]
        type_int:i32}
}
 
// examples/gem_host_example.rs
fn main() {
    let wrapper = TransSecsWrapper::new("./GEMHostRuntime.jar").unwrap();
 
    let port = 5010;
    wrapper.publish_string("gemhost/configuration/persistencefilename", "/tmp/testpersistence").unwrap();
    wrapper.publish_string("gemhost/configuration/equipmenthostname", "localhost").unwrap();
    wrapper.publish_int("gemhost/configuration/deviceid", 1).unwrap();
    wrapper.publish_int("gemhost/configuration/activeport", port).unwrap();
 
    wrapper.start_main("GEMHost").unwrap();
 
    wrapper.subscribe("gemhost/variables/ceid/loaded", |topic,value| {
        println!("Callback called on {}:", topic);
        if let Value::String(string_value) = value.value {
            // The ceid appears as a json object, which we can parse for example with serde_json
            let parsed:LoadedCeid = serde_json::from_str(&string_value).unwrap();
            // We'll just immediately reserialize the json to demonstrate that we have the fields
            println!("{}", serde_json::to_string_pretty(&parsed).unwrap());
        }
    }).unwrap();
 
    wrapper.subscribe("gemhost/variables/vid/ppid", |topic,value| {
        println!("Callback called on {} with {:?}", topic, value)
    }).unwrap();
 
    wrapper.subscribe("gemhost/variables/vid/lotid", |topic,value| {
        println!("Callback called on {} with {:?}", topic, value)
    }).unwrap();
 
    loop{
        thread::sleep(time::Duration::from_secs(10));
    } // If we drop the wrapper, it will cleanup the jvm
}