nanoclr 1.0.591

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global nanoclr --version 1.0.591                
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local nanoclr --version 1.0.591                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=nanoclr&version=1.0.591                
nuke :add-package nanoclr --version 1.0.591                

.NET nanoFramework nanoCLR

This .NET Core Tool allows running nanoCLR in Windows machines. This can be useful to have virtual devices for development purposes, performing automated tests on pipelines or other environments and other uses that benefit from having a virtual device opposed to real physical hardware. The virtual device can be accessed just like a real one through a virtual serial port, a named pipe or a TCP/IP port.

Is part of .NET nanoFramework toolbox, along with other various tools that are required in .NET nanoFramework development, usage or repository management.

Install .NET nanoFramework nanoCLR

Perform a one-time install of the .NET nanoFramework nanoCLR tool using the following .NET Core CLI command:

dotnet tool install -g nanoclr

After a successful installation a message is displayed showing the command that's to be used to call the tool along with the version installed. Similar to the following example:

You can invoke the tool using the following command: nanoff
Tool 'nanoclr' (version '9.9.9') was successfully installed.

Update .NET nanoFramework nanoCLR

To update .NET nanoFramework nanoCLR tool use the following .NET Core CLI command:

dotnet tool update -g nanoclr

Usage

Once the tool is installed, you can call it by using its command nanoclr, which is a short version of the name to ease typing.

nanoclr [command] [args]

The tool includes help for all available commands. You can see a list of all available ones by entering:

nanoclr --help

Virtual Serial Ports

This verb allows managing the virtual serial port exposing the virtual device. The virtual serial port it's only available in Windows machines. It's made available with the sponsorship of HHD Software which has kindly sponsored a free license for running their tool.

List Virtual Serial ports

This command lists the installed virtual serial port bridges in the system.

nanoclr virtualserial --list

Create Virtual Serial port

This command creates a virtual serial port that will be used to expose the nanoCLR instance. A random COM port will be created. A COM port can be optionally specified as an option. In this case, if that COM port it's not being used, it will be created.

nanoclr virtualserial --create [COM99]

Remove Virtual Serial port

This command removes an existing virtual serial port.

nanoclr virtualserial --remove [COM99]

Install Virtual Serial Port tools

This command installs HHD Software Virtual Serial Port Tools software. The installer is downloaded from their website and executed. Executing the installer requires "Install Driver" privilege and must be elevated. If the process running it doesn't have the required permissions an UAC prompt will be show.

nanoclr virtualserial --install

Running the virtual nanoCLR

These options run the nanoCRL instance loading the specified assemblies and exposing the device on a specified interface. Please note that for successfully running a nanoCLR instance it's require to load a set of assemblies and specify an interface to expose it, otherwise it has no use.

Load a set of assemblies

This loads a set of .NET nanoFramework assemblies and runs the nanoCLR. These have to be in .NET nanoFramework PE (Portable Executable) format. They are found in the output folder of a Visual Studio project (typically bin\Debug or bin\Release). Full path of the PE files is required.

nanoclr run --assemblies "C:\nano\my_nice_project\bin\Debug\mscorlib.pe" "C:\nano\my_nice_project\bin\Debug\my_nice_project.pe"

Specify Serial Port

This option specifies the COM port that will be used to expose the virtual nanoCLR that will be running. It requires a previous setup of a Virtual Serial Port (see Create Virtual Serial port).

nanoclr run --serialport COM99  (--assemblies ...)

Specify Named Pipe

This option specifies a Named Pipe that will be used to expose the virtual nanoCLR that will be running.

nanoclr run --namedpipe MyNanoDevice  (--assemblies ...)

Resolve references

This option tries to resolve cross-assembly references between the loaded assemblies.

nanoclr run --resolve (--assemblies ...)

Options to control debugger connection

There are two options that control how the nanoCLR execution interacts with a debugger. If it's intended that after a program terminates and exits the execution a debugger will be connecting, the option --loopafterexit should be included. In case it's expected that imediatly after nanoCLR is started,a debugger is to connect to it, the option --waitfordebugger should be included.

Maintenance operations with the nanoCLR

The nanoCLR it's, in fact, a wrapper to the nanoCLR instance that is distributed as DLL so it can be easily updated. The following operations are available to manage this.

Version of nanoCLR

Gets the version of the current nanoCLR instance.

nanoclr instance --getversion

Update nanoCLR instance

Checks for stable versions of nanoCLR and updates it, if there is one. A version can be specified. To check preview versions add the --preview option.

nanoclr instance --update [--preview] [--clrversion 1.22.333.4444]

Uninstall .NET nanoFramework nanoCLR

To uninstall the .NET nanoFramework nanoCLR tool use the following .NET Core CLI command:

