Logic changes to make use of gcode buffering improvements

[woutgg]

With the modifications to print3d's GCodeBuffer (details here, integration in progress), it is now possible for the server to perform several sanity checks while appending code as well as rejecting new code when the buffer is full.

Steps to take

For this to work though, the client should undergo some changes:

• [x] API docs on the wiki should be updated with the new metadata fields (in requests) as well as new possible errors (in responses);
• [x] it should handle errors when sending GCode - this is currently being ignored, see here;
• [x] moreover, it should deal with rejections when the buffer is full, possibly by exposing getMaxBufferSize through the API somehow, so the client can fill up the buffer and wait until it drops below a certain percentage (e.g. to 100%, back to 60%, fill back up again, etc.);
• [x] although not something to be done in the client itself, with a small change in print3d, accuracy of printing progress could be improved (details here);
• [x] it should send sequence number (and perhaps also total number of chunks) with each GCode part, to fix https://github.com/Doodle3D/doodle3d-client/issues/226 (so we can leave the stop button enabled - it is currently disabled while sending).

  Related issues

Where appropriate, links are marked with 'unsure'.

• print3d / unresponsiveness
  • crash - https://github.com/Doodle3D/doodle3d-client/issues/280, which references https://github.com/Doodle3D/doodle3d-firmware/issues/11 and https://github.com/Doodle3D/print3d/issues/21
  • (unsure) stops printing - https://github.com/Doodle3D/print3d/issues/33
  • (unsure) big makerbot print - https://github.com/Doodle3D/print3d/issues/6 (fixed in the meantime?)
  • slow makerbot printing: https://github.com/Doodle3D/doodle3d-client/issues/93 (fixed in the meantime?)
  • makerbot print does not finish sending: https://github.com/Doodle3D/doodle3d-client/issues/177 (fixed?)
  • (unsure) sending big files: https://github.com/Doodle3D/doodle3d-firmware/issues/13 (quite old, fixed?) (closed)
• stopping a print
  • check print parts order: https://github.com/Doodle3D/doodle3d-firmware/issues/16, referenced by https://github.com/Doodle3D/doodle3d-client/issues/226 and https://github.com/Doodle3D/doodle3d-client/issues/35 (all fixed?)
  • check printer state before sending data: https://github.com/Doodle3D/Doodle3D-API/issues/5
• progress reporting - https://github.com/Doodle3D/doodle3d-firmware/issues/51 and equivalent: https://github.com/Doodle3D/print3d/issues/31
• logging - extend&unify: https://github.com/Doodle3D/doodle3d-client/issues/243 (fixed?)
• tmpfs/memory-related (can be fixed using buffer_full fail response)
  • buffer full: https://github.com/Doodle3D/doodle3d-client/issues/240 (fixed?)
  • sketch disk usage: https://github.com/Doodle3D/doodle3d-firmware/issues/50 (unrelated)
  • sending large files: https://github.com/Doodle3D/Doodle3D-API/issues/15
• miscellaneous
  • gcode repeated: https://github.com/Doodle3D/doodle3d-client/issues/231 (might be easier to inspect now?)

[peteruithoven]

See branch: https://github.com/Doodle3D/doodle3d-client/commits/feature/buffer-full-retry

[woutgg]

• API documentation changes are in the printer section.
• Handling gcode send failures in the client implemented here.
• Handling buffer full failures: changes in the client, firmware and print3d.
• An overview of changes for sending total lines can be found in this issue: https://github.com/Doodle3D/print3d/issues/34.
• Sending sequence numbers from the client is implemented here.

Only recent changes have been mentioned here, they should make a good starting point to find older changes (mainly in firmware and print3d) which facilitate the new ones though.