equal
deleted
inserted
replaced
8 |
8 |
9 With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. |
9 With Beremiz, you conform to standards, avoid vendor lock, and contribute to the better future of Automation. |
10 |
10 |
11 Beremiz consists of two components: |
11 Beremiz consists of two components: |
12 |
12 |
13 * Integrated Development Environment (IDE), [Beremiz.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz.py?at=default). It's running on user's computer and is used to write/compile/debug PLC programs and control PLC runtime. |
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. |
14 * Reference runtime implementation in python, [Beremiz_service.py](https://bitbucket.org/automforge/beremiz/src/tip/Beremiz_service.py?at=default). It's running on target platform, communicates with I/O and executes PLC program. |
14 * Reference runtime implementation in python, Beremiz_service.py. It's running on target platform, communicates with I/O and executes PLC program. |
15 |
15 |
16 See official [Beremiz website](http://www.beremiz.org/) for more information. |
16 See official [Beremiz website](http://www.beremiz.org/) for more information. |
17 |
17 |
18 ## Build on Linux ## |
18 ## Build on Linux ## |
19 |
19 |
75 * Launch Beremiz IDE |
75 * Launch Beremiz IDE |
76 |
76 |
77 cd ~/Beremiz/beremiz |
77 cd ~/Beremiz/beremiz |
78 python Beremiz.py |
78 python Beremiz.py |
79 |
79 |
|
80 ## Build documentation |
|
81 |
|
82 Source code for Beremiz user manual is stored in |
|
83 [doc](tree/default/doc) |
|
84 directory in project's source tree. |
|
85 It's written in reStructuredText (ReST) and uses Sphinx to build documentation in different formats. |
|
86 |
|
87 |
|
88 To build documentation you need following packages on Ubuntu/Debian: |
|
89 |
|
90 ``` |
|
91 sudo apt-get install build-essential python-sphynx |
|
92 ``` |
|
93 |
|
94 ### Documentation in HTML |
|
95 |
|
96 Build documentation |
|
97 |
|
98 ``` |
|
99 cd ~/Beremiz/doc |
|
100 make all |
|
101 |
|
102 ``` |
|
103 |
|
104 Result documentation is stored in directories 'doc/\_build/dirhtml\*'. |
|
105 |
|
106 ### Documentation in PDF |
|
107 |
|
108 To build pdf documentation you have to install additional packages on Ubuntu/Debian: |
|
109 |
|
110 ``` |
|
111 sudo apt-get install textlive-latex-base texlive-latex-recommended \ |
|
112 texlive-fonts-recommended texlive-latex-extra |
|
113 |
|
114 ``` |
|
115 |
|
116 Build documentation |
|
117 |
|
118 ``` |
|
119 cd ~/Beremiz/doc |
|
120 make latexpdf |
|
121 |
|
122 ``` |
|
123 |
|
124 Result documentation is stored in 'doc/\_build/latex/Beremiz.pdf'. |
|
125 |
80 ## Run standalone Beremiz runtime ## |
126 ## Run standalone Beremiz runtime ## |
81 |
127 |
82 Runtime implementation can be different on different platforms. |
128 Runtime implementation can be different on different platforms. |
83 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. |
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. |
84 This section will describe how to run it. |
130 This section will describe how to run it. |
87 |
133 |
88 If you want to run Beremiz_service.py as standalone service, then follow these instructions: |
134 If you want to run Beremiz_service.py as standalone service, then follow these instructions: |
89 |
135 |
90 * Start standalone Beremiz service |
136 * Start standalone Beremiz service |
91 |
137 |
92 cd ~/Beremiz |
138 mkdir ~/beremiz_workdir |
93 mkdir beremiz_workdir |
139 python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/beremiz_workdir |
94 cd ~/beremiz |
|
95 python Beremiz_service.py -p 61194 -i localhost -x 0 -a 1 ~/Beremiz/beremiz_workdir |
|
96 |
140 |
97 * Launch Beremiz IDE |
141 * Launch Beremiz IDE |
98 |
142 |
99 cd ~/Beremiz/beremiz |
|
100 python Beremiz.py |
143 python Beremiz.py |
101 |
144 |
102 * Open/Create PLC project in Beremiz IDE. |
145 * Open/Create PLC project in Beremiz IDE. |
103 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). |
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). |
104 Save project and connect to running Beremiz service. |
147 Save project and connect to running Beremiz service. |
105 |
148 |
106 ## Examples ## |
149 ## Examples ## |
107 |
150 |
108 Almost for all functionality exists example in ['tests'](https://bitbucket.org/automforge/beremiz/src/tip/tests/?at=default) directory. |
151 Almost for all functionality exists example in ['tests'](tree/default/tests/projects) and ['exemples'](tree/default/tests/projects) directories. |
|
152 |
109 Most of examples are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA). |
153 Most of examples are shown on [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA). |
110 |
154 |
111 ## Documentation ## |
155 ## Documentation ## |
112 |
156 |
113 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE. |
157 * See [Beremiz youtube channel](https://www.youtube.com/channel/UCcE4KYI0p1f6CmSwtzyg-ZA) to get quick information how to use Beremiz IDE. |