1

[![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](https://beremiz.readthedocs.io)

     2

     3

# Beremiz #

     4

     5

Beremiz is an integrated development environment for machine automation. It is Free Software, conforming to IEC-61131 among other standards.

     6

     7

It relies on open standards to be independent of the targeted device, and let you turn any processor into a PLC. Beremiz includes tools to create HMI, and to connect your PLC programs to existing supervisions, databases, or fieldbuses.

     8

     9

With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. 

    10

    11

See official [Beremiz website](http://www.beremiz.org/) for more information.

    12

    13

### Build on Linux ###

    14

    15

* Prerequisites

    16

```

    17

#!sh

    18

    19

* # Ubuntu/Debian :

    20

sudo apt-get install build-essential bison flex autoconf

    21

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

    23

```

    24

* Prepare

    25

```

    26

#!sh

    27

mkdir ~/Beremiz

    28

cd ~/Beremiz

    29

```

    30

    31

* Get Source Code

    32

```

    33

#!sh

    34

cd ~/Beremiz

    35

    36

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

    37

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

    38

```

    39

    40

* Build MatIEC compiler

    41

```

    42

#!sh

    43

cd ~/Beremiz/matiec

    44

autoreconf -i

    45

./configure

    46

make

    47

```

    48

    49

* Build CanFestival (optional)

    50

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

    51

    52

```

    53

#!sh

    54

cd ~/Beremiz

    55

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

    56

    57

cd ~/Beremiz/CanFestival-3

    58

./configure --can=virtual

    59

make

    60

```

    61

    62

* Launch Beremiz IDE

    63

    64

```

    65

#!sh

    66

cd ~/Beremiz/beremiz

    67

python Beremiz.py

    68

```

    69

    70

### Run standalone Beremiz service ###

    71

    72

* Start standalone Beremiz service

    73

```

    74

#!sh

    75

cd ~/Beremiz

    76

mkdir beremiz_workdir

    77

    78

cd ~/beremiz

    79

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

    80

```

    81

    82

* Launch Beremiz IDE

    83

```

    84

#!sh

    85

cd ~/Beremiz/beremiz

    86

python Beremiz.py

    87

```

    88

* Open/Create PLC project in Beremiz IDE.

    89

* 

    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

### Documentation ###

    94

    95

 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE.

    96

    97

 * [Official user manual](http://beremiz.readthedocs.io/) is built from sources in doc directory.

    98

   Documentation does not cover all aspects of Beremiz use yet.

    99

   Contribution are very welcome!

   100

   101

 * [User manual](http://www.sm1820.ru/files/beremiz/beremiz_manual.pdf) from INEUM (Russian).

   102

   Be aware that it contains some information about functions available only in INEUM's fork of Beremiz.

   103

   104

 * [User manual](http://www.beremiz.org/LpcManager_UserManual.pdf) from Smarteh (English).

   105

   Be aware that it contains some information about functions available only in Smarteh's fork of Beremiz.

   106

   107

 * Outdated short [user manual](https://www.scribd.com/document/76101511/Manual-Beremiz#scribd) from LOLI Tech (English).

   108

   109

 * See official [Beremiz website](http://www.beremiz.org/) for more information.

   110

   111

### Support and development ###

   112

   113

Main community support channel is [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).

   114

   115

The list is moderated and requires subscription for posting to it.

   116

   117

To subscribe to the mailing list go [here](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/).

   118

   119

Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).