cleaned up repo

installation-bookworm.md → installation-v1-1.md

@@ -1,8 +1,9 @@
-# Installation instructions for RPi OS Bookworm
+# Software Installation Instructions for Solar Protocol V1.1 for RPi OS Bookworm
+
+These are the installation instructions for the current version of Solar Protocol that runs on Bookworm.
 
 Major changes in this version 
-* Bookworm requires the use of a venv when using pip.
-* The 'wait for network at boot' option in raspi-config is no longer available.
+* All python scripts now run in a virtual environment.
 
 ## Hardware
 
@@ -19,7 +20,7 @@ This works with a USB to RS485 converter (ch340T chip model).
 NOTE: The default admin user needs to be 'pi'
 
 ### OS
-* In the Raspberry Pi disk imager, set user to 'sp', password, enable ssh, wifi network, etc
+* In the Raspberry Pi disk imager, set user to 'pi', password, enable ssh, wifi network, etc
 * Configure device `sudo raspi-config` https://www.raspberrypi.org/documentation/configuration/raspi-config.md  
 	* A reboot is generally required and happens automatically after exiting the raspi-config interface. If it isn't automatic, reboot with this command:`sudo reboot`
 * `sudo apt-get update`  
@@ -100,7 +101,7 @@ Enable key-based authentication
 ### Network Configuration & Server Setup
 Open and forward these ports:
 * 80 -> 80 (This is to catch external traffic coming in on port 80. It could probably forward to the internal port 80 just fine too)
-* 8080 -> 80 (Alt-HTTP... Many residential networks have internal loopback prohibitions on port 80.)
+* 8080 -> 8080 (Alt-HTTP... Many residential networks have internal loopback prohibitions on port 80.)
 * 443 -> 443 (For HTTPS)
 * 8443 -> 443 (Alt-HTTP... Many residential networks have internal loopback prohibitions on port 443.)
 * 2222 -> 22 (For SSH)
@@ -182,7 +183,7 @@ If the above command was successful, you do not need to set permissions individu
 ## Troubleshooting  
 * Run `python3 /home/pi/solar-protocol/charge-controller/test.py` to test the connection between Pi and charge controller  
 * Run `ps -aux` to list running processes  
-* Run `ps -ef | grep .py` to list running python processes
+* Run `ps -ef | grep .py` or `ps aux | grep .py` to list running python processes
 * All Python scripts use python3  
 * PHP error logging (best to only use these during development and revert back for production version)  
 	* `sudo /etc/php/7.3/apache2/php.ini` The exact path will differ depending on the version of PHP  

installation.md → installation-v1-depreciated.md

@@ -1,6 +1,6 @@
-# Installation
+# Software Installation Instructions for Solar Protocol V1.0 Bullseye
 
-These are the original installation instructions. The automated installer stuff is untested and should not be used yet.
+These are the installation instructions for the version of Solar Protocol that ran on Bullseye. This version is depreciated and should only be used as a reference for older systems running the previous version.
 
 ## Hardware
 

software-development-troubleshooting.md

@@ -6,6 +6,8 @@ Troubleshooting the Solar Protocol network can be extremely difficult and confus
 
 ### Logs
 
+Start script logs are located in /home/pi/solar-protocol/start.log
+
 Backend core logs are located in the /home/pi/solar-protocol/backend/runner.log
 
 Charge controller data collection log is located at /home/pi/solar-protocol/chargecontroller/datalogger.log
@@ -39,7 +41,7 @@ You should see at least 4 lines. 2 lines from root user and 2 lines from pi.
 
 * SSH in to device
 * run `ps aux | grep .py`
-* you should see 2 lines ending in 'csv_datalogger.py' (1 from root user and 1 from pi)
+* you should see 1-2 lines ending in 'csv_datalogger.py' (1 from root user and 1 from pi)
 * check the log file at /home/pi/solar-protocol/chargecontroller/datalogger.log
 * confirm that the automated start up code is correct. Check the /etc/rc.local file to confirm there are no typos.