Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
eb24d7d
Initial draft of docs
banchan86 Aug 20, 2026
1ad8245
Add, test and revise peripheral articles and images
banchan86 Aug 31, 2026
e8b0960
Polishing and update harp-python section
banchan86 Sep 4, 2026
dfb2920
Fill out register examples
banchan86 Sep 4, 2026
efcb1fb
Add mockups for style variants of workflow articles
banchan86 Sep 6, 2026
bc91461
Remove duplicate mockup
banchan86 Sep 6, 2026
b3863d8
Add collapsible mockup
banchan86 Sep 6, 2026
c19bba4
Minor grammar edit
banchan86 Sep 7, 2026
6ca0b87
Polish camera trigger and rename LED article
banchan86 Sep 9, 2026
62e33ae
Polish advanced configuration article
banchan86 Sep 10, 2026
6f428d8
Clean up behavior spec and version history
banchan86 Sep 11, 2026
b21f973
Rework connections as tabs and add first diagram
banchan86 Sep 13, 2026
e5b16e9
Add more diagrams and polish
banchan86 Sep 14, 2026
4b819e0
Clean up images
banchan86 Sep 14, 2026
8c4aa2a
Add more diagrams
banchan86 Sep 15, 2026
8846dfc
Add encoder diagram and polish
banchan86 Sep 16, 2026
ce81fef
Add more diagrams
banchan86 Sep 18, 2026
1fd4f67
Add camera and firmware update diagrams
banchan86 Sep 21, 2026
b6597ee
Edits for grammar and clarity
banchan86 Sep 21, 2026
5ca148c
More polishing
banchan86 Sep 22, 2026
320c7fa
More polishing
banchan86 Sep 23, 2026
bebf46d
Add missing xref
banchan86 Sep 23, 2026
c400870
Clean up device pinout labels
banchan86 Sep 28, 2026
c100516
Remove mockups
banchan86 Sep 29, 2026
8a60813
Add about these examples guide
banchan86 Oct 1, 2026
afaf04c
Make overview image bigger and update photos
banchan86 Oct 1, 2026
78725f3
Update website subsection name to latest convention
banchan86 Oct 2, 2026
bdb4786
Simplify text, convert workflows to images
banchan86 Oct 5, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .bonsai/Bonsai.config
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
<Package id="Bonsai.Core" version="2.9.0" />
<Package id="Bonsai.Design" version="2.9.0" />
<Package id="Bonsai.Editor" version="2.9.0" />
<Package id="Bonsai.Windows.Input" version="2.9.0" />
<Package id="DockPanelSuite" version="3.1.1" />
<Package id="DockPanelSuite.ThemeVS2015" version="3.1.1" />
<Package id="jacobslusser.ScintillaNET" version="3.6.3" />
Expand All @@ -27,12 +28,14 @@
<AssemblyReference assemblyName="Bonsai.Core" />
<AssemblyReference assemblyName="Bonsai.Design" />
<AssemblyReference assemblyName="Bonsai.Editor" />
<AssemblyReference assemblyName="Bonsai.Windows.Input" />
</AssemblyReferences>
<AssemblyLocations>
<AssemblyLocation assemblyName="Bonsai" processorArchitecture="MSIL" location="Packages/Bonsai.2.9.0/lib/net48/Bonsai.exe" />
<AssemblyLocation assemblyName="Bonsai.Core" processorArchitecture="MSIL" location="Packages/Bonsai.Core.2.9.0/lib/net472/Bonsai.Core.dll" />
<AssemblyLocation assemblyName="Bonsai.Design" processorArchitecture="MSIL" location="Packages/Bonsai.Design.2.9.0/lib/net472/Bonsai.Design.dll" />
<AssemblyLocation assemblyName="Bonsai.Editor" processorArchitecture="MSIL" location="Packages/Bonsai.Editor.2.9.0/lib/net472/Bonsai.Editor.dll" />
<AssemblyLocation assemblyName="Bonsai.Windows.Input" processorArchitecture="MSIL" location="Packages/Bonsai.Windows.Input.2.9.0/lib/net472/Bonsai.Windows.Input.dll" />
<AssemblyLocation assemblyName="Markdig" processorArchitecture="MSIL" location="Packages/Markdig.0.41.1/lib/net462/Markdig.dll" />
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.Core" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.2792.45/lib/net462/Microsoft.Web.WebView2.Core.dll" />
<AssemblyLocation assemblyName="Microsoft.Web.WebView2.WinForms" processorArchitecture="MSIL" location="Packages/Microsoft.Web.WebView2.1.0.2792.45/lib/net462/Microsoft.Web.WebView2.WinForms.dll" />
Expand Down
5 changes: 5 additions & 0 deletions docs/apidoc/Harp_Behavior.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Harp.Behavior
---

[!include[RegisterTables](./Harp_Behavior_Device.md)]
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_AnalogData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.AnalogData
---

### Visualize Analog Data

