Project home: Original repository at:

Michael Buesch 8d727cb272 core/cpu: Fix AR and ACCU getters 2 hours ago
awlsim 8d727cb272 core/cpu: Fix AR and ACCU getters 2 hours ago
awlsim_loader 3e9086995e coverage: Add check_preimported 4 days ago
awlsimhw_debug faf5590718 coverage: Add more coverage annotations 4 days ago
awlsimhw_dummy 608c2af02f cython: Add central cython support definitions 1 month ago
awlsimhw_linuxcnc faf5590718 coverage: Add more coverage annotations 4 days ago
awlsimhw_pixtend d9911c30f9 hw/pixtend: Fix floating point compare of pollInt 2 weeks ago
awlsimhw_pyprofibus faf5590718 coverage: Add more coverage annotations 4 days ago
awlsimhw_rpigpio faf5590718 coverage: Add more coverage annotations 4 days ago
debian 478930adef Bump version 4 days ago
doc 843e21c5af doc: Add coreserver source management diagram 1 week ago
examples 4940f7d6ce Refresh all project files 1 month ago
libs 289457ba5a tests: Fix PiXtend tests 4 months ago
maintenance 819b4d8676 cleantree: Do not delete releases 4 days ago
misc 868d4820de cython: Enable full tracing, if profiling is enabled 1 day ago
pilc 89e977545f pilc: Extend rpiver description 2 months ago
progs 0ea711b94d Update putty to 0.70 2 months ago
submodules 372d8e4407 Update pyprofibus 4 months ago
tests de03ae93b4 tests: Enhance RND+ and RND- tests 1 day ago
.gitignore 465f14daec doc: Do not generate PDF and PS docs 6 months ago
.gitmodules 80da6e14c3 Remove pilc-hat 6 months ago 9c2919739b Add development documentation 4 days ago
COPYING.txt 193467d27e Clarify license conditions (GPL2+) 4 years ago b3653cbbf1 cython: Add #+suffix-LL annotation 1 day ago 9c2919739b Add development documentation 4 days ago 9c2919739b Add development documentation 4 days ago 9c2919739b Add development documentation 4 days ago 9c2919739b Add development documentation 4 days ago
awlsim-client 2d76736f0d Move cython logic to separate awlsim_loader module 1 year ago
awlsim-covreport faf5590718 coverage: Add more coverage annotations 4 days ago
awlsim-gui 250f25803b Update copyright 2 years ago
awlsim-linuxcnc-hal 9303873178 Move options to cpuconf structure 1 month ago
awlsim-proupgrade a104ac167a awlsim-proupgrade: Add option to regenerate all UUIDs 2 months ago
awlsim-server 164c250f7f awlsim-server: Fix cython helper check 1 year ago 3a85aaf2d2 systemd: Restart server on failure 1 month ago
awlsim-symtab 21e6cad1f8 ASC: Strip white space in ASC files 1 year ago
awlsim-test 5e39091783 Add support for code coverage tracing 5 days ago
awlsim-win.cmd bbaa7ed08d Update windows build scripts 1 year ago
awlsimhw_pyprofibus.conf a2825f0256 hw/pyprofibus/conf: Fix py2 compatibility 2 years ago b4d718edce setup: Remove hardcoded build restriction for Cython on Win 1 week ago

Awlsim - S7 compatible Programmable Logic Controller (PLC/SPS)

Awlsim is a free Step 7 compatible Programmable Logic Controller, that supports the automation languages AWL/STL and FUP/FBD. Awlsim itself is written in Python.

The latest version of Awlsim can be downloaded at the official Awlsim site.

Awlsim - Programmable Logic Controller (PLC/SPS)

Awlsim is a free Step 7 compatible Programmable Logic Controller, that supports the automation languages AWL/STL and FUP/FBD. Awlsim itself is written in Python. The speed of execution ranges from several ten thousand AWL/STL instructions per second on slow embedded machines to a couple of million instructions per second on faster computers.

AWL/STL programs on PLCs are used for automation of industrial processes. However Awlsim is very flexible, so it can be used for other purposes beyond industrial applications, too. Awlsim aims to be compatible with the industry standard S7 software on the AWL/STL level.

Awlsim can emulate CPUs with two and four accumulator registers (S7-3xx and S7-4xx). Compatibility to S7 hardware is a task taken seriously by the Awlsim project. We want to be as close as possible to the real PLC hardware with our AWL/STL code execution. For this reason Awlsim ships an extensive selftest suite. Missing features and differences between Awlsim and Step 7 are documented in the COMPATIBILITY documentation and TODO documentation files.

Quick start tutorial

See the quick start tutorial for a simple example on how to use Awlsim in simulator mode. In simulator mode Awlsim can be run on any desktop PC. No special hardware is required.

Example project

If you don't know where to start, you can find an example project in the examples directory as EXAMPLE.awlpro. You can easily run this example in simulation mode without the need for special hardware.

Git repository

The latest development version of Awlsim can be fetched with git:

git clone
cd awlsim

After cloning the main repository the git submodules must also be fetched. The following helper script can be used:



Awlsim depends on Python 3.4 or later or alternatively Python 2.7.

PyQT 5 or alternatively PySide

These packages can be installed with pip:

pip3 install --upgrade PyQt5
pip3 install --upgrade pyside

On Windows all Awlsim dependencies can be installed by double clicking the shipped installer script: maintenance\win-install-dependencies.cmd

If building and using Awlsim with Cython acceleration is desired, Cython must also be installed:

