Commit dfb721fd authored by Christoffer Ackelman's avatar Christoffer Ackelman

Added documentation explaining the source code layout.

parent e3390825
...@@ -20,7 +20,7 @@ Optional: ...@@ -20,7 +20,7 @@ Optional:
Mandatory if you want to build the QT version of ProviewR: Mandatory if you want to build the QT version of ProviewR:
> apt-get install qt4-dev-tools libphonon-dev > apt-get install libqt4-dev libphonon-dev
Mandatory if you want to build the GTK version of ProviewR: Mandatory if you want to build the GTK version of ProviewR:
...@@ -39,15 +39,15 @@ Optional if you build the GTK version of ProviewR: ...@@ -39,15 +39,15 @@ Optional if you build the GTK version of ProviewR:
Unpack the source package Unpack the source package
> tar -xzvf pwrsrc_4.8.0.tar.gz > tar -xzvf pwrsrc_5.6.1.tar.gz
Enter the sourcecode root directory Enter the sourcecode root directory
> cd pwr_4.8.0 > cd pwr_5.6.1
Execute the makefile Execute the build script
> make > ./build.sh
When the compilation is finished, follow the instructions to insert the three lines in your .bashrc file. When the compilation is finished, follow the instructions to insert the three lines in your .bashrc file.
...@@ -69,15 +69,15 @@ Replace /home/robert/x5-6-1 with the directory where you unpacked the sources. ...@@ -69,15 +69,15 @@ Replace /home/robert/x5-6-1 with the directory where you unpacked the sources.
### 3.2 Creating the environment ### 3.2 Creating the environment
Creating and handling your environment is done with the pwre-function (added by sourcing $pwre_bin/pwre_function). See section "Cross-compiling" below about compiling a 32-bit version of ProviewR on a 64-bit machine. Creating and handling your environment is done with the pwre-function (added by sourcing $pwre_bin/pwre_function). If you want to compile a 32-bit version of ProviewR on a 64-bit machine, see section "Cross-compiling" below.
> pwre > pwre
shows all possibilites of the pwre build script. shows all possibilites of the pwre build script.
Add an environment named 'x561x86' (choose any name you like). Add an environment named 'x561x86_64' (choose any name you like).
> pwre add x561x86 > pwre add x561x86_64
> Source root [...] ? /home/robert/x5-6-1/src (where /home/robert/x5-6-1 is replaced with the directory where you unpacked the sources) > Source root [...] ? /home/robert/x5-6-1/src (where /home/robert/x5-6-1 is replaced with the directory where you unpacked the sources)
Import root [] ? Import root [] ?
...@@ -92,12 +92,12 @@ List all existing environments: ...@@ -92,12 +92,12 @@ List all existing environments:
> pwre list > pwre list
> -- Defined environments: > -- Defined environments:
x460x86 x561x86_64
-- --
Initiate your new environment: Initiate your new environment:
> pwre init x561x86 > pwre init x561x86_64
Now, create the build tree Now, create the build tree
......
The core of ProviewR consists of three modules:
1. The WorkBench (WB) used to create PLC programs and graphical interfaces for operators
2. The command-line RunTime (RT) used to start and stop PLC programs
3. The Runtime Viewer (XTT) used to monitor and operate running PLC programs
The source code for ProviewR is organised in layers, where each layers is built on top of, and adds additional functionality to, the layer below. These layers are:
0. src/exp/inc: Basic type definitions and macros.
1. src/lib/co: Library of common (CO) functionality used by all other parts of ProviewR.
2. src/lib/rt: Library of functionality used by the ProviewR RunTime (RT).
3. xtt/lib/cow: Library of common widgets (COW) used by all graphical parts of ProviewR.
4. xtt/lib/flow and xtt/lib/glow: These are small GUI widget libraries. Flow is used by ProviewR itself to draw the WorkBench and Runtime Viewer, while Glow is used to draw the user-created graphical interfaces for operators.
5. xtt/lib/ge: GE is used to create graphical interfaces for operators.
6. xtt/lib/xtt and wb/lib/wb: These libraries contain the graphical widgets used by the xtt/exe and wb/exe executables respectively.
7. src/exe, xtt/exe and wb/exe: These folders contain the code for the actual executables. src/exe contain the command-line RunTime executables, wb/exe contain the executables for the WorkBench (WB), and xtt/exe contain the executables for the Runtime Viewer.
In addition to these, ProviewR comes with a number of plugins that adds support for various hardware, for example: the profibus folder adds support for profibus, etc.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment