Skip to content

Commit

Permalink
Add changes for 271c2ae
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Feb 18, 2024
1 parent d31b730 commit 77bcccc
Show file tree
Hide file tree
Showing 20 changed files with 384 additions and 13,367 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a7243683cc3839afd9fd9fd7b7df784d
config: 05c20eb6b88474601f720cc1e4c10653
tags: 645f666f9bcd5a90fca523b33c5a78b7
30 changes: 14 additions & 16 deletions API.html
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@

<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>API &#8212; PyRoombaAdapter 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<script src="_static/documentation_options.js?v=938c9ccc"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="PyRoombaAdapter" 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>

Expand All @@ -34,7 +32,7 @@
<div class="body" role="main">

<section id="api">
<h1>API<a class="headerlink" href="#api" title="Permalink to this heading"></a></h1>
<h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1>
</section>


Expand Down Expand Up @@ -109,11 +107,11 @@ <h3 class="donation">Donate/support</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Atsushi Sakai.
&#169;2019, Atsushi Sakai.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="_sources/API.rst.txt"
Expand All @@ -122,7 +120,7 @@ <h3 class="donation">Donate/support</h3>


<a href="https://github.com/AtsushiSakai/PyRoombaAdapter" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>


Expand Down
54 changes: 26 additions & 28 deletions README.html
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@

<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>PyRoombaAdapter &#8212; PyRoombaAdapter 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
<script src="_static/documentation_options.js?v=938c9ccc"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.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>

Expand All @@ -33,12 +31,12 @@
<div class="body" role="main">

