OpenPLC is an open-source Programmable Logic Controller that is based on easy to use software. Our focus is to provide a low cost industrial solution for automation and research. OpenPLC has been used in many research papers as a framework for industrial cyber security research, given that it is the only controller to provide the entire source code. The OpenPLC Project consists of three sub-projects:
Follow the steps below to install OpenPLC runtime by ensuring your system satisfies the prerequisites then following the setup steps.
If you system is Debian-based Linux, then the OpenPLC install script will automatically satisfy dependencies. Otherwise, see below for requirements.
| System | Prerequisites |
|---|---|
| Linux (Debian based, including Ubuntu) | None required |
| Raspberry PI | None required |
| Linux (other) | See background_installer.sh |
| Docker | Just the docker client |
| Windows | Git, Python 2.7, Cygwin with gcc, autoconf, automake, bison, cmake, flex, gcc-c++ |
To setup OpenPLC, clone the repository, then run the install.sh script. If you are
running Docker, then see Docker-specific steps below.
git clone https://github.com/thiagoralves/OpenPLC_v3.git
cd OpenPLC_v3
./install.sh [platform]where [platform] is one of:
linux - Install OpenPLC on a Debian-based Linux distribution
docker - Used by the Dockerfile (i.e. doesn't invoke sudo)
rpi - Install OpenPLC on a Raspberry Pi
win - Install OpenPLC on Windows over Cygwin
custom - Skip all specific package installation and tries to install OpenPLC assuming your system already has all dependencies met. This option can be useful if you're trying to install OpenPLC on an unsupported Linux platform or had manually installed all the dependency packages before.
Make sure docker is installed
# instead of running install.sh as stated above, run:
docker build -t openplc:v3 .Devices can be passed to the docker daemon using the -v flag (e.g. -v /dev/ttyACM0:/dev/ttyACM0)
docker run -it --rm --cap-add=SYS_NICE --cap-add=IPC_LOCK -p 8080:8080 openplc:v3The normal approach for running OpenPLC is though the web interface. However, it is possible to run OpenPLC without the web interface using configuration information supplied in a configuration file.
See the file config.example.ini in this repository for information about
how to run standalone.