For interacting with the server from your python code directly, you can use the following functions.
Python client¶
The following functions provide modes of interaction with a running server.
- class client.Client(host, port)¶
Client for gRPC functionality
- getStatusEvo()¶
Start a script prepared with PrepareScript. :param scriptID: scriptID of script :return:
- initialize()¶
Initialize device drivers and the attached hardware.
This function must be executed prior to starting any process or script. If this function is not called before starting a script or a process a message box from EVOware pops up to request permission to initialize the system.
- return:
- logoff()¶
Log off user
Closes the connection between the API and EVOware.exe. Logon parameters like UserName, Password etc. are not changed. This also closes the message box about the locked EVOware and enables EVOware GUI .
- return:
- logonEvo(user, pw, plus, simulation)¶
Log on user
If EVOware is not already started, Logon starts EVOware.exe. A call of Logon should match with a call to Logoff to close all connections between the API and EVOware. If EVOware is already running the User is changed if a valid UserName and Password are passed. The parameters Plus and Simulation are ignored in this case. At Logon the EVOware GUI is locked and a message box is shown. It is not possible to call any API method without a valid logon. The status flag STATUS_LOADING is set to TRUE until EVOware is really started and following commands can be executed.
- param user:
Username for Evoware
- param pw:
Password for Evoware
- param plus:
Plus version
- param simulation:
If simulation is true
- return:
- prepScript(folder, script)¶
Loads and prepares a script file for execution. :param folder: directory to script :param script: script which is supposed to be executed :return:
- setDoorLock(mode=True)¶
Open/close door locks. Remote Mode must be enabled. :param mode: :return:
- setRemote()¶
- Set API mode on/off.
When set to true API mode is enabled.
When API mode is enabled the API programmer takes over responsibility for door lock and status lamp control. When API mode is not enabled it is the systems responsibility to control door locks and status lamp.
- param remote:
- return:
- shutdown()¶
Shutdown device drivers.
- Shutdown EVOware. The call to shutdown is blocking. It returns if EVOware is really closed.
- return:
- startScript(scriptID)¶
Start a script prepared with PrepareScript. :param scriptID: scriptID of script :return: