Add application notes for Harp SoundCard and Harp StepperDriver

[banchan86]

Requirements:

Soundcard

• How to update and play waveforms in Bonsai, without using the Harp SoundCard GUI
• How to generate the waveforms themselves in Bonsai

StepperDriver

• Position set and speed set
• How to implement quick retract

[banchan86]

Previous discussions:

• Proposal for site reorganization and revamp #23
• Documentation development roadmap device.soundcard#27

Although we likely don't have time to set up a full guide, the examples will probably need some basic scaffolding, like a "Getting Started" article. We can scope this based on time and expand on this scaffold in the future.

Another point to consider is where to put these application notes. There is an existing "Tutorials" section of the website that only covers the Harp Hobgoblin so far, but the format might end up being quite different. We could create a new "Guides" or "Examples" section, keeping in mind people's expectations for each label.

[banchan86]

SoundCard Setup Notes:

• Harp SoundCard GUI - there are two versions of the GUI, v1.2.1 on the device README and v1.3.2 at CF Hardware and Software Platform. We probably won't feature the GUI, but if we include the README.md in a "Getting Started" article, we should probably update the link to align the two.

• Binding WinUSB driver - I had trouble installing the WICD driver on both Windows 11 Home and Pro, with it not properly binding (device manager still shows the SoundCard as not installed properly despite Zadig reporting it a success). Switching to the non-WICD version works (it still recognizes the device on reboot/replug). I do not know if this is a common issue or just specific to my setup, but if it is, we should probably also update the instructions in the README for the same reason above.

[banchan86]

@bruno-f-cruz keeping you in the loop!

[banchan86]

I finished my review of the soundcard and created examples for it, I think I am going to go with putting them under the current "Tutorials" section, and here is the TOC I have in mind.

Harp SoundCard

• Getting Started
  • Installation
    • Install FTDI dirvers
    • Install Zadig (direct from Zadig website) and WinUSB driver 
    • Install Bonsai
    • Install Harp.SoundCard Package
    • (Optional) Install Harp Soundcard GUI
  • Testing the device
    • Play Sound Frequency (Hello World Equivalent)
• Connections
  • Wiring diagram (figure 4 from paper)
  • Amplifier info
  • Speaker info
• Play Sounds
  • Setting up device pattern
  • Play from sound index via keydown trigger (add note on other possible triggers Timer/Delay)
  • Play and stop frequency via keydown trigger/delay  (add note on non-RTOS timings for sound duration)
  • Play sound with attenuation (AttenuationAndPlaySound register)
  • Configure Digital Inputs for sound trigger
• Upload Sounds
  • Pure tones
  • Wavs (24 bit warning)
  • Bin Mats
  • White Noise

There is some other stuff I considered to add, but will leave them out for now either due to time constraints or some other factors:

• Updating firmware (document harp.toolkit, link to it)
• Adjusting channel attenuation during sound playback
• Adding fade in/fade out window to eliminate clicks
• Generating tone sweeps (chirp is not possible, but steps are)
• Generating differential stereo channel waveforms
• Configuring digital input trigger for playback frequency and attenuation (only start sound seems to work? not sure if i am the only one running into this issue)
• Sending digital output pulses on sound play or stop
• Using analog input data to control audio parameters
• Saving waveforms as MAT or WAV (24 bit warning)

[bruno-f-cruz]

This looks absolutely amazing! thanks @banchan86!

You may be able to re-use some of the diagrams in the paper btw: https://www.sciencedirect.com/science/article/pii/S246806722400049X?via%3Dihub

[banchan86]

SoundCard PR is up at #41!

[banchan86]

Finished my review of the Harp Stepper Driver, this is my plan for the TOC:

Harp Stepper Driver

• Getting started
  • Installation
    • Install FTDI drivers
    • Install Bonsai
    • Install Harp.StepperDriver Package (show advanced)
  • Connections
    • Stepper Motor
    • Power supply (current and voltage)
• Configuration
  • Device Pattern
  • Interlock
  • Microstep Resolution
  • Other parameters (OperationMode, MaximumRunCurrent, HoldCurrentReduction)
  • Enable/Disable Motor
• Control Motor
  • Add safety warning?
  • Position visualizer (AccumulatedSteps, AccumulatedStepsSampling)
  • Speed (S-ramp profile)
  • Position
    • Move relative position
    • Move absolute position
  • Stopping the motor
    • Set absolute position limits
    • Emergency stop
  • Continuous Movement
    • Move continuously (StepRelative)
  • Zero Position/Set origin (warn about absolute positions)
• Quick Movement
  • Prerelease notice
  • Firmware prerequisite
  • Configure DynamicMovement and AccumulatedStepsSamplingRate
  • Configure QuickMovement

Stuff not included this round:

• Hello world example (might be dangerous without going through tutorial?)
• Saving data (there is no `DeviceDataWriter` yet, can use generic `MessageWriter`, but maybe better to wait for bonsai interface update)
• Integration with quadrature encoder
• Digital Input stop movement (for end-of-travel switches)
• Error registers
• Calibration and conversion to SI units instead of steps