<section id="pyroombaadapter">
<h1>PyRoombaAdapter<a class="headerlink" href="#pyroombaadapter" title="Permalink to this heading"></a></h1>
<h1>PyRoombaAdapter<a class="headerlink" href="#pyroombaadapter" title="Link to this heading"></a></h1>
<p>A Python library for Roomba Open Interface</p>
<p><a class="reference external" href="https://pepy.tech/project/pyroombaadapter"><img alt="Downloads" src="https://pepy.tech/badge/pyroombaadapter" /></a> <a class="reference external" href="https://pepy.tech/project/pyroombaadapter"><img alt="image1" src="https://pepy.tech/badge/pyroombaadapter/month" /></a> <a class="reference external" href="https://pepy.tech/project/pyroombaadapter"><img alt="image2" src="https://pepy.tech/badge/pyroombaadapter/week" /></a></p>
</section>
<section id="what-is-this">
<h1>What is this?<a class="headerlink" href="#what-is-this" title="Permalink to this heading"></a></h1>
<h1>What is this?<a class="headerlink" href="#what-is-this" title="Link to this heading"></a></h1>
<p>This is a python library for Roomba Open Interface(ROI)</p>
<p>This module is based on the document:</p>
<ul class="simple">
Expand All @@ -49,7 +47,7 @@ <h1>What is this?<a class="headerlink" href="#what-is-this" title="Permalink to
<p>This module is only tested on Roomba 690 model.</p>
</section>
<section id="install">
<h1>Install<a class="headerlink" href="#install" title="Permalink to this heading"></a></h1>
<h1>Install<a class="headerlink" href="#install" title="Link to this heading"></a></h1>
<p>You can use pip to install it.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install pyroombaadapter
</pre></div>
Expand All @@ -60,26 +58,26 @@ <h1>Install<a class="headerlink" href="#install" title="Permalink to this headin
</ul>
</section>
<section id="requirements">
<h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h1>
<h1>Requirements<a class="headerlink" href="#requirements" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p>Python 3.6.x or higher (2.7 is not supported)</p></li>
<li><p><a class="reference external" href="https://pythonhosted.org/pyserial/">pyserial</a></p></li>
</ul>
</section>
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1>
<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading"></a></h1>
<p>Please check the document for all API and usages.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://atsushisakai.github.io/PyRoombaAdapter/">Welcome to PyRoombaAdapter’s
documentation!</a></p></li>
</ul>
</section>
<section id="usage-examples">
<h1>Usage examples<a class="headerlink" href="#usage-examples" title="Permalink to this heading"></a></h1>
<h1>Usage examples<a class="headerlink" href="#usage-examples" title="Link to this heading"></a></h1>
<p>All examples are in examples directory.</p>
<p>Click each image to see each example movie.</p>
<section id="go-and-back-example">
<h2>Go and back example<a class="headerlink" href="#go-and-back-example" title="Permalink to this heading"></a></h2>
<h2>Go and back example<a class="headerlink" href="#go-and-back-example" title="Link to this heading"></a></h2>
<p><a class="reference external" href="https://www.youtube.com/watch?v=rGppIKN-roE"><img alt="image3" src="https://img.youtube.com/vi/rGppIKN-roE/0.jpg" /></a></p>
<p>This example uses “move” API.</p>
<ul class="simple">
Expand Down Expand Up @@ -107,7 +105,7 @@ <h2>Go and back example<a class="headerlink" href="#go-and-back-example" title="
</div>
</section>
<section id="play-song1">
<h2>Play song1<a class="headerlink" href="#play-song1" title="Permalink to this heading"></a></h2>
<h2>Play song1<a class="headerlink" href="#play-song1" title="Link to this heading"></a></h2>
<p><a class="reference external" href="https://www.youtube.com/watch?v=0XqpQq7PQ8I"><img alt="image4" src="https://img.youtube.com/vi/0XqpQq7PQ8I/0.jpg" /></a></p>
<p>This example uses “send_song_cmd” and “send_play_cmd” API.</p>
<ul class="simple">
Expand Down Expand Up @@ -135,7 +133,7 @@ <h2>Play song1<a class="headerlink" href="#play-song1" title="Permalink to this
</div>
</section>
<section id="play-song2">
<h2>Play song2<a class="headerlink" href="#play-song2" title="Permalink to this heading"></a></h2>
<h2>Play song2<a class="headerlink" href="#play-song2" title="Link to this heading"></a></h2>
<p><a class="reference external" href="https://www.youtube.com/watch?v=nYstniMkJo0"><img alt="image5" src="https://img.youtube.com/vi/nYstniMkJo0/0.jpg" /></a></p>
<p>This example uses “send_song_cmd” and “send_play_cmd” API.</p>
<ul class="simple">
Expand Down Expand Up @@ -189,7 +187,7 @@ <h2>Play song2<a class="headerlink" href="#play-song2" title="Permalink to this
</div>
</section>
<section id="read-sensors">
<h2>Read sensors<a class="headerlink" href="#read-sensors" title="Permalink to this heading"></a></h2>
<h2>Read sensors<a class="headerlink" href="#read-sensors" title="Link to this heading"></a></h2>
<p>There are two ways how to read sensor values. Request manually on
demand:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="sd">&quot;&quot;&quot;</span>
Expand Down Expand Up @@ -239,16 +237,16 @@ <h2>Read sensors<a class="headerlink" href="#read-sensors" title="Permalink to t
</section>
</section>
<section id="contribution">
<h1>Contribution<a class="headerlink" href="#contribution" title="Permalink to this heading"></a></h1>
<h1>Contribution<a class="headerlink" href="#contribution" title="Link to this heading"></a></h1>
<p>Any contributions to this project are welcome!</p>
<p>Feel free to make an issue and a PR to improve this OSS.</p>
</section>
<section id="license">
<h1>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h1>
<h1>License<a class="headerlink" href="#license" title="Link to this heading"></a></h1>
<p>MIT</p>
</section>
<section id="authors">
<h1>Authors<a class="headerlink" href="#authors" title="Permalink to this heading"></a></h1>
<h1>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/AtsushiSakai/">Atsushi Sakai</a></p></li>
</ul>
Expand Down Expand Up @@ -325,11 +323,11 @@ <h3 class="donation">Donate/support</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Atsushi Sakai.
&#169;2019, Atsushi Sakai.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>

|
<a href="_sources/README.rst.txt"
Expand All @@ -338,7 +336,7 @@ <h3 class="donation">Donate/support</h3>


<a href="https://github.com/AtsushiSakai/PyRoombaAdapter" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>


Expand Down
134 changes: 0 additions & 134 deletions _static/_sphinx_javascript_frameworks_compat.js
View file

This file was deleted.

Loading

0 comments on commit 77bcccc

Please sign in to comment.