Cura/util/printerConnection/doodle3dConnect.py

   1 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
   2
   3 import threading
   4 import json
   5 import httplib as httpclient
   6 import urllib
   7 import time
   8
   9 from Cura.util.printerConnection import printerConnectionBase
  10
  11 class doodle3dConnectionGroup(printerConnectionBase.printerConnectionGroup):
  12         PRINTER_LIST_HOST = 'connect.doodle3d.com'
  13         PRINTER_LIST_PATH = '/api/list.php'
  14
  15         def __init__(self):
  16                 super(doodle3dConnectionGroup, self).__init__("Doodle3D")
  17                 self._http = None
  18                 self._host = self.PRINTER_LIST_HOST
  19                 self._connectionMap = {}
  20
  21                 self._thread = threading.Thread(target=self._doodle3DThread)
  22                 self._thread.daemon = True
  23                 self._thread.start()
  24
  25         def getAvailableConnections(self):
  26                 return filter(lambda c: c.isAvailable(), self._connectionMap.values())
  27
  28         def remove(self, host):
  29                 del self._connectionMap[host]
  30
  31         def getIconID(self):
  32                 return 27
  33
  34         def getPriority(self):
  35                 return 100
  36
  37         def __cmp__(self, other):
  38                 return self.getPriority() - other.getPriority()
  39
  40         def __repr__(self):
  41                 return self.name
  42
  43         def _doodle3DThread(self):
  44                 self._waitDelay = 0
  45                 while True:
  46                         printerList = self._request('GET', self.PRINTER_LIST_PATH)
  47                         if not printerList or type(printerList) is not dict or 'data' not in printerList or type(printerList['data']) is not list:
  48                                 #Check if we are connected to the Doodle3D box in access point mode, as this gives an
  49                                 # invalid reply on the printer list API
  50                                 printerList = {'data': [{'localip': 'draw.doodle3d.com'}]}
  51
  52                         #Add the 192.168.5.1 IP to the list of printers to check, as this is the LAN port IP, which could also be available.
  53                         # (connect.doodle3d.com also checks for this IP in the javascript code)
  54                         printerList['data'].append({'localip': '192.168.5.1'})
  55
  56                         #Check the status of each possible IP, if we find a valid box with a printer connected. Use that IP.
  57                         for possiblePrinter in printerList['data']:
  58                                 if possiblePrinter['localip'] not in self._connectionMap:
  59                                         status = self._request('GET', '/d3dapi/config/?network.cl.wifiboxid=', host=possiblePrinter['localip'])
  60                                         if status and 'data' in status and 'network.cl.wifiboxid' in status['data']:
  61                                                 self._connectionMap[possiblePrinter['localip']] = doodle3dConnect(possiblePrinter['localip'], status['data']['network.cl.wifiboxid'], self)
  62
  63                         # Delay a bit more after every request. This so we do not stress the connect.doodle3d.com api too much
  64                         if self._waitDelay < 10:
  65                                 self._waitDelay += 1
  66                         time.sleep(self._waitDelay * 60)
  67
  68         def _request(self, method, path, postData = None, host = None):
  69                 if host is None:
  70                         host = self._host
  71                 if self._http is None or self._http.host != host:
  72                         self._http = httpclient.HTTPConnection(host, timeout=30)
  73
  74                 try:
  75                         if postData is not None:
  76                                 self._http.request(method, path, urllib.urlencode(postData), {"Content-type": "application/x-www-form-urlencoded", "User-Agent": "Cura Doodle3D connection"})
  77                         else:
  78                                 self._http.request(method, path, headers={"Content-type": "application/x-www-form-urlencoded", "User-Agent": "Cura Doodle3D connection"})
  79                 except:
  80                         self._http.close()
  81                         return None
  82                 try:
  83                         response = self._http.getresponse()
  84                         responseText = response.read()
  85                 except:
  86                         self._http.close()
  87                         return None
  88                 try:
  89                         response = json.loads(responseText)
  90                 except ValueError:
  91                         self._http.close()
  92                         return None
  93                 if response['status'] != 'success':
  94                         return False
  95
  96                 return response
  97
  98 #Class to connect and print files with the doodle3d.com wifi box
  99 # Auto-detects if the Doodle3D box is available with a printer
 100 class doodle3dConnect(printerConnectionBase.printerConnectionBase):
 101         def __init__(self, host, name, group):
 102                 super(doodle3dConnect, self).__init__(name)
 103
 104                 self._http = None
 105                 self._group = group
 106                 self._host = host
 107
 108                 self._isAvailable = False
 109                 self._printing = False
 110                 self._fileBlocks = []
 111                 self._commandList = []
 112                 self._blockIndex = None
 113                 self._lineCount = 0
 114                 self._progressLine = 0
 115                 self._hotendTemperature = [None] * 4
 116                 self._bedTemperature = None
 117                 self._errorCount = 0
 118                 self._interruptSleep = False
 119
 120                 self.checkThread = threading.Thread(target=self._doodle3DThread)
 121                 self.checkThread.daemon = True
 122                 self.checkThread.start()
 123
 124         #Load the file into memory for printing.
 125         def loadGCodeData(self, dataStream):
 126                 if self._printing:
 127                         return False
 128                 self._fileBlocks = []
 129                 self._lineCount = 0
 130                 block = []
 131                 blockSize = 0
 132                 for line in dataStream:
 133                         #Strip out comments, we do not need to send comments
 134                         if ';' in line:
 135                                 line = line[:line.index(';')]
 136                         #Strip out whitespace at the beginning/end this saves data to send.
 137                         line = line.strip()
 138
 139                         if len(line) < 1:
 140                                 continue
 141                         self._lineCount += 1
 142                         #Put the lines in 8k sized blocks, so we can send those blocks as http requests.
 143                         if blockSize + len(line) > 1024 * 8:
 144                                 self._fileBlocks.append('\n'.join(block) + '\n')
 145                                 block = []
 146                                 blockSize = 0
 147                         blockSize += len(line) + 1
 148                         block.append(line)
 149                 self._fileBlocks.append('\n'.join(block) + '\n')
 150                 self._doCallback()
 151                 return True
 152
 153         #Start printing the previously loaded file
 154         def startPrint(self):
 155                 if self._printing or len(self._fileBlocks) < 1:
 156                         return
 157                 self._progressLine = 0
 158                 self._blockIndex = 0
 159                 self._printing = True
 160                 self._interruptSleep = True
 161
 162         #Abort the previously loaded print file
 163         def cancelPrint(self):
 164                 if not self._printing:
 165                         return
 166                 if self._request('POST', '/d3dapi/printer/stop', {'gcode': 'M104 S0\nG28'}):
 167                         self._printing = False
 168
 169         def isPrinting(self):
 170                 return self._printing
 171
 172         #Amount of progression of the current print file. 0.0 to 1.0
 173         def getPrintProgress(self):
 174                 if self._lineCount < 1:
 175                         return 0.0
 176                 return float(self._progressLine) / float(self._lineCount)
 177
 178         # Return if the printer with this connection type is available
 179         def isAvailable(self):
 180                 return self._isAvailable
 181
 182         #Are we able to send a direct coammand with sendCommand at this moment in time.
 183         def isAbleToSendDirectCommand(self):
 184                 #The delay on direct commands is very high and so we disabled it.
 185                 return False #self._isAvailable and not self._printing
 186
 187         #Directly send a command to the printer.
 188         def sendCommand(self, command):
 189                 if not self._isAvailable or self._printing:
 190                         return
 191                 self._commandList.append(command)
 192                 self._interruptSleep = True
 193
 194         # Get the connection status string. This is displayed to the user and can be used to communicate
 195         #  various information to the user.
 196         def getStatusString(self):
 197                 if not self._isAvailable:
 198                         return "Doodle3D box not found"
 199                 if self._printing:
 200                         ret = "Print progress: %.1f%%" % (self.getPrintProgress() * 100.0)
 201                         if self._blockIndex < len(self._fileBlocks):
 202                                 ret += "\nSending GCode: %.1f%%" % (float(self._blockIndex) * 100.0 / float(len(self._fileBlocks)))
 203                         elif len(self._fileBlocks) > 0:
 204                                 ret += "\nFinished sending GCode to Doodle3D box.\nPrint will continue even if you shut down Cura."
 205                         else:
 206                                 ret += "\nDifferent print still running..."
 207                         ret += "\nErrorCount: %d" % (self._errorCount)
 208                         return ret
 209                 return "Printer found, waiting for print command."
 210
 211         #Get the temperature of an extruder, returns None is no temperature is known for this extruder
 212         def getTemperature(self, extruder):
 213                 return self._hotendTemperature[extruder]
 214
 215         #Get the temperature of the heated bed, returns None is no temperature is known for the heated bed
 216         def getBedTemperature(self):
 217                 return self._bedTemperature
 218
 219         def _doodle3DThread(self):
 220                 while True:
 221                         stateReply = self._request('GET', '/d3dapi/info/status')
 222                         if stateReply is None or not stateReply:
 223                                 # No API, wait 5 seconds before looking for Doodle3D again.
 224                                 # API gave back an error (this can happen if the Doodle3D box is connecting to the printer)
 225                                 # The Doodle3D box could also be offline, if we reach a high enough errorCount then assume the box is gone.
 226                                 self._errorCount += 1
 227                                 if self._errorCount > 10:
 228                                         if self._isAvailable:
 229                                                 self._printing = False
 230                                                 self._isAvailable = False
 231                                                 self._doCallback()
 232                                         self._sleep(15)
 233                                         self._group.remove(self._host)
 234                                         return
 235                                 else:
 236                                         self._sleep(3)
 237                                 continue
 238                         if stateReply['data']['state'] == 'disconnected':
 239                                 # No printer connected, we do not have a printer available, but the Doodle3D box is there.
 240                                 # So keep trying to find a printer connected to it.
 241                                 if self._isAvailable:
 242                                         self._printing = False
 243                                         self._isAvailable = False
 244                                         self._doCallback()
 245                                 self._sleep(15)
 246                                 continue
 247                         self._errorCount = 0
 248
 249                         #We got a valid status, set the doodle3d printer as available.
 250                         if not self._isAvailable:
 251                                 self._isAvailable = True
 252
 253                         if 'hotend' in stateReply['data']:
 254                                 self._hotendTemperature[0] = stateReply['data']['hotend']
 255                         if 'bed' in stateReply['data']:
 256                                 self._bedTemperature = stateReply['data']['bed']
 257
 258                         if stateReply['data']['state'] == 'idle' or stateReply['data']['state'] == 'buffering':
 259                                 if self._printing:
 260                                         if self._blockIndex < len(self._fileBlocks):
 261                                                 if self._request('POST', '/d3dapi/printer/print', {'gcode': self._fileBlocks[self._blockIndex], 'start': 'True', 'first': 'True'}):
 262                                                         self._blockIndex += 1
 263                                                 else:
 264                                                         self._sleep(1)
 265                                         else:
 266                                                 self._printing = False
 267                                 else:
 268                                         if len(self._commandList) > 0:
 269                                                 if self._request('POST', '/d3dapi/printer/print', {'gcode': self._commandList[0], 'start': 'True', 'first': 'True'}):
 270                                                         self._commandList.pop(0)
 271                                                 else:
 272                                                         self._sleep(1)
 273                                         else:
 274                                                 self._sleep(5)
 275                         elif stateReply['data']['state'] == 'printing':
 276                                 if self._printing:
 277                                         if self._blockIndex < len(self._fileBlocks):
 278                                                 for n in xrange(0, 5):
 279                                                         if self._blockIndex < len(self._fileBlocks):
 280                                                                 if self._request('POST', '/d3dapi/printer/print', {'gcode': self._fileBlocks[self._blockIndex]}):
 281                                                                         self._blockIndex += 1
 282                                                                 else:
 283                                                                         #Cannot send new block, wait a bit, so we do not overload the API
 284                                                                         self._sleep(15)
 285                                                                         break
 286                                         else:
 287                                                 #If we are no longer sending new GCode delay a bit so we request the status less often.
 288                                                 self._sleep(5)
 289                                         if 'current_line' in stateReply['data']:
 290                                                 self._progressLine = stateReply['data']['current_line']
 291                                 else:
 292                                         #Got a printing state without us having send the print file, set the state to printing, but make sure we never send anything.
 293                                         if 'current_line' in stateReply['data'] and 'total_lines' in stateReply['data'] and stateReply['data']['total_lines'] > 2:
 294                                                 self._printing = True
 295                                                 self._fileBlocks = []
 296                                                 self._blockIndex = 1
 297                                                 self._progressLine = stateReply['data']['current_line']
 298                                                 self._lineCount = stateReply['data']['total_lines']
 299                                         self._sleep(5)
 300                         self._doCallback()
 301
 302         def _sleep(self, timeOut):
 303                 while timeOut > 0.0:
 304                         if not self._interruptSleep:
 305                                 time.sleep(0.1)
 306                         timeOut -= 0.1
 307                 self._interruptSleep = False
 308
 309         def _request(self, method, path, postData = None, host = None):
 310                 if host is None:
 311                         host = self._host
 312                 if self._http is None or self._http.host != host:
 313                         self._http = httpclient.HTTPConnection(host, timeout=30)
 314
 315                 try:
 316                         if postData is not None:
 317                                 self._http.request(method, path, urllib.urlencode(postData), {"Content-type": "application/x-www-form-urlencoded", "User-Agent": "Cura Doodle3D connection"})
 318                         else:
 319                                 self._http.request(method, path, headers={"Content-type": "application/x-www-form-urlencoded", "User-Agent": "Cura Doodle3D connection"})
 320                 except:
 321                         self._http.close()
 322                         return None
 323                 try:
 324                         response = self._http.getresponse()
 325                         responseText = response.read()
 326                 except:
 327                         self._http.close()
 328                         return None
 329                 try:
 330                         response = json.loads(responseText)
 331                 except ValueError:
 332                         self._http.close()
 333                         return None
 334                 if response['status'] != 'success':
 335                         return False
 336
 337                 return response
 338
 339 if __name__ == '__main__':
 340         d = doodle3dConnect()
 341         print 'Searching for Doodle3D box'
 342         while not d.isAvailable():
 343                 time.sleep(1)
 344
 345         while d.isPrinting():
 346                 print 'Doodle3D already printing! Requesting stop!'
 347                 d.cancelPrint()
 348                 time.sleep(5)
 349
 350         print 'Doodle3D box found, printing!'
 351         d.loadFile("C:/Models/belt-tensioner-wave_export.gcode")
 352         d.startPrint()
 353         while d.isPrinting() and d.isAvailable():
 354                 time.sleep(1)
 355                 print d.getTemperature(0), d.getStatusString(), d.getPrintProgress(), d._progressLine, d._lineCount, d._blockIndex, len(d._fileBlocks)
 356         print 'Done'