OpcUaFileServer/README.rst at master · ASNeG/OpcUaFileServer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
OpcUaFileServer
===========

OpcUaFileServer is an OPC UA application based on `ASNeG OPC UA Stack`_.


Requirements
------------

* ANSeG OPC UA Stack >= 4.0.0
* CMake
* C++ compiler with C++11 support


Installing
----------

Before install OpcUaFileServer you must install `ASNeG OPC UA Stack`_.
See `this tutorial <https://opcuastack.readthedocs.io/en/latest/1_getting_started/installation.html>`_
for more information. Then type the following command:

**On Linux**

::

  $ sh build.sh -t local -i ~/.ASNeG


**On Windows**

::

  $ build.bat -t local -i C:\\ASNeG


Usage
-----

Having installed OpcUaFileServer locally, you can run it by using the following command:

**On Linux**

::

  $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${HOME}/.ASNeG/usr/lib
  $ OpcUaServer4 ~/.ASNeG/etc/OpcUaStack/OpcUaFileServer/OpcUaServer.xml

**On Windows**

::

  $ set PATH=%PATH%;C:\ASNeG\lib
  $ OpcUaServer4 CONSOLE C:\ASNeG\etc\OpcUaStack\OpcUaFileServer\OpcUaServer.xml


Also you can use Docker without installing any dependencies:

::

  $ docker build -t OpcUaFileServer:latest .
  $ docker run -d -p 4840:4840 OpcUaFileServer:latest


Documentaion
------------

OpcUaFileServer uses `Sphinx`_ to generate its documentation and it is ready for hosting on `RTD`_.
You can build the documentation locally. For that you should `install Sphinx <http://www.sphinx-doc.org/en/master/usage/installation.html>`_
on your machine with Pyhton and `Doxygen <http://www.doxygen.nl/manual/install.html>`_ .Then run the following command from the root directory of the project:

::

  $ cd docs
  $ pip install -r requirements.txt
  $ make html

The generated HTML files you can find in **build/html** directory.


References
----------

* `ASNeG OPC UA Stack`_
* `Hello World Example`_ with ASNeG OPC UA Stack
* `Sphinx`_ Documentation Generator


.. _`ASNeG OPC UA Stack`: https://asneg.github.io/projects/opcuastack
.. _`Hello World Example`: https://opcuastack.readthedocs.io/en/latest/1_getting_started/hello_world.html
.. _`Sphinx`: http://www.sphinx-doc.org/en/master/
.. _`RTD`: https://readthedocs.org/