11

Beremiz consists of two components:

    12

    13

* Integrated Development Environment (IDE), [Beremiz.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz.py?at=default). It's running on user's computer and is used to write/compile/debug PLC programs and control PLC runtime.

    14

* Reference runtime implementation in python, [Beremiz_service.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz_service.py?at=default). It's running on target platform, communicates with I/O and executes PLC program.

    15

    18

## Build on Linux ##

    22

		# Ubuntu/Debian :

    23

		sudo apt-get install build-essential bison flex autoconf

    24

		sudo apt-get install python-wxgtk3.0 pyro mercurial

    25

		sudo apt-get install python-nevow python-matplotlib python-lxml python-zeroconf python-cycler

    26

    28

    29

		mkdir ~/Beremiz

    30

		cd ~/Beremiz

    34

		cd ~/Beremiz

    35

		hg clone https://bitbucket.org/skvorl/beremiz

    36

		hg clone https://bitbucket.org/mjsousa/matiec

    40

		cd ~/Beremiz/matiec

    41

		autoreconf -i

    42

		./configure

    43

		make

    45

* Build CanFestival (optional)  

    46

  Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'.

    48

        cd ~/Beremiz

    49

        hg clone http://dev.automforge.net/CanFestival-3

    50

        cd ~/Beremiz/CanFestival-3

    51

        ./configure --can=virtual

    52

        make

    53

    54

* Build Modbus library (optional)

    55

  Only needed for Modbus support.

    56

    57

		cd ~/Beremiz

    58

		hg clone https://bitbucket.org/mjsousa/modbus Modbus

    59

		cd ~/Beremiz/Modbus

    60

		make

    64

		cd ~/Beremiz/beremiz

    65

		python Beremiz.py

    67

## Run standalone Beremiz runtime ##

    68

    69

Runtime implementation can be different on different platforms.

    70

For example, PLC used Cortex-M most likely would have C-based runtime. Beremiz project contains reference implementation in python, that can be easily run on GNU/Linux, Windows and Mac OS X.

    71

This section will describe how to run it.

    72

    73

If project's URL is 'LOCAL://', then IDE launches temprorary instance of Beremiz python runtime (Beremiz_service.py) localy as user tries to connect to PLC. This allows to debug programs localy without PLC.

    74

    75

If you want to run Beremiz_service.py as standalone service, then follow these instructions:

    79

		cd ~/Beremiz

    80

		mkdir beremiz_workdir

    81

		cd ~/beremiz

    82

		python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/Beremiz/beremiz_workdir

    86

		cd ~/Beremiz/beremiz

    87

		python Beremiz.py

    88

    89

* Open/Create PLC project in Beremiz IDE.  

    90

  Enter target location URI in project's settings (project->Config->BeremizRoot/URI_location) pointed to your running Beremiz service (For example, PYRO://127.0.0.1:61194).

    91

  Save project and connect to running Beremiz service.

    92

    93

## Examples ##

    94

    95

Almost for all functionality exists example in ['tests'](https://bitbucket.org/automforge/beremiz/src/tip/tests/?at=default) directory.

    96

Most of examples are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA).

    97

    98

## Documentation ##

   116

## Support and development ##