work on help management

Author: madgrizzle

Background/messageProcessor.py

@@ -19,6 +19,7 @@ def start(self):
             if time.time()-self.data.lastChecked > 60*60:
                 self.data.lastChecked = time.time()
                 self.data.releaseManager.checkForLatestPyRelease()
+                self.data.helpManager.checkForUpdatedHelp()
             # process messages while queue is not empty.  Everything else is on hold until queue is cleared.
             while (  not self.data.message_queue.empty() ):  # if there is new data to be read
                 message = self.data.message_queue.get()

Connection/nonVisibleWidgets.py

@@ -18,6 +18,7 @@
 from Background.webcamVideoStream import WebcamVideoStream
 from Boards.boardManager import BoardManager
 from ReleaseManager.releaseManager import ReleaseManager
+from HelpManager.helpManager import HelpManager
 
 class NonVisibleWidgets(MakesmithInitFuncs):
     """
@@ -42,6 +43,7 @@ class NonVisibleWidgets(MakesmithInitFuncs):
     gpioActions = GPIOActions()
     boardManager = BoardManager()
     releaseManager = ReleaseManager()
+    helpManager = HelpManager()
 
     def setUpData(self, data):
         """
@@ -72,6 +74,7 @@ def setUpData(self, data):
         data.gpioActions = self.gpioActions
         data.boardManager = self.boardManager
         data.releaseManager = self.releaseManager
+        data.helpManager = self.helpManager
 
         if hasattr(sys, '_MEIPASS'):
             data.platform = "PYINSTALLER"
@@ -126,6 +129,7 @@ def setUpData(self, data):
         self.boardManager.setUpData(data)
         self.boardManager.initializeNewBoard()
         self.releaseManager.setUpData(data)
+        self.helpManager.setUpData(data)
 
         #set up kinematics with current settings
         self.holeyKinematics.initializeSettings()

Documentation/boardManagement.md

@@ -0,0 +1,38 @@
+# Board Management
+
+## Concept
+
+Board management as implemented in WebControl allows the user to track the areas of a given board that have been cut or otherwise marked by executing gcode.  The system tracks cut areas at a 1-inch square resolution.  That is, a standard 4-foot by 8-foot sheet of plywood is tracked by a 48 x 96 grid.
+
+## Functions
+
+### Create/Edit Board
+
+This function allows the user to define the size (width, height, thickness) of a board, provide identifying information (board ID, material type), and the position of center of the board on the frame.
+
+Board Details:
+The "Board ID" can be any name or other identifier the user desires to give the board (e.g., Board 1, A1, MDF-1, etc.)  The "Material" can be any description the user desires to enter (e.g, MDF, Plywood, Acrylic, Depleted Uranium, etc.)
+
+Board Dimensions:
+The units of the board is based upon the unit setting for the machine.  So if you have it set to metrics, your units will be reported in metric.. if in imperial, they will be reported in imperial.
+
+Board Positions:
+Center X (horizontal) and Center Y (vertical) position of the center of the board with respect to the frame.  A 4-foot x 8-foot sheet of plywood perfectly aligned on a 'standard' Maslow would have a Center X and Center Y of 0, 0.
+
+Align Board to Router allows the user to use the router's current position to indicate where the board is located.  For boards that are not full sheet sizes, this makes it easy to align the board for cutting.  For example, if the router is located at 12, 0 (1-foot to the right of center) and the board is perfectly centered under the router bit, pressing the 'Center' button will set the Center X and Center Y of the board to 12, 0.  If, instead, the top right corner of a 1-foot board is located directly under the router bit, pressing 'Top Right' will set the Center X and Center Y of the board to 6, 0 (6-inches to the right of the center).
+
+### Process GCode
+
+The GCode that has been loaded will be used to mark areas on the board that have been cut.  Obviously, this would be performed after you actually perform a cut. 
+
+### Open / Save Board
+
+Allows user to save board data to the drive and open previously saved board data.
+
+### Trim GCode
+
+In the event the user cuts part of the board off (i.e., trims an edge), this function allows for the board data to be updated.  For example, if the user cuts 1-foot off the top of the board, the user can enter 12 under 'Trim Top' and the top 12-inches will be removed from the board data.  Note, this doesn't affect the value of Center X and Center Y.
+
+### Clear Board
+
+Clears all cut information from current board.  

HelpManager/__init__.py

@@ -0,0 +1,66 @@
+from DataStructures.makesmithInitFuncs import MakesmithInitFuncs
+import re
+import requests
+from github import Github
+
+class HelpManager(MakesmithInitFuncs):
+
+    def __init__(self):
+        pass
+
+    releases = None
+    latestRelease = None
+
+    def getReleases(self):
+        return self.releases
+
+    def getLatestRelease(self):
+        return self.latestRelease
+
+    def checkForUpdatedHelp(self):
+        self.getWikiUrls()
+        return True
+
+    def getWikiUrls(self):
+
+        url = 'https://api.github.com/graphql'
+        json = {'query': '{ viewer { repositories(first: 30) { totalCount pageInfo { hasNextPage endCursor } edges { node { name } } } } }'}
+        api_token = "your api token here..."
+        headers = {'Authorization': 'token %s' % api_token}
+
+        r = requests.post(url=url, json=json)
+        print(r.text)
+
+        '''
+        g = Github()
+        self.wiki = g.get_repo("madgrizzle/WebControl.wiki.repo")
+        print(self.wiki)
+        
+        latest = 0
+        latestRelease = None
+        type = self.data.pyInstallType
+        platform = self.data.pyInstallPlatform
+        for release in self.releases:
+            try:
+                tag_name = re.sub(r'[v]', r'', release.tag_name)
+                # print(tag_name)
+                if float(tag_name) > latest:
+                    latest = float(tag_name)
+                    self.latestRelease = release
+
+            except:
+                print("error parsing tagname")
+        print(latest)
+        if latest > self.data.pyInstallCurrentVersion:
+            if self.latestRelease is not None:
+                print(self.latestRelease.tag_name)
+                assets = self.latestRelease.get_assets()
+                for asset in assets:
+                    if asset.name.find(type) != -1 and asset.name.find(platform) != -1:
+                        print(asset.name)
+                        print(asset.url)
+                        self.data.ui_queue1.put("Action", "pyinstallUpdate", "on")
+                        self.data.pyInstallUpdateAvailable = True
+                        self.data.pyInstallUpdateBrowserUrl = asset.browser_download_url
+                        self.data.pyInstallUpdateVersion = latest
+        '''