node-red-contrib-opcua-server
Version:
Node-RED contribution nodes with next generation OPC UA in a compact and less dependencies package.
256 lines (174 loc) • 7.71 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Documentation Index</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">Documentation</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<section class="readme-section">
<article><p><img src="https://img.shields.io/badge/Platform-Node--RED-red.png" alt="Platform Node-RED">
<img src="http://b.repl.ca/v1/Contrib-OPC--UA-blue.png" alt="Contrib OPC UA">
<img src="https://img.shields.io/badge/License-MIT-orange.png" alt="License">
<a href="https://www.npmjs.com/package/node-red-contrib-opcua-server"><img src="https://badge.fury.io/js/node-red-contrib-opcua-server.png" alt="NPM version"></a>
<img src="https://img.shields.io/badge/NodeJS-14.19.1-green.png" alt="NodeJS_Version">
<a href="http://standardjs.com/"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="Standard - JavaScript Style Guide"></a>
<a href="https://www.npmtrends.com/node-red-contrib-iiot-opcua"><img src="https://img.shields.io/npm/dm/node-red-contrib-iiot-opcua.svg" alt="NPM download"></a>
<a href="https://github.com/BiancoRoyal/node-red-contrib-opcua-server"><img src="http://b.repl.ca/v1/Repository-GitHub-orange.png" alt="Repository GitHub"></a>
<a href="https://github.com/BiancoRoyal/node-red-contrib-opcua-server/actions/workflows/build.yml"><img src="https://github.com/BiancoRoyal/node-red-contrib-opcua-server/actions/workflows/build.yml/badge.svg" alt="Build and publish"></a>
<a href="https://www.codacy.com/gh/BiancoRoyal/node-red-contrib-opcua-server/dashboard?utm_source=github.com&utm_medium=referral&utm_content=BiancoRoyal/node-red-contrib-opcua-server&utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/b229fe21da624408b51d075e8e0800cc" alt="Codacy Badge"></a></p>
<h1>node-red-contrib-opcua-server</h1>
<p>A programmable OPC UA server for Node-RED based on node-opcua next generation version with less dependencies.</p>
<h2>Core</h2>
<p>using next generation node-opcua version from <a href="https://github.com/erossignon/">Etienne Rossignon</a></p>
<h2>Install</h2>
<p>Run the following command in your Node-RED user directory - typically <code>~/.node-red</code></p>
<pre><code> npm install node-red-contrib-opcua-server
</code></pre>
<p>try these options on npm install to build from source if you have problems to install</p>
<pre><code> --unsafe-perm --build-from-source
</code></pre>
<h2>Debug</h2>
<p>Debugging on remote devices is important to help users. The verbose logging
provides interesting points in different abstractions if IDE or console debugging is not possible.</p>
<p>Start debug with Node-RED in verbose (-v) mode to get a verbose logging:</p>
<pre><code>DEBUG=opcuaCompact* node-red -v 1>Node-RED-OPC-UA-Server.log 2>&1
</code></pre>
<p>or on local Node-RED</p>
<pre><code>DEBUG=opcuaCompact* node red.js -v 1>Node-RED-OPC-UA-Server.log 2>&1
</code></pre>
<h2>Code Style</h2>
<p>Prettier</p>
<h2>Contribution</h2>
<p><strong>Yes, sure!</strong> Please help us to make it even better and send your pull requests or tests!</p>
<h4>Happy coding!</h4>
<h2>License</h2>
<p>based on node-opcua we use MIT license
Copyright (c) 2019 <a href="https://github.com/BiancoRoyal/">Bianco Royal Software Innovations®</a></p></article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
on July 31st 2022, 9:14:52 pm
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>