-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add conceputal template to auto-generate pages based on tags
- Loading branch information
Showing
40 changed files
with
310 additions
and
240 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,8 +6,7 @@ | |
/**/packages/ | ||
/**/bin/ | ||
/**/obj/ | ||
_exported_templates | ||
_site | ||
_*/ | ||
.vscode | ||
|
||
## bonsai environment | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## 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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## 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 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## Workflow (Output) | ||
|
||
> [!Note] | ||
> Add workflow showing how to use AnalogOuput | ||
## Visualize Data | ||
|
||
> [!IMPORTANT] | ||
> Document how to use Digital Output |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
<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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## Visualize Data | ||
|
||
Right-click on `Sample` and choose the `TimeSeriesVisualizer`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## Visualize Data | ||
|
||
Right-click on `PercentUsed` and choose the `TimeSeriesVisualizer`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: | ||
|
||
## Visualize Data | ||
|
||
Right-click on `SpikeData` or `LfpData` and choose the `Bonsai.Dsp.Design.MatVisualizer`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
 | ||
::: |
Oops, something went wrong.