Skip to main content
net5.0net6.0net7.0

Real-time communication framework for .NET using SignalR and the industrial IoT Middleware Codabix as backend. Using Codabix any IIoT Entity (PLCs, DBs, Files, Sockets, Ports, IOs ...) can be connected to each other just using Nodes. This package provides the API required to implement custom client applications using SignalR on top of WebSocket as the transport layer to connect to the communication data bridge for things (Codabix). Features: • Authentication using JSON Web Token • Create, Read, Update & Delete IIoT Entities • Setup new connection channels • Configure symbols, files, tables, ... • Subscribe change notifications • Read & Write Values of IIoT Entities • Directly from the Web to a device, file, table, ... • Using custom Human Machine Interfaces (HMI) • Visualize processes using historical data The whole framework is provided for free and can be used for commercial and non-commercial application development.

Published
Mar 6, 2024
2y ago
Total Downloads
5.4K
5,435

Install

dotnet add package Codabix.Web.SignalR --version 1.0.0-preview8-240306
ProductVersions
.NET
net5.0net6.0net7.0

README

Real-time communication framework for .NET using SignalR and the industrial IoT Middleware Codabix as backend. Using Codabix any IIoT Entity (PLCs, DBs, Files, Sockets, Ports, IOs ...) can be connected to each other just using Nodes.

This package provides the API required to implement custom client applications using SignalR on top of WebSocket as the transport layer to connect to the communication data bridge for things (Codabix).

Features:

  • Authentication using JSON Web Token
  • Create, Read, Update & Delete IIoT Entities
    • Setup new connection channels
    • Configure symbols, files, tables, ...
    • Subscribe change notifications
  • Read & Write Values of IIoT Entities
    • Directly from the Web to a device, file, table, ...
    • Using custom Human Machine Interfaces (HMI)
    • Visualize processes using historical data

The whole framework is provided for free and can be used for commerical and non-commerical application development.

Getting Started

At first you need an installed and running Codabix. Just go to https://www.codabix.com/en/downloads to get a latest evaluation version for free and without registration.

The most essential snippet to dig in:

using Codabix.Web.SignalR;
...
var client = new CodabixClient("http://localhost:8181", "username", "password");
await client.ConnectAsync();

// Your code to interact with Codabix.

Let's Read a Node

var response = await client.ReadNodeValueAsync("/Nodes/TestValue");

Let's Write a Node

var response = await client.WriteNodeValueAsync("/Nodes/TestValue", "Hello World!");

Let's Subscribe to value changes of a Node

var subscriptionParameters = new NodeValueSubscriptionParameters {
    Nodes = new string[] {
        "/Nodes/TestValue"
    }
};
var subscription = await client.SubscribeValueChangesAsync(subscriptionParameters);
while (await subscription.WaitToReadAsync()) {
    while (subscription.TryRead(out var eventArgs)) {
        Console.WriteLine(
            $"Node: {eventArgs.Node}, " +
            $"Old Value: {eventArgs.OldValue.Value}, " +
            $"New Value: {eventArgs.NewValue.Value}");
    }
}

Changes from Previous Version

v1.0.0-preview7-220822v1.0.0-preview8-240306
Added Frameworks
net7.0
Added Dependencies

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.No SPDX license expression is published. Review the license text and your organisation's policy before redistribution.Compatibility metadata lists 3 target frameworks; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.