Sign upLogin

gunthercox/Salvius

View on GitHub
Star
docs/salvius.html

Summary

Maintainability
Test Coverage

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <title>salvius package &#8212; Salvius 0.0.1 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="prev" title="Salvius robot documentation" href="index.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="salvius-package">
<h1>salvius package<a class="headerlink" href="#salvius-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-salvius.communication">
<span id="salvius-communication-module"></span><h2>salvius.communication module<a class="headerlink" href="#module-salvius.communication" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="salvius.communication.ApiDriver">
<em class="property">class </em><code class="sig-prename descclassname">salvius.communication.</code><code class="sig-name descname">ApiDriver</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/communication.html#ApiDriver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.communication.ApiDriver" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.driver.Driver</span></code></p>
<dl class="py method">
<dt id="salvius.communication.ApiDriver.get_response">
<code class="sig-name descname">get_response</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/communication.html#ApiDriver.get_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.communication.ApiDriver.get_response" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt id="salvius.communication.Conversation">
<em class="property">class </em><code class="sig-prename descclassname">salvius.communication.</code><code class="sig-name descname">Conversation</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/communication.html#Conversation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.communication.Conversation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.adaptor.Adaptor</span></code></p>
<dl class="py method">
<dt id="salvius.communication.Conversation.respond">
<code class="sig-name descname">respond</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/communication.html#Conversation.respond"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.communication.Conversation.respond" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-salvius.hbridge">
<span id="salvius-hbridge-module"></span><h2>salvius.hbridge module<a class="headerlink" href="#module-salvius.hbridge" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="salvius.hbridge.HBridge">
<em class="property">class </em><code class="sig-prename descclassname">salvius.hbridge.</code><code class="sig-name descname">HBridge</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#HBridge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.HBridge" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.driver.Driver</span></code></p>
<p>A h-bridge base class.</p>
<dl class="py exception">
<dt id="salvius.hbridge.HBridge.RelayException">
<em class="property">exception </em><code class="sig-name descname">RelayException</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#HBridge.RelayException"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.HBridge.RelayException" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="salvius.hbridge.RelayHBridge">
<em class="property">class </em><code class="sig-prename descclassname">salvius.hbridge.</code><code class="sig-name descname">RelayHBridge</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#RelayHBridge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.RelayHBridge" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#salvius.hbridge.HBridge" title="salvius.hbridge.HBridge"><code class="xref py py-class docutils literal notranslate"><span class="pre">salvius.hbridge.HBridge</span></code></a></p>
<p>A relay h-bridge driver class.</p>
<dl class="py method">
<dt id="salvius.hbridge.RelayHBridge.rotate_clockwise">
<code class="sig-name descname">rotate_clockwise</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#RelayHBridge.rotate_clockwise"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.RelayHBridge.rotate_clockwise" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge on and set it to spin the motor clockwise.</p>
</dd></dl>

<dl class="py method">
<dt id="salvius.hbridge.RelayHBridge.rotate_counterclockwise">
<code class="sig-name descname">rotate_counterclockwise</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#RelayHBridge.rotate_counterclockwise"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.RelayHBridge.rotate_counterclockwise" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge on and set it to spin the motor counterclockwise.</p>
</dd></dl>

<dl class="py method">
<dt id="salvius.hbridge.RelayHBridge.turn_off">
<code class="sig-name descname">turn_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#RelayHBridge.turn_off"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.RelayHBridge.turn_off" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge off.</p>
</dd></dl>

<dl class="py method">
<dt id="salvius.hbridge.RelayHBridge.turn_relays_off_if_on">
<code class="sig-name descname">turn_relays_off_if_on</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#RelayHBridge.turn_relays_off_if_on"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.RelayHBridge.turn_relays_off_if_on" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn each relay off only if it is on.
This prevents unnecessary writes to relays that are already off.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="salvius.hbridge.ServoHBridge">
<em class="property">class </em><code class="sig-prename descclassname">salvius.hbridge.</code><code class="sig-name descname">ServoHBridge</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#ServoHBridge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.ServoHBridge" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#salvius.hbridge.HBridge" title="salvius.hbridge.HBridge"><code class="xref py py-class docutils literal notranslate"><span class="pre">salvius.hbridge.HBridge</span></code></a></p>
<p>A servo h-bridge driver class.</p>
<dl class="py method">
<dt id="salvius.hbridge.ServoHBridge.rotate_clockwise">
<code class="sig-name descname">rotate_clockwise</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#ServoHBridge.rotate_clockwise"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.ServoHBridge.rotate_clockwise" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge on and set it to spin the motor clockwise.</p>
</dd></dl>

