Repo cleanup and maintenance (#269)

* Remove existing .DS_Store files

* use .keep vs readme

* Add editorconfig to match existing code

* remove extra whitespace

* ignore backup .tgz files

* ignore .done files

* fixup! use .keep vs readme

* Ignore more grafana directories

* ignore more local configs

* Remove duplicate .sample file

* remove other excess .sample file

* .json files don't want a trailing newline

* Whitespace/trailing newline cleanup

* fixup! Whitespace/trailing newline cleanup

* update visualstudio entry

* organize gitignore, add vscode

* Update default indent to 4 spaces

Yes, I know, we aren't consistent. This should help. :)

* Remove separate *.py indentation

Not needed since default is already 4 spaces.

---------

Co-authored-by: Jason Cox <jason@jasonacox.com>

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# json files don't want a final newline
+[*.json]
+insert_final_newline = false
+
+# Tab indentation (no size specified)
+[*.md]
+trim_trailing_whitespace = false

.github/ISSUE_TEMPLATE/other.md

@@ -6,5 +6,3 @@ labels: ''
 assignees: ''
 
 ---
-
-

.gitignore

@@ -1,13 +1,40 @@
-sandbox/
+# Ignore common local files
+.DS_Store
+
+# VisualStudio
+.vs/
+
+# VisualStudio code
+# https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local Settings
+compose.env
+grafana.env
+pypowerwall.env
+telegraf.local
+
+# Local Dev files
 *.bak
+backups/*.tgz
+influxdb/run-once-*.sql.done
+
+sandbox/
+
+grafana/alerting/
+grafana/csv/
 grafana/grafana.db
 grafana/plugins/
+
 influxdb/meta/
 influxdb/wal/
 influxdb/data/
-pypowerwall.env
+
 weather/uploadtest.sh
 weather/weather411.conf
 weather/weather411.conf.orig
-.DS_Store
-/.vs

README.md

@@ -48,8 +48,7 @@ Run the interactive setup script that will ask you for your Powerwall details an
   * _For Windows 11 users, see the [Windows 11 Instructions](https://github.com/jasonacox/Powerwall-Dashboard#windows-11-instructions) below._
 
 Follow the **[Grafana Setup](https://github.com/jasonacox/Powerwall-Dashboard#grafana-setup)** instructions provided (or see below) to complete the setup.
-
-
+
 ## Option 2 - Manual Install
 
 If you prefer, you can perform the same steps that `setup.sh` performs.
@@ -87,7 +86,7 @@ You will want to set your local timezone by editing `pypowerwall.env`, `telegraf
       [OpenWeatherMap]
       # Register and get APIKEY from OpenWeatherMap.org
       APIKEY = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-      # Enter your location in latitude and longitude 
+      # Enter your location in latitude and longitude
       LAT = xxx.xxxx
       LON = yyy.yyyy
   ```
@@ -100,7 +99,7 @@ You will want to set your local timezone by editing `pypowerwall.env`, `telegraf
 
 ### InfluxDB
 
-* Connect to the Influx database to import setup commands: 
+* Connect to the Influx database to import setup commands:
 
   ```bash
     docker exec -it influxdb influx -import -path=/var/lib/influxdb/influxdb.sql
@@ -149,7 +148,7 @@ Check the logs of the services using:
   docker logs -f grafana
 ```
 
-* Docker terminating with `error 139`:  InfluxDB does not run reliably on older models of Raspberry Pi. 
+* Docker terminating with `error 139`:  InfluxDB does not run reliably on older models of Raspberry Pi.
 * Grafana Error: Invalid interval string, expecting a number followed by one of "Mwdhmsy" - This indicates that the Grafana setup for InfluxDB is missing the time unit, "s", in the "Min time interval" field:
   - Min time interval: `5s`
 
@@ -244,7 +243,7 @@ InfluxDB is configured to use a infinite retention policy (see [influxdb.sql](..
 ### Credits
 
 * This project is based on the great work by mihailescu2m at [https://github.com/mihailescu2m/powerwall_monitor](https://github.com/mihailescu2m/powerwall_monitor) and has been modified to use pypowerwall as a proxy to the Powerwall and includes solar String, Inverter and Powerwall Temperature graphs for Powerwall+ systems.
-* Grafana at https://github.com/grafana/grafana 
+* Grafana at https://github.com/grafana/grafana
 * Telegraf at https://github.com/influxdata/telegraf
 * InfluxDB at https://github.com/influxdata/influxdb
 * pyPowerwall at https://github.com/jasonacox/pypowerwall

_config.yml

@@ -1 +1 @@
-theme: jekyll-theme-cayman
+theme: jekyll-theme-cayman

compose.env.sample

@@ -1,6 +1,6 @@
 # Environment variables for docker compose.
-# 
+#
 # GRAFANAUSER - may need to be adjusted for cases such as rootless docker.
-# See issue #22, 
+# See issue #22,
 # https://github.com/jasonacox/Powerwall-Dashboard/issues/22#issuecomment-1253076441)
-GRAFANAUSER="1000:1000"
+GRAFANAUSER="1000:1000"

dashboards/README.md

@@ -8,7 +8,6 @@ This dashboard graphs min(), mean() and max() values for the Solar, Home, Grid a
 
 <img width="863" alt="image" src="https://user-images.githubusercontent.com/836718/224519614-76dcab24-deb3-42fe-a0ba-9f4837af7ee8.png">
 
-
 ## No Animation
 
 This dashboard provides the original time series "Live Monitoring" graph but removes the Powerwall flow animation panel.
@@ -17,7 +16,6 @@ This dashboard provides the original time series "Live Monitoring" graph but rem
 
 <img width="864" alt="image" src="https://user-images.githubusercontent.com/836718/224519662-f29a044a-34d8-4d1f-9220-bebfe7172cd3.png">
 
-
 ## Simple
 
 Similar to the above, this dashboard provides a basic time series graph and meter data but without any of the Powerwall+ or extended data.
@@ -27,4 +25,3 @@ Similar to the above, this dashboard provides a basic time series graph and mete
 ## Submit Your Dashboard
 
 Do you have a great dashboard?  Do you think others might be able to use it?  If so, submit a PR so we can get it added.
-

dashboards/powerflow-animation.html

@@ -40,7 +40,7 @@
     })
   }
   window.addEventListener('resize', function(e){ scale(); }, false);
-  
+
   // Display Firmware Version
   function showversion() {
       var pwver = window.location.protocol + "//" + window.location.hostname + ":8675/version";
@@ -51,7 +51,7 @@
       setTimeout(showversion, 60000);
   }
   showversion();
-  
+
   // Load Animation from pyPowerwall
   var powerFrame = document.getElementById('frame8675');
   powerFrame.onload = function() {
@@ -61,4 +61,4 @@
     scale();
   }
   powerFrame.src = window.location.protocol + "//" + window.location.hostname + ":8675/";
-  </script>
+  </script>

grafana/.keep

@@ -0,0 +1 @@
+

influxdb.conf

@@ -152,4 +152,3 @@ bind-address = "127.0.0.1:8088"
 [tls]
   min-version = ""
   max-version = ""
-

influxdb/backups/.keep

@@ -0,0 +1 @@
+

location.html

@@ -47,4 +47,3 @@
         </script>
     </body>
 </html>
-

powerwall.yml

@@ -39,9 +39,9 @@ services:
         restart: always
         user: "1000:1000"
         command: [
-            "telegraf", 
-            "--config",  
-            "/etc/telegraf/telegraf.conf", 
+            "telegraf",
+            "--config",
+            "/etc/telegraf/telegraf.conf",
             "--config-directory",
             "/etc/telegraf/telegraf.d"
         ]
@@ -53,7 +53,7 @@ services:
             - type: bind
               source: ./telegraf.local
               target: /etc/telegraf/telegraf.d/local.conf
-              read_only: true            
+              read_only: true
         depends_on:
             - influxdb
             - pypowerwall
@@ -96,4 +96,3 @@ services:
             - WEATHERCONF=/var/lib/weather/weather411.conf
         depends_on:
             - influxdb
-

telegraf.local.sample

@@ -4,7 +4,7 @@
 #
 # The local configuration file should be named "telegraf.local".
 # Upgrade.sh does not modify this file.
-# 
+#
 # The following sample adds some power and energy data from the solar meter
 # as a measurement called "solarmeter" (used in a three phase monitoring example)
 
@@ -47,4 +47,4 @@
 #                 return new_metric
 #         else:
 #                 return metric
-# '''
+# '''

tools/ecowitt-weather-history/ecowitt-weather-history.py

@@ -10,12 +10,12 @@
 
  Overview:
     Historical weather data from Ecowitt API can be imported into your
-    Powerwall Dashboard graphs by repeatedly calling the historical API with a short time range and a short interval`.
+    Powerwall Dashboard graphs by repeatedly calling the historical API with a short time range and a short interval.
 
  Usage:
     * Subscribe to the Ecowitt API as described here
         https://github.com/jasonacox/Powerwall-Dashboard/tree/main/weather/contrib/ecowitt#ecowitt-local-weather-server
-        
+
     * Install the required python modules:
         pip install python-dateutil influxdb
 
@@ -506,7 +506,7 @@ def get_weather_history(start, end):
         print(f"* Loading data for time: [{curr.astimezone(influxtz)}]")
         try:
             dtstart = curr.date()
-            dtend = dtstart 
+            dtend = dtstart
             dtend += interval
             url = f"{ecoapi}&start_date={dtstart}%2000:00:00&end_date={dtend}%2023:59:59"
             response = session.get(url, timeout=TIMEOUT)

tools/solar-only/grafana/.keep

@@ -0,0 +1 @@
+

tools/solar-only/influxdb/.keep

@@ -0,0 +1 @@
+

v6.5.1/grafana/.keep

@@ -0,0 +1 @@
+

v6.5.1/influxdb/.keep

@@ -0,0 +1 @@
+