Add better logging for Currency API

Slight tweak to readme.

Author: muppet9010

README.md

@@ -17,8 +17,9 @@ Installation & Usage
 4. Unzip the files into the desired folder.
 5. Open config.json in a text editor and add in your details - see later in readme for details
 6. Run the program: Streamlabs Rcon Integration.exe
-7. Select the desired profile from the dropdown and click Start.
-8. The integration is now running between the Streamlabs account and the game using the selected profile.
+7. Select the desired profile from the dropdown. Suggested are the `Print All` and `Print Most Fancy`.
+8. Click the Start button to connect the integration between Streamlabs and Factorio.
+9. The integration is now running between the Streamlabs account and the game using the selected profile. Test event sfrom streamlabs or from within the integration tool will now trigger activity within Factorio.
 
 Should a critical error occur the program may fail to load or close. Details can be found in the most recent log file within the Logs folder.
 
@@ -175,7 +176,7 @@ The program has a `config.json` that stores its global configuration. The settin
 
 - Logging DaysLogsToKeep - How many days back of logs the program will keep. -1 keeps logs indefinitely.
 - Logging DebugLogging - If enhanced Debug logs are generated. true/false
-- Currency ApiLayerAccessKey - The Currency API key generated when wigning up to that free website.
+- Currency ApiLayerAccessKey - The Currency API key generated when signing up to the free currency API website.
 - Streamlabs SocketApiToken - Your streamlabs API key. This can be found on the streamlabs website under your account:
     1. login to streamlabs website.
     1. "Settings" on left hand menu.

Source/Currency.py

@@ -14,9 +14,10 @@ def __init__(self, state):
     def GetRates(self):
         if len(self.rates) > 0:
             return True
+        self.logging.DebugLog("Checking for a currency cache file")
         if Os.path.isfile(self.cacheFileName):
             self.logging.DebugLog(
-                "Trying to get currancy rates from cache file")
+                "Currency rates cache file exists, so reviewing it")
             with open(self.cacheFileName, "r", encoding='utf-8') as file:
                 data = Json.load(file)
             file.closed
@@ -31,6 +32,11 @@ def GetRates(self):
                     self.logging.DebugLog(
                         "Got currency rates from cache file")
                     return True
+            else:
+                self.logging.DebugLog(
+                    "Currency rates cache file too old to use")
+        else:
+            self.logging.DebugLog("No currency rates cache file found")
 
         self._SourceRateData()
         if len(self.rates) > 0:
@@ -51,6 +57,7 @@ def _SourceRateData(self):
         if not response["success"]:
             self.state.RecordActivity(
                 self.state.translations.GetTranslation("Currency WebsiteDownloadFailed"))
+            self.logging.Log(request.text)
             return False
         with open(self.cacheFileName, "w", encoding='utf-8') as file:
             file.write(Json.dumps(response))

Source/Streamlabs Rcon Integration.py

@@ -16,7 +16,7 @@
 
 class State():
     def __init__(self):
-        self.version = "0.1.2"
+        self.version = "0.1.3"
         self.config = Config(self)
         self.logging = Logging(self)
         self.config.LogMissingSettings()

Source/Translations.py

@@ -22,7 +22,7 @@ def LoadLocalisedTexts(self, language):
                 "Status OBSConnecting": "OBS Connecting",
                 "Status Running": "Running",
                 "Status Stopped": "Stopped",
-                "Currency WebsiteDownloadFailed": "ERROR: Can't get currency conversion data from website",
+                "Currency WebsiteDownloadFailed": "ERROR: Can't get currency conversion data from website. See log for details.",
                 "StreamlabsEvent ErrorProcessingEvent": "ERROR: event data not as expected: ",
                 "StreamlabsEvent BadEventPayloadCount": "ERROR: wrong number of payloads in event: ",
                 "StreamlabsEvent MissingEventPayloadCount": "ERROR: no payload in event",