Forráskód Böngészése

update the documenttion for 0.3

Julius Pfrommer 7 éve
szülő
commit
7bc620432e
2 módosított fájl, 18 hozzáadás és 20 törlés
  1. 9 7
      README.md
  2. 9 13
      doc/index.rst

+ 9 - 7
README.md

@@ -38,16 +38,15 @@ Features currently being implemented:
 - Target 0.3 release (to be released in the coming weeks):
 - Target 0.3 release (to be released in the coming weeks):
   - Secure communication with encrypted messages (Done)
   - Secure communication with encrypted messages (Done)
   - Access control for individual nodes (Done)
   - Access control for individual nodes (Done)
+  - Asynchronous service requests in the client (Done)
 - Target 0.4 release:
 - Target 0.4 release:
   - Events (notifications emitted by objects, data change notifications are implemented), WIP by @Pro
   - Events (notifications emitted by objects, data change notifications are implemented), WIP by @Pro
-  - Event-loop (background tasks) and asynchronous service requests in the client, WIP #1117 #1410
+  - Event-loop (background tasks) in the client
   - Publish/Subscribe based on UDP (Specification Part 14), WIP @ Fraunhofer IOSB
   - Publish/Subscribe based on UDP (Specification Part 14), WIP @ Fraunhofer IOSB
 
 
 ### Dependencies
 ### Dependencies
 
 
