Merge pull request #66 from SFXRescue/merge

Merge merged branch 'merge' into merged master branch

Author: Conr86

README.md

@@ -2,17 +2,17 @@
 # SART Integrated GUI and Host Teleoperation Service (SIGHTS)
 
 [![Build status](https://img.shields.io/badge/build-passing-brightgreen)](https://www.sfxrescue.com)
-[![GitHub license](https://img.shields.io/github/license/SFXRescue/SIGHTSRobot)](https://github.com/SFXRescue/SIGHTSRobot/blob/master/LICENSE)
-[![GitHub issues](https://img.shields.io/github/issues/SFXRescue/SIGHTSRobot)](https://github.com/SFXRescue/SIGHTSRobot/issues)
-[![GitHub forks](https://img.shields.io/github/forks/SFXRescue/SIGHTSRobot)](https://github.com/SFXRescue/SIGHTSRobot/network)
+[![GitHub license](https://img.shields.io/github/license/SFXRescue/sights)](https://github.com/SFXRescue/sights/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/SFXRescue/sights)](https://github.com/SFXRescue/sights/issues)
+[![GitHub forks](https://img.shields.io/github/forks/SFXRescue/sights)](https://github.com/SFXRescue/sights/network)
 
 S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete teleoperation interface written by the Semi-Autonomous Rescue Team for the S.A.R.T. rescue robots.
 
-![Screenshot](https://github.com/SFXRescue/SIGHTSInterface/blob/master/images/demo_screenshot_dark.png?raw=true "Screenshot of the interface")
+![Screenshot](https://github.com/SFXRescue/sights/blob/master/interface/images/demo_screenshot_dark.png?raw=true "Screenshot of the interface")
 
 ## Features
 
-- All SIGHTS configuation is done through a single configuration file which can be edited visually from within the interface, even if the SIGHTSRobot service is stopped or has crashed
+- All SIGHTS configuation is done through a single configuration file which can be edited visually from within the interface, even if the SIGHTS service is stopped or has crashed
 - A powerful and extensible modular sensor system
   - A sensor plugin system to allow new sensors to be added with ease
   - Sensor wrapper classes that can use existing Python libraries to access sensors over I2C. No need to write libraries specifically for SIGHTS
@@ -32,12 +32,12 @@ S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete te
     - Percentage circle chart
     - Thermal camera with overlay features
     - Text box (with optional uptime display box)
-- An extremely powerful [web interface](https://github.com/SFXRescue/SIGHTSInterface) that allows the operator to control every aspect of the robot
+- An extremely powerful that allows the operator to control every aspect of the robot
   - Up to four video camera streams through [Motion](https://github.com/Motion-Project/motion)
   - Integrated tabbed SSH console allowing advanced access to the underlying OS
   - Full gamepad and keyboard support
   - Full visual configuration file editor and an advanced text-based editor
-  - Configuration file management allowing you to swap the active configuration file at runtime, even if the SIGHTSRobot service is stopped or has crashed
+  - Configuration file management allowing you to swap the active configuration file at runtime, even if the SIGHTS service is stopped or has crashed
   - Keep track of old revisions of your config file to easily restore to a previous version
   - Light and dark themes
   - Ability for the operator to safely shut down or restart the robot through the interface
@@ -47,7 +47,7 @@ S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete te
   - Support for adding additional motor connection handlers in a similar manner to sensors
 - Built entirely using open protocols and open-source software.
 
-All configuration for SIGHTS is done in the `.json` files within the `configs/` directory, which can be edited through the web interface. The active configuration file can be changed through the interface at any time, even if the SIGHTSRobot service is stopped or has crashed. This gives you the ability to fix any configuration issue without physical access to the robot.
+All configuration for SIGHTS is done in the `.json` files within the `configs/` directory, which can be edited through the web interface. The active configuration file can be changed through the interface at any time, even if the SIGHTS service is stopped or has crashed. This gives you the ability to fix any configuration issue without physical access to the robot.
 
 ## Requirements
 
@@ -64,7 +64,7 @@ Python >= 3.6 is required. All the officially supported distributions ship with
 To install on a robot, just download and run the installer as root:
 
 ```shell
-wget https://raw.githubusercontent.com/SFXRescue/SIGHTSRobot/master/install.sh
+wget https://raw.githubusercontent.com/SFXRescue/sights/master/install.sh
 chmod +x install.sh
 sudo ./install.sh
 ```

docs/extending.md

@@ -4,7 +4,7 @@ SIGHTS is designed to be modular and extensible. There are a number of ways you
 
 ## Adding new sensors
 
-New sensors can be added by creating a new sensor wrapper. These reside within the `SIGHTSRobot/src/sensors` directory and inherit from the `SensorWrapper` class.
+New sensors can be added by creating a new sensor wrapper. These reside within the `sights/src/sensors` directory and inherit from the `SensorWrapper` class.
 
 The purpose of a sensor wrapper is to implement a set of methods (`get_data()`, `get_initial()`, etc.) that are common to all sensor wrappers.
 
@@ -18,7 +18,7 @@ The purpose of a sensor wrapper is to implement a set of methods (`get_data()`,
 
     The sensor wrapper class is designed to be pretty broad in what it will support. If you can access a sensor through Python, you can wrap it within a sensor wrapper.
 
-    Create a new file with an appropriate name in the `SIGHTSRobot/src/sensors` directory. It should follow the format of `<sensor_name>_wrapper.py`.
+    Create a new file with an appropriate name in the `sights/src/sensors` directory. It should follow the format of `<sensor_name>_wrapper.py`.
 
     Here's a (untested) example for the Adafruit BME280 using [this Adafruit library](https://github.com/adafruit/Adafruit_Python_BME280). Your file should like something like this:
 
@@ -61,7 +61,7 @@ The purpose of a sensor wrapper is to implement a set of methods (`get_data()`,
 
 3. Add a section to the config schema for your sensor.
 
-    The interface can generate the necessary configuration file additions for your new sensor if you specify requirements in the schema located at `SIGHTSInterface/js/sights.config.schema.js`.
+    The interface can generate the necessary configuration file additions for your new sensor if you specify requirements in the schema located at `sights/interface/js/sights.config.schema.js`.
 
     Sensors are defined in the list `properties.sensors.items.anyOf`.
 
@@ -150,7 +150,7 @@ The purpose of a sensor wrapper is to implement a set of methods (`get_data()`,
 
     A sensor graph is a JavaScript class that determines how sensor data is displayed on the interface. In many cases, you may be able to use an existing graph to display the data from your new sensor.
 
-    A new sensor graph class can extend the existing "abstract" class `Graph` (`SIGHTSInterface/js/graphs/graph.js`) for an easy framework to build your graph class around.
+    A new sensor graph class can extend the existing "abstract" class `Graph` (`sights/interface/js/graphs/graph.js`) for an easy framework to build your graph class around.
 
 5. Add the sensor and it's corresponding graph to your config file.
 

docs/getting_started.md

@@ -5,7 +5,7 @@ S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete te
 
 ## Features
 
-- All SIGHTS configuation is done through a single configuration file which can be edited visually from within the interface, even if the SIGHTSRobot service is stopped or has crashed
+- All SIGHTS configuation is done through a single configuration file which can be edited visually from within the interface, even if the SIGHTS service is stopped or has crashed
 - A powerful and extensible modular sensor system
   - A sensor plugin system to allow new sensors to be added with ease
   - Sensor wrapper classes that can use existing Python libraries to access sensors over I2C. No need to write libraries specifically for SIGHTS
@@ -25,12 +25,12 @@ S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete te
     - Percentage circle chart
     - Thermal camera with overlay features
     - Text box (with optional uptime display box)
-- An extremely powerful [web interface](https://github.com/SFXRescue/SIGHTSInterface) that allows the operator to control every aspect of the robot
+- An extremely powerful web interface that allows the operator to control every aspect of the robot
   - Up to four video camera streams through [Motion](https://github.com/Motion-Project/motion)
   - Integrated tabbed SSH console allowing advanced access to the underlying OS
   - Full gamepad and keyboard support
   - Full visual configuration file editor and an advanced text-based editor
-  - Configuration file management allowing you to swap the active configuration file at runtime, even if the SIGHTSRobot service is stopped or has crashed
+  - Configuration file management allowing you to swap the active configuration file at runtime, even if the SIGHTS service is stopped or has crashed
   - Keep track of old revisions of your config file to easily restore to a previous version
   - Light and dark themes
   - Ability for the operator to safely shut down or restart the robot through the interface
@@ -40,7 +40,7 @@ S.A.R.T. Integrated GUI and Host Teleoperation Service (SIGHTS) is a complete te
   - Support for adding additional motor connection handlers in a similar manner to sensors
 - Built entirely using open protocols and open-source software.
 
-All configuration for SIGHTS is done in the `.json` files within the `configs/` directory, which can be edited through the web interface. The active configuration file can be changed through the interface at any time, even if the SIGHTSRobot service is stopped or has crashed. This gives you the ability to fix any configuration issue without physical access to the robot.
+All configuration for SIGHTS is done in the `.json` files within the `configs/` directory, which can be edited through the web interface. The active configuration file can be changed through the interface at any time, even if the SIGHTS service is stopped or has crashed. This gives you the ability to fix any configuration issue without physical access to the robot.
 
 ## Requirements
 
@@ -57,7 +57,7 @@ Python >= 3.6 is required. All the officially supported distributions ship with
 To install on a robot, just download and run the installer as root:
 
 ```shell
-wget https://raw.githubusercontent.com/SFXRescue/SIGHTSRobot/master/install.sh
+wget https://raw.githubusercontent.com/SFXRescue/sights/master/install.sh
 chmod +x install.sh
 sudo ./install.sh
 ```

docs/manual_install.md

@@ -1,10 +1,10 @@
 # Manual Installation
 
-> This page is maintained for posterity, however small changes in installation instructions may escape future revisions. The most up-to-date installation instructions can always be inferred by reading the current [install.sh](https://github.com/SFXRescue/SIGHTSRobot/blob/master/install.sh) script.
+> This page is maintained for posterity, however small changes in installation instructions may escape future revisions. The most up-to-date installation instructions can always be inferred by reading the current [install.sh](https://github.com/SFXRescue/sights/blob/master/install.sh) script.
 
 Installation is preferably done to the `/opt/sights/` directory. This was chosen to make it easier to manage running the software (e.g. making it run on boot) as putting it in the home folder can cause permission issues. Installing to other locations will require changes to various config files.
 
-[Supervisor](http://supervisord.org/) is used to manage running the SIGHTSRobot software.
+[Supervisor](http://supervisord.org/) is used to manage running the SIGHTS software.
 
 ## Preparing the installation directory
 
@@ -17,12 +17,11 @@ sudo chown $USER:$USER /opt/sights
 
 ## Downloading the software
 
-Next clone this repository, as well as [`SIGHTSInterface`](https://github.com/SFXRescue/SIGHTSInterface).
+Next clone this repository
 
 ```shell
 cd /opt/sights
-git clone https://github.com/SFXRescue/SIGHTSRobot
-git clone https://github.com/SFXRescue/SIGHTSInterface
+git clone https://github.com/SFXRescue/sights
 ```
 
 Install the required packages:
@@ -34,13 +33,13 @@ sudo apt install git apache2 python3 python3-pip wget gdebi
 Then install the Python dependencies with:
 
 ```shell
-cd /opt/sights/SIGHTSRobot/src
+cd /opt/sights/src
 python3 -m pip install -r requirements.txt
 ```
 
 ## Setting up Apache
 
-Apache should be configured to point to the `SIGHTSInterface` directory.
+Apache should be configured to point to the `sights/interface` directory.
 
 Edit `/etc/apache2/apache2.conf` and add the following in the relevant section to allow Apache to access the `/opt/sights/` directory:
 
@@ -55,7 +54,7 @@ Edit `/etc/apache2/apache2.conf` and add the following in the relevant section t
 Copy the provided site file to the appropriate directory.
 
 ```shell
-sudo cp /opt/sights/SIGHTSRobot/src/configs/apache/SIGHTSInterface.conf /etc/apache2/sites-available/
+sudo cp /opt/sights/src/configs/apache/SIGHTSInterface.conf /etc/apache2/sites-available/
 ```
 
 And then enable this site, and disable the default one, with
@@ -97,11 +96,11 @@ wget https://github.com/Motion-Project/motion/releases/download/release-4.2.2/bi
 sudo gdebi ./bionic_motion_4.2.2-1_amd64.deb
 ```
 
-Create a symlink from `/etc/motion` to `/opt/sights/SIGHTSRobot/src/configs/motion/` for Motion config files.
+Create a symlink from `/etc/motion` to `/opt/sights/src/configs/motion/` for Motion config files.
 
 ```shell
 rm -r /etc/motion
-sudo ln -s /opt/sights/SIGHTSRobot/src/configs/motion /etc
+sudo ln -s /opt/sights/src/configs/motion /etc
 ```
 
 Next, allow Motion to be run as a service by editing `/etc/default/motion` and changing `start_motion_daemon=no` to `start_motion_daemon=yes`.
@@ -157,7 +156,7 @@ To test it out, navigate to `http://<robot_ip>:4200`
 
 ## Running as a managed service with Supervisor
 
-All we need to do now is ensure that `SIGHTSRobot`'s `manager.py` is run on boot as a managed service so we can start, stop and restart it at will.
+All we need to do now is ensure that `manager.py` is run on boot as a managed service so we can start, stop and restart it at will.
 
 For this, we'll use [Supervisor](http://supervisord.org/) which is a software package designed to manage (including starting/stopping/restarting) processes and also handle logging their output.
 
@@ -170,7 +169,7 @@ sudo -H python3 -m pip install supervisor
 Create a symlink for the Supervisor configuration file with:
 
 ```shell
-sudo ln -sf /opt/sights/SIGHTSRobot/src/configs/supervisor /etc
+sudo ln -sf /opt/sights/src/configs/supervisor /etc
 ```
 
 Install the SIGHTS Supervisor extension. This allows Supervisor to manage configuration files, even when SIGHTS is not running.
@@ -187,7 +186,7 @@ Supervisor is now installed and set up.
 To ensure that `supervisord` is run at boot, we will install a provided init script for Supervisor:
 
 ```shell
-sudo cp SIGHTSRobot/src/configs/systemd/supervisord /etc/init.d/
+sudo cp src/configs/systemd/supervisord /etc/init.d/
 sudo chmod 755 /etc/init.d/supervisord
 sudo chown root:root /etc/init.d/supervisord
 sudo update-rc.d supervisord defaults