Repository files navigation

HARDWARIO .NET SDK project is here to help you with creating your custom application around the HARDWARIO ecosystem of IoT devices and services.

This SDK focuses to .NET C# developers mainly, but thanks to the simplicity and readibility of the C# it can help to programmers who uses different languages as well.

SDK consists of several libraries and example projects which will be described below. Here is screenshot of one of the example application you can find in this SDK:

Please note that HARDWARIO .NET SDK is still under the development. We are happy to receive tips and bugreports if you would like to help us.

HARDWARIO .NET SDK is created inVisual Studio 2022 (tested in actual Version 17.12.1) with.NET 8 (updated to .NET 9 is in roadmap).

Compilation and building MAUI applications for Android requires Installlation ofAndroid SDK.

We recommend to use Windows machine for the development, but project can be build on MacOS and Linux as well because the .NET 8 is multiplatform framework. Applications written in .NET 8 C# can run on all platforms (Windows, MacOS, Linux).MAUI Applications can run also on Android and iOS devices.

UI Library usesRadzen Component Library. More information about the using this component library you can find inReadme file for Hio-DotNet UI Component Library.

WebAssembly applications demos are part of the demo projects. You can run them in most of the modern web browsers without having the active web server. You need just webhosting for this type of applications. We usually test them in Chrome browser or Edge browser.

First step is to clone the repository to some local folder in your computer. You can do it with the command:

git clone https://github.com/hardwario/hio-dotnet.git

Then you can enter the project folder:

cd hio-dotnet

where you will find the hio-dotnet.sln solution file. This file can be opened in the Visual Studio 2022.

There are multiple demo applications. One of them is simple console application with multiple partial demos how to use parts of the SDK. All partial demos are turned off in default and you need to allow one or multiple of them by setting the proper variable to "true". Then you can run the build with command:

dotnet run --project "hio-dotnet.Demos.SimpleConsoleApp/hio-dotnet.Demos.SimpleConsoleApp.csproj" --configuration Debug

As it is written above, the project has no sub-demo allowed by default so if you will not change it in theProgram.cs it will just write this (in case you are running it on Windows machine):

Running on WindowsProgram ends. Goodbye

To discover more about the parts of theSimple Console App Demo Please Continue with reading Here.

There are multiple projects in the solution:

• hio-dotnet.Demos.BlazorComponents.RadzenLib.WASM - Example WebAssembly app with the UI components with use of the Radzen Component Library
• hio-dotnet.Demos.BlazorComponents.WASM - Example WebAssembly app with the own basic UI components
• hio-dotnet.Demos.HardwarioManager - Example MAUI Blazor Hybrid App for phones which can search for and connect toCHESTER device and communicate with it
• hio-dotnet.Demos.HardwarioMonitor - Example MAUI Blazor Hybrid App for desktop which can search and connectSEGGER JLink programmer,Nordic Semiconductor Power Profiler Kit II and connect the CHESTER device.
• hio-dotnet.Demos.SimpleConsoleApp - Simple console application with examples of using parts of the HARDWARIO .NET SDK.
• hio-dotnet.Demos.SimpleDriversServer - Simple backend server with HW related drivers
• hio-dotnet.Demos.WSSessionServer - Server that creates sessions and transfer data for remote acess of shell for HARDWARIO Monitor

• hio-dotnet.APIs.HioCloudv2 - Wrapper library for Official HARDWARIO Cloud version 2 API.
• hio-dotnet.APIs.Chirpstack - Wrapper library forChirpstack LoRaWAN network Server API
• hio-dotnet.APIs.ThingsBoard - Wrapper library forThingsBoard Application API
• hio-dotnet.APIs.Wmbusmeters - Wrapper library for HARDWARIO instance ofwmbusmeters application running on our server.

There are two basic UI Components library project in the HARDWARIO .NET SKD. One shows how you can create own wrappers for components to create own component library from scratch. Second (main) uses already existing component library calledRadzen to simplify the creating nice smooth responsive UIs.

• hio-dotnet.UI.BlazorComponents - own UI components build from scratch
• hio-dotnet.UI.BlazorComponents.RadzenLib - UI components build with use of Radzen component library

• hio-dotnet.Common - basic models, helpers and classes usefull across all other projects, this project includes models of allCHESTER Catalog Applications output data models and other usefull classes.
• hio-dotnet.HWDrivers - hardware dependent drivers such asSEGGER JLink andNordic Semiconductors Power Profiler Kit II
• hio-dotnet.PhoneDrivers - library with phone dependend drivers such as Bluetooth Low Energy driver.
• hio-dotnet.LibSerialPort - wrapper for LibSerialPort.

• hio-dotnet.Tests.Common - main test project with use ofxUnit test framework.

This project is under standardMIT license.

We welcome any contribution to the project. There are multiple ways how to contribute:

• Testing and creating issues for bugs or features.
• Improving the library with pull requests
• Bringing ideas for new features

If you need help please feel free to contact us viaform on our website.