IoTHubClientGeneratorSDK 0.1.7

There is a newer version of this package available.
See the version list below for details.
dotnet add package IoTHubClientGeneratorSDK --version 0.1.7                
NuGet\Install-Package IoTHubClientGeneratorSDK -Version 0.1.7                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IoTHubClientGeneratorSDK" Version="0.1.7" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IoTHubClientGeneratorSDK --version 0.1.7                
#r "nuget: IoTHubClientGeneratorSDK, 0.1.7"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install IoTHubClientGeneratorSDK as a Cake Addin
#addin nuget:?package=IoTHubClientGeneratorSDK&version=0.1.7

// Install IoTHubClientGeneratorSDK as a Cake Tool
#tool nuget:?package=IoTHubClientGeneratorSDK&version=0.1.7                

A pre-release version of the IoT Hub Client Generator library. This is a C# code generation attribute library that makes it very easy to create an Azure IoT Client.

V0.1.7:

  • Remove EnrollmentGroupId property from DeviceDPSAtributes
  • FIx the Readme.MD file with the latest changes of V0.1.6

V0.1.6:

  • This release fixed some issues and added the ability to use variables' values in attribute properties: Example for the new option:
private static string CSFromVar="fgserg3456tesrg";
[Device(ConnectionString="[CSFromVar]"] DeviceClient DeviceClient {get;set;}

An example (A full client with Twin properties and messages):

using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using IoTHubClientGeneratorSDK;
using Microsoft.Azure.Devices.Client;
using Microsoft.Azure.Devices.Client.Exceptions;
using Microsoft.Azure.Devices.Client.Transport.Mqtt;

namespace IoTHubClientGeneratorDemo
{
    class Program
    {
        static async Task Main()
        {
            IoTHubClient iotHubClient = new IoTHubClient();
            await iotHubClient.InitIoTHubClientAsync();
            await iotHubClient.RunSampleAsync(TimeSpan.FromMinutes(5));
        }
    }

    [IoTHub(GeneratedSendMethodName = "SendTelemetryAsync")]
    public partial class IoTHubClient
    {
        private static readonly Random RandomGenerator = new();
        private const int TemperatureThreshold = 30;
        private static readonly TimeSpan SleepDuration = TimeSpan.FromSeconds(5);

        [Device(ConnectionString = "%connectionString%")]
        public DeviceClient DeviceClient { get; set; }

        //desired property are created and managed by the source generator
        [Desired("valueFromTheCloud")] private string DesiredPropertyDemo { get; set; }
        [Desired] private string DesiredPropertyAutoNameDemo { get; set; }
        [Reported("valueFromTheDevice")] private string _reportedPropertyDemo;
        [Reported("ReportedPropertyAutoNameDemo", "reportedPropertyAutoNameDemo")] private string _reportedPropertyAutoNameDemo;

        [ConnectionStatus] 
        private (ConnectionStatus Status, ConnectionStatusChangeReason Reason) DeviceConnectionStatus { get; set; }
        
        [IoTHubErrorHandler]
        void IoTHubErrorHandler(string errorMessage, Exception exception)
        {
        if(exception is IotHubException {IsTransient: true})
        {
                Console.WriteLine($"An IotHubException was caught, but will try to recover and retry: {exception}");
        }
        if (ExceptionHelper.IsNetworkExceptionChain(exception))
        {
            Console.WriteLine(
                $"A network related exception was caught, but will try to recover and retry: {exception}");
        }
        Console.WriteLine($"{errorMessage}, Exception: {exception.Message}");
        }
        
        [C2DMessage(AutoComplete = true)]
        private async Task OnC2dMessageReceived2(Message receivedMessage)
        {
            Console.WriteLine(
                $"{DateTime.Now}> C2D message callback - message received with Id={receivedMessage.MessageId}.");

            //do something with the message
        }

        [DirectMethod]
        private Task<MethodResponse> WriteToConsoleAsync(MethodRequest methodRequest)
        {
            Console.WriteLine($"\t *** {methodRequest.Name} was called.");
            Console.WriteLine($"\t{methodRequest.DataAsJson}\n");

            return Task.FromResult(new MethodResponse(new byte[0], 200));
        }
        
        [DirectMethod(CloudMethodName = "TestMethod")]
        private Task<MethodResponse> WriteToConsole2Async(MethodRequest methodRequest)
        {
            Console.WriteLine($"\t *** {methodRequest.Name} was called.");
            Console.WriteLine($"\t{methodRequest.DataAsJson}\n");

            return Task.FromResult(new MethodResponse(new byte[0], 200));
        }
        
        private async Task SendMessagesAsync(CancellationToken cancellationToken)
        {
            int messageCount = 0;

            while (!cancellationToken.IsCancellationRequested)
            {
                ++messageCount;
                var temperature = RandomGenerator.Next(20, 35);
                var humidity = RandomGenerator.Next(60, 80);
                string messagePayload = $"{{\"temperature\":{temperature},\"humidity\":{humidity}}}";
                var properties = new Dictionary<string, string>()
                {
                    {
                        "temperatureAlert", (temperature > TemperatureThreshold) ? "true" : "false"
                    }
                };

                while (true)
                {
                    var succeeded = await SendTelemetryAsync(messagePayload, messageCount.ToString(), cancellationToken, properties);
                    if (succeeded)
                        break;
                    // wait and retry
                    await Task.Delay(SleepDuration, cancellationToken);
                }
                await Task.Delay(SleepDuration, cancellationToken);
            }
        }

        public async Task RunSampleAsync(TimeSpan sampleRunningTime)
        {
            var cts = new CancellationTokenSource(sampleRunningTime);
            Console.CancelKeyPress += (_, eventArgs) =>
            {
                eventArgs.Cancel = true;
                cts.Cancel();
                Console.WriteLine("Sample execution cancellation requested; will exit.");
            };

            Console.WriteLine("Sample execution started, press Control+C to quit the sample.");

            try
            {
                await SendMessagesAsync(cts.Token);
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Unrecoverable exception caught, user action is required, so exiting...: \n{ex}");
            }
        }
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.4 186 9/9/2023
1.1.2 245 3/22/2023
1.1.0 308 3/22/2023
1.0.1 828 6/11/2022
1.0.0 859 6/11/2022
0.1.9 740 3/22/2021
0.1.8 676 1/9/2021
0.1.7 713 1/6/2021
0.1.6 711 1/6/2021
0.1.5 703 12/30/2020
0.1.4 769 12/28/2020
0.1.3 752 12/28/2020
0.1.2 649 12/28/2020
0.1.1 716 12/28/2020