Merge pull request #5 from harp-tech/protocol

Add protocol documentation pages

Author: glopesdev

.gitmodules

@@ -31,3 +31,6 @@
 [submodule "src/device.outputexpander"]
 	path = src/device.outputexpander
 	url = https://github.com/harp-tech/device.outputexpander.git
+[submodule "protocol"]
+	path = protocol
+	url = https://github.com/harp-tech/protocol.git

articles/about.md

@@ -0,0 +1,11 @@
+# What is Harp
+
+Harp describes a communication protocol and architecture, as well as specific devices that implement these structures.
+
+## Why Harp was developed
+
+Current Neuroscience experiments rely on multiple parallel streams of data, acquired from different devices, to examine how neural circuit activity relates to animal behaviours. This requires precise timestamping of experimental events, so that neural and behavioural data can be accurately ordered in time. Temporally aligning different streams of data, often acquired at different frequencies, rapidly becomes more difficult as setups increase in complexity.
+
+Harp is a family of high-performance devices that make it easy for scientists to synchronize and extend the functionality of their setups. Harp devices can configure, control, & track a wide range of peripheral devices such as cameras, LEDs, nosepokes, & motors. Connecting an extra Harp device is a straightforward way to add extra functionality to a setup. All Harp devices can be connected to a shared clock line, self-synchronizing to a precision of tens of microseconds. This means that all experimental events are timestamped on the same clock and no post-hoc alignment of timing is necessary.
+
+From an engineering perspective, extending the functionality of a setup can also be difficult, if this requires developing a new device, including how this device will communicates with a computer, and how users will interact with the device. By agreeing beforehand how the entire family of devices will communicate, engineers do not have to reinvent or attune protocols each time they wish to develop a new device. This leads to faster, cheaper, and more robust development.

articles/toc.yml

@@ -1,4 +1,16 @@
-- name: Getting Started
+- name: About
+  items:
+    - name: What is Harp
+      href: about.md
+- name: Protocol
+  items:
+    - name: Binary Protocol
+      href: ~/protocol/BinaryProtocol-8bit.md
+    - name: Common Registers
+      href: ~/protocol/Device.md
+    - name: Synchronization Clock
+      href: ~/protocol/SynchronizationClock.md
+- name: Interface
   items:
     - name: Quickstart
       href: intro.md

docfx.json

@@ -34,8 +34,12 @@
           "articles/**/toc.yml",
           "tutorials/**.md",
           "tutorials/**/toc.yml",
+          "protocol/**.md",
           "toc.yml",
           "*.md"
+        ],
+        "exclude": [
+          "protocol/README.md"
         ]
       }
     ],
@@ -46,6 +50,9 @@
           "favicon.ico",
           "src/device.*/Assets/*.png",
           "src/device.*/Assets/*.jpg",
+          "protocol/Assets/**",
+          "protocol/Logo/*.svg",
+          "protocol/*.pdf",
           "images/**",
           "workflows/**"
         ]

protocol

@@ -0,0 +1,15 @@
+<!-- Mermaid -->
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.2/css/all.min.css" />
+<script type="text/javascript" src="{{_rel}}styles/docfx.vendor.min.js"></script>
+<script type="text/javascript" src="{{_rel}}styles/docfx.js"></script>
+<script type="text/javascript" src="{{_rel}}styles/main.js"></script>
+<script type="text/javascript" src="https://unpkg.com/mermaid@10.3.1/dist/mermaid.min.js"
+        integrity="sha384-58cFgoKnTNsiRsIGipaj7SlPrj6T0tkDXKnAqT3uZMRaNnGXX/ORrpCSMzznqldk" 
+        crossorigin="anonymous"></script>
+<!-- Initialize Mermaid -->
+<script>
+    mermaid.initialize({
+        startOnLoad: false
+    });
+    mermaid.init(undefined, ".lang-mermaid");
+</script>