Skip to content

Commit

Permalink
Updated and added some more files
Browse files Browse the repository at this point in the history
  • Loading branch information
Jm-Taylor committed Jul 14, 2020
1 parent 00ed241 commit 425645f
Show file tree
Hide file tree
Showing 24 changed files with 209 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -16,7 +16,16 @@ After python is downloaded run the following commands in command prompt.
- ``pip install "Sphinx==3.03"``
- ``pip install sphinx-tabs``
- ``pip install sphinx-rtd-theme``
- ``pip install sphinx-notfound-page``

Clone the repo using git into your local system. To build the docs open command prompt and navigate to the folder where the Makefile is located. In that folder run ``make html``. This will show a display of the compilation and if completed without errors there will be a new folder called build. To open the local version of the docs, open the index.html file located inside build/html/

**Note** you need to run ``make html`` every time you make a change.
**Note** you need to run ``make html`` every time you make a change.

If you get a **app.add_javascript() is deprecated** error follow these steps:

1. Locate the tabs.py folder. Example path ``C:\python\lib\site-packages\sphinx_tabs\``
2. Open tabs.py using a text editor.
3. Navigate to line 341 or search for ``app.add_javascript(path)``
4. Replace ``app.add_javascript(path)`` with ``app.add_js_file(path)``
5. Save and close.
36 changes: 36 additions & 0 deletions source/docs/Titan/download-update-app.rst
@@ -0,0 +1,36 @@
Download Update App
===================

To download the latest update app ``V1.0`` click `here <https://www.studica.com/downloads/Studica-Robotics/FRC-WSR/Titan/SCU/SCUSetup.exe>`__.

.. important:: This app is still in early development and there will be bugs. Report any bugs here(link not made yet).

After running the installer there will be a prompt as shown below.

.. figure:: images/download-update-app-1.png
:align: center
:width: 500

.. note:: Don't panic it is not a virus!

Hit more info.

.. figure:: images/download-update-app-2.png
:align: center
:width: 500

This will then show the ``Run Anyway`` button. Hit that button to start the install.

.. note:: Admin is required.

After accepting admin privileges the EULA will pop up. You can read through it if you wish or hit next.

.. figure:: images/download-update-app-3.png
:align: center
:width: 500

Hit next for the next few prompts and the install will start. When complete you will see this page.

.. figure:: images/download-update-app-5.png
:align: center
:width: 500
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-4.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-5.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-6.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/docs/Titan/images/titan-status-light-7.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 61 additions & 0 deletions source/docs/Titan/titan-status-light.rst
@@ -0,0 +1,61 @@
Titan Status Light
=====================

Below are the various status light blink codes and the meaning behind them.

.. list-table:: Status Light Blink Codes
:widths: 50 25 25 25
:header-rows: 1
:align: center

* - Function
- Blink 1
- Blink 2
- Blink 3
* - Titan Off
- .. image:: images/titan-status-light-5.png
- .. image:: images/titan-status-light-5.png
- .. image:: images/titan-status-light-5.png
* - No Communication
- .. image:: images/titan-status-light-1.png
- .. image:: images/titan-status-light-1.png
- .. image:: images/titan-status-light-1.png
* - CAN Detected, Robot Disabled
- .. image:: images/titan-status-light-1.png
- .. image:: images/titan-status-light-2.png
- .. image:: images/titan-status-light-3.png
* - CAN Detected, Robot Enabled
- .. image:: images/titan-status-light-4.png
- .. image:: images/titan-status-light-4.png
- .. image:: images/titan-status-light-4.png
* - Fault Detected
- .. image:: images/titan-status-light-6.png
- .. image:: images/titan-status-light-6.png
- .. image:: images/titan-status-light-6.png

Titan Off
---------

When the Titan is off, there will be no flashing light. If the Titan is on, and the light is off, there could be a problem with the microcontroller or the LED.

No Communication
----------------

Is typically seen during bootup. When the Titan receives any CAN packet that is not blocked by the filter, the flashing blue will switch over to CAN Detected. If the light is still flashing blue when it should be in CAN Detected, either the CAN ID on the Titan is set incorrectly or the CAN ID set in the robot code is incorrect.

