README.md
author Andrey Skvortsov <andrej.skvortzov@gmail.com>
Mon, 21 Aug 2017 20:14:34 +0000
changeset 1727 865e157c6474
parent 1679 2fcea15858a5
child 1728 9a2d192a7aef
permissions -rw-r--r--
Add information about built official documentation to README.md
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
     1
[![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](beremiz.readthedocs.io)
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
     2
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     3
# Beremiz #
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     4
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     5
Beremiz is an integrated development environment for machine automation. It is Free Software, conforming to IEC-61131 among other standards.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     6
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     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.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     8
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
     9
With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. 
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    10
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    11
See official [Beremiz website](http://www.beremiz.org/) for more information.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    12
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    13
### Build on Linux ###
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    14
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    15
* Prerequisites
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    16
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    17
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    18
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    19
* # Ubuntu/Debian :
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    20
sudo apt-get install build-essential bison flex autoconf
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    21
sudo apt-get install python-wxgtk3.0 pyro mercurial
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    22
sudo apt-get install python-numpy python-nevow python-matplotlib python-lxml
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    23
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    24
* Prepare
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    25
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    26
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    27
mkdir ~/Beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    28
cd ~/Beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    29
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    30
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    31
* Get Source Code
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    32
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    33
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    34
cd ~/Beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    35
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    36
hg clone https://bitbucket.org/skvorl/beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    37
hg clone https://bitbucket.org/mjsousa/matiec
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    38
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    39
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    40
* Build MatIEC compiler
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    41
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    42
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    43
cd ~/Beremiz/matiec
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    44
autoreconf -i
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    45
./configure
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    46
make
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    47
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    48
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    49
* Build CanFestival (optional)
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    50
Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    51
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    52
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    53
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    54
cd ~/Beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    55
hg clone http://dev.automforge.net/CanFestival-3
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    56
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    57
cd ~/Beremiz/CanFestival-3
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    58
./configure --can=virtual
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    59
make
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    60
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    61
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    62
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    63
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    64
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    65
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    66
cd ~/Beremiz/beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    67
python Beremiz.py
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    68
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    69
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    70
### Run standalone Beremiz service ###
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    71
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    72
* Start standalone Beremiz service
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    73
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    74
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    75
cd ~/Beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    76
mkdir beremiz_workdir
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    77
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    78
cd ~/beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    79
python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/Beremiz/beremiz_workdir
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    80
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    81
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    82
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    83
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    84
#!sh
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    85
cd ~/Beremiz/beremiz
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    86
python Beremiz.py
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    87
```
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    88
* Open/Create PLC project in Beremiz IDE.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    89
* 
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    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).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    91
Save project and connect to running Beremiz service.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    92
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    93
### Documentation ###
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    94
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    95
 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    96
 
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
    97
 * [Official user manual]http://beremiz.readthedocs.io/.
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
    98
   It's built from sources in doc directory. Documentation does not cover all aspects of Beremiz use yet.
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
    99
   Contribution are very welcome.
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
   100
   
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   101
 * [User manual](http://www.sm1820.ru/files/beremiz/beremiz_manual.pdf) from INEUM (Russian).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   102
   Be aware that it contains some information about functions available only in INEUM's fork of Beremiz.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   103
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   104
 * [User manual](http://www.beremiz.org/LpcManager_UserManual.pdf) from Smarteh (English).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   105
   Be aware that it contains some information about functions available only in Smarteh's fork of Beremiz.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   106
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   107
 * Outdated short [user manual](https://www.scribd.com/document/76101511/Manual-Beremiz#scribd) from LOLI Tech (English).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   108
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   109
 * See official [Beremiz website](http://www.beremiz.org/) for more information.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   110
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   111
### Support and development ###
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   112
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   113
Main community support channel is [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   114
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   115
The list is moderated and requires subscription for posting to it.
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   116
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   117
To subscribe to the mailing list go [here](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/).
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   118
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   119
Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).