<dl class="py method">
<dt id="salvius.hbridge.ServoHBridge.rotate_counterclockwise">
<code class="sig-name descname">rotate_counterclockwise</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#ServoHBridge.rotate_counterclockwise"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.ServoHBridge.rotate_counterclockwise" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge on and set it to spin the motor counterclockwise.</p>
</dd></dl>

<dl class="py method">
<dt id="salvius.hbridge.ServoHBridge.turn_off">
<code class="sig-name descname">turn_off</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/hbridge.html#ServoHBridge.turn_off"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.hbridge.ServoHBridge.turn_off" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn the h-bridge off.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-salvius.speech">
<span id="salvius-speech-module"></span><h2>salvius.speech module<a class="headerlink" href="#module-salvius.speech" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="salvius.speech.ApiDriver">
<em class="property">class </em><code class="sig-prename descclassname">salvius.speech.</code><code class="sig-name descname">ApiDriver</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#ApiDriver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.ApiDriver" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.driver.Driver</span></code></p>
<dl class="py method">
<dt id="salvius.speech.ApiDriver.get_words">
<code class="sig-name descname">get_words</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#ApiDriver.get_words"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.ApiDriver.get_words" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.ApiDriver.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#ApiDriver.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.ApiDriver.start" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.ApiDriver.stop">
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#ApiDriver.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.ApiDriver.stop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="py class">
<dt id="salvius.speech.SpeechRecognition">
<em class="property">class </em><code class="sig-prename descclassname">salvius.speech.</code><code class="sig-name descname">SpeechRecognition</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechRecognition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechRecognition" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.adaptor.Adaptor</span></code></p>
<dl class="py method">
<dt id="salvius.speech.SpeechRecognition.callback">
<code class="sig-name descname">callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">recognizer</span></em>, <em class="sig-param"><span class="n">audio</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechRecognition.callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechRecognition.callback" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.SpeechRecognition.connect">
<code class="sig-name descname">connect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechRecognition.connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechRecognition.connect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.SpeechRecognition.disconnect">
<code class="sig-name descname">disconnect</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechRecognition.disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechRecognition.disconnect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.SpeechRecognition.start_listening">
<code class="sig-name descname">start_listening</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechRecognition.start_listening"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechRecognition.start_listening" title="Permalink to this definition">¶</a></dt>
<dd><p>Start the listening process.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="salvius.speech.SpeechSynthesis">
<em class="property">class </em><code class="sig-prename descclassname">salvius.speech.</code><code class="sig-name descname">SpeechSynthesis</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">options</span></em>, <em class="sig-param"><span class="n">connection</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechSynthesis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechSynthesis" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">zorg.driver.Driver</span></code></p>
<dl class="py method">
<dt id="salvius.speech.SpeechSynthesis.reply">
<code class="sig-name descname">reply</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">text</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechSynthesis.reply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechSynthesis.reply" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.SpeechSynthesis.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechSynthesis.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechSynthesis.start" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt id="salvius.speech.SpeechSynthesis.stop">
<code class="sig-name descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/salvius/speech.html#SpeechSynthesis.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#salvius.speech.SpeechSynthesis.stop" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-salvius">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-salvius" title="Permalink to this headline">¶</a></h2>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">Salvius</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">salvius package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-salvius.communication">salvius.communication module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-salvius.hbridge">salvius.hbridge module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-salvius.speech">salvius.speech module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-salvius">Module contents</a></li>
</ul>
</li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="index.html" title="previous chapter">Salvius robot documentation</a></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    
    <div class="footer">
      &copy;2020, Gunther Cox.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.3</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>
      
      |
      <a href="_sources/salvius.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
    <script>
        (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
        (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
        m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
        })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

        ga('create', 'UA-12573345-13', 'auto');
        ga('send', 'pageview');
        </script>

  </body>
</html>