Merge pull request #63 from glopesdev/interface-gen

Embed device metadata as part of interface project
harp-tech · Nov 6, 2024 · 8159545 · 8159545
2 parents c92023c + 2b87c1b
commit 8159545
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 3 deletions.
diff --git a/interface/Device.tt b/interface/Device.tt
@@ -68,6 +68,41 @@ foreach (var register in deviceRegisters)
 }
 #>
         };
+
+        /// <summary>
+        /// Gets the contents of the metadata file describing the <see cref="<#= deviceName #>"/>
+        /// device registers.
+        /// </summary>
+        public static readonly string Metadata = GetDeviceMetadata();
+
+        static string GetDeviceMetadata()
+        {
+            var deviceType = typeof(Device);
+            using var metadataStream = deviceType.Assembly.GetManifestResourceStream($"{deviceType.Namespace}.device.yml");
+            using var streamReader = new System.IO.StreamReader(metadataStream);
+            return streamReader.ReadToEnd();
+        }
+    }
+
+    /// <summary>
+    /// Represents an operator that returns the contents of the metadata file
+    /// describing the <see cref="<#= deviceName #>"/> device registers.
+    /// </summary>
+    [Description("Returns the contents of the metadata file describing the <#= deviceName #> device registers.")]
+    public partial class GetMetadata : Source<string>
+    {
+        /// <summary>
+        /// Returns an observable sequence with the contents of the metadata file
+        /// describing the <see cref="<#= deviceName #>"/> device registers.
+        /// </summary>
+        /// <returns>
+        /// A sequence with a single <see cref="string"/> object representing the
+        /// contents of the metadata file.
+        /// </returns>
+        public override IObservable<string> Generate()
+        {
+            return Observable.Return(Device.Metadata);
+        }
     }
 
     /// <summary>

diff --git a/interface/Harp.Generators.csproj b/interface/Harp.Generators.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <VersionPrefix>0.2.0</VersionPrefix>
+    <VersionPrefix>0.3.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <PackageId>Harp.Generators</PackageId>
     <Title>Harp Generators</Title>

diff --git a/template/Bonsai.DeviceTemplate/Generators/Generators.csproj b/template/Bonsai.DeviceTemplate/Generators/Generators.csproj
@@ -15,7 +15,7 @@
     <FirmwarePath>..\Firmware\$projectname$</FirmwarePath>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Harp.Generators" Version="0.1.0" GeneratePathProperty="true" />
+    <PackageReference Include="Harp.Generators" Version="0.3.0" GeneratePathProperty="true" />
   </ItemGroup>
   <Target Name="TextTransform" BeforeTargets="AfterBuild">
     <PropertyGroup>

diff --git a/template/Bonsai.DeviceTemplate/Interface/DeviceTemplate/DeviceTemplate.csproj b/template/Bonsai.DeviceTemplate/Interface/DeviceTemplate/DeviceTemplate.csproj
@@ -23,4 +23,8 @@
     <PackageReference Include="Bonsai.Harp" Version="3.5.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <EmbeddedResource Include="..\..\device.yml" />
+  </ItemGroup>
+
 </Project>
diff --git a/template/Harp.Templates.csproj b/template/Harp.Templates.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageType>Template</PackageType>
-    <VersionPrefix>0.1.2</VersionPrefix>
+    <VersionPrefix>0.2.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <PackageId>Harp.Templates</PackageId>
     <Title>Harp Templates</Title>