1

<!---

     2

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

     3

-->

     4

     5

# Beremiz #

     6

     7

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

     8

     9

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.

    10

    11

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

    12

    13

Beremiz consists of two components:

    14

    15

* Integrated Development Environment (IDE), Beremiz.py. It is running on user's computer and is used to write/compile/debug PLC programs and control PLC runtime.

    16

* Reference runtime implementation in python, Beremiz_service.py. It's running on target platform, communicates with I/O and executes PLC program.

    17

    18

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

    19

    20

## Install latest release ##

    21

    22

Windows installer and Snap package for Linux are available in [Github releases](https://github.com/beremiz/beremiz/releases) and [Snapcraft's store](https://snapcraft.io/beremiz)

    23

    24

## Tutorials and examples ##

    25

    26

In IDE, find menu "File>Tutorials and examples" to quickly open examples that should run as-is.

    27

    28

There are more examples in `tests/projects` and `exemples` directories.

    29

    30

Some example and test are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA).

    31

    32

## Development with Beremiz ##

    33

    34

Developers are invited to subscribe to [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).

    35

    36

The list is moderated and requires subscription before posting.

    37

    38

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

    39

    40

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

    41

    42

## Build on Linux (developer setup) ##

    43

    54

    55

### Prepare build directory

    56

    57

All commands hereafter assume that selected directory to contain all downloaded source code and build results is `~/Beremiz`

    58

    59

```

    60

mkdir ~/Beremiz

    61

cd ~/Beremiz

    62

```

    63

    64

### Get Source Code (Mercurial)

    65

    66

```

    67

cd ~/Beremiz

    68

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

    69

hg clone https://hg.beremiz.org/matiec

    70

```

    71

    72

### Get Source Code (Git)

    73

    74

```

    75

cd ~/Beremiz

    76

git clone https://github.com/beremiz/beremiz

    77

git clone https://github.com/beremiz/matiec

    78

```

    79

    90

### Build MatIEC compiler

    91

    92

```

    93

cd ~/Beremiz/matiec

    94

autoreconf -i

    95

./configure

    96

make

    97

```

    98

    99

### Build CanFestival (optional)

   100

   101

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

   102

   103

```

   104

cd ~/Beremiz

   111

./configure --can=virtual

   112

make

   113

```

   114

   115

### Build Modbus library (optional)

   116

   117

Only needed for Modbus support.

   118

   119

```

   120

cd ~/Beremiz

   126

cd ~/Beremiz/Modbus

   127

make

   128

```

   129

   130

### Build BACnet (optional)

   131

   132

Only needed for BACnet support.

   133

   134

```

   135

cd ~/Beremiz

   136

svn checkout https://svn.code.sf.net/p/bacnet/code/trunk/bacnet-stack/ BACnet

   137

cd BACnet

   138

make MAKE_DEFINE='-fPIC' MY_BACNET_DEFINES='-DPRINT_ENABLED=1 -DBACAPP_ALL -DBACFILE -DINTRINSIC_REPORTING -DBACNET_TIME_MASTER -DBACNET_PROPERTY_LISTS=1 -DBACNET_PROTOCOL_REVISION=16' library

   139

```

   140

   141

### Launch Beremiz IDE

   142

   143

```

   145

```

   146

   147

## Run standalone Beremiz runtime ##

   148

   149

* Start standalone Beremiz service

   150

   151

```

   152

mkdir ~/beremiz_runtime_workdir

   154

```

   155

   156

To connect IDE with runtime, enter target location URI in project's settings (project->Config->BeremizRoot/URI_location) pointed to your running Beremiz service in this case :

   157

   158

```

   159

PYRO://127.0.0.1:61194

   160

```

   161

   162

If project's URL is 'LOCAL://', then IDE launches on demand a local instance of Beremiz python runtime working on a temporary directory.

   163

   164

## Build documentation

   165

   166

Source code for documentation is stored in `doc` directory in project's source tree.

   167

It's written in reStructuredText (ReST) and uses Sphinx to generate documentation in different formats.

   168

   169

To build documentation you need following packages on Ubuntu/Debian:

   170

   171

```

   172

sudo apt-get install build-essential python-sphynx

   173

```

   174

   175

### Documentation in HTML

   176

   177

Build documentation

   178

   179

```

   180

cd ~/Beremiz/doc

   181

make all

   182

```

   183

   184

Result documentation is stored in directories `doc/_build/dirhtml*`.

   185

   186

### Documentation in PDF

   187

   188

To build pdf documentation you have to install additional packages on Ubuntu/Debian:

   189

   190

```

   191

sudo apt-get install textlive-latex-base texlive-latex-recommended \

   192

     texlive-fonts-recommended texlive-latex-extra

   193

```

   194

   195

Build documentation

   196

   197

```

   198

cd ~/Beremiz/doc

   199

make latexpdf

   200

```

   201

   202

Result documentation is stored in `doc/_build/latex/Beremiz.pdf`.

   203

   204

## Documentation ##

   205

   206

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

   207

   208

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

   209

   Documentation does not cover all aspects of Beremiz use yet.

   210

   Contribution are very welcome!

   211

   212

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

   213

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

   214

   215

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

   216

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

   217

   218

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

   219

   220

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

   221