mirror of
https://github.com/thiagoralves/OpenPLC_v3.git
synced 2025-12-08 19:45:18 +08:00
51 lines
2.4 KiB
Markdown
51 lines
2.4 KiB
Markdown
# OpenPLC Runtime version 3
|
|
|
|
[](https://travis-ci.org/thiagoralves/OpenPLC_v3)
|
|
[](https://ci.appveyor.com/project/shrmrf/openplc-v3)
|
|
|
|
OpenPLC is an open-source [Programmable Logic Controller](https://en.wikipedia.org/wiki/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](https://scholar.google.com/scholar?as_ylo=2014&q=openplc&hl=en&as_sdt=0,1) 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 two sub-projects:
|
|
1. [Runtime](https://github.com/thiagoralves/OpenPLC_v3)
|
|
2. [Programming editor](https://openplcproject.com/docs/installing-openplc-editor/)
|
|
|
|
|
|
## Installation:
|
|
```bash
|
|
git clone https://github.com/thiagoralves/OpenPLC_v3.git
|
|
cd OpenPLC_v3
|
|
./install.sh [platform]
|
|
```
|
|
|
|
Where `[platform]` can be:
|
|
|
|
`win` - Install OpenPLC on Windows over Cygwin
|
|
|
|
`linux` - Install OpenPLC on a supported Linux distribution, currently Debian-based, Fedora-based, Opensuse and Alpine Linux is supported.
|
|
|
|
`docker` - Used by the `Dockerfile` (i.e. doesn't invoke `sudo`)
|
|
|
|
`rpi` - Install OpenPLC on a Raspberry Pi
|
|
|
|
`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 unsuported Linux platform or had manually installed all the dependency packages before.
|
|
|
|
### Building, Installing and Running inside Docker
|
|
When using Ubuntu: make sure [`docker for Ubuntu` is installed](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
|
|
|
|
When using Linux Mint 21: make sure [`docker for Linux Mint 21` is installed](https://computingforgeeks.com/install-docker-docker-compose-on-linux-mint/)
|
|
|
|
#### Build
|
|
```
|
|
# instead of running install.sh as stated above, run:
|
|
docker build -t openplc:v3 .
|
|
```
|
|
|
|
#### RUN
|
|
_Devices can be passed to the `docker` daemon using the `-v` flag (e.g. `-v /dev/ttyACM0:/dev/ttyACM0`)_
|
|
|
|
```bash
|
|
docker run -it --rm --privileged -p 8080:8080 openplc:v3
|
|
```
|
|
|
|
### EtherCAT capability
|
|
To build with EtherCAT capability try `./install.sh linux ethercat` for more information see `utils/ethercat_src`
|