Skip to content

Commit

Permalink
Add basic usage guide with panels, charger (#6)
Browse files Browse the repository at this point in the history
* Add basic usage guide with panels, charger

* Reorder getting started
  • Loading branch information
lukeschmitt-tr authored Jul 3, 2024
1 parent cdc531a commit 47b34c7
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 4 deletions.
20 changes: 16 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@
# Add any Sphinx extension module names here, as strings. They can be extensions coming with Sphinx
# (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.githubpages',
'sphinx_collapse',
'sphinx_copybutton',
'sphinx_tabs.tabs',
'sphinx.ext.extlinks',
'sphinx.ext.githubpages',
'sphinx.ext.graphviz',
'sphinx.ext.mathjax',
'sphinxcontrib.youtube',
'sphinx_copybutton',
'sphinx_tabs.tabs',
'sphinx_collapse',
"sphinx.ext.autosectionlabel",
]

# True to prefix each section label with the name of the document it is in, followed by a colon.
Expand All @@ -39,6 +40,17 @@
# documents.
autosectionlabel_prefix_document = True

# If set, autosectionlabel chooses the sections for labeling by its depth. For example, when set 1
# to autosectionlabel_maxdepth, labels are generated only for top level sections, and deeper
# sections are not labeled. It defaults to None (disabled).
# autosectionlabel_maxdepth = 4

# True to prefix each section label with the name of the document it is in, followed by a colon.
# For example, index:Introduction for a section called Introduction that appears in document
# index.rst. Useful for avoiding ambiguity when the same section heading appears in different
# documents.
autosectionlabel_prefix_document = True

# If set, autosectionlabel chooses the sections for labeling by its depth. For example, when set 1
# to autosectionlabel_maxdepth, labels are generated only for top level sections, and deeper
# sections are not labeled. It defaults to None (disabled).
Expand Down
1 change: 1 addition & 0 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Getting Started
:maxdepth: 1

getting_started/hardware_setup.rst
getting_started/basic_usage.rst
getting_started/ros_interface.rst
48 changes: 48 additions & 0 deletions docs/getting_started/basic_usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
===========
Basic Usage
===========

Rear Interface Panel
====================

.. image:: images/panel_rear.jpg
:align: center
:width: 80%

Interfaces from the left:

* Charger Port
* Screen
* Power Button
* Emergency Stop Button

Top Interface Panel
===================

.. image:: images/panel_top.jpg
:align: center
:width: 80%

Interface from the left:

* Unused
* Power breakout — VBat (~24V), 12V
* Serial
* RJ45 (Unused)

Plug-In Charger
===============

.. image:: images/charger.jpg
:align: center
:width: 60%

The SLATE base comes with a plug-in battery charger with the following specifications:

* ~110VAC 60Hz On
* 24VDC - 29.4VDC Out
* 5A
* 160W

To charge the SLATE base's battery, plug the charger's barrel jack into the base's Charger Port.
See the :ref:`getting_started/basic_usage:Rear Interface Panel` for details on the port.
Binary file added docs/getting_started/images/charger.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting_started/images/panel_rear.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/getting_started/images/panel_top.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 47b34c7

Please sign in to comment.