dotnet tool uninstall -g nanoclr
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.655 86 9/26/2024
1.0.654 71 9/26/2024
1.0.653 61 9/25/2024
1.0.650 180 9/20/2024
1.0.643 461 8/28/2024
1.0.637 414 8/7/2024
1.0.632 113 8/3/2024
1.0.630 91 8/2/2024
1.0.623 89 8/1/2024
1.0.618 81 7/30/2024
1.0.616 61 7/30/2024
1.0.615 69 7/30/2024
1.0.613 67 7/30/2024
1.0.612 75 7/29/2024
1.0.608 132 7/24/2024
1.0.606 64 7/24/2024
1.0.603 110 7/23/2024
1.0.601 131 7/19/2024
1.0.597 228 7/10/2024
1.0.591 226 6/26/2024
1.0.580 184 6/18/2024
1.0.573 225 6/12/2024
1.0.572 154 6/10/2024
1.0.569 189 6/7/2024
1.0.555 502 5/22/2024
1.0.554 115 5/22/2024
1.0.543 279 5/13/2024
1.0.530 211 5/7/2024
1.0.520 379 4/10/2024
1.0.515 485 3/22/2024
1.0.510 253 3/21/2024
1.0.509 260 3/14/2024
1.0.501 275 3/4/2024
1.0.494 302 2/22/2024
1.0.492 265 2/15/2024
1.0.488 223 2/9/2024
1.0.479 202 2/6/2024
1.0.473 309 1/26/2024
1.0.467 327 1/16/2024
1.0.455 498 12/22/2023
1.0.443 362 12/8/2023
1.0.430 510 11/16/2023
1.0.426 308 11/11/2023
1.0.425 233 11/10/2023
1.0.422 159 11/10/2023
1.0.421 204 11/9/2023
1.0.417 200 11/8/2023
1.0.412 197 11/7/2023
1.0.396 378 10/30/2023
1.0.392 343 10/24/2023
1.0.385 303 10/18/2023
1.0.381 325 10/12/2023
1.0.363 529 9/27/2023
1.0.334 469 8/31/2023
1.0.318 387 8/16/2023
1.0.317 322 8/7/2023
1.0.303 243 7/26/2023
1.0.302 162 7/26/2023
1.0.301 191 7/26/2023
1.0.292 189 7/26/2023
1.0.281 212 7/14/2023
1.0.267 347 6/16/2023
1.0.259 264 6/5/2023
1.0.256 181 5/31/2023
1.0.252 223 5/30/2023
1.0.250 172 5/29/2023
1.0.238 380 5/19/2023
1.0.237 183 5/19/2023
1.0.234 171 5/18/2023
1.0.233 179 5/17/2023
1.0.230 270 5/11/2023
1.0.225 304 5/5/2023
1.0.217 398 4/18/2023
1.0.216 195 4/17/2023
1.0.212 283 4/14/2023
1.0.211 317 4/11/2023
1.0.208 355 4/3/2023
1.0.205 272 3/30/2023
1.0.201 308 3/25/2023
1.0.200 256 3/22/2023
1.0.197 342 3/15/2023
1.0.196 260 3/15/2023
1.0.193 243 3/15/2023
1.0.190 240 3/14/2023
1.0.184 291 3/10/2023
1.0.182 248 3/10/2023
1.0.180 235 3/9/2023
1.0.179 264 3/9/2023
1.0.159 479 2/20/2023
1.0.151 301 2/17/2023
1.0.148 319 2/16/2023
1.0.145 286 2/15/2023
1.0.117 391 2/3/2023
1.0.116 283 2/3/2023
1.0.114 350 1/31/2023
1.0.111 339 1/30/2023
1.0.105 444 1/17/2023
1.0.104 493 1/5/2023
1.0.103 337 1/4/2023
1.0.100 337 1/3/2023
1.0.98 359 1/2/2023
1.0.95 385 1/2/2023
1.0.93 361 1/2/2023
1.0.92 421 12/22/2022
1.0.84 419 12/14/2022
1.0.63 459 12/5/2022
1.0.62 342 12/5/2022
1.0.55 373 12/2/2022
1.0.53 365 12/2/2022
1.0.50 352 12/2/2022
1.0.47 387 12/2/2022
1.0.45 373 12/2/2022
1.0.41 386 12/2/2022
1.0.39 359 12/2/2022
1.0.38 375 12/1/2022
1.0.37 378 12/1/2022
1.0.36 393 12/1/2022
1.0.34 381 11/30/2022
1.0.28 349 11/30/2022
1.0.25 432 11/29/2022
1.0.23 358 12/13/2022
1.0.22 354 12/13/2022
1.0.19 364 11/29/2022
1.0.15 387 11/29/2022
1.0.14 371 11/29/2022
1.0.13 360 11/29/2022
1.0.12 325 12/8/2022
1.0.11 364 12/7/2022
1.0.9 362 12/7/2022
1.0.3 334 12/5/2022
1.0.1 326 12/5/2022