ArduinoSketchUploader

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).

Compatibility

The library has been tested with the following configurations:

Arduino Model	MCU	Bootloader protocol
Mega 2560	ATMega2560	STK500v2
Micro	ATMega32U4	AVR109
Nano (R3)	ATMega328P	STK500v1
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).

How to use the command line application

Download the latest Windows binaries here (.zip file, version 2.3.0).

When running ArduinoSketchUploader.exe without arguments, the application will document it's usage:

ArduinoSketchUploader 2.3.0.0
Copyright c  2017

ERROR(S):
  -f/--file required option is missing.
  -p/--port 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     Required. 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: [Mega2560, Micro, NanoR3, UnoR3].

  --help         Display this help screen.

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

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

How to use the .NET library

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

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();

Logging

The library emits log messages (in varying levels, from Info to Trace) via NLog. Hook up an NLog dependency (and configuration) in any project that uses ArduinoSketchUploader to automagically emit these messages as well.

pimmetje / arduinosketchuploader Goto Github PK