Skip to content

Commit

Permalink
Add conceputal template to auto-generate pages based on tags
Browse files Browse the repository at this point in the history
  • Loading branch information
bparks13 committed Jul 10, 2024
1 parent b3e6299 commit 809cb5d
Show file tree
Hide file tree
Showing 40 changed files with 310 additions and 240 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
/**/packages/
/**/bin/
/**/obj/
_exported_templates
_site
_*/
.vscode

## bonsai environment
Expand Down
28 changes: 11 additions & 17 deletions articles/device-analogio.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
---
uid: device-analogio
title: AnalogIO
isGuide: true
isDevice: true
isHeadstage: false
device: AnalogIO
headstage: Breakout Board
workflow: true
workflow_file: ~/workflows/device-analogio_breakout-board.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
---

## Workflow (Input)

This is a fully functional workflow that configures and streams Analog Input data from a Breakout Board:

:::workflow
![AnalogIO](~/workflows/device-analogio_breakout-board.bonsai)
:::

## Workflow (Output)

> [!Note]
> Add workflow showing how to use AnalogOuput
## Visualize Data

`AnalogData` is a **CV.Mat** data type, and to view this requires a `Bonsai.Dsp.Design.MatVisualizer`.
28 changes: 11 additions & 17 deletions articles/device-bno055.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
---
uid: device-bno055
title: Bno055
---

## Stream Data

This is a fully functional workflow that configures and streams BNO055 data from a Headstage64.

:::workflow
![Bno055](~/workflows/device-bno055_headstage64.bonsai)
:::

## Visualize Data

In this example, the `RollingGraph` visualizer is used to combine data for plotting data types with multiple axes (i.e., **EulerAngle**, **Quaternion**, etc.), while **Temperature** can be plotted using a `TimeSeriesVisualizer`. To enable visualization of the **Temperature** data, right-click on the node and choose `Bonsai.Design.Visualizers.TimeSeriesVisualizer`.

If the `TimeSeriesVisualizer` is not listed as an option for the **Temperature** data, make sure to download the `Bonsai.Design.Visualizers` library. Refer to <xref:VisualizingData> for more information on visualizers and how to download them.

Data will not be shown until a workflow is running. Please refer to <xref:RunningAWorkflow> to see how to run a workflow.
isGuide: true
isDevice: true
isHeadstage: false
device: BNO055
headstage: Headstage64
workflow: true
workflow_file: ~/workflows/device-bno055_headstage64.bonsai
visualize: true
visualize_rollinggraph: true
visualize_timeseries: true
---
27 changes: 11 additions & 16 deletions articles/device-bno055_neuropixelsv1e.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,15 @@
---
uid: device-bno055_neuropixelsv1e
title: NeuropixelsV1eBno055
isGuide: true
isDevice: true
isHeadstage: false
device: BNO055
headstage: NeuropixelsV1e
workflow: true
workflow_file: ~/workflows/device-bno055_neuropixelsv1e.bonsai
visualize: true
visualize_rollinggraph: true
visualize_timeseries: true
visualize_mat: false
---

## Workflow

This is a fully functional workflow to enable a BNO055 device from a NeuropixelsV1e headstage:

:::workflow
![NeuropixelsV1eBno055](~/workflows/device-bno055_neuropixelsv1e.bonsai)
:::

## Visualize Data

In this example, the `RollingGraph` visualizer is used to combine data for plotting data types with multiple axes (i.e., **EulerAngle**, **Quaternion**, etc.), while **Temperature** can be plotted using a `TimeSeriesVisualizer`. To enable visualization of the **Temperature** data, right-click on the node and choose `Bonsai.Design.Visualizers.TimeSeriesVisualizer`.

If the `TimeSeriesVisualizer` is not listed as an option for the **Temperature** data, make sure to download the `Bonsai.Design.Visualizers` library. Refer to <xref:VisualizingData> for more information on visualizers and how to download them.

Data will not be shown until a workflow is running. Please refer to <xref:RunningAWorkflow> to see how to run a workflow.
19 changes: 11 additions & 8 deletions articles/device-bno055_neuropixelsv2e.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
uid: device-bno055_neuropixelsv2e
title: NeuropixelsV2eBno055
isGuide: true
isDevice: true
isHeadstage: false
device: BNO055
headstage: NeuropixelsV2e
workflow: true
workflow_file: ~/workflows/device-bno055_neuropixelsv2e.bonsai
visualize: true
visualize_rollinggraph: true
visualize_timeseries: true
visualize_mat: false
---

## Workflow

This is a fully functional workflow to enable a BNO055 device paired with a NeuropixelsV2e:

:::workflow
![NeuropixelsV2eBno055](~/workflows/device-bno055_neuropixelsv2e.bonsai)
:::
29 changes: 14 additions & 15 deletions articles/device-digitalio.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
---
uid: device-digitalio
title: DigitalIO
isGuide: true
isDevice: true
isHeadstage: false
device: DigitalIO
headstage: Breakout Board
workflow: true
workflow_file: ~/workflows/device-digitalio_breakout-board.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: false
visualize_text: true
---

## Workflow

This is a fully functional workflow that configures and streams DigitalIO data from a Breakout Board:

:::workflow
![DigitalIO](~/workflows/device-digitalio_breakout-board.bonsai)
:::

## Workflow (Output)

> [!Note]
> Add workflow showing how to use AnalogOuput
## Visualize Data