-None.
-
-On a more serious note, on most systems, open62541 requires the C standard library only. For dependencies during the build process, see the following list and the [build documentation](https://open62541.org/doc/current/building.html) for details.
+On most systems, open62541 requires the C standard library only. For dependencies during the build process, see the following list and the [build documentation](https://open62541.org/doc/current/building.html) for details.
 
 
 - Core Library: The core library has no dependencies besides the C99 standard headers.
 - Core Library: The core library has no dependencies besides the C99 standard headers.
 - Default Plugins: The default plugins use the POSIX interfaces for networking and accessing the system clock. Ports to different (embedded) architectures are achieved by customizing the plugins.
 - Default Plugins: The default plugins use the POSIX interfaces for networking and accessing the system clock. Ports to different (embedded) architectures are achieved by customizing the plugins.
@@ -64,17 +63,20 @@ We emphasize code quality. The following quality metrics are continuously checke
 - Zero unresolved issues from fuzzing the library in Google's oss-fuzz infrastructure
 - Zero unresolved issues from fuzzing the library in Google's oss-fuzz infrastructure
 - Zero issues indicated by Valgrind (Linux), DrMemory (Windows) and Clang AddressSanitizer / MemorySanitizer for the CTT tests, unit tests and fuzzing
 - Zero issues indicated by Valgrind (Linux), DrMemory (Windows) and Clang AddressSanitizer / MemorySanitizer for the CTT tests, unit tests and fuzzing
 
 
-### Using open62541
+### Documentation and Support
 
 
 A general introduction to OPC UA and the open62541 documentation can be found at http://open62541.org/doc/current.
 A general introduction to OPC UA and the open62541 documentation can be found at http://open62541.org/doc/current.
 Past releases of the library can be downloaded at https://github.com/open62541/open62541/releases.
 Past releases of the library can be downloaded at https://github.com/open62541/open62541/releases.
 To use the latest improvements, download a nightly build of the *single-file distribution* (the entire library merged into a single source and header file) from http://open62541.org/releases. Nightly builds of MSVC binaries of the library are available [here](https://ci.appveyor.com/project/open62541/open62541/build/artifacts).
 To use the latest improvements, download a nightly build of the *single-file distribution* (the entire library merged into a single source and header file) from http://open62541.org/releases. Nightly builds of MSVC binaries of the library are available [here](https://ci.appveyor.com/project/open62541/open62541/build/artifacts).
 
 
-For discussion and help, you can use
+For individual discussion and support, use the following channels
+
 - the [mailing list](https://groups.google.com/d/forum/open62541)
 - the [mailing list](https://groups.google.com/d/forum/open62541)
 - our [IRC channel](http://webchat.freenode.net/?channels=%23open62541)
 - our [IRC channel](http://webchat.freenode.net/?channels=%23open62541)
 - the [bugtracker](https://github.com/open62541/open62541/issues)
 - the [bugtracker](https://github.com/open62541/open62541/issues)
 
 
+or contact a member of the core development group (see below).
+
 ### Development
 ### Development
 
 
 Besides the general open62541 community, a group of core maintainers jointly steers the long-term development. The current core maintainers are (as of Mai 2017, in alphabetical order):
 Besides the general open62541 community, a group of core maintainers jointly steers the long-term development. The current core maintainers are (as of Mai 2017, in alphabetical order):
@@ -84,7 +86,7 @@ Besides the general open62541 community, a group of core maintainers jointly ste
 - Julius Pfrommer (Fraunhofer IOSB, Karlsruhe)
 - Julius Pfrommer (Fraunhofer IOSB, Karlsruhe)
 - Stefan Profanter (fortiss, Munich)
 - Stefan Profanter (fortiss, Munich)
 
 
-As an open source project, we encourage new contributors to help improve open62541. There are ways to begin contributing without deep knowledge of the OPC UA standard:
+As an open source project, we encourage new contributors to help improve open62541. The following are good starting points for new contributors:
 - [Report bugs](https://github.com/open62541/open62541/issues)
 - [Report bugs](https://github.com/open62541/open62541/issues)
 - Improve the [documentation](http://open62541.org/doc/current)
 - Improve the [documentation](http://open62541.org/doc/current)
 - Work on issues marked as "[good first issue](https://github.com/open62541/open62541/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)"
 - Work on issues marked as "[good first issue](https://github.com/open62541/open62541/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)"

+ 9 - 13
doc/index.rst

@@ -36,7 +36,7 @@ At its core, OPC UA defines
   response message in the protocol type system.
   response message in the protocol type system.
 
 
 The standard itself can be purchased from IEC or downloaded for free on the
 The standard itself can be purchased from IEC or downloaded for free on the
-website of the OPC Foundation at https://opcfoundation.org/ (you only need to
+website of the OPC Foundation at https://opcfoundation.org/ (you need to
 register with a valid email).
 register with a valid email).
 
 
 The OPC Foundation drives the continuous improvement of the standard and the
 The OPC Foundation drives the continuous improvement of the standard and the
@@ -55,23 +55,20 @@ server SDK. It currently supports the Micro Embedded Device Server Profile plus
 some additional features. Server binaries can be well under 100kb in size,
 some additional features. Server binaries can be well under 100kb in size,
 depending on the contained information model.
 depending on the contained information model.
 
 
-open62541 adheres to the OPC UA specification as closely as possible and the
-released features pass the official Conformance Testing Tools (CTT). However,
-the library comes without any warranty. If you intend to use OPC UA in a
-mission-critical product, please consider talking to a commercial vendor of OPC
-UA SDKs and services.
-
 - Communication Stack
 - Communication Stack
 
 
   - OPC UA binary protocol
   - OPC UA binary protocol
   - Chunking (splitting of large messages)
   - Chunking (splitting of large messages)
   - Exchangeable network layer (plugin) for using custom networking APIs (e.g. on embedded targets)
   - Exchangeable network layer (plugin) for using custom networking APIs (e.g. on embedded targets)
+  - Encrypted communication
+  - Asynchronous service requests in the client
 
 
 - Information model
 - Information model
 
 
   - Support for all OPC UA node types (including method nodes)
   - Support for all OPC UA node types (including method nodes)
   - Support for adding and removing nodes and references also at runtime.
   - Support for adding and removing nodes and references also at runtime.
   - Support for inheritance and instantiation of object- and variable-types (custom constructor/destructor, instantiation of child nodes)
   - Support for inheritance and instantiation of object- and variable-types (custom constructor/destructor, instantiation of child nodes)
+  - Access control for individual nodes
 
 
 - Subscriptions
 - Subscriptions
 
 
@@ -83,12 +80,11 @@ UA SDKs and services.
   - Support for generating data types from standard XML definitions
   - Support for generating data types from standard XML definitions
   - Support for generating server-side information models (nodesets) from standard XML definitions
   - Support for generating server-side information models (nodesets) from standard XML definitions
 
 
-Features still missing in the 0.2 release are:
+Features on the roadmap for the 0.3 release series but missing in the initial v0.3 release are:
 
 
-- Encryption
-- Access control for individual nodes
+- Encrypted communication in the client
 - Events (notifications emitted by objects, data change notifications are implemented)
 - Events (notifications emitted by objects, data change notifications are implemented)
-- Event-loop (background tasks) and asynchronous service requests in the client
+- Event-loop (background tasks) in the client
 
 
 Getting Help
 Getting Help
 ------------
 ------------
@@ -103,8 +99,8 @@ Contributing
 ------------
 ------------
 
 
 As an open source project, we invite new contributors to help improve open62541.
 As an open source project, we invite new contributors to help improve open62541.
-Issue reports, bugfixes and new features are very welcome. Note that there are
-ways to begin contributing without deep knowledge of the OPC UA standard:
+Issue reports, bugfixes and new features are very welcome. The following are
+good starting points for new contributors:
 
 
 - `Report bugs <https://github.com/open62541/open62541/issues>`_
 - `Report bugs <https://github.com/open62541/open62541/issues>`_
 - Improve the `documentation <http://open62541.org/doc/current>`_
 - Improve the `documentation <http://open62541.org/doc/current>`_