a couple midi doc pages

machineagency · Nov 14, 2024 · 40cf2bd · 40cf2bd
1 parent 03da3a4
commit 40cf2bd
Show file tree

Hide file tree

Showing 52 changed files with 694 additions and 46 deletions.
diff --git a/content/docs/reference/_index.md b/content/docs/reference/_index.md
@@ -146,8 +146,25 @@ weight: 1
     </tr>
   </tbody>
 </table>
-</div>
+
 
 
 ## <a href="reference-pages/fab">MIDI</a>
+<table>
+  <tbody>
+    <tr>
+      <td>
+        <a href="reference-pages/mididata" class="ref-item">midiData</a><br>
+        <span class="ref-info">Message data sent from a MIDI device</span>
+      </td>
+      <td>
+        <a href="reference-pages/mapvalue" class="ref-item">mapValue()</a><br>
+        <span class="ref-info">Map MIDI value data to a new range.</span>
+      </td>
+      <td>
+      </td>
+    </tr>
+  </tbody>
+</table>
 
+</div>
diff --git a/content/docs/reference/reference-pages/mapValue.md b/content/docs/reference/reference-pages/mapValue.md
@@ -0,0 +1,21 @@
+---
+title: "mapValue"
+bookHidden: true
+---
+
+<h2 class="ref-header">mapValue()</h2>
+Remap the incoming value of MIDI message data from 0-127 to a new range
+
+### Syntax
+```
+midiData.mapValue(startRange, endRange)
+```
+
+### Parameters
+<div class="grid-container">
+ <div class="grid-item">startRange</div>
+ <div class="grid-item">Number, the lower bound of the value's target range.</div>
+
+ <div class="grid-item">endRange</div>
+ <div class="grid-item">Number, the upper bound of the value's target range.</div>
+</div>
diff --git a/content/docs/reference/reference-pages/midiData.md b/content/docs/reference/reference-pages/midiData.md
@@ -0,0 +1,20 @@
+---
+title: "midiData"
+bookHidden: true
+---
+
+<h2 class="ref-header">midiData</h2>
+Object carrying MIDI message data. Use it in the `midiSetup` loop.
+
+### Fields
+<div class="grid-container">
+ <div class="grid-item">Note</div>
+ <div class="grid-item">Number, the unique ID for the MIDI input</div>
+
+ <div class="grid-item">Value</div>
+ <div class="grid-item">Number, a value between 0-127.</div>
+
+ <div class="grid-item">Type</div>
+ <div class="grid-item">Number, different MIDI devices might assign different types to various inputs/interactions.</div>
+
+</div>
diff --git a/content/docs/resources/tutorials/etch-a-sketch-tutorial.md b/content/docs/resources/tutorials/etch-a-sketch-tutorial.md
@@ -23,4 +23,4 @@ For our etch a sketch, we'll toggle between extruding and just moving around wit
 
 
 ## Step 3: Print
-Connect to your print and start the print: the machine will home and set temperatures (as defined in `fabDraw`). Then, you can use your knobs to move the machine around. Press your button to start extruding; make sure you raise the z height up a little bit so filament can exit the nozzle.
+Connect to your printer and start the print: the machine will home and set temperatures (as defined in `fabDraw`). Then, you can use your knobs to move the machine around. Press your button to start extruding; make sure you raise the z height up a little bit so filament can exit the nozzle.
diff --git a/public/404.html b/public/404.html
@@ -18,7 +18,7 @@
 <link rel="canonical" href="http://localhost:1313/404.html">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book

diff --git a/public/categories/index.html b/public/categories/index.html
@@ -17,7 +17,7 @@
 <link rel="canonical" href="http://localhost:1313/categories/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <link rel="alternate" type="application/rss+xml" href="http://localhost:1313/categories/index.xml" title="p5.fab" />
 <!--
 Made with Book Theme

diff --git a/public/docs/index.html b/public/docs/index.html
@@ -17,7 +17,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <link rel="alternate" type="application/rss+xml" href="http://localhost:1313/docs/index.xml" title="p5.fab" />
 <!--
 Made with Book Theme

diff --git a/public/docs/machine-compatibility/index.html b/public/docs/machine-compatibility/index.html
@@ -21,7 +21,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/machine-compatibility/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book

diff --git a/public/docs/quickstart/index.html b/public/docs/quickstart/index.html
@@ -21,7 +21,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/quickstart/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book

diff --git a/public/docs/reference/index.html b/public/docs/reference/index.html
@@ -25,7 +25,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/reference/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <link rel="alternate" type="application/rss+xml" href="http://localhost:1313/docs/reference/index.xml" title="p5.fab" />
 <!--
 Made with Book Theme
