Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derekgn/openthings
.net core library for encoding and decoding OpenThings messages
https://github.com/derekgn/openthings
dotnet openthings
Last synced: 2 days ago
JSON representation
.net core library for encoding and decoding OpenThings messages
- Host: GitHub
- URL: https://github.com/derekgn/openthings
- Owner: DerekGn
- License: mit
- Created: 2021-03-08T12:54:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T16:48:07.000Z (8 months ago)
- Last Synced: 2025-01-20T17:26:47.268Z (21 days ago)
- Topics: dotnet, openthings
- Language: C#
- Homepage:
- Size: 510 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenThings
[](https://dev.azure.com/DerekGn/GitHub/_build/latest?definitionId=4&branchName=main)
[](https://www.nuget.org/packages/OpenThings/)
A .net core library for encoding and decoding OpenThings messages. See [specification](https://github.com/DerekGn/OpenThings/blob/main/OpenThings%20Specification%5B2505%5D.pdf).
## Installing OpenThings
Install the OpenThings package via nuget package manager console:
``` cmd
Install-Package OpenThings
```
## Supported .Net Runtimes
The OpenThings package is compatible with the following runtimes:
* .NET Core 8.0
## Encoding
``` csharp
var messageHeader = new MessageHeader(0x55, 0xAA, 0x0000, 0xFEEDED);
var message = new Message(messageHeader);
message.Records.Add(
new MessageRecord(
new Parameter(OpenThingsParameter.Temperature),
new MessageRecordDataFloat(RecordType.UnsignedX4, 20.5f)));
message.Records.Add(
new MessageRecord(
new Parameter(OpenThingsParameter.Debug),
new MessageRecordDataString("TEST")));
message.Records.Add(
new MessageRecord(
new Parameter(OpenThingsParameter.Frequency),
new MessageRecordDataUInt(120)));
message.Records.Add(
new MessageRecord(
new Parameter(OpenThingsParameter.Level),
new MessageRecordDataInt(-50)));
List encodedMessageBytes = openthingsMessageEncoder.Encode(message);
// A random seed source for linear encrypt encryption
ushort seed = GetSeed();
// Alternatively apply linear shift encryption to message
List encodedMessageBytes = openthingsMessageEncoder.Encode(message, 0x45, seed);
```
## Decoding
``` csharp
// List of manufacturer Ids to PID's for linear shift decryption
List pidMaps = new List()
{
new PidMap(0xAA, 1)
}
List payload = GetPayloadFromSource();
var openthingsMessage = _decoder.Decode(payload, pidMaps);
Console.WriteLine($"Message: {openthingsMessage}");
```
## Adding Extended Parameters And Commands
The OpenThings specification specifies a number of parameter types out of the box, however there are situations when new parameters are required to be added to support a custom sensor type. There are a number of steps required to support additional parameter types encoding and decoding.
### Extend Parameter Identifiers
To support the encoding and decoding of custom parameter types first extend the **ParameterIdentifiers** base class and add the additional parameters.
``` csharp
internal class ExtendedParameterIdentifiers : ParameterIdentifiers
{
///
/// The devices battery voltage
///
public const byte BatteryVoltage = 0x7D;
///
/// The Indoor air quality
///
public const byte Iaq = 0x7E;
///
/// The estimated carbon dioxide level
///
public const byte eCo2 = 0x7F;
///
/// The equivalent ethanol level
///
public const byte EtOH = 0x80;
///
/// The total volatile organic compounds
///
public const byte TVOC = 0x81;
}
```
### Extend Commands
To support encoding of command type parameters extend the **DefaultCommands** type.
``` csharp
internal class ExtendedCommands : DefaultCommands
{
///
/// A command to execute the devices boot loader
///
public const byte ExecuteBootLoaderCommand = 0xFF;
}
```
### Extend Parameter Definitions
To support the encoding and decoding of custom parameter types the OpenThings library contains a collection of the default parameters called **DefaultParameters**. This class implements the interface **IParameters** interface.
Create a derived type from the **DefaultParameters** type and add the custom parameters to the collection via the **Add** method.
``` csharp
internal class ExtendedParameters : DefaultParameters
{
public ExtendedParameters()
{
Add(new Parameter(
ExtendedParameterIdentifiers.BatteryVoltage,
nameof(ExtendedParameterIdentifiers.BatteryVoltage), "V"));
Add(new Parameter(
ExtendedParameterIdentifiers.Iaq,
nameof(ExtendedParameterIdentifiers.Iaq), string.Empty));
Add(new Parameter(
ExtendedParameterIdentifiers.eCo2,
nameof(ExtendedParameterIdentifiers.eCo2), "ppm"));
Add(new Parameter(
ExtendedParameterIdentifiers.EtOH,
nameof(ExtendedParameterIdentifiers.EtOH), "ppm"));
Add(new Parameter(
ExtendedParameterIdentifiers.TVOC,
nameof(ExtendedParameterIdentifiers.TVOC), "mg/m^3"));
Add(new Parameter(
ExtendedCommands.ExecuteBootLoaderCommand,
nameof(ExtendedCommands.ExecuteBootLoaderCommand), string.Empty));
}
}
```
An instance of this custom ExtendedParameters type is then injected into the **OpenThingsDecoder** instance either directly or via a DI framework.