Faactory.Channels.Teltonika 0.1.5

Channels - Teltonika Protocol

This project contains a set of Channels adapters to decode data encoded with Teltonika's protocol. The supported codecs for device data include

• Codec 8
• Codec 8 Extended
• Codec 16

The following codecs for communication are also supported

• Codec 12
• Codec 13
• Codec 14

NOTE: This library is still experimental and should not be used in production.

Learn more about Channels.

Getting started

Install the package from NuGet

dotnet add package Faactory.Channels.Teltonika

To enable decoding of Teltonika packets on the input pipeline, we just need to register the respective adapters with the channel pipeline. We do that with an extension method.

IChannelBuilder builder = ...;

builder.AddTeltonikaDecoderAdapters();

With the adapters in place, we need to implement our handlers to handle the correct data. The different kinds of data are

• Identity Data
• AVL Data
• Message Data

Identity Data

This is the first thing that a device sends and it contains the identifier for the device, typically its IMEI. The ModuleId is a struct with an implicit string operator.

Example of an identity handler

public class MyIdentityHandler : ChannelHandler<ModuleId>
{
    public override Task ExecuteAsync( IChannelContext context, ModuleId data )
    {
        // do whatever we need to do with the identifier
        bool isAllowed = someService.IsDeviceAllowed( data );

        // if we don't want to allow the device to communicate, we can close the channel
        if ( !isAllowed )
        {
            return context.Channel.CloseAsync();
        }

        return Task.CompletedTask;
    }
}

AVL Data

Contains telemetry data sent by the device. Since the base handler takes care of T <--> T[] mutation, we can choose to implement our handler with IAvlData[] or IAvlData.

Example of an AVL handler

public class MyDataHandler : ChannelHandler<IAvlData[]>
{
    public override Task ExecuteAsync( IChannelContext context, IAvlData[] data )
    {
        // do whatever we need to do
        return Task.CompletedTask;
    }
}

Message Data

Used for device-server communication, configuration, digital outputs control commands or other special purpose commands. Since the base handler takes care of T <--> T[] mutation, we can choose to implement our handler with IMessageData[] or IMessageData.

Example of a Message handler

public class MyMessageHandler : ChannelHandler<IMessageData[]>
{
    public override Task ExecuteAsync( IChannelContext context, IMessageData[] data )
    {
        // do whatever we need to do
        return Task.CompletedTask;
    }
}

This type of data can also be used for server-device communication. To enable this, we need to add the encoder adapter to the output pipeline as well.

IChannelBuilder builder = ...;

builder.AddOutputAdapter<MessageEncoderAdapter>();

We can then use the MessageBuilder to create custom messages and push it into the output pipeline. For example

// create a Codec 12 message
var codec12Message = MessageBuilder.Create( 0x05, customPayload );

// create a Codec 13 message
var codec13Message = MessageBuilder.Create( customPayload, DateTime.UtcNow );