1

<!---

     2

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

     3

-->

     4

[![CI Automated testing](https://github.com/beremiz/beremiz/actions/workflows/run_tests_in_docker.yml/badge.svg?branch=python3)](https://github.com/beremiz/beremiz/actions/workflows/run_tests_in_docker.yml)

     5

     6

# Beremiz #

     7

     8

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

     9

    10

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.

    11

    12

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

    13

    14

Beremiz provides:

    15

    16

* Integrated Development Environment (IDE). GUI to configure, write, build and debug PLC programs and control PLC runtime.

    17

* Command Line Interface (CLI). Build PLC and control PLC runtime in a terminal or from a script.

    18

* Runtimes, running on target platform communicates with I/O and executes PLC program.

    19

    * Python reference runtime implementation.

    20

    * C runtime for smaller targets.

    21

    22

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

    23

    24

[Beremiz company](https://beremiz.fr/) develops and maintains the Beremiz Free Software project while also providing professional support services.

    25

    26

## Install latest release ##

    27

    28

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)

    29

    30

## Tutorials and examples ##

    31

    32

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

    33

    34

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

    35

    36

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

    37

    38

## Development with Beremiz ##

    39

    40

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

    41

    42

The list is moderated and requires subscription before posting.

    43

    44

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

    45

    46

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

    47

    48

## Build on Linux (developer setup) ##

    49

    50

### System prerequisites (Ubuntu 22.04) :

    51

```

    52

# install required system packages as root

    53

sudo apt-get install \

    54

  build-essential automake flex bison mercurial \

    55

  libgtk-3-dev libgl1-mesa-dev libglu1-mesa-dev \

    56

  libpython3.10-dev libssl-dev \

    57

  python3.10 virtualenv cmake git mercurial

    58

```

    59

    60

    61

### Prepare build directory

    62

    63

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

    64

    65

```

    66

mkdir ~/Beremiz

    67

cd ~/Beremiz

    68

```

    69

    70

### Get Source Code (Mercurial)

    71

    72

```

    73

cd ~/Beremiz

    74

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

    75

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

    76

```

    77

    78

### Get Source Code (Git)

    79

    80

```

    81

cd ~/Beremiz

    82

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

    83

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

    84

```

    85

    86

### Python prerequisites (virtualenv) :

    87

```

    88

# setup isolated python environment

    89

virtualenv ~/Beremiz/venv

    90

    91

# install required python packages

    92

~/Beremiz/venv/bin/pip install -r ~/Beremiz/beremiz/requirements.txt

    93

    94

```

    95

    96

### Build MatIEC compiler

    97

    98

```

    99

cd ~/Beremiz/matiec

   100

autoreconf -i

   101

./configure

   102

make

   103

```

   104

   105

### Build CanFestival (optional)

   106

   107

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

   108

   109

```

   110

cd ~/Beremiz

   111

   112

hg clone http://hg.beremiz.org/canfestival

   113

#  -- or --

   114

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

   115

   116

cd ~/Beremiz/canfestival

   117

./configure --can=virtual

   118

make

   119

```

   120

   121

### Build Modbus library (optional)

   122

   123

Only needed for Modbus support.

   124

   125

```

   126

cd ~/Beremiz

   127

   128

hg clone http://hg.beremiz.org/Modbus

   129

#  -- or --

   130

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

   131

   132

cd ~/Beremiz/Modbus

   133

make

   134

```

   135

   136

### Build BACnet (optional)

   137

   138

Only needed for BACnet support.

   139

   140

```

   141

cd ~/Beremiz

   142

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

   143

cd BACnet

   144

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

   145

```

   146

   147

### Launch Beremiz IDE

   148

   149

```

   150

~/Beremiz/venv/bin/python ~/Beremiz/beremiz/Beremiz.py

   151

```

   152

   153

## Run standalone Beremiz runtime ##

   154

   155

* Start standalone Beremiz service

   156

   157

```

   158

mkdir ~/beremiz_runtime_workdir

   159

~/Beremiz/venv/bin/python ~/Beremiz/beremiz/Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/beremiz_runtime_workdir

   160

```

   161

   162

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 :

   163

   164

```

   165

PYRO://127.0.0.1:61194

   166

```

   167

   168

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

   169

   170

## Build documentation

   171

   172

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

   173

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

   174

   175

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

   176

   177

```

   178

sudo apt-get install build-essential python-sphynx

   179

```

   180

   181

### Documentation in HTML

   182

   183

Build documentation

   184

   185

```

   186

cd ~/Beremiz/doc

   187

make all

   188

```

   189

   190

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

   191

   192

### Documentation in PDF

   193

   194

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

   195

   196

```

   197

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

   198

     texlive-fonts-recommended texlive-latex-extra

   199

```

   200

   201

Build documentation

   202

   203

```

   204

cd ~/Beremiz/doc

   205

make latexpdf

   206

```

   207

   208

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

   209

   210

## Documentation ##

   211

   212

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

   213

   214

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

   215

   Documentation does not cover all aspects of Beremiz use yet.

   216

   Contribution are very welcome!

   217

   218

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

   219

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

   220

   221

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

   222

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

   223

   224

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

   225

   226

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

   227