Skip to content

Commit

Permalink
sync terms in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
parasxos committed Dec 6, 2023
1 parent 4f7874b commit 64ee331
Show file tree
Hide file tree
Showing 10 changed files with 41 additions and 41 deletions.
4 changes: 2 additions & 2 deletions Documentation/source/AlternativeBackends.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
OPC-UA back-ends for quasar
OPC UA back-ends for quasar
===========================

Author: Piotr P. Nikiel
Expand Down Expand Up @@ -47,7 +47,7 @@ quasar developers as one of supported "optional modules".
Activating open62541 is a simple procedure which is best described in the quasar tutorials on YouTube,
see e.g. `<https://www.youtube.com/watch?v=6MsWUQ0OXbY>`__ .

OPC-UA Back-end dependent features: a comparison table
OPC UA Back-end dependent features: a comparison table
------------------------------------------------------

+-----------------+-----------------+-----------------+-----------------+
Expand Down
14 changes: 7 additions & 7 deletions Documentation/source/ChangeLog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1321,7 +1321,7 @@ ChangeLog
Task <br>
<ul>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-1971">OPCUA-1971</a>]
- Expose configentry as OPC-UA property - for scalars </li>
- Expose configentry as OPC UA property - for scalars </li>
</ul>
Improvement <br>
<ul>
Expand Down Expand Up @@ -2510,7 +2510,7 @@ ChangeLog
Task<br>
<ul>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-1128">OPCUA-1128</a>]
- generate device --all doesn't work in SCA OPC-UA</li>
- generate device --all doesn't work in SCA OPC UA</li>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-1144">OPCUA-1144</a>]
- Remove stale boost/foreach includes in Meta</li>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-1147">OPCUA-1147</a>]
Expand Down Expand Up @@ -2885,7 +2885,7 @@ ChangeLog
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-106">OPCUA-106</a>]
- Quasar methods</li>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-579">OPCUA-579</a>]
- Easily selectable OPC-UA backend configuration file
- Easily selectable OPC UA backend configuration file
(ServerConfig.xml)</li>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-668">OPCUA-668</a>]
- Post-merge: missing copyright header in
Expand Down Expand Up @@ -2961,7 +2961,7 @@ ChangeLog
</td>
<td style="vertical-align: top;">Major features:<br>
<ul>
<li>Compatibility with the API of OPC-UA Toolkit 1.3.x,
<li>Compatibility with the API of OPC UA Toolkit 1.3.x,
1.4.x and 1.5.x.<br>
</li>
</ul>
Expand All @@ -2987,7 +2987,7 @@ ChangeLog
Task
<ul>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-588">OPCUA-588</a>]
- Port quasar to OPC-UA Toolkit 1.4.x</li>
- Port quasar to OPC UA Toolkit 1.4.x</li>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-606">OPCUA-606</a>]
- Refresh FAQ of Quasar</li>
</ul>
Expand Down Expand Up @@ -3116,7 +3116,7 @@ ChangeLog
New Feature
<ul>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-489">OPCUA-489</a>]
- Make QUASAR framework version info available to OPC-UA
- Make QUASAR framework version info available to OPC UA
clients from StandardMetaData</li>
</ul>
Task
Expand Down Expand Up @@ -3166,7 +3166,7 @@ ChangeLog
New Feature
<ul>
<li>[<a href="https://its.cern.ch/jira/browse/OPCUA-489">OPCUA-489</a>]
- Make QUASAR framework version info available to OPC-UA
- Make QUASAR framework version info available to OPC UA
clients from StandardMetaData</li>
</ul>
Task
Expand Down
12 changes: 6 additions & 6 deletions Documentation/source/LogIt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Initializing LogIt in the Quasar Server code
- sending commands to some target hardware (e.g. calling some 3rd party
API)
- accepting input (e.g. handling OPC-UA client item writes and method
- accepting input (e.g. handling OPC UA client item writes and method
calls)
- handling hardware disconnection/reconnection events

Expand Down Expand Up @@ -115,7 +115,7 @@ allows for an integrated approach to logging that allows you to
configure the verbosity of logging components both

- initially, via the quasar server XML configuration
- dynamically, via an OPC-UA client
- dynamically, via an OPC UA client

Initial Verbosity: Via Server Config XML
----------------------------------------
Expand Down Expand Up @@ -147,14 +147,14 @@ Runtime Verbosity: Via an OPC_UA client
---------------------------------------

| Per-component verbosity can be read and set at runtime via standard
quasar OPC-UA items (via *StandardMetaData.Log.ComponentLogLevels*).
The screenshot below shows a graphical OPC-UA client (Unified
quasar OPC UA items (via *StandardMetaData.Log.ComponentLogLevels*).
The screenshot below shows a graphical OPC UA client (Unified
Auomtation's uaexpert client) viewing these items. Writing a new
verbosity value, for example, setting component
*ADDRESS_SPACE_UPDATES* verbosity from *WRN* -> *TRC*, would result in
all messages (TRC is the highest verbosity setting) for that component
being delivered to the log.
| |screenshot of OPC-UA client setting log component verbosity|
| |screenshot of OPC UA client setting log component verbosity|
Quasar Framework Maintainers: Dealing with LogIt as a Git Submodule
-------------------------------------------------------------------
Expand Down Expand Up @@ -220,4 +220,4 @@ Then your fellow quasar maintainers update their environments with
git submodule update --init --recursive

.. |screenshot of OPC-UA client setting log component verbosity| image:: images/opc-ua-items-for-logging-verbosity.PNG
.. |screenshot of OPC UA client setting log component verbosity| image:: images/opc-ua-items-for-logging-verbosity.PNG
4 changes: 2 additions & 2 deletions Documentation/source/UserDefinedCommandLineParameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ User Defined Command Line Parameters
Background
----------

An OPC-UA server may be a rather complex process, as such, developers
An OPC UA server may be a rather complex process, as such, developers
may well want to provide implementation specific command line options -
to allows end-users to control aspects of the server's runtime
behaviour, say specifying additional configuration options outside of
Expand Down Expand Up @@ -55,7 +55,7 @@ A Simple Example
----------------

This example shows how to add the 2 command line options listed below
such that a quasar OPC-UA server executable, once built, will parse for
such that a quasar OPC UA server executable, once built, will parse for
these options, complete with end-user facing, option specifc,
documentation:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ User Defined Runtime Configuration Modification
Background
----------

| A completely static configuration for an OPC-UA server may not always
| A completely static configuration for an OPC UA server may not always
be exactly the desired behaviour; for example - consider a
multi-channel, highly modular, power supply system. For such a system
it may be beneficial to users to provide functionality from the quasar
server such that (with the correct command line options specified of
course) the server actually detects the hardware that is connected and
uses this as the basis for its runtime configuration. This might be an
efficient way to run an OPC-UA server in situations where, say, the
efficient way to run an OPC UA server in situations where, say, the
hardware setup is in flux (maybe an ad-hoc lab configuration) and so
manual modification of a static configuration file to describe the
system is painful. Equally, in a large production set up, the server
Expand Down
2 changes: 1 addition & 1 deletion Documentation/source/_init_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ Quasar
:hidden:
:caption: Quasar OpcUa Server

Summary of known quasar-based OPC-UA servers <./quasar_OPC_UA_servers>
Summary of known quasar-based OPC UA servers <./quasar_OPC_UA_servers>

12 changes: 6 additions & 6 deletions Documentation/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Quasar
quasar
======

| The quick opcua server generation framework.
Expand All @@ -23,10 +23,10 @@ Quasar
Design manual <./DesignManual>
For quasar developers <./forQuasarDevelopers>
LogIt <./LogIt>
Quasar <./quasar>
quasar <./quasar>

Quasar build system <./quasarBuildSystem>
Quasar commands <./quasarCommands>
quasar build system <./quasarBuildSystem>
quasar commands <./quasarCommands>
User defined command line parameters <./UserDefinedCommandLineParameters>
User defined runtime configuration modification <./UserDefinedRuntimeConfigurationModification>
Windows setup <./WindowsSetup>
Expand All @@ -44,7 +44,7 @@ Quasar

.. toctree::
:hidden:
:caption: Quasar OpcUa Server
:caption: quasar OPC UA Servers

Summary of known quasar-based OPC-UA servers <./quasar_OPC_UA_servers>
Summary of known quasar-based OPC UA servers <./quasar_OPC_UA_servers>

8 changes: 4 additions & 4 deletions Documentation/source/quasarBuildSystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ quasar, quasar-based servers and the build system
=================================================

quasar is a framework for rapid and efficient development of
(quasar-based) OPC-UA servers in the C++ programming language. A build
(quasar-based) OPC UA servers in the C++ programming language. A build
system must accompany a framework like quasar to offload its users from
tasks like:

Expand Down Expand Up @@ -183,7 +183,7 @@ A build configuration file is a CMake script defining (typically using
the set() statement) the configuration of a build. The aspects typically
covered by build configs are:

- Path to OPC-UA stack (if used)
- Path to OPC UA stack (if used)
- Path to boost headers and libs and list of libraries to link against
if they cannot be automatically resolved. Note that by default, the
quasar cmake engine uses FindBoost to resolve boost header and lib
Expand All @@ -196,7 +196,7 @@ In addition, path(s) to cross-compilers and their sysroot(s) are often
specified there.

You can have (store) multiple build configuration files because one
OPC-UA server project might be built to suit requirements of different
OPC UA server project might be built to suit requirements of different
clients. For instance, you can have one build config for Windows Server
2012, one config for Windows 10, one config for Ubuntu and one for
cross-compiling for Raspian.
Expand Down Expand Up @@ -319,4 +319,4 @@ Recommendations to server developers
- Never modify the master CMakeLists.txt
- Put relevant settings to ProjectSettings.cmake
- Use as many build configurations as you need. It is common to reuse
build configurations between multiple OPC-UA server projects.
build configurations between multiple OPC UA server projects.
2 changes: 1 addition & 1 deletion Documentation/source/quasarCommands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ quasar.py commands help
build
-----

| This is the main command to build the project (a quasar-based OPC-UA
| This is the main command to build the project (a quasar-based OPC UA
server).
| Syntax:
Expand Down
20 changes: 10 additions & 10 deletions Documentation/source/yocto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Introduction

|
| This rather short how-to explains how to integrate a Quasar-based
OPC-UA server with Yocto.
OPC UA server with Yocto.
| Prerequisites:
- familiarity with Quasar: creating Quasar projects, working with
Expand All @@ -25,7 +25,7 @@ Introduction
| The how-to presented here has been attempted in:
- Yocto, different versions (including Rocko and Sumo),
- PetaLinux 2017.4, which uses Yocto behind the scenes, to build OPC-UA
- PetaLinux 2017.4, which uses Yocto behind the scenes, to build OPC UA
server for a PetaLinux-based project.
Note that only few points of those presented here will be of use for
PetaLinux integration, especially the recipes will be of value.
Expand All @@ -44,7 +44,7 @@ The terminology
(in this manual it was in the krogoth version). I cloned it from
Yocto git repo. I will call it **poky repo**.
- ~/gitProjects/poky-quasar
is where I will have my Quasar-based OPC-UA server project. I will
is where I will have my Quasar-based OPC UA server project. I will
call it **project repo**.

The procedure
Expand Down Expand Up @@ -201,7 +201,7 @@ Build core-image-minimal (in case it's your first Yocto build)

bitbake core-image-minimal

Create a new Yocto layer for your quasar OPC-UA server(s)
Create a new Yocto layer for your quasar OPC UA server(s)
---------------------------------------------------------

| From poky repo:
Expand All @@ -214,7 +214,7 @@ Create a new Yocto layer for your quasar OPC-UA server(s)

|
Deploy the Yocto recipe for your OPC-UA server
Deploy the Yocto recipe for your OPC UA server
----------------------------------------------

|
Expand Down Expand Up @@ -261,7 +261,7 @@ Deploy pygit2 if you want to have your build stamp embedded in the build (and av
----------------------------------------------------------------------------------------------------------

|
| If pygit2 is available at the OPC-UA server build time then later on,
| If pygit2 is available at the OPC UA server build time then later on,
from the address-space as well as command line you'll be able to check
which project commit has been used to produce the executable.
| In case you don't have pygit2 via your Yocto/PetaLinux you can use the
Expand Down Expand Up @@ -318,7 +318,7 @@ Deploy meta-openembedded layer to get some required Python modules
bitbake-layers add-layer ../meta-openembedded/meta-oe
bitbake-layers add-layer ../meta-openembedded/meta-python

Add your OPC-UA server artifacts to be installed on the target image
Add your OPC UA server artifacts to be installed on the target image
--------------------------------------------------------------------

|
Expand All @@ -336,7 +336,7 @@ Build the minimal image

bitbake core-image-minimal

| You can also build only the OPC-UA server:
| You can also build only the OPC UA server:
.. container::

Expand All @@ -353,7 +353,7 @@ Run the minimal image in qemu

| You should see your operating system bootin in qemu.
Run the OPC-UA server
Run the OPC UA server
---------------------

| Once you see login prompt in qemu, login as root.
Expand All @@ -369,7 +369,7 @@ Run the OPC-UA server
just edit (vi) the config file making sure that Configuration.xsd has
no path prefix**.
Connect to the OPC-UA server using UaExpert
Connect to the OPC UA server using UaExpert
-------------------------------------------

|
Expand Down

0 comments on commit 64ee331

Please sign in to comment.