Merge pull request #129 from AllenNeuralDynamics/fix-docs

Fix harp logging in docs

Author: bruno-f-cruz

docs/articles/core-logging.md

@@ -21,7 +21,7 @@ Once this `Subject` is created, other nodes can access to it. For instance, if o
 
 ### With Metadata
 
-Each device can be saved with metadata by providing the `device.yml` file information to the operator. This string can be passed manually or by using the `GetMetadata` node from the device-specific package.
+Each device can be saved with metadata by providing the `device.yml` file information to the operator. This string (i.e. the literal of the [`device.yml`](https://github.com/AllenNeuralDynamics/harp.device.lickety-split/blob/main/device.yml)) can be passed manually or by using the `GetMetadata` node from the device-specific package.
 For example, to log data from a `LicketySplit` device:
 
 :::workflow

docs/articles/harp-utils.md

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<WorkflowBuilder Version="2.8.2"
+<WorkflowBuilder Version="2.8.5"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns:harp="clr-namespace:Bonsai.Harp;assembly=Bonsai.Harp"
                  xmlns:rx="clr-namespace:Bonsai.Reactive;assembly=Bonsai.Core"
@@ -43,20 +43,20 @@
       <Expression xsi:type="SubscribeSubject">
         <Name>DeviceEvents</Name>
       </Expression>
-      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.Core:LogHarpDevice.bonsai">
+      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.HarpUtils:LogHarpDevice.bonsai">
         <SubjectName>LoggingRootPath</SubjectName>
         <Modality>Behavior</Modality>
-        <DeviceName>DeviceName</DeviceName>
-        <HarpDeviceName>HarpDeviceName</HarpDeviceName>
+        <DeviceName>Device</DeviceName>
+        <HarpDeviceName>HarpBehavior</HarpDeviceName>
       </Expression>
       <Expression xsi:type="SubscribeSubject">
         <Name>AnotherDeviceEvents</Name>
       </Expression>
-      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.Core:LogHarpDevice.bonsai">
+      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.HarpUtils:LogHarpDevice.bonsai">
         <SubjectName>LoggingRootPath</SubjectName>
         <Modality>Behavior</Modality>
-        <DeviceName>AnotherDeviceName</DeviceName>
-        <HarpDeviceName>HarpDeviceName</HarpDeviceName>
+        <DeviceName>AnotherDevice</DeviceName>
+        <HarpDeviceName>HarpBehavior</HarpDeviceName>
       </Expression>
     </Nodes>
     <Edges>

docs/workflows/SaveHarpData.bonsai

@@ -30,6 +30,14 @@
       <Expression xsi:type="SubscribeSubject">
         <Name>LicketySplitEvents</Name>
       </Expression>
+      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.HarpUtils:LogHarpDeviceWithMetadata.bonsai">
+        <DeviceMetadata xsi:nil="true" />
+        <Modality>Behavior</Modality>
+        <DeviceName xsi:nil="true" />
+      </Expression>
+      <Expression xsi:type="SubscribeSubject">
+        <Name>LicketySplitEvents</Name>
+      </Expression>
       <Expression xsi:type="Combinator">
         <Combinator xsi:type="p1:GetMetadata" />
       </Expression>
@@ -38,17 +46,18 @@
           <Property Name="DeviceMetadata" />
         </PropertyMappings>
       </Expression>
-      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.Core:LogHarpDeviceWithMetadata.bonsai">
-        <DeviceMetadata />
+      <Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.HarpUtils:LogHarpDeviceWithMetadata.bonsai">
+        <DeviceMetadata xsi:nil="true" />
         <Modality>Behavior</Modality>
-        <DeviceName>Lickometer</DeviceName>
+        <DeviceName xsi:nil="true" />
       </Expression>
     </Nodes>
     <Edges>
       <Edge From="1" To="2" Label="Source1" />
-      <Edge From="3" To="6" Label="Source1" />
-      <Edge From="4" To="5" Label="Source1" />
-      <Edge From="5" To="6" Label="Source2" />
+      <Edge From="3" To="4" Label="Source1" />
+      <Edge From="5" To="8" Label="Source1" />
+      <Edge From="6" To="7" Label="Source1" />
+      <Edge From="7" To="8" Label="Source2" />
     </Edges>
   </Workflow>
 </WorkflowBuilder>