.. important:: If the CAN ID on the Titan is changed through the config app, the Titan needs to be rebooted for the configuration on the Titan to be set correctly.

CAN Detected, Robot Disabled
----------------------------

The flashing lights of RED, GREEN, BLUE, resembles that the CAN bus is detected; however, the robot is disabled. To get out of this state, the robot must be enabled via the driver station. If the robot is enabled and the status light is still showing this state, there is no communication between the driver station and the VMXpi.

CAN Detected, Robot Enabled
---------------------------

The blinking purple displays that the robot is enabled and allows for the motors to be moved.

Fault Detected
--------------

This state will occur if there is a fault error on one of the gates for driving the motors. This could be but not limited to: thermal shutdown, current overflow, voltage cutoff, and gate failure.
99 changes: 99 additions & 0 deletions source/docs/Titan/using-the-update-app.rst
@@ -0,0 +1,99 @@
Using the Update App
====================

The Studica Update and Config app was created to allow users to get the most out of their Titan motor controller.

Settings
--------

The landing or Settings page allows for the setting of the custom CAN ID, Encoder Ticks per rev for the motor your using, current limit for the motors, Motor idle mode, S-curve sensitivity and limit switch control.

.. figure:: images/using-the-update-app-2.png
:align: center

When a valid device is found by the app it will be displayed in the drop down menu.

.. note:: The default CAN ID out of the box is 42.

CAN ID
^^^^^^

The CAN ID is the unique id of the motor controller on the CAN bus. The valid range is 1 - 62.

Encoder Count
^^^^^^^^^^^^^

Is the counts per revolution of the encoder you are using on your motor. For example the Studica Maverick has a CPR of 732, whereas the Pitsco Torquenado has a CPR of 1440.

Current Limit
^^^^^^^^^^^^^

This is the limit you want for the amount of current to flow to the motors. Valid range 0 - 20A.

Idle Mode
^^^^^^^^^

When false this sets the motors to coast mode and when high the motors are in break mode.

S-Curve Sensitivity
^^^^^^^^^^^^^^^^^^^

Sets the sensitivity level of the S-Curve formula.

Limit Switches
^^^^^^^^^^^^^^

Control panel for limit switch configuration. There are two limit switch ports per motor on the Titan, a high and a low.

Parameters
- Limit Switch - Simple enable and disable
- NO/NC - let the microcontroller know if you are using a NO contact or a NC contact (inverts the output)
- Automatic Bounce back - upon making contact with the limit switch the motor will move in the opposite direction just a little bit.

Save Configuration
^^^^^^^^^^^^^^^^^^

Saves the current settings to the Titan.

Restore Factory Defaults
^^^^^^^^^^^^^^^^^^^^^^^^

Will restore the Titan back to it's recommended factory settings.

Firmware
--------

Every so often a firmware upgrade is required to fix a bug or include new functionality.

.. figure:: images/using-the-update-app-3.png
:align: center

The firmware upgrade tab will search for an update online and install if there is one.

System Info
-----------

System Information is used for diagnosing and contacting support.

.. figure:: images/using-the-update-app-4.png
:align: center

.. important:: The Unique ID is required for any support tickets.

Calibration
-----------

The calibration tab is used to tune PID constants for expected results.

.. figure:: images/using-the-update-app-5.png
:align: center

.. note:: This tab is non functional currently.

About
-----

Houses the basic information about the app.

.. figure:: images/using-the-update-app-6.png
:align: center
5 changes: 3 additions & 2 deletions source/index.rst
Expand Up @@ -34,8 +34,9 @@ Welcome to the Studica Robotics documentation page. Here you will find lots of i
:maxdepth: 1
:caption: Titan

docs/Titan/calibration
docs/Titan/update
docs/Titan/download-update-app
docs/Titan/using-the-update-app
docs/Titan/titan-status-light
docs/Titan/troubleshooting

.. toctree::
Expand Down

0 comments on commit 425645f

Please sign in to comment.