andrej@1728: [![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](https://beremiz.readthedocs.io)
andrej@1727: 
andrej@1679: # Beremiz #
andrej@1679: 
andrej@1679: Beremiz is an integrated development environment for machine automation. It is Free Software, conforming to IEC-61131 among other standards.
andrej@1679: 
andrej@1679: 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.
andrej@1679: 
andrej@1679: With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. 
andrej@1679: 
andrej@1679: See official [Beremiz website](http://www.beremiz.org/) for more information.
andrej@1679: 
andrej@1679: ### Build on Linux ###
andrej@1679: 
andrej@1679: * Prerequisites
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: 
andrej@1679: * # Ubuntu/Debian :
andrej@1679: sudo apt-get install build-essential bison flex autoconf
andrej@1679: sudo apt-get install python-wxgtk3.0 pyro mercurial
andrej@1830: sudo apt-get install python-nevow python-matplotlib python-lxml python-zeroconf
andrej@1679: ```
andrej@1679: * Prepare
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: mkdir ~/Beremiz
andrej@1679: cd ~/Beremiz
andrej@1679: ```
andrej@1679: 
andrej@1679: * Get Source Code
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz
andrej@1679: 
andrej@1679: hg clone https://bitbucket.org/skvorl/beremiz
andrej@1679: hg clone https://bitbucket.org/mjsousa/matiec
andrej@1679: ```
andrej@1679: 
andrej@1679: * Build MatIEC compiler
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz/matiec
andrej@1679: autoreconf -i
andrej@1679: ./configure
andrej@1679: make
andrej@1679: ```
andrej@1679: 
andrej@1679: * Build CanFestival (optional)
andrej@1679: Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'.
andrej@1679: 
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz
andrej@1679: hg clone http://dev.automforge.net/CanFestival-3
andrej@1679: 
andrej@1679: cd ~/Beremiz/CanFestival-3
andrej@1679: ./configure --can=virtual
andrej@1679: make
andrej@1679: ```
andrej@1679: 
andrej@1679: * Launch Beremiz IDE
andrej@1679: 
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz/beremiz
andrej@1679: python Beremiz.py
andrej@1679: ```
andrej@1679: 
andrej@1679: ### Run standalone Beremiz service ###
andrej@1679: 
andrej@1679: * Start standalone Beremiz service
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz
andrej@1679: mkdir beremiz_workdir
andrej@1679: 
andrej@1679: cd ~/beremiz
andrej@1679: python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/Beremiz/beremiz_workdir
andrej@1679: ```
andrej@1679: 
andrej@1679: * Launch Beremiz IDE
andrej@1679: ```
andrej@1679: #!sh
andrej@1679: cd ~/Beremiz/beremiz
andrej@1679: python Beremiz.py
andrej@1679: ```
andrej@1679: * Open/Create PLC project in Beremiz IDE.
andrej@1679: * 
andrej@1679: 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).
andrej@1679: Save project and connect to running Beremiz service.
andrej@1679: 
andrej@1679: ### Documentation ###
andrej@1679: 
andrej@1679:  * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE.
andrej@1679:  
andrej@1729:  * [Official user manual](http://beremiz.readthedocs.io/) is built from sources in doc directory.
andrej@1729:    Documentation does not cover all aspects of Beremiz use yet.
andrej@1729:    Contribution are very welcome!
andrej@1727:    
andrej@1679:  * [User manual](http://www.sm1820.ru/files/beremiz/beremiz_manual.pdf) from INEUM (Russian).
andrej@1679:    Be aware that it contains some information about functions available only in INEUM's fork of Beremiz.
andrej@1679: 
andrej@1679:  * [User manual](http://www.beremiz.org/LpcManager_UserManual.pdf) from Smarteh (English).
andrej@1679:    Be aware that it contains some information about functions available only in Smarteh's fork of Beremiz.
andrej@1679: 
andrej@1679:  * Outdated short [user manual](https://www.scribd.com/document/76101511/Manual-Beremiz#scribd) from LOLI Tech (English).
andrej@1679: 
andrej@1679:  * See official [Beremiz website](http://www.beremiz.org/) for more information.
andrej@1679: 
andrej@1679: ### Support and development ###
andrej@1679: 
andrej@1679: Main community support channel is [mailing list](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/) (beremiz-devel@lists.sourceforge.net).
andrej@1679: 
andrej@1679: The list is moderated and requires subscription for posting to it.
andrej@1679: 
andrej@1679: To subscribe to the mailing list go [here](https://sourceforge.net/p/beremiz/mailman/beremiz-devel/).
andrej@1679: 
andrej@1679: Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).