Metadata-Version: 2.1
Name: hello_robot_stretch_diagnostics
Version: 0.0.12
Summary: Stretch Diagnostics
Home-page: https://github.com/hello-robot/stretch_diagnostics
Author: Hello Robot Inc.
Author-email: support@hello-robot.com
License: UNKNOWN
Description: # Overview 
        #### The Stretch Diagnostics package provides tools to run different suites of tests on the stretch robot to debug issues.
        
        > **Note**
        > This tool is to be used only with Hello Robot's guidance.
        
        ## Installation
        Standard python package install
        ```commandline
        pip3 install hello-robot-stretch-diagnostics
        ```
        For local python package installation
        ```commandline
        cd ~/repos
        git clone https://github.com/hello-robot/stretch_diagnostics
        cd stretch_diagnostics/python
        pip3 install -e .
        ```
        
        ## Using the `stretch_diagnostic_check.py` tool
        The `stretch_diagnostic_check.py` tool can be executed anywhere from the terminal 
        to run different tests, see test status reports, manage test data and zip the generated diagnostics data.   
        ```commandline
        $ stretch_diagnostics_tool.py -h
        For use with S T R E T C H (R) RESEARCH EDITION from Hello Robot Inc.
        ---------------------------------------------------------------------
        
        usage: stretch_diagnostic_check.py [-h] [--report] [--zip] [--archive] [--menu] [--unzip [zip file]] [--list [verbosity]]
                                           [--simple | --power | --realsense | --stepper | --firmware | --dynamixel | --gripper | --ros | --cpu | --arm | --all]
        
        Script to run Diagnostic Test Suite and generate reports.
        
        optional arguments:
          -h, --help          show this help message and exit
          --report            Report the latest diagnostic check
          --zip               Generate zip file of latest diagnostic check
          --archive           Archive old diagnostic test data
          --menu              Run tests from command line menu
          --unzip [zip file]  Unzip the given stretch diagnostics zipped data and view report.
          --list [verbosity]  Lists all the available TestSuites and its included TestCases Ordered (Default verbosity=1)
          --simple            Run simple diagnostics across entire robot
          --power             Run diagnostics on the power subsystem
          --realsense         Run diagnostics on the Intel RealSense D435 camera
          --stepper           Run diagnostics on stepper drivers
          --firmware          Run diagnostics on robot firmware versions
          --dynamixel         Run diagnostics on all robot Dynamixel servos
          --gripper           Run diagnostics on the gripper subsystem
          --ros               Run diagnostics on the ROS packages
          --cpu               Run diagnostics on the CPU
          --arm               Run diagnostics on the Arm
          --all               Run all diagnostics
        ```
        The diagnostics data are stored under the directory `~/stretch_user/log/diagnostic_check`.
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
