Deploy docs website

emotional-cities · Oct 5, 2023 · 75b7318 · 75b7318
commit 75b7318
Show file tree

Hide file tree

Showing 79 changed files with 26,499 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,27 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+###############################
+# Core EditorConfig Options   #
+###############################
+# All files
+[*]
+indent_style = space
+
+# XML project files
+[*.{csproj,vcxproj,vcxproj.filters,proj,projitems,shproj,bonsai}]
+indent_size = 2
+
+# XML config files
+[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
+indent_size = 2
+
+# Code files
+[*.{cs,csx}]
+indent_size = 4
+insert_final_newline = true
+charset = utf-8-bom
+###############################
+# .NET Coding Conventions     #
+###############################
+[*.{cs}]
+# Organize usings
+dotnet_sort_system_directives_first = true
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+* text=auto
+*.cmd text eol=crlf
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,37 @@
+# Builds and publishes the documentation website to gh-pages branch
+name: Build docs
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      # Build static site content using DocFX
+      - uses: nikeee/[email protected]
+        name: Build Documentation
+        with:
+         args: Docs/docfx.json
+
+      - name: Checkout gh-pages
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+          path: gh-pages
+      - name: Publish to github pages
+        run: |
+          cd gh-pages
+          rm -rf *
+          touch .nojekyll
+          cp -a ../Docs/_site/. .
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add .
+          git commit --reset-author --amend -m "Deploy docs website"
+          git push --force origin gh-pages
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+
+desktop.ini
+
+# Visual studio files
+.vs
+.vscode
+.suo
+.nuget
+bin
+obj
+Debug
+packages
+*.componentinfo.xml
diff --git a/.nojekyll b/.nojekyll
diff --git a/api/EmotionalCities.Pluma.AccelerometerData.html b/api/EmotionalCities.Pluma.AccelerometerData.html
diff --git a/api/EmotionalCities.Pluma.AsyncDevice.html b/api/EmotionalCities.Pluma.AsyncDevice.html
diff --git a/api/EmotionalCities.Pluma.CreateAccelerometerDataPayload.html b/api/EmotionalCities.Pluma.CreateAccelerometerDataPayload.html
@@ -0,0 +1,285 @@
+<!DOCTYPE html>
+<!--[if IE]><![endif]-->
+<html>
+
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>Class CreateAccelerometerDataPayload
+   </title>
+    <meta name="viewport" content="width=device-width">
+    <meta name="title" content="Class CreateAccelerometerDataPayload
+   ">
+    <meta name="generator" content="docfx 2.56.7.0">
+
+    <link rel="shortcut icon" href="../favicon.ico">
+    <link rel="stylesheet" href="../styles/docfx.vendor.css">
+    <link rel="stylesheet" href="../styles/docfx.css">
+    <link rel="stylesheet" href="../styles/main.css">
+    <meta property="docfx:navrel" content="../toc.html">
+    <meta property="docfx:tocrel" content="toc.html">
+
+    <meta property="docfx:rel" content="../">
+
+  </head>
+  <body data-spy="scroll" data-target="#affix" data-offset="120">
+    <div id="wrapper">
+      <header>
+
+        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
+          <div class="container">
+            <div class="navbar-header">
+              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+              </button>
+
+              <a class="navbar-brand" href="../index.html">
+                <img id="logo" class="svg" src="../logo.svg" alt="">
+              </a>
+            </div>
+            <div class="collapse navbar-collapse" id="navbar">
+              <form class="navbar-form navbar-right" role="search" id="search">
+                <div class="form-group">
+                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
+                </div>
+              </form>
+            </div>
+          </div>
+        </nav>
+
+        <div class="subnav navbar navbar-default">
+          <div class="container hide-when-search" id="breadcrumb">
+            <ul class="breadcrumb">
+              <li></li>
+            </ul>
+          </div>
+        </div>
+      </header>
+      <div class="container body-content">
+
+        <div id="search-results">
+          <div class="search-list">Search Results for <span></span></div>
+          <div class="sr-items">
+            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
+          </div>
+          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
+        </div>
+      </div>
+      <div role="main" class="container body-content hide-when-search">
+
+        <div class="sidenav hide-when-search">
+          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
+          <div class="sidetoggle collapse" id="sidetoggle">
+            <div id="sidetoc"></div>
+          </div>
+        </div>
+        <div class="article row grid-right">
+          <div class="col-md-10">
+            <article class="content wrap" id="_content" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload">
+
+
+  <h1 id="EmotionalCities_Pluma_CreateAccelerometerDataPayload" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload" class="text-break">Class CreateAccelerometerDataPayload
+  </h1>
+  <div class="markdown level0 summary"><p>Represents an operator that creates a message payload
+that stream that generates an event on each triggered acquisition by the external accelerometer board.</p>
+</div>
+  <div class="markdown level0 conceptual"></div>
+  <div class="inheritance">
+    <h5>Inheritance</h5>
+    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
+    <div class="level1"><span class="xref">CreateAccelerometerDataPayload</span></div>
+      <div class="level2"><a class="xref" href="EmotionalCities.Pluma.CreateTimestampedAccelerometerDataPayload.html">CreateTimestampedAccelerometerDataPayload</a></div>
+  </div>
+  <div class="inheritedMembers">
+    <h5>Inherited Members</h5>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
+    </div>
+    <div>
+      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
+    </div>
+  </div>
+  <h6><strong>Namespace</strong>: <a class="xref" href="EmotionalCities.Pluma.html">EmotionalCities.Pluma</a></h6>
+  <h6><strong>Assembly</strong>: EmotionalCities.Pluma.dll</h6>
+  <h5 id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_syntax">Syntax</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public class CreateAccelerometerDataPayload</code></pre>
+  </div>
+  <h3 id="properties">Properties
+  </h3>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/emotional-cities/pluma/new/main/apiSpec/new?filename=EmotionalCities_Pluma_CreateAccelerometerDataPayload_AccelerometerData.md&amp;value=---%0Auid%3A%20EmotionalCities.Pluma.CreateAccelerometerDataPayload.AccelerometerData%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/emotional-cities/pluma/blob/main/Interface/EmotionalCities.Pluma/Device.Generated.cs/#L1460">View Source</a>
+  </span>
+  <a id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_AccelerometerData_" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.AccelerometerData*"></a>
+  <h4 id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_AccelerometerData" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.AccelerometerData">AccelerometerData</h4>
+  <div class="markdown level1 summary"><p>Gets or sets the value that stream that generates an event on each triggered acquisition by the external accelerometer board.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public byte AccelerometerData { get; set; }</code></pre>
+  </div>
+  <h5 class="propertyValue">Property Value</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">Byte</a></td>
+        <td></td>
+      </tr>
+    </tbody>
+  </table>
+  <h3 id="methods">Methods
+  </h3>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/emotional-cities/pluma/new/main/apiSpec/new?filename=EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetMessage_MessageType_.md&amp;value=---%0Auid%3A%20EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetMessage(MessageType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/emotional-cities/pluma/blob/main/Interface/EmotionalCities.Pluma/Device.Generated.cs/#L1477">View Source</a>
+  </span>
+  <a id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetMessage_" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetMessage*"></a>
+  <h4 id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetMessage_MessageType_" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetMessage(MessageType)">GetMessage(MessageType)</h4>
+  <div class="markdown level1 summary"><p>Creates a message that stream that generates an event on each triggered acquisition by the external accelerometer board.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public HarpMessage GetMessage(MessageType messageType)</code></pre>
+  </div>
+  <h5 class="parameters">Parameters</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Name</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">MessageType</span></td>
+        <td><span class="parametername">messageType</span></td>
+        <td><p>Specifies the type of the created message.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">HarpMessage</span></td>
+        <td><p>A new message for the AccelerometerData register.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/emotional-cities/pluma/new/main/apiSpec/new?filename=EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetPayload.md&amp;value=---%0Auid%3A%20EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetPayload%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+  </span>
+  <span class="small pull-right mobile-hide">
+    <a href="https://github.com/emotional-cities/pluma/blob/main/Interface/EmotionalCities.Pluma/Device.Generated.cs/#L1467">View Source</a>
+  </span>
+  <a id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetPayload_" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetPayload*"></a>
+  <h4 id="EmotionalCities_Pluma_CreateAccelerometerDataPayload_GetPayload" data-uid="EmotionalCities.Pluma.CreateAccelerometerDataPayload.GetPayload">GetPayload()</h4>
+  <div class="markdown level1 summary"><p>Creates a message payload for the AccelerometerData register.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public byte GetPayload()</code></pre>
+  </div>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">Byte</a></td>
+        <td><p>The created message payload value.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+</article>
+          </div>
+
+          <div class="hidden-sm col-md-2" role="complementary">
+            <div class="sideaffix">
+              <div class="contribution">
+                <ul class="nav">
+                  <li>
+                    <a href="https://github.com/emotional-cities/pluma/new/main/apiSpec/new?filename=EmotionalCities_Pluma_CreateAccelerometerDataPayload.md&amp;value=---%0Auid%3A%20EmotionalCities.Pluma.CreateAccelerometerDataPayload%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
+                  </li>
+                  <li>
+                    <a href="https://github.com/emotional-cities/pluma/blob/main/Interface/EmotionalCities.Pluma/Device.Generated.cs/#L1453" class="contribution-link">View Source</a>
+                  </li>
+                </ul>
+              </div>
+              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
+                <h5>In This Article</h5>
+                <div></div>
+              </nav>
+            </div>
+          </div>
+        </div>
+      </div>
+
+      <footer>
+        <div class="grad-bottom"></div>
+        <div class="footer">
+          <div class="container">
+            <span class="pull-right">
+              <a href="#top">Back to top</a>
+            </span>
+
+            <span>Generated by <strong>DocFX</strong></span>
+          </div>
+        </div>
+      </footer>
+    </div>
+
+    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
+    <script type="text/javascript" src="../styles/docfx.js"></script>
+    <script type="text/javascript" src="../styles/main.js"></script>
+  </body>
+</html>