Skip to content

Commit

Permalink
build based on 8c1f0a9
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 17, 2024
1 parent c2b473a commit 264da7c
Show file tree
Hide file tree
Showing 12 changed files with 366 additions and 366 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-06-14T15:59:18","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-06-17T21:22:21","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · Open62541.jl</title><meta name="title" content="Introduction · Open62541.jl"/><meta property="og:title" content="Introduction · Open62541.jl"/><meta property="twitter:title" content="Introduction · Open62541.jl"/><meta name="description" content="Documentation for Open62541.jl."/><meta property="og:description" content="Documentation for Open62541.jl."/><meta property="twitter:description" content="Documentation for Open62541.jl."/><meta property="og:url" content="https://martinkosch.github.io/Open62541.jl/"/><meta property="twitter:url" content="https://martinkosch.github.io/Open62541.jl/"/><link rel="canonical" href="https://martinkosch.github.io/Open62541.jl/"/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>Open62541.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Introduction</a><ul class="internal"><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li><li><a class="tocitem" href="#Structure-of-the-documentation"><span>Structure of the documentation</span></a></li></ul></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="tutorials/server_first_steps/">First steps: Server</a></li><li><a class="tocitem" href="tutorials/client_first_steps/">First steps: Client</a></li><li><a class="tocitem" href="tutorials/combined_variables/">Adding and reading/writing variables</a></li></ul></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="manual/numbertypes/">Supported number types</a></li><li><a class="tocitem" href="manual/nodeid/">Nodeid</a></li><li><a class="tocitem" href="manual/attributegeneration/">Attribute generation</a></li><li><a class="tocitem" href="manual/server/">Server</a></li><li><a class="tocitem" href="manual/client/">Client</a></li></ul></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="reference_lowlevel/">Low level interface</a></li><li><a class="tocitem" href="reference_highlevel/">High level interface</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/martinkosch/Open62541.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/martinkosch/Open62541.jl/blob/main/docs/src/index.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Open62541.jl"><a class="docs-heading-anchor" href="#Open62541.jl">Open62541.jl</a><a id="Open62541.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Open62541.jl" title="Permalink"></a></h1><p>Welcome to the documentation of Open62541.jl. </p><p>Open62541.jl is a <a href="https://julialang.org">Julia</a> package that interfaces with the <a href="https://www.open62541.org/">open62541</a> library written in C (<a href="https://github.com/open62541/open62541">source</a>).</p><p>As such, it provides functionality following the <a href="https://en.wikipedia.org/wiki/OPC_Unified_Architecture">OPC Unified Architecture (OPC UA) standard</a> for data exchange from sensors to cloud applications developed by the <a href="https://opcfoundation.org/">OPC Foundation</a>.</p><p>In short, it provides the ability to create OPC servers that make data from different sources available to clients and, naturally, also a client functionality that allows to read data from OPC UA servers. Features are summarized further on the <a href="https://www.open62541.org/">open62541 website</a>.</p><p>Open62541.jl&#39;s <em>ultimate</em> aim is to provide the full functionality of open62541 to Julia users through a convenient high level interface without the need to engage in manual memory management etc. (as required in open62541).</p><p>At its current development stage the high level interface is implemented for a (commonly used) subset of functionality. An essentially feature-complete lower level interface that wraps all functionality of open62541 is, however, available.</p><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>Note that Open62541.jl is still under active development and has not reached a maturity that would make it safe to use in a production environment.</p><p>The developers aim to observe <a href="https://semver.org/">semantic versioning</a>, but accidental breakage and evolutions of the API have to be expected.</p></div></div><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>Open62541.jl is registered in Julia&#39;s General registry.</p><p>Assuming you have Julia already installed (otherwise: <a href="https://julialang.org/">JuliaLang Website</a>), you can install Open62541.jl by executing:</p><pre><code class="language-julia hljs">using Pkg
Pkg.add(&quot;Open62541&quot;)</code></pre><h2 id="Structure-of-the-documentation"><a class="docs-heading-anchor" href="#Structure-of-the-documentation">Structure of the documentation</a><a id="Structure-of-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-the-documentation" title="Permalink"></a></h2><p>The documentation has the following structure:</p><ul><li>Tutorials: Provides a few brief instructions that showcase basic functionality. </li><li>Manual: Currently only slightly more than a reference, but intended to be more explanatory than the reference.</li><li>Reference: Low level interface: Contains a list of functions and types that ship with open62541.</li><li>Reference: High level interface: Contains a list of functions and types that constitute the higher level interface generated for Open62541.jl.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The documentation is still a work in progress. To be concrete, many functions within src/Open62541.jl are still without docstrings. These are thin wrappers to functions in open62541 generated through Clang.jl. Therefore, users who are familiar with open62541 should be aware of the functions; users unfamilar with open62541 will have to resort to the source code for the time being.</p><p>Docstrings will be added (pull requests welcome!).</p><p>The docstring situation is better on the handwritten functions contained in the other source files.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/server_first_steps/">First steps: Server »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Friday 14 June 2024 15:59">Friday 14 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Pkg.add(&quot;Open62541&quot;)</code></pre><h2 id="Structure-of-the-documentation"><a class="docs-heading-anchor" href="#Structure-of-the-documentation">Structure of the documentation</a><a id="Structure-of-the-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-the-documentation" title="Permalink"></a></h2><p>The documentation has the following structure:</p><ul><li>Tutorials: Provides a few brief instructions that showcase basic functionality. </li><li>Manual: Currently only slightly more than a reference, but intended to be more explanatory than the reference.</li><li>Reference: Low level interface: Contains a list of functions and types that ship with open62541.</li><li>Reference: High level interface: Contains a list of functions and types that constitute the higher level interface generated for Open62541.jl.</li></ul><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The documentation is still a work in progress. To be concrete, many functions within src/Open62541.jl are still without docstrings. These are thin wrappers to functions in open62541 generated through Clang.jl. Therefore, users who are familiar with open62541 should be aware of the functions; users unfamilar with open62541 will have to resort to the source code for the time being.</p><p>Docstrings will be added (pull requests welcome!).</p><p>The docstring situation is better on the handwritten functions contained in the other source files.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/server_first_steps/">First steps: Server »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 17 June 2024 21:22">Monday 17 June 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 264da7c

Please sign in to comment.