-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
54090d0
commit a8cd7a4
Showing
1 changed file
with
12 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,13 @@ | ||
| ## Table of Contents | ||
| * [Introduction](#Introduction) | ||
| * [Requirements](#Requirements) | ||
| * [Installation](#Installation) | ||
| * [Samples](#Samples) | ||
| * [Revision History](#Revision-History) | ||
|
|
||
| <a name="Introduction"></a> | ||
| ## Introduction | ||
| This is a sample project to execute a shell command on a remote PC. The remote command is executed with a Python script that connects via OPC UA to the B&R PLC. The PLC only needs the variable structure to execute a command and some code to indicate the connection status. The sample uses a mappView visualization for demo purpose but mappView is not required to run the sample. The variable structure mappRemoteShell has the following members: | ||
|
|
||
| * execute Starts the remote command. The Python script resets this variable when the command is finished. | ||
| * command The shell command string that is excecuted on the remote PC | ||
| * alive_counter This counter is used to detect the connection state | ||
| * connected Indicates that the remote PC is connected and ready to receive a command | ||
| * status The status of the command | ||
|
|
||
| The following status codes show the state of the command<br/> | ||
| * 65535 The command is still busy<br/> | ||
| * 10000 Generic command error<br/> | ||
| * 10001 The command was not found<br/> | ||
| * 10002 The response data is larger than the response string on the PLC<br/> | ||
| * 0 The command was successful | ||
| <br/><br/> | ||
|
|
||
| <table><tr><td><img src='Docs/screenshot_python.png' width=400><p align="center">Python Script</p></td><td><img src='Docs/screenshot_plc.png' width=400><p align="center">PLC UI</p></td></tr></table> | ||
|
|
||
| The Python script can run on any system that supports the Python framework. The logger gives a detailed feedback about the connection status and executed command. The option for balloon messages will show a notification every time a command is executed. Auto reconnect will automatically connect when the script is started or when the connection was interrupted. Start minimized will put the application into the system tray on startup. If the command produces response data the script will transfer this data back to PLC. If the command generates an error the error message will be sent back as response to the PLC. | ||
|
|
||
| <a name="Requirements"></a> | ||
| ## Requirements | ||
| * Automation Studio 4.7 | ||
| * Automation Runtime C4.72 | ||
| * Python 3.8 or higher | ||
|
|
||
| Recommended task class is #8 with a 10ms cycle time. | ||
|
|
||
| <a name="Installation"></a> | ||
| ## Installation | ||
|
|
||
| ### PC | ||
|
|
||
| Download and install Python from https://www.python.org/ | ||
|
|
||
| Start the installation, set checkboxes, customize installation, restart the system to make sure that the path information are in affect. | ||
|
|
||
| <table><tr><td><img src='Docs/python_install1.png'></td><td><img src='Docs/python_install2.png'></td><td><img src='Docs/python_install3.png'></td></tr></table> | ||
|
|
||
| Open a command window and execute the following commands to install the required packages | ||
|
|
||
| * pip3 install PyQt5 | ||
| * pip3 install asyncua | ||
| * pip3 install timeloop | ||
| * pip3 install ConfigParser | ||
|
|
||
| Copy the folder \Logical\mappRemoteShell\PythonScript to the target PC. Change the config.ini file as needed. | ||
|
|
||
| Run the file start.pyw from the PythonScript folder | ||
|
|
||
| ### B&R PLC | ||
| * Copy the package mappRemoteShell into new project | ||
| * Activate OPC UA server in the PLC configuration | ||
| * Enable the variable structure "mappRemoteShell" in the OPC UA configuration including all the sub elements | ||
|
|
||
| <a name="Samples"></a> | ||
| ## Samples | ||
| Here are few examples that can be used as a command string. | ||
|
|
||
| * Start Windows file explorer ``` explorer.exe ``` | ||
| * Start Automation Studio ``` C:\BrAutomation\AS47\Bin-en\AutomationStudio.exe ``` | ||
| * Start Power Shell script with parameter ``` powershell C:\Temp\GoogleRoute.ps1 ``` | ||
|
|
||
| <a name="Revision-History"></a> | ||
| ## Revision History | ||
|
|
||
| #### Version 0.4 | ||
| * Python Script: Added task and variable name to config.ini | ||
| * Python Script: Added ip and port to config.ini | ||
| * Python Script: Switched to new asyncua library | ||
| * Automation Studio: Update sample to mapp 5.15 | ||
|
|
||
| #### Version 0.3 | ||
| * Support for command response to PLC | ||
| * Detailed error text when command fails to PLC | ||
| * Python window is now resizable | ||
| * Bug fixes and code cleanup | ||
|
|
||
| #### Version 0.1 | ||
| * First release | ||
| This is a sample project to execute a shell command on a remote PC. The remote command is executed with a Python script that connects via OPC UA to the B&R PLC. The PLC only needs the variable structure to execute a command and some code to indicate the connection status. The sample uses a mappView visualization for demo purpose but mappView is not required to run the sample. [**For a detailed description follow this link.**](https://br-automation-com.github.io/mappRemoteShell/index.html) | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td> | ||
| <img src='https://br-automation-com.github.io/mappRemoteShell/images/screenshot_python.png' width=400><p align="center">Python Script</p> | ||
| </td> | ||
| <td> | ||
| <img src='https://br-automation-com.github.io/mappRemoteShell/images/screenshot_plc.png' width=400><p align="center">PLC UI</p> | ||
| </td> | ||
| </tr> | ||
| </table> |