Merge pull request #8 from harp-tech/Feature-update-generators-to-include-metadata

Include device metadata file as embedded resource

Author: artursilva0

Generators/Generators.csproj

@@ -15,7 +15,7 @@
     <FirmwarePath>..\Firmware\Harp.LedArray</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>

Interface/Harp.LedArray/Device.Generated.cs

@@ -69,8 +69,44 @@ public Device() : base(WhoAmI) { }
             { 61, typeof(AuxDigitalOutputState) },
             { 62, typeof(AuxLedPower) },
             { 63, typeof(DigitalOutputState) },
+            { 64, typeof(Reserved0) },
             { 65, typeof(EnableEvents) }
         };
+
+        /// <summary>
+        /// Gets the contents of the metadata file describing the <see cref="LedArray"/>
+        /// 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="LedArray"/> device registers.
+    /// </summary>
+    [Description("Returns the contents of the metadata file describing the LedArray device registers.")]
+    public partial class GetMetadata : Source<string>
+    {
+        /// <summary>
+        /// Returns an observable sequence with the contents of the metadata file
+        /// describing the <see cref="LedArray"/> 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>
@@ -3511,6 +3547,28 @@ public static Timestamped<DigitalOutputs> GetPayload(HarpMessage message)
         }
     }
 
+    /// <summary>
+    /// Represents a register that reserved for future use.
+    /// </summary>
+    [Description("Reserved for future use")]
+    internal partial class Reserved0
+    {
+        /// <summary>
+        /// Represents the address of the <see cref="Reserved0"/> register. This field is constant.
+        /// </summary>
+        public const int Address = 64;
+
+        /// <summary>
+        /// Represents the payload type of the <see cref="Reserved0"/> register. This field is constant.
+        /// </summary>
+        public const PayloadType RegisterType = PayloadType.U8;
+
+        /// <summary>
+        /// Represents the length of the <see cref="Reserved0"/> register. This field is constant.
+        /// </summary>
+        public const int RegisterLength = 1;
+    }
+
     /// <summary>
     /// Represents a register that specifies all the active events in the device.
     /// </summary>
@@ -5599,6 +5657,22 @@ public DigitalOutputSyncPayload(
         /// Configuration of the DO1 functionality.
         /// </summary>
         public DO1SyncConfig DO1Sync;
+
+        /// <summary>
+        /// Returns a <see cref="string"/> that represents the payload of
+        /// the DigitalOutputSync register.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="string"/> that represents the payload of the
+        /// DigitalOutputSync register.
+        /// </returns>
+        public override string ToString()
+        {
+            return "DigitalOutputSyncPayload { " +
+                "DO0Sync = " + DO0Sync + ", " +
+                "DO1Sync = " + DO1Sync + " " +
+            "}";
+        }
     }
 
     /// <summary>
@@ -5628,6 +5702,22 @@ public DigitalInputTriggerPayload(
         /// Configuration of the DI1 input pin.
         /// </summary>
         public DigitalInputTriggerConfig DI1Trigger;
+
+        /// <summary>
+        /// Returns a <see cref="string"/> that represents the payload of
+        /// the DigitalInputTrigger register.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="string"/> that represents the payload of the
+        /// DigitalInputTrigger register.
+        /// </returns>
+        public override string ToString()
+        {
+            return "DigitalInputTriggerPayload { " +
+                "DI0Trigger = " + DI0Trigger + ", " +
+                "DI1Trigger = " + DI1Trigger + " " +
+            "}";
+        }
     }
 
     /// <summary>
@@ -5657,6 +5747,22 @@ public PulseModePayload(
         /// Sets the pulse mode used in LED0
         /// </summary>
         public PulseModeConfig Led1Mode;
+
+        /// <summary>
+        /// Returns a <see cref="string"/> that represents the payload of
+        /// the PulseMode register.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="string"/> that represents the payload of the
+        /// PulseMode register.
+        /// </returns>
+        public override string ToString()
+        {
+            return "PulseModePayload { " +
+                "Led0Mode = " + Led0Mode + ", " +
+                "Led1Mode = " + Led1Mode + " " +
+            "}";
+        }
     }
 
     /// <summary>

Interface/Harp.LedArray/Harp.LedArray.csproj

@@ -9,6 +9,7 @@
     <GeneratePackageOnBuild Condition="'$(Configuration)'=='Release'">true</GeneratePackageOnBuild>
     <Description>Bonsai Library containing interfaces for data acquisition and control of Harp LedArray devices.</Description>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageType>Dependency;BonsaiLibrary</PackageType>
     <PackageTags>Harp LedArray Bonsai Rx</PackageTags>
     <PackageProjectUrl>https://harp-tech.org</PackageProjectUrl>
     <RepositoryUrl>https://github.com/harp-tech/device.ledarray.git</RepositoryUrl>
@@ -17,7 +18,7 @@
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageOutputPath>..\bin\$(Configuration)</PackageOutputPath>
     <TargetFrameworks>net462;netstandard2.0</TargetFrameworks>
-    <VersionPrefix>0.1.0</VersionPrefix>
+    <VersionPrefix>0.2.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <LangVersion>9.0</LangVersion>
   </PropertyGroup>
@@ -29,6 +30,7 @@
   <ItemGroup>
     <Content Include="..\LICENSE" PackagePath="/" />
     <Content Include="..\icon.png" PackagePath="/" />
+    <EmbeddedResource Include="..\..\device.yml" />
   </ItemGroup>
 
 </Project>

device.yml

@@ -1,6 +1,6 @@
 %YAML 1.1
 ---
-# yaml-language-server: $schema=https://raw.githubusercontent.com/harp-tech/reflex-generator/main/schema/device.json
+# yaml-language-server: $schema=https://harp-tech.org/draft-02/schema/device.json
 device: LedArray
 whoAmI: 1088
 firmwareVersion: "2.4"