:::workflow
![Visualize Analog Data](../workflows/acquireanalogdata-visualizedata.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_Camera0Frame.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.Camera0Frame
---

### Visualize Frame Events

:::workflow
![Visualize Frame Events](../workflows/apidoc-camera0frame.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_Camera0Frequency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.Camera0Frequency
---

### Configure Trigger Frequency

:::workflow
![Configure Trigger Frequency](../workflows/apidoc-camera0frequency.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_Camera1Frame.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.Camera1Frame
---

### Visualize Frame Events

:::workflow
![Visualize Frame Events](../workflows/triggercameras-visualizeframes.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_Camera1Frequency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.Camera1Frequency
---

### Configure Trigger Frequency

:::workflow
![Configure Trigger Frequency](../workflows/triggercameras-frequency.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateCamera0FrequencyPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateCamera0FrequencyPayload
---

### Configure Trigger Frequency

:::workflow
![Configure Trigger Frequency](../workflows/apidoc-camera0frequency.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateCamera1FrequencyPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateCamera1FrequencyPayload
---

### Configure Trigger Frequency

:::workflow
![Configure Trigger Frequency](../workflows/triggercameras-frequency.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateDisableServosPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateDisableServosPayload
---

### Enable and Disable Servos

:::workflow
![Enable and Disable Servos](../workflows/driveservos-enabledisable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateEnableEncodersPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEnableEncodersPayload
---

### Enable the Encoder

:::workflow
![Enable the Encoder](../workflows/trackrotaryencoder-enable.bonsai)
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEnableSerialTimestampPayload
---

### Stream Timestamps

:::workflow
![Stream Timestamps](../workflows/advancedconfiguration-serialtimestamp.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateEnableServosPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEnableServosPayload
---

### Enable and Disable Servos

:::workflow
![Enable and Disable Servos](../workflows/driveservos-enabledisable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateEncoderModePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEncoderModePayload
---

### Enable the Encoder

:::workflow
![Enable the Encoder](../workflows/trackrotaryencoder-enable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateEncoderResetPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEncoderResetPayload
---

### Reset the Encoder

:::workflow
![Reset the Encoder](../workflows/trackrotaryencoder-reset.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateEventEnablePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateEventEnablePayload
---

### Select Active Events

:::workflow
![Select Active Events](../workflows/advancedconfiguration-eventenable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateLed0CurrentPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateLed0CurrentPayload
---

### Configure LED Current

:::workflow
![Configure LED Current](../workflows/controlleds-current.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateLed0MaxCurrentPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateLed0MaxCurrentPayload
---

### Configure LED Current

:::workflow
![Configure LED Current](../workflows/controlleds-current.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateLed1CurrentPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateLed1CurrentPayload
---

### Configure LED Current

:::workflow
![Configure LED Current](../workflows/apidoc-led1current.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateLed1MaxCurrentPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateLed1MaxCurrentPayload
---

### Configure LED Current

:::workflow
![Configure LED Current](../workflows/apidoc-led1current.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort0IRPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort0IRPayload
---

### Mimic Poke Inputs

:::workflow
![Mimic Poke Inputs](../workflows/mimicpokesignals-mimicir.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort0ValvePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort0ValvePayload
---

### Mimic Poke Valves

:::workflow
![Mimic Poke Valves](../workflows/mimicpokesignals-mimicvalve.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort1IRPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort1IRPayload
---

### Mimic Poke Inputs

:::workflow
![Mimic Poke Inputs](../workflows/apidoc-mimicport1ir.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort1ValvePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort1ValvePayload
---

### Mimic Poke Valves

:::workflow
![Mimic Poke Valves](../workflows/apidoc-mimicport1valve.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort2IRPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort2IRPayload
---

### Mimic Poke Inputs

:::workflow
![Mimic Poke Inputs](../workflows/apidoc-mimicport2ir.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateMimicPort2ValvePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateMimicPort2ValvePayload
---

### Mimic Poke Valves

:::workflow
![Mimic Poke Valves](../workflows/apidoc-mimicport2valve.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateOutputClearPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateOutputClearPayload
---

### Set and Clear Outputs

:::workflow
![Set and Clear Outputs](../workflows/controldigitaloutputs-setclear.bonsai)
:::
17 changes: 17 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateOutputPulseEnablePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
uid: Harp.Behavior.CreateOutputPulseEnablePayload
---

[!INCLUDE [](../articles/outputpulseenable-warning.md)]

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/controldigitaloutputs-pulse.bonsai)
:::

### Generate PWM Bursts

:::workflow
![Generate PWM Bursts](../workflows/generatepwm-pulseenable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateOutputSetPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateOutputSetPayload
---

### Set and Clear Outputs

:::workflow
![Set and Clear Outputs](../workflows/controldigitaloutputs-setclear.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateOutputStatePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateOutputStatePayload
---

### Write All Outputs

:::workflow
![Write All Outputs](../workflows/controldigitaloutputs-state.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreateOutputTogglePayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreateOutputTogglePayload
---

### Toggle Outputs

:::workflow
![Toggle Outputs](../workflows/controldigitaloutputs-toggle.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePokeInputFilterPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreatePokeInputFilterPayload
---

### Configure Input Filter

:::workflow
![Configure Input Filter](../workflows/controlpoke-inputfilter.bonsai)
:::
15 changes: 15 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePulseDO0Payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
uid: Harp.Behavior.CreatePulseDO0Payload
---

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/controldigitaloutputs-pulse.bonsai)
:::

### Generate PWM Bursts

:::workflow
![Generate PWM Bursts](../workflows/generatepwm-pulseenable.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePulseDO1Payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreatePulseDO1Payload
---

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/apidoc-pulsedo1.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePulseDO2Payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreatePulseDO2Payload
---

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/apidoc-pulsedo2.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePulseDO3Payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreatePulseDO3Payload
---

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/apidoc-pulsedo3.bonsai)
:::
9 changes: 9 additions & 0 deletions docs/apidoc/Harp_Behavior_CreatePulseDOPort0Payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
uid: Harp.Behavior.CreatePulseDOPort0Payload
---

### Pulse Outputs

:::workflow
![Pulse Outputs](../workflows/apidoc-pulsedoport0.bonsai)
:::
Loading
Loading