ArduinoUploader.NET 7.1.0

.NET 7.0
dotnet add package ArduinoUploader.NET --version 7.1.0
NuGet\Install-Package ArduinoUploader.NET -Version 7.1.0
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="ArduinoUploader.NET" Version="7.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ArduinoUploader.NET --version 7.1.0
#r "nuget: ArduinoUploader.NET, 7.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ArduinoUploader.NET as a Cake Addin
#addin nuget:?package=ArduinoUploader.NET&version=7.1.0

// Install ArduinoUploader.NET as a Cake Tool
#tool nuget:?package=ArduinoUploader.NET&version=7.1.0

ArduinoUploader.NET

This repository is a .NET7.0 upgraded version of the original work done by Christophe Diericx Added support for upload with both filePath and fileContent.

This repository contains a .NET library and a corresponding Windows command line utility that can be used to upload a compiled sketch (.HEX) directly to an Arduino board over USB. It talks to the boards bootloader over the serial (USB) connection, much like avrdude does (when invoked from the Arduino IDE, or from the command line).

ArduinoSketchUploader

Compatibility

The library has been tested with the following configurations:

Arduino Model MCU Bootloader protocol
Leonardo ATMega32U4 AVR109
Mega 1284 ATMega1284 STK500v1
Mega 2560 ATMega2560 STK500v2
Micro ATMega32U4 AVR109
Nano (R2) ATMega168 STK500v1
Nano (R3) ATMega328P STK500v1
Pro Micro 8 ATMega32U4 AVR109
Pro Micro 16 ATMega32U4 AVR109
Uno (R3) ATMega328P STK500v1

If you have a need for this library to run on another Arduino model, feel free to open an issue on GitHub, it should be relatively straightforward to add support (for most).

Support for Mega 1284 was added by https://github.com/sijk, thanks!

How to use the command line application

!! LINK NOT UPDATED - Will be fixed !! Download the latest Windows binaries here (.zip file, version 7.0.0).

When running ArduinoUploaderTool.exe without arguments, the application will document its usage:

ArduinoSketchUploader 7.1.0.0
Copyright c Anders Dyhrberg 2022 - 

ERROR(S):
  -f/--file required option is missing.
  -m/--model required option is missing.


  -f, --file     Required. Path to the input file (in intel HEX format) which
                 is to be uploaded to the Arduino.

  -p, --port     Name of the COM port where the Arduino is attached (e.g.
                 'COM1', 'COM2', 'COM3'...).

  -m, --model    Required. Arduino model. Valid parameters are any of the
                 following: [Leonardo, Mega1284, Mega2560, Micro, NanoR2,
                 NanoR3, ProMicro, UnoR3].

  -s, --silent   Required. Arduino model. Valid parameters are any of the
                 following: [Leonardo, Mega1284, Mega2560, Micro, NanoR2,
                 NanoR3, UnoR3].

  -?, --help     Display this help screen.

A sample command line invocation (for a Mega2560 type Arduino attached to COM4):

ArduinoSketchUploader.exe --file=C:\MyHexFiles\myHexFile.hex --port=COM4 --model=Mega2560

If only a single COM port is in use on the system (used by the attached Arduino), one can omit the port:

ArduinoSketchUploader.exe --file=C:\MyHexFiles\myHexFile.hex --model=UnoR3

How to use the .NET library

NuGet version

Link the following nuget package in your project in order to use the ArduinoUploader: https://www.nuget.org/packages/ArduinoUploader.NET/

Alternatively, install the package using the nuget package manager console:

Install-Package ArduinoUploader

The following minimal snippet shows how to upload a .HEX file to an Arduino (UNO) board attached at COM port 3:

var uploader = new ArduinoSketchUploader(
    new ArduinoSketchUploaderOptions()
    {
        FileName = @"C:\MyHexFiles\UnoHexFile.ino.hex",
        PortName = "COM3",
        ArduinoModel = ArduinoModel.UnoR3
    });

uploader.UploadSketch();

As discussed above, one can try to auto-detect the COM port by omitting it.

Logging

In earlier versions of the library, it emitted log messages through a dependency on NLog. From an architectural point of view, it is suboptimal to be forcing a dependency on a particular logging framework from library code.

A simple IArduinoUploaderLogger interface is exposed from within the library. Implement this interface, and pass an instance into the ArduinoSketchUploader constructor if you want to consume log messages (in varying levels, from Info to Trace).

Implementing the interface using NLog consists of nothing more than this:

private class NLogArduinoUploaderLogger : IArduinoUploaderLogger
{
    private static readonly Logger Logger = LogManager.GetLogger("ArduinoSketchUploader");

    public void Error(string message, Exception exception)
    {
        Logger.Error(exception, message);
    }

    public void Warn(string message)
    {
        Logger.Warn(message);
    }

    public void Info(string message)
    {
        Logger.Info(message);
    }

    public void Debug(string message)
    {
        Logger.Debug(message);
    }

    public void Trace(string message)
    {
        Logger.Trace(message);
    }
}
Product Versions
.NET net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
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
7.1.0 99 1/13/2023
7.0.0 87 1/10/2023
6.0.1 149 11/25/2022
6.0.0 161 10/29/2022

Added support for ProMicro8 and ProMicro16