Skip to main content
. 2020 Nov 2;6:e302. doi: 10.7717/peerj-cs.302

Table 2. “ParameterList” description.

Name of method Description of method
start_logging(sampling_rate) By executing this method the system starts logging IMM’s process parameters with specified by a user sampling rate. “sampling_rate” parameter is the user-desired sampling rate in Hz. The logging sequence is stopped by launching the idle() method.
get_process_param(names) This method returns actual and set values of chosen process parameter or list of parameters. Parameter name(s) is/are given as “names” argument of the method. This method is independent of the control loop.
get_async_act_sample(params) Returns unsynchronized current value(s) of process parameter(s). Name of one or more parameters are given as “params” argument of the method. Method is independent of the control loop.
set_process_param(name,value) This method sets a desired value of a specified process parameter on the IMM. Arguments “name” and “value” mean respectively process parameter’s name and desired value of that parameter.
get_samples(number_of_shots) Method returns data sampled during certain number of production cycles (shots) buffered in a FIFO queue. “number_of_shots” parameter defines how many shots/cycles in the past user is interested in.
event() Set API’s state to an event, can be launched externally with method event_sample().
event_sample() Trigger an event based sampling. The state has to be an event.
idle() Set interface’s state to idle, a passive state where the connection is maintained.
disconnect() Connection is ended and the API is shut down.