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