Skip to content

Commit

Permalink
Add harp-utils to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-f-cruz committed Jan 12, 2024
1 parent cd75845 commit 0d7edf5
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/articles/harp-utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Harp Utilities
==========

# Get device metadata from device

In order to get device metadata from device, use the `GetHarpDeviceMetadata` operator. This operator will connect to an harp device and serialize a `HarpDeviceMetadata` object that can then be saved to a text file. For instance:

4 changes: 3 additions & 1 deletion docs/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@
- name: Version Control
href: version-control.md
- name: Core Logging
href: core-logging.md
href: core-logging.md
- name: Harp Utilities
href: harp-utils.md
23 changes: 23 additions & 0 deletions docs/workflows/GenerateHarpDeviceMetadatataExample.bonsai
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<WorkflowBuilder Version="2.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:io="clr-namespace:Bonsai.IO;assembly=Bonsai.System"
xmlns="https://bonsai-rx.org/2018/workflow">
<Workflow>
<Nodes>
<Expression xsi:type="IncludeWorkflow" Path="AllenNeuralDynamics.HarpUtils:GetHarpDeviceMetadata.bonsai">
<PortName>COM3</PortName>
</Expression>
<Expression xsi:type="Combinator">
<Combinator xsi:type="io:WriteAllText">
<io:Path>metadata.json</io:Path>
<io:Overwrite>false</io:Overwrite>
<io:Append>false</io:Append>
</Combinator>
</Expression>
</Nodes>
<Edges>
<Edge From="0" To="1" Label="Source1" />
</Edges>
</Workflow>
</WorkflowBuilder>
3 changes: 3 additions & 0 deletions docs/workflows/GenerateHarpDeviceMetadatataExample.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0d7edf5

Please sign in to comment.