@@ -346,12 +346,27 @@ <h3 id="streaming">
     </tr>
   </tbody>
 </table>
-</div>
 <h2 id="a-hrefreference-pagesfabmidia">
   <a href="reference-pages/fab">MIDI</a>
   <a class="anchor" href="#a-hrefreference-pagesfabmidia">#</a>
 </h2>
-</article>
+<table>
+  <tbody>
+    <tr>
+      <td>
+        <a href="reference-pages/mididata" class="ref-item">midiData</a><br>
+        <span class="ref-info">Message data sent from a MIDI device</span>
+      </td>
+      <td>
+        <a href="reference-pages/mapvalue" class="ref-item">mapValue()</a><br>
+        <span class="ref-info">Map MIDI value data to a new range.</span>
+      </td>
+      <td>
+      </td>
+    </tr>
+  </tbody>
+</table>
+</div></article>
 
 
 

diff --git a/public/docs/reference/index.xml b/public/docs/reference/index.xml
@@ -28,6 +28,20 @@
       <guid>http://localhost:1313/docs/reference/reference-pages/fab/</guid>
       <description> Fab # A class to describe a fabrication machine.&#xA;A fab object represents a 3D printer. It is comprised of the following information:&#xA;workEnvelope: maximum X, Y, and Z dimensions of the machine nozzleDiameter: Diameter of the nozzle in mm filamentDiameter: Diameter of filament in mm name: a human readable string to identify this machine Syntax # fab([config])&#xA;Parameters # config: a json object specifying requisite machine information </description>
     </item>
+    <item>
+      <title>mapValue</title>
+      <link>http://localhost:1313/docs/reference/reference-pages/mapvalue/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      <guid>http://localhost:1313/docs/reference/reference-pages/mapvalue/</guid>
+      <description>mapValue() Remap the incoming value of MIDI message data from 0-127 to a new range Syntax # midiData.mapValue(startRange, endRange) Parameters # startRange Number, the lower bound of the value&#39;s target range. endRange Number, the upper bound of the value&#39;s target range. </description>
+    </item>
+    <item>
+      <title>midiData</title>
+      <link>http://localhost:1313/docs/reference/reference-pages/mididata/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      <guid>http://localhost:1313/docs/reference/reference-pages/mididata/</guid>
+      <description>midiData Object carrying MIDI message data. Use it in the `midiSetup` loop. Fields # Note Number, the unique ID for the MIDI input Value Number, a value between 0-127. Type Number, different MIDI devices might assign different types to various inputs/interactions. </description>
+    </item>
     <item>
       <title>Move</title>
       <link>http://localhost:1313/docs/reference/reference-pages/move/</link>

diff --git a/public/docs/reference/reference-pages/autohome/index.html b/public/docs/reference/reference-pages/autohome/index.html
@@ -19,7 +19,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/reference/reference-pages/autohome/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book

diff --git a/public/docs/reference/reference-pages/continuous-mode/index.html b/public/docs/reference/reference-pages/continuous-mode/index.html
@@ -19,7 +19,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/reference/reference-pages/continuous-mode/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book

diff --git a/public/docs/reference/reference-pages/fab/index.html b/public/docs/reference/reference-pages/fab/index.html
@@ -25,7 +25,7 @@
 <link rel="canonical" href="http://localhost:1313/docs/reference/reference-pages/fab/">
 <link rel="stylesheet" href="/book.min.58f1cb8a5f164a60e2fe794ee720850e12c90ce1075a71225158cf8cfce361af.css" integrity="sha256-WPHLil8WSmDi/nlO5yCFDhLJDOEHWnEiUVjPjPzjYa8=" crossorigin="anonymous">
   <script defer src="/flexsearch.min.js"></script>
-  <script defer src="/en.search.min.0b454365993b2814700e6baca016c3ac1a8102611c92a77c3ac7dc2cce7b0c3d.js" integrity="sha256-C0VDZZk7KBRwDmusoBbDrBqBAmEckqd8OsfcLM57DD0=" crossorigin="anonymous"></script>
+  <script defer src="/en.search.min.61894a67e4e6e3125c0e85491dcf148e52158d8a96aac0de1c93292436805139.js" integrity="sha256-YYlKZ&#43;Tm4xJcDoVJHc8UjlIVjYqWqsDeHJMpJDaAUTk=" crossorigin="anonymous"></script>
 <!--
 Made with Book Theme
 https://github.com/alex-shpak/hugo-book