Location>code7788 >text

How to access the device via Tcp or UDP network components with the surging-based WoodenBoat platform

Popularity：277 ℃/2024-11-10 17:01:17

I. Overview

The previous article introduced the wooden boat through the HTTP network components to access the device, then this article will introduce how to use Tcp or UDP network components to access the device.

What is Kayak?

Kayak (Kayak) is based on .NET6.0 software environment surging microservices engine for development, the platform contains microservices and Internet of Things platform. Support for asynchronous and responsive programming development , the function contains a model of things , devices , products , network components of unified management and microservices platform under the registry , service routing , modules , intermediate services and other management. There are also multi-protocol adaptation (TCP, MQTT, UDP, CoAP, HTTP, Grpc, websocket, rtmp, httpflv, webservice, etc.), through a variety of flexible configurations adapted to access different manufacturers of different protocols and other equipment. And through the device alarms, message notification, data visualization and other functions. Enable you to quickly set up a microservice IoT platform system.

So here's how to go from creating components, protocols, and device gateways, devices to device gateway access, and then to device data reporting, putting the whole process through this article.

II. Network components

1. Edit the network components to create the Tcp protocol, you can choose between shared configuration and standalone configuration (standalone configuration is the cluster mode). The following figure is the parsing method selected custom script for decoding operations.

Other parsing options are also available: as shown below

2. Edit the network component that creates the UDP protocol. you can choose between shared configuration and standalone configuration (standalone configuration is cluster mode). You can choose unicast or multicast.

 

III. Customized protocols

  • How to create a custom protocol module

If the network programming and development, will inevitably involve the protocol message encoding and decoding processing, then for the platform is also done to deal with the flexibility, first of all, the protocol module to create, through the following code to see the protocol module can be added to the protocol description of the md document, identity authentication processing, message encoding and decoding, metadata configuration. The following one by one on how to write

 public class Demo3ProtocolSupportProvider : ProtocolSupportProvider
 { 
     public override IObservable<ProtocolSupport> Create(ProtocolContext context)
     {

         var support = new ComplexProtocolSupport();
          = "demo_3";
          = "Demo Protocol 3";
          = "Demo Protocol 3";
         (, new Demo5Authenticator());
         (, "Document/");
          = "\r\nvar decode=function(buffer)\r\n{\r\n (5).Handler(\r\n function(buffer){ \r\n var bytes = (buffer,1,4);\r\n var len = (bytes,1,4);//2. Get message length.\r\n var buf = (buffer,0,5); \r\n (len).Result(buf); \r\n }).Handler(function(buffer){ (buffer).Complete(); \r\n }\r\n )\r\n}\r\nvar encode=function(buffer)\r\n{\r\n}";       
         (, () => (new ScriptDeviceMessageCodec()));
         (, _tcpConfig);

         (, new Demo5Authenticator()); 
          = "\r\nvar decode=function(buffer)\r\n{\r\n (5).Handler(\r\n function(buffer){ \r\n var bytes = (buffer,1,4);\r\n var len = (bytes,1,4);//2. Get message length.\r\n var buf = (buffer,0,5); \r\n (len).Result(buf); \r\n }).Handler(function(buffer){ (buffer).Complete(); \r\n }\r\n )\r\n}\r\nvar encode=function(buffer)\r\n{\r\n}";
         (, () => (new ScriptDeviceMessageCodec()));
         (, _udpConfig);
         return (support);
     }
}

1. Add a protocol description document such as the following code. (, "Document/");, the document only supports the markdown file, as follows

 

### Authentication instructions

