README.md
author Edouard Tisserant <edouard.tisserant@gmail.com>
Tue, 17 May 2022 13:22:20 +0200
changeset 3465 2f5b5c14a650
parent 3450 8be4b8f092cd
child 3605 7aa4209c2b2d
permissions -rw-r--r--
Tests: No need to archive test results before uploading them as action artifacts.
1728
9a2d192a7aef fix link to documentation in README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1727
diff changeset
     1
[![docs](https://readthedocs.org/projects/beremiz/badge/?version=latest)](https://beremiz.readthedocs.io)
1727
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
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    11
Beremiz consists of two components:
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    12
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    13
* 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.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    14
* Reference runtime implementation in python, Beremiz_service.py. It's running on target platform, communicates with I/O and executes PLC program.
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    15
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    16
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
    17
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    18
## Build on Linux ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    19
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    20
* Prerequisites
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    21
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    22
		# Ubuntu/Debian :
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    23
		sudo apt-get install build-essential bison flex autoconf
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    24
		sudo apt-get install python-wxgtk3.0 pyro mercurial
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    25
		sudo apt-get install python-nevow python-matplotlib python-lxml python-zeroconf python-cycler
2292
7c34d6f9d59b Update requirements to include WAMP support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2276
diff changeset
    26
		sudo apt-get install python-autobahn python-u-msgpack
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    27
2545
1cc6390a7c0b Update Beremiz dependencies because of added PYROS:// support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2541
diff changeset
    28
		sudo apt-get install libpython2.7-dev
2577
f88eef34a523 Fix typo in README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2545
diff changeset
    29
		pip2 install --user sslpsk posix_spawn
2545
1cc6390a7c0b Update Beremiz dependencies because of added PYROS:// support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2541
diff changeset
    30
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    31
* Prepare
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    32
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    33
		mkdir ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    34
		cd ~/Beremiz
1679
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
* Get Source Code
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    37
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    38
		cd ~/Beremiz
2495
016748ef5fc4 update links to matiec and beremiz repos in README
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2292
diff changeset
    39
		hg clone https://bitbucket.org/automforge/beremiz
016748ef5fc4 update links to matiec and beremiz repos in README
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2292
diff changeset
    40
		hg clone https://bitbucket.org/automforge/matiec
1679
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
* Build MatIEC compiler
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    43
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    44
		cd ~/Beremiz/matiec
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    45
		autoreconf -i
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    46
		./configure
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    47
		make
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    48
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    49
* Build CanFestival (optional)  
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    50
  Only needed for CANopen support. Please read CanFestival manual to choose CAN interface other than 'virtual'.
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    51
2276
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    52
		cd ~/Beremiz
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    53
		hg clone http://dev.automforge.net/CanFestival-3
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    54
		cd ~/Beremiz/CanFestival-3
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    55
		./configure --can=virtual
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    56
		make
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    57
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    58
* Build Modbus library (optional)
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    59
  Only needed for Modbus support.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    60
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    61
		cd ~/Beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    62
		hg clone https://bitbucket.org/mjsousa/modbus Modbus
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    63
		cd ~/Beremiz/Modbus
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    64
		make
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    65
2276
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    66
* Build BACnet (optional)
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    67
  Only needed for BACnet support.
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    68
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    69
		cd ~/Beremiz
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    70
		svn checkout https://svn.code.sf.net/p/bacnet/code/trunk/bacnet-stack/ BACnet
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    71
		cd BACnet
2541
92f0980888e8 Update build instruction for BACNet in README
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2495
diff changeset
    72
		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
92f0980888e8 Update build instruction for BACNet in README
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2495
diff changeset
    73
2276
ba0fc3e73ce2 Update README with instruction to build BACnet library for BACnet support
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2253
diff changeset
    74
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    75
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    76
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    77
		cd ~/Beremiz/beremiz
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
    78
		python Beremiz.py
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
    79
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    80
## Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    81
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    82
Source code for Beremiz user manual is stored in
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    83
[doc](tree/default/doc)
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    84
directory in project's source tree.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    85
It's written in reStructuredText (ReST) and uses Sphinx to build documentation in different formats.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    86
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    87
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    88
To build documentation you need following packages on Ubuntu/Debian:
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    89
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    90
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    91
sudo apt-get install build-essential python-sphynx
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    92
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    93
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    94
### Documentation in HTML
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    95
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    96
Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    97
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    98
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
    99
cd ~/Beremiz/doc
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   100
make all
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   101
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   102
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   103
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   104
Result documentation is stored in directories 'doc/\_build/dirhtml\*'.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   105
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   106
### Documentation in PDF
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   107
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   108
To build pdf documentation you have to install additional packages on Ubuntu/Debian:
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   109
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   110
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   111
sudo apt-get install textlive-latex-base texlive-latex-recommended \
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   112
     texlive-fonts-recommended texlive-latex-extra
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   113
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   114
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   115
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   116
Build documentation
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   117
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   118
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   119
cd ~/Beremiz/doc
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   120
make latexpdf
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   121
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   122
```
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   123
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   124
Result documentation is stored in 'doc/\_build/latex/Beremiz.pdf'.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   125
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   126
## Run standalone Beremiz runtime ##
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   127
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   128
Runtime implementation can be different on different platforms.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   129
For example, PLC used Cortex-M most likely would have C-based runtime. Beremiz project contains reference implementation in python, that can be easily run on GNU/Linux, Windows and Mac OS X.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   130
This section will describe how to run it.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   131
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   132
If project's URL is 'LOCAL://', then IDE launches temprorary instance of Beremiz python runtime (Beremiz_service.py) localy as user tries to connect to PLC. This allows to debug programs localy without PLC.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   133
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   134
If you want to run Beremiz_service.py as standalone service, then follow these instructions:
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   135
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   136
* Start standalone Beremiz service
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   137
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   138
		mkdir ~/beremiz_workdir
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   139
		python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/beremiz_workdir
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   140
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   141
* Launch Beremiz IDE
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   142
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   143
		python Beremiz.py
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   144
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   145
* Open/Create PLC project in Beremiz IDE.  
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   146
  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).
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   147
  Save project and connect to running Beremiz service.
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   148
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   149
## Examples ##
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   150
3450
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   151
Almost for all functionality exists example in ['tests'](tree/default/tests/projects) and ['exemples'](tree/default/tests/projects) directories.
8be4b8f092cd Minor changes to README.md
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2577
diff changeset
   152
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   153
Most of examples are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA).
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   154
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   155
## Documentation ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   156
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   157
 * 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
   158
 
1729
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   159
 * [Official user manual](http://beremiz.readthedocs.io/) is built from sources in doc directory.
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   160
   Documentation does not cover all aspects of Beremiz use yet.
31e63e25b4cc README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1728
diff changeset
   161
   Contribution are very welcome!
1727
865e157c6474 Add information about built official documentation to README.md
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1679
diff changeset
   162
   
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   163
 * [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
   164
   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
   165
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   166
 * [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
   167
   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
   168
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   169
 * 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
   170
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   171
 * 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
   172
2253
b0418bb13527 Rework README.md, add examples section, add instructions for Modbus extension, more information about runtime.
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 2012
diff changeset
   173
## Support and development ##
1679
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   174
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   175
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
   176
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   177
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
   178
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   179
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
   180
2fcea15858a5 README.md edited online with Bitbucket
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents:
diff changeset
   181
Searchable archive using search engine of your choice is available [here](http://beremiz-devel.2374573.n4.nabble.com/).