Harp.Generators 0.5.2

Prefix Reserved
.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Harp.Generators --version 0.5.2
                    


                    

                
NuGet\Install-Package Harp.Generators -Version 0.5.2
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="Harp.Generators" Version="0.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Harp.Generators" Version="0.5.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Harp.Generators" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Harp.Generators --version 0.5.2
                    


                    

                
#r "nuget: Harp.Generators, 0.5.2"
#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. 
#:package Harp.Generators@0.5.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Harp.Generators&version=0.5.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Harp.Generators&version=0.5.2
                    


                            Install as a Cake Tool

Harp.Generators

Provides a device and IO pin configuration metadata model and a set of T4 runtime templates supporting the automatic generation of firmware and Bonsai interface code for Harp devices.

Installing

Installation can be done through the Harp.Generators NuGet package.

dotnet add package Harp.Generators

Editing device metadata

  1. Install Visual Studio Code
  2. Install the YAML extension.

The device interface can be described using a device.yml file. A complete specification of all device registers, including bit masks, group masks, and payload formats needs to be provided.

%YAML 1.1
---
# yaml-language-server: $schema=https://harp-tech.org/draft-02/schema/device.json
device: DeviceName
whoAmI: 0000
firmwareVersion: "0.1"
hardwareTargets: "0.0"
registers:
  DigitalInputs:
    address: 32
    type: U8
    access: Event

Generating device interface code

A complete reactive interface to communicate with the device can be generated from the device metadata file.

using var reader = new StreamReader("device.yml");
var parser = new MergingParser(new Parser(reader));
var deviceMetadata = MetadataDeserializer.Instance.Deserialize<DeviceInfo>(parser);

var generator = new InterfaceGenerator(deviceMetadata, "MyNamespace");
var implementation = generator.GenerateImplementation();

Generating device firmware code

Assuming the deviceMetadata object loaded above is available, device firmware interface stubs can be generated by providing an additional metadata file describing IO pin configuration.

...
using var reader = new StreamReader("ios.yml");
var portPinMetadata = MetadataDeserializer.Instance.Deserialize<PortPinMetadata>(reader);
var generator = new FirmwareGenerator(deviceMetadata, portPinMetadata);

var headers = generator.GenerateHeaders();
var implementation = generator.GenerateImplementation();

Contributing

Bug reports and contributions are welcome at the GitHub repository.

License

Harp.Generators is released as open-source under the MIT license.

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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
0.5.3 56 3/22/2026
0.5.2 53 3/22/2026
0.5.1 277 3/14/2026
0.5.0 82 3/13/2026
0.4.0 489 5/23/2025
0.3.0 489 11/7/2024
0.2.0 572 11/19/2023
0.1.0 547 8/3/2023
0.1.0-build062701 453 7/31/2023
0.1.0-build061901 440 6/19/2023
0.1.0-build041201 511 4/12/2023