Merge pull request #2 from harp-tech/bc-manual

Documentation on core Harp package operators

Author: bruno-f-cruz

articles/firmware-updates.md

@@ -0,0 +1,20 @@
+# Firmware
+
+As Harp devices are updated, new features are added and bugs are fixed. Device-specific interfaces depend on the right firmware being installed on your device. This section details how to check and maintain the correct version of device firmware to ensure reproducible workflows.
+
+## Updating device firmware
+
+To ensure that your device is running the latest firmware, you can use the **Device Setup** tool available in Bonsai. This tool is made available by installing the `Bonsai.Harp.Design` package. To launch it, simply add a generic `Device` node to your workflow, and open its default editor (by double-clicking on the node). If a Harp device is detected on the currently selected COM port, the following dialog will appear:
+
+![firmware update](~/images/fw-update.png){height=200px}
+
+To update the device's firmware version:
+
+1. Click `Bootloader`;
+2. Click `Open`;
+3. Select a `.hex` file containing the new firmware. These files should be available on the device's releases page (e.g.: [Harp Behavior](https://github.com/harp-tech/device.behavior/releases) under the `fwX.Y-harpV.W` release name). Importantly, as stated in the dialog window, please ensure the the new firmware is compatible with the targeted device;
+4. Click `Update`.
+
+![firmware update step2](~/images/fw-update_hex.png){height=200px}
+
+If everything goes well, the device will reboot with the new firmware.

articles/firmware.md

@@ -0,0 +1,21 @@
+Getting Started with Bonsai - Harp
+==================================
+
+All [Harp Devices](https://harp-tech.org/Devices/device_list.html) implement the [Harp Protocol](https://harp-tech.org/About/How-HARP-works/index.html) to communicate with an host PC. The `Bonsai.Harp` library provides an implementation of the Harp protocol that can be used to interface with any Harp device.
+
+## Pre-requisites
+
+1. [Bonsai](https://bonsai-rx.org)
+2. [FTDI D2XX Drivers](https://www.ftdichip.com/old2020/Drivers/CDM/CDM%20v2.12.26%20WHQL%20Certified.zip)
+
+## How to install
+
+The latest release of the Bonsai.Harp can be downloaded and installed through the Bonsai package manager (see [here](https://bonsai-rx.org/docs/articles/packages.html) for details on how to install Bonsai packages). We also recommend installing the `Bonsai.Harp.Design` package which provides useful additional functionality such as dialogs for updating device firmware and visualizers.
+
+## Device specific packages
+
+A high-level interface will usually be available for the specific Harp device you are using. To install them, first change the package manager **Package source** to `nuget.org`. Then, in the search bar, look for your device by typing: `harp.<device>`. For instance, for the Harp Behavior board, you should find the following package:
+
+![HarpDevicePackage](~/images/behaviorpackage.png)
+
+The device nodes should now be available in the Bonsai Toolbox. You can now start using them in your workflows.