> [!IMPORTANT]
> Document how to use Digital Output
22 changes: 14 additions & 8 deletions articles/device-electricalstimulator.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
---
uid: device-electricalstimulator
title: Headstage64ElectricalStimulator
isGuide: true
isDevice: true
isHeadstage: false
device: ElectricalStimulator
headstage: Headstage64
workflow: true
workflow_file: ~/workflows/device-electricalstimulator_headstage64.bonsai
visualize: false
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: false
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable an Electrical Stimulator device from a Headstage64:

:::workflow
![Headstage64ElectricalStimulator](~/workflows/device-electricalstimulator_headstage64.bonsai)
:::
<br>

## Send Trigger

In the workflow, pressing the middle button on the mouse will send a True value to the Electrical Stimulator Trigger device, triggering the stimulation waveform that is configured to be delivered.
In the workflow, pressing the middle button on the mouse will send a trigger, delivering the stimulation waveform that is configured. The `MouseButtonDown` node can be found in the `Bonsai.Windows.Input` package.
24 changes: 12 additions & 12 deletions articles/device-heartbeat.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
uid: device-heartbeat
title: Heartbeat
isGuide: true
isDevice: true
isHeadstage: false
device: Heartbeat
headstage: Breakout Board
workflow: true
workflow_file: ~/workflows/device-heartbeat_breakout-board.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: true
visualize_mat: false
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a Heartbeat device from a Breakout Board:

:::workflow
![Heartbeat](~/workflows/device-heartbeat_breakout-board.bonsai)
:::

## Visualize Data

Right-click on `Sample` and choose the `TimeSeriesVisualizer`.
24 changes: 12 additions & 12 deletions articles/device-memorymonitor.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
uid: device-memorymonitor
title: MemoryMonitor
isGuide: true
isDevice: true
isHeadstage: false
device: MemoryMonitor
headstage: Breakout Board
workflow: true
workflow_file: ~/workflows/device-memorymonitor_breakout-board.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: true
visualize_mat: false
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a Memory Monitor device from a Breakout Board:

:::workflow
![MemoryMonitor](~/workflows/device-memorymonitor_breakout-board.bonsai)
:::

## Visualize Data

Right-click on `PercentUsed` and choose the `TimeSeriesVisualizer`.
24 changes: 12 additions & 12 deletions articles/device-neuropixelsv1e.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
uid: device-neuropixelsv1e
title: NeuropixelsV1e
isGuide: true
isDevice: true
isHeadstage: false
device: NeuropixelsV1e
headstage: NeuropixelsV1e
workflow: true
workflow_file: ~/workflows/device-neuropixelsv1e_neuropixelsv1eheadstage.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a NeuropixelsV1e device from a NeuropixelsV1e Headstage:

:::workflow
![NeuropixelsV1e](~/workflows/device-neuropixelsv1e_neuropixelsv1eheadstage.bonsai)
:::

## Visualize Data

Right-click on `SpikeData` or `LfpData` and choose the `Bonsai.Dsp.Design.MatVisualizer`.
20 changes: 12 additions & 8 deletions articles/device-neuropixelsv2e.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
uid: device-neuropixelsv2e
title: NeuropixelsV2e
isGuide: true
isDevice: true
isHeadstage: false
device: NeuropixelsV2e
headstage: NeuropixelsV2e
workflow: true
workflow_file: ~/workflows/device-neuropixelsv2e_neuropixelsv2eheadstage.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a NeuropixelsV2e device from a NeuropixelsV2e headstage:

:::workflow
![NeuropixelsV2e](~/workflows/device-neuropixelsv2e_neuropixelsv2eheadstage.bonsai)
:::
20 changes: 12 additions & 8 deletions articles/device-neuropixelsv2ebeta.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
uid: device-neuropixelsv2ebeta
title: NeuropixelsV2eBeta
isGuide: true
isDevice: true
isHeadstage: false
device: NeuropixelsV2eBeta
headstage: NeuropixelsV2eBeta
workflow: true
workflow_file: ~/workflows/device-neuropixelsv2ebeta_neuropixelsv2ebetaheadstage.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a NeuropixelsV2eBeta device from a NeuropixelsV2eBeta headstage:

:::workflow
![NeuropixelsV2eBeta](~/workflows/device-neuropixelsv2ebeta_neuropixelsv2ebetaheadstage.bonsai)
:::
20 changes: 12 additions & 8 deletions articles/device-rhd2164.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
uid: device-rhd2164
title: Rhd2164
isGuide: true
isDevice: true
isHeadstage: false
device: Rhd2164
headstage: Headstage64
workflow: true
workflow_file: ~/workflows/device-rhd2164_headstage64.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable an Rhd2164 device from a Headstage64:

:::workflow
![Rhd2164](~/workflows/device-rhd2164_headstage64.bonsai)
:::
20 changes: 12 additions & 8 deletions articles/device-test0.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
uid: device-test0
title: Test0
isGuide: true
isDevice: true
isHeadstage: false
device: Test0
headstage: test
workflow: true
workflow_file: ~/workflows/device-test0.bonsai
visualize: true
visualize_rollinggraph: false
visualize_timeseries: false
visualize_mat: true
visualize_text: false
---

## Workflow

This is a fully functional workflow to enable a Test0 device:

:::workflow
![Test0](~/workflows/device-test0.bonsai)
:::
Loading

0 comments on commit 809cb5d

Please sign in to comment.