Package: awlsim
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 theofficial Awlsim site.Main git repositoryGithub / issue tracking / pull requestsAwlsim - 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 theCOMPATIBILITY documentationandTODO documentationfiles.Quick start tutorialSee thequick start tutorialfor 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 projectIf you don't know where to start, you can find an example project in theexamplesdirectory asEXAMPLE.awlpro. You can easily run this example in simulation mode without the need for special hardware.Git repositoryThe latest development version of Awlsim can be fetched with git:git clone https://git.bues.ch/git/awlsim.git
cd awlsimAfter cloning the main repository the git submodules must also be fetched. The following helper script can be used:./maintenance/update-submodulesDependenciesAwlsim depends onPython3.4 or later (or alternatively Python 2.7)PyQT 5or alternativelyPySide 2CFFIThese packages can be installed with pip:pip3 install --upgrade PyQt5
pip3 install --upgrade cffiIf building and using Awlsim with Cython acceleration is desired, Cython must also be installed:pip3 install --upgrade CythonOn Windows all Awlsim dependencies can be installed by double clicking the shipped installer script:maintenance\win-install-dependencies.cmdFor Debian Linux users the scriptmaintenance/deb-dependencies-install.shinstalls all required and optional runtime and build dependencies.Directory structureThe Awlsim Git repository and source archiveawlsim-x.yz.tar.bz2contain lots of files and directories. Here is an overview of the main files and directories and their purpose:Main executablesUser interface executables. The main user executable isawlsim-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/run.sh for execution of unit tests.
.  awlsim-win.cmd            : Windows wrapper for awlsim-gui.DocumentationThese 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.
.  COMPATIBILITY.md|html     : S7 compatibility documentation.
.  COPYING.txt               : Main license.
.  DEVELOPMENT.md|html       : How to enhance and develop Awlsim.
.  QUICK-START.md|html       : Quick start tutorial.
.  README.md|html            : Main README document.
.  TODO.md|html              : TODO list.Main modulesThe 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/run.sh              : Main interface to run unit tests. Please see --helpHardware support modulesThe 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.  awlsim-server.service     : Systemd unit for awlsim-server.
.  debian/                   : Debian packaging support.
.  maintenance/              : Maintainer scripts.
.  misc/                     : Miscellaneous scripts and files.
.  setup.py                  : Python package build script. This also builds the Cython modules.FUP - Funktionsplan - Function block diagramAwlsim supports programming in an S7-FUP like language. Seethe FUP documentationfor more information about Awlsim's implementation of FUP.Environment variablesThe following environment variables control Awlsim's basic behavior:AWLSIM_GUI=autoAutomatically select the best GUI framework (default)=pysideUse PySide as GUI framework.=pyqtUse PyQt as GUI framework.AWLSIM_CYTHON=0Do not attempt to use Cython core (default)=1Attempt to use Cython core, but fall back to Python=2Enforce Cython coreAWLSIM_SCHED=defaultDo not change the scheduling policy. Keep the policy that was assigned to Awlsim by the operating system. (default)=normalUse the normal non-realtime OS scheduling.=fifoUse FIFO realtime scheduling (SCHED_FIFO).=rrUse Round-robin realtime scheduling (SCHED_RR).=deadlineUse Deadline realtime scheduling (SCHED_DEADLINE).=realtimeUse a realtime scheduling algorithm that performs best in most situations. The actual algorithm selection might change between Awlsim releases.The suffix-if-multicorecan be appended to the optionsfifo,rr,deadlineandrealtime. That will trigger a fall back tonormal, if the system is single-core (has only one CPU).AWLSIM_PRIO=defaultDo not change the priority (default).=1-99Set the scheduling priority. The meaning of the priority depends on the operating system and the selected scheduling algorithm. SeeAWLSIM_SCHED.AWLSIM_AFFINITY=0,2,...Comma separated list of host CPU cores to run on. Default: all cores.AWLSIM_MLOCK=0Do not try to mlockall. See man 2 mlockall. (default).=1Try to mlockall all current and future memory. See man 2 mlockall.=2mlockall all current and future memory. Abort on failure. See man 2 mlockall.AWLSIM_PROFILE=0Disable profiling (default)=1Enable core cycle profiling=2Enable full core profiling (including startup)AWLSIM_COVERAGE=DATAFILEEnable code coverage tracing.AWLSIM_GCMODE=realtimeEnable manual garbage collection, if realtime scheduling is enabled. (default)=autoAlways use automatic garbage collection.=manualAlways use manual garbage collection.AWLSIM_GCTHRES=700,1,1A comma separated string with up to 3 integers.Each integer corresponding to the Python garbage collector generation 0 to 2 thresholds for manual garbage collection.A threshold value of 0 disables garbage collection. (not recommended)AWLSIM_GCCYCLE=64The number of OB1 cycles it takes to trigger a manual garbage collection.Environment variables during build (setup.py)The following environment variables control Awlsim's build (setup.py) behavior:AWLSIM_FULL_BUILD=0Do not include scripts that are not necessary on this platform. (default)=1Include all scripts; also those that aren't required on the platform.AWLSIM_CYTHON_BUILD=0Do not build any Cython modules. (default on non-Posix)=1Build Cython modules. (default on Posix)AWLSIM_CYTHON_PARALLEL=0Do not use parallel compilation for Cython modules.=1Invoke multiple compilers in parallel (faster on multicore). (default)AWLSIM_PROFILE=0Do not enable profiling support in compiled Cython modules. (default)=1Enable profiling support in compiled Cython modules.AWLSIM_DEBUG_BUILD=0Do not enable debugging support in compiled Cython modules. (default)=1Enable debugging support in compiled Cython modules.Building AwlsimAwlsim can be run from the source directory in interpreted Python mode without building it. Justcdinto the Awlsim source directory and execute the desired main executable (e.g../awlsim-guior./awlsim-serveretc...).The accelerated Cython libraries can be built with the standard Python./setup.py buildcommand.For convenience there also is a helper script./maintenance/build.sh, which will do everything right to build Awlsim. That can be used instead of calling setup.py directly.There also is./maintenance/build-noopt.sh. 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.PiLC - The Raspberry Pi PLCIf you want to use PiLC, please also see thePiLC documentation.Building Debian / Raspbian / PiLC .deb packagesInstalling or upgrading Awlsim on a Debian based system is easy.
Thedebuildcan 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/deb-dependencies-install.sh    # This installs all dependencies
debuild -uc -us                                   # Build all Awlsim .deb packages
sudo ./maintenance/deb-install.sh ..              # Install or upgrade all Awlsim .deb packagesThe .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 directorythis can be fixed by re-installing the libc development package:sudo apt install --reinstall libc-devDevelopmentInformation about Awlsim development can be found inthe Awlsim development documentation.License / CopyrightCopyright (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.