CONNECT message.
``text
clientId: device ID
password: md5(timestamp+"|"+secureKey)
 ```

 

2. Add authentication as follows. (, new Demo5Authenticator()) , custom authenticationThe Demo5Authenticator code is as follows:

 

public class Demo5Authenticator : IAuthenticator
       {
           public IObservable<AuthenticationResult> Authenticate(IAuthenticationRequest request, IDeviceOperator deviceOperator)
           {
               var result = <AuthenticationResult>(default);
               if (request is DefaultAuthRequest)
               {
                   var authRequest = request as DefaultAuthRequest;
                   (()==?"token": "key").Subscribe(  config =>
                   {
                       var password = <string>();
                       if ((password))
                       {
                           result= (());
                       }
                       else
                       {
                           result= ((StatusCode.CUSTOM_ERROR, "Authentication failed, wrong password"));
                       }
                   });
               }
               else
               result = <AuthenticationResult>((StatusCode.CUSTOM_ERROR, "Request parameter types are not supported"));
               return result;
           }

           public IObservable<AuthenticationResult> Authenticate(IAuthenticationRequest request, IDeviceRegistry registry)
           {
               var result = <AuthenticationResult>(default);
               var authRequest = request as DefaultAuthRequest;
               registry
                 .GetDevice()
                 .Subscribe(async p => {

                    var config=  await (() ==  ? "token" : "key");
                     var password= <string>();
                    if((password))
                     {
                         result= (());
                     }
                     else
                     {
                         result= ((StatusCode.CUSTOM_ERROR, "Authentication failed, wrong password"));
                     }
                 });
               return result;
           }
       }

 

3. Add message encoding and decoding code (, () => (new ScriptDeviceMessageCodec()));, can customize the codec.ScriptDeviceMessageCodecThe code is as follows:

 

using ;
using Jint;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using System;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;
using ;

namespace 
{
    public class ScriptDeviceMessageCodec : DeviceMessageCodec
    {
        public string GlobalVariable { get; private set; }
        public string EncoderScript { get; private set; }
        public string DecoderScript { get; private set; }
        public IObservable<Task<RulePipePayloadParser>> _rulePipePayload;
        private readonly ILogger<ScriptDeviceMessageCodec> _logger; 
        public ScriptDeviceMessageCodec(string script) {

            _logger = <ILogger<ScriptDeviceMessageCodec>>();
            RegexOptions options =  | ;
            string matchStr = (script, @"var\s*[\w$]*\s*\=.*function.*\(.*\)\s*\{[\s\S]*\}.*?v", options).Value;
            if (!string.IsNullOrEmpty(matchStr))
            {
                DecoderScript = ('v');
                DecoderScript= (DecoderScript, @"var\s*[\w$]*\s*\=[.\r|\n|\t|\s]*?(function)\s*\([\w$]*\s*\)\s*\{", "", );
                DecoderScript= (0, ('}'));
                EncoderScript = (DecoderScript, ""); 
               
            }
             var matchStr1 = (script, @"(?<=var).*?(?==)|(?=;)|(?=v)", options).FirstOrDefault(p=>!string.IsNullOrEmpty())?.Value;
            if (!string.IsNullOrEmpty(matchStr1))
            {
                GlobalVariable = (';');
            }
            var ruleWorkflow = new RuleWorkflow(DecoderScript);
            _rulePipePayload= ( GetParser( GetRuleEngine(ruleWorkflow), ruleWorkflow)); 
        }
        public override   IObservable<IDeviceMessage> Decode(MessageDecodeContext context)
        {
            var result = <IDeviceMessage>(null);
            _rulePipePayload.Subscribe(async p =>
            {
                var parser = await p;
                (().Payload);
                ().Subscribe(async p =>
                {
                    try
                    {
                        var headerBuffer=().FirstOrDefault();
                        var buffer = ().LastOrDefault();
                        var str = (, , Encoding.UTF8); 
                        var session = await ();
                        if (session?.GetOperator() == null)
                        {
                            var onlineMessage = <DeviceOnlineMessage>(str);
                            result = (onlineMessage);
                        }
                        else
                        {
                            var messageType = (0, 1, Encoding.UTF8);
                            if (<MessageType>(()) == MessageType.READ_PROPERTY)
                            {
                                var onlineMessage = <ReadPropertyMessage>(str);
                                result = (onlineMessage);
                            }
                            else if (<MessageType>(()) == )
                            {
                                var onlineMessage = <EventMessage>(str);
                                result = (onlineMessage);
                            }
                        }
                    }
                    catch (Exception e)
                    {

                    }
                    finally
                    {
                        ();
                        ();
                    }
                });
            });
            return result;
        }

        public override IObservable<IEncodedMessage> Encode(MessageEncodeContext context)
        {
            (((RespondDeviceMessage<IDeviceMessageReply>)).NewReply().Success(true));
            return <IEncodedMessage>();
        }

        private  GetRuleEngine(RuleWorkflow ruleWorkflow)
        {
            var reSettingsWithCustomTypes = new ReSettings { CustomTypes = new Type[] { typeof(RulePipePayloadParser) } };
            var result = new (new Workflow[] { () }, null, reSettingsWithCustomTypes);
            return result;
        }

        private async Task<RulePipePayloadParser> GetParser( engine, RuleWorkflow ruleWorkflow)
        {
            var payloadParser = new RulePipePayloadParser();
            var ruleResult = await (, , new RuleParameter[] { new RuleParameter("parser", payloadParser) });
            if ( != null && _logger.IsEnabled())
                _logger.LogError(, );
            return payloadParser;
        }
    }
}

 

4. Add metadata configuration code (, _tcpConfig);  _tcpConfigThe code is as follows.

 

        private readonly DefaultConfigMetadata _tcpConfig = new DefaultConfigMetadata(
        "TCP Authentication Configuration"
        , "key is the tcp authentication key")
        .Add("tcp_auth_key", "key", "TCP Authentication KEY", );

 

The _udpConfig code is as follows.

 

     private readonly DefaultConfigMetadata _udpConfig = new DefaultConfigMetadata(
     "udp authentication configuration"
     , "key is the udp authentication key")
     .Add("udp_auth_key", "key", "TCP Authentication KEY", );

 

  • How to load the protocol module, the protocol module contains the protocol module support custom scripts, add references, upload hot deployment load.

Custom Scripts, with Custom Script Parsing selected, will override message codecs if they are set up locally

 

Reference Load Module

Upload Heat Deployment Protocol Module

First publish the module using the following command:

Then package and upload the protocol module

 

IV. Equipment gateways

Creating a TCP Device Gateway

Creating a UDP Device Gateway

 

V. Product management

The following products are added.

 

Device Access

 

VI. Equipment management

Add Device

Tcp Authentication Configuration

Adding Alarm Thresholds

Event Definition

 

VII. Testing

Tcp test using the test tool to call thetcp://127.0.0.1:993As an example.

Test equipment on line

String: 293\0\0{"MessageType":2, "Headers":{"token": "123456"}, "DeviceId": "scro-34", "Timestamp":1726540220311}

Description: the first character indicates the type, the second indicates the length of the message content

Hexadecimal. 32393300007b224d65737361676554797065223a322c2248656164657273223a7b22746f6b656e223a22313233343536227d2c224465766963654964223a227363726f2d3334222c2254696d657374616d70223a313732363534303232303331317d

The results are as follows:

Test Reporting Properties

String: 195\0\0{"MessageType":1, "Properties":{"temp": "38.24"}, "DeviceId": "scro-34", "Timestamp":1726560007339}

Hexadecimal. 31393500007b224d65737361676554797065223a312c2250726f70657274696573223a7b2274656d70223a2233382e3234227d2c224465766963654964223a227373726f2d3334222c2254696d657374616d70223a313732363536303030373333397d

The results are as follows:

 

test event

String: 8307\0{"MessageType":8, "Data":{"deviceId": "scro-34", "level": "alarm", "alarmTime": "2024-11-07 19:47:00", "from": "device","" alarmType": "Device alarm", "coordinate": "33.345,566.33", "createTime": "2024-11-07 19:47:00", "desc": "Temperature exceeded threshold"}, "DeviceId": "scro-34", "EventId":" alarm", "Timestamp":1726540220311}

Hexadecimal. 38333037007b224d65737361676554797065223a382c2244617461223a7b226465766963654964223a227363726f2d3334222c226c6576656c223a22616c61726d222c22616c61726d54696d65223a22323032342d31312d30372031393a34373a3030222c2266726f6d223a22646576696365222c22616c61726d54797065223a22e8aebee5a487e5918ae8ada6222c22636f6f7264696e617465223a2233332e3334352c3536362e3333222c2263726561746554696d65223a22323032342d31312d30372031393a34373a3030222c2264657363223a22e6b8a9e5baa6e8b685e8bf87e99888e580bc227d2c224465766963654964223a227363726f2d3334222c224576656e744964223a22616c61726d222c2254696d657374616d70223a313732363534303232303331317d

The results are as follows:

Reported data can be seen in the Platform interface

Udp test using test tool to call udp://127.0.0.1:267 as an example.

Test equipment on line

String: 295\0\0{"MessageType":2, "Headers":{"token": "123456"}, "DeviceId": "srco-2555", "Timestamp":1726540220311}

Description: the first character indicates the type, the second indicates the length of the message content

Hexadecimal. 32393500007b224d65737361676554797065223a322c2248656164657273223a7b22746f6b656e223a22313233343536227d2c224465766963654964223a227372636f2d32353535222c2254696d657374616d70223a313732363534303232303331317d

The results are as follows:

 

Test Reporting Properties

String: 197\0\0{"MessageType":1, "Properties":{"temp": "38.24"}, "DeviceId": "srco-2555", "Timestamp":1726560007339}

Description: the first character indicates the type, the second indicates the length of the message content

Hexadecimal. 31393700007b224d65737361676554797065223a312c2250726f70657274696573223a7b2274656d70223a2233382e3234227d2c224465766963654964223a227372636f2d3235353522222c2254696d657374616d70223a313732363536303030373333397d

The results are as follows:

 

test event

String: 8301\0{"MessageType":8, "Data":{"deviceId": "srco-2555", "level": "alarm", "alarmTime": "2024-11-07 19:47:00", "from": "device","" alarmType": "Device alarm", "coordinate": "33.345,566.33", "createTime": "2024-11-07 19:47:00", "desc": "Temperature exceeded threshold"}, "DeviceId": "srco-2555", "EventId" : "alarm", "Timestamp":1726540220311}

Description: the first character indicates the type, the second indicates the length of the message content

Hexadecimal. 38333031007b224d65737361676554797065223a382c2244617461223a7b226465766963654964223a227372636f2d32353535222c226c6576656c223a22616c61726d222c22616c61726d54696d65223a22323032342d31312d30372031393a34373a3030222c2266726f6d223a22646576696365222c22616c61726d54797065223a22e8aebee5a487e5918ae8ada6222c22636f6f7264696e617465223a2233332e3334352c3536362e3333222c2263726561746554696d65223a22323032342d31312d30372031393a34373a3030222c2264657363223a22e6b8a9e5baa6e8b685e8bf87e99888e580bc227d2c224465766963654964223a227372636f2d32353535222c224576656e744964223a22616c61726d222c2254696d657374616d70223a313732363534303232303331317d

The results are as follows:

Reported data can be seen in the Platform interface

 

VII. Summary

The above is based on Tcp and UDP network components device access, the existing platform network components can support TCP, MQTT, UDP, CoAP, HTTP, Grpc, websocket, rtmp, httpflv, webservice, tcpclient, while the device access to support TCP, UDP, HTTP network components. Before the year try to complete the national standard 28181 and MQTT, will also begin to start the development of rules engine, and then scheduled for November 20, released 1.0 beta platform. Please pay attention to the show.

 

 

<Previous Next>