pip3 install --upgrade Cython

Directory structure

The Awlsim Git repository and source archive awlsim-x.yz.tar.bz2 contain lots of files and directories. Here is an overview of the main files and directories and their purpose:

Main executables

User interface executables. The main user executable is awlsim-gui.

  awlsim-client             : Command line client tool.
  awlsim-gui                : Graphical user interface. This is the main user frontend.
  awlsim-linuxcnc-hal       : LinuxCNC HAL module executable.
  awlsim-proupgrade         : Command line tool to update .awlpro file formats.
  awlsim-server             : Command line server tool.
  awlsim-symtab             : Command line tool to parse symbol tables (.ASC).
  awlsim-test               : Command line tool for unit testing.

                          See tests/ for execution of unit tests.

awlsim-win.cmd : Windows wrapper for awlsim-gui.


These files and directories contain useful information about Awlsim.

  doc/                      : Main documentation.
  doc/fup/                  : Awlsim FUP language and editor documentation.
  examples/                 : Various example projects and feature demonstrations.|html     : S7 compatibility documentation.
  COPYING.txt               : Main license.|html       : How to enhance and develop Awlsim.|html       : Quick start tutorial.|html            : Main README document.|html              : TODO list.

Main modules

The main modules implement most of Awlsim's functionality.

  awlsim/                   : Main Awlsim Python-module directory. This is where the magic happens.
  awlsim/awlcompiler        : AWL compiler.
  awlsim/awloptimizer       : AWL optimizer.
  awlsim/common             : Common libraries, modules and helper functions.
  awlsim/core               : AWL interpreter core. This is where the AWL program is executed.
  awlsim/core/instructions  : Implementation of AWL instructions.
  awlsim/core/systemblocks  : Implementation of SFCs and SFBs.
  awlsim/coreclient         : Client library to connect to coreserver.
  awlsim/coreserver         : Server library to provide AWL interpreter core access via networking.
  awlsim/fupcompiler        : FUP compiler.
  awlsim/gui                : Graphical user interface implementation (Qt).
  awlsim/library            : AWL block (FC and FB) libraries.
  awlsim/library/iec        : Implementation of IEC FCs and FBs.
  awlsim_loader/            : Import wrapper for the main Awlsim Python-module.

                          This is used to automatically load Cython optimized modules.

libs/ : External libraries used for running or testing Awlsim. progs/ : External programs used in Awlsim. submodules/ : Git submodules used for running Awlsim.

                          See  man git-submodule  for general help about Git submodules.

submodules/pyprofibus/ : PROFIBUS-DP implementation. tests/ : Unit test cases. tests/ : Main interface to run unit tests. Please see --help

Hardware support modules

The hardware modules are the glue between the Awlsim core and the real world. The hardware modules are invoked before and after running the user cycle (OB 1).

  awlsimhw_debug/           : Hardware module for unit tests. Do not use in production.
  awlsimhw_dummy/           : Dummy no-operation hardware module for testing, debugging or simulation.
  awlsimhw_linuxcnc/        : LinuxCNC hardware support module.
  awlsimhw_pixtend/         : PiXtend hardware support module.
  awlsimhw_pyprofibus/      : PROFIBUS-DP hardware support module.
  awlsimhw_pyprofibus.conf  : Configuration file for awlsimhw_pyprofibus.
  awlsimhw_rpigpio/         : Raspberry Pi GPIO hardware support module.

Misc  : Systemd unit template for awlsim-server.
  debian/                   : Debian packaging support.
  maintenance/              : Maintainer scripts.
  misc/                     : Miscellaneous scripts and files.
  pilc/                     : PiLC distribution build scripts.                  : Python package build script. This also builds the Cython modules.

FUP - Funktionsplan - Function block diagram

Awlsim supports programming in an S7-FUP like language. See the FUP documentation for more information about Awlsim's implementation of FUP.

Building Awlsim

Awlsim can be run from the source directory in interpreted Python mode without building it. Just cd into the Awlsim source directory and execute the desired main executable (e.g. ./awlsim-gui or ./awlsim-server etc...).

The accelerated Cython libraries can be built with the standard Python ./ build command.

For convenience there also is a helper script ./maintenance/, which will do everything right to build Awlsim. That can be used instead of calling directly.

There also is ./maintenance/ That builds Cython modules without optimization. The build is much faster, but the resulting Cython libraries will be much slower. This is useful for development. Do not use this for production.

Building Debian / Raspbian / PiLC .deb packages

Installing or upgrading Awlsim on a Debian based system is easy. The debuild can be used to build the .deb packages. Just run the following commands to build all Awlsim .deb packages:

cd path/to/awlsim                                 # Go to Awlsim source directory
sudo ./maintenance/    # This installs all dependencies
debuild -uc -us                                   # Build all Awlsim .deb packages
sudo ./maintenance/ ..              # Install or upgrade all Awlsim .deb packages

The .deb files will be put into the parent directory of the Awlsim source directory.

If you get the following build failure during build:

/usr/include/features.h:xxx:xx: fatal error: sys/cdefs.h: No such file or directory

this can be fixed by re-installing the libc development package:

sudo apt install --reinstall libc-dev


Information about Awlsim development can be found in the Awlsim development documentation.

License / Copyright

Copyright (C) Michael Büsch / et al.

Awlsim is Open Source Free Software licensed under the GNU General Public License v2+. That means it's available in full source code and you are encouraged to improve it and contribute your changes back to the community. Awlsim is free of charge, too.