Added licicense.md

Author: ielson

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Daniel Mascarenhas de Andrade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,63 @@
-# octoROS
-Integration between OctoPrint and ROS
+# OctoROS
+This projects aims to be a bridge between 3d printers and ROS. 
+It uses OctoPrint to control the printer, and get the info that is sent to ROS topics. 
+
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+First you'll need to install OctoPrint, the instructions are available at https://github.com/foosel/OctoPrint. But the easiest way that I see is with the following instructions
+
+1. Checkout OctoPrint:  ```$ git clone https://github.com/foosel/OctoPrint.git```
+2. Change into the OctoPrint folder: ```$ cd OctoPrint```
+3. Create a user-owned virtual environment therein: ```$ virtualenv venv```
+4. Install OctoPrint into that virtual environment: ```$ ./venv/bin/pip install .```
+5. After installing OctoPrint, you should run it using:```$ octoprint serve```   
+6. Now you should verify your installation opening a web browser and going to http://localhost:5000
+7. If everything went right you should see the OctoPrint home screen  
+
+If the printer that you're using is a MakerBot, now it's time to install the GPX plug-in, that will enable us to to send gcode to octoprint, that will take care of the conversion to x3g. To that do the following:
+1. In the octoPrint home screen go to configurations/Plugin manager/Get More
+2. Search for GPX and click install 
+3. Go to GPX settings and click enable GPX
+4. Choose your machine, gcode flavor and other settings
+
+
+### Installing
+
+This project should be run from source, to do so just go to your ROS workspace and clone it with ```git clone https://github.com/ielson/octoROS.git```. After that you can't forget to make the file executable, or ROS won't find it.
+
+### Usage
+To use it, you need to have your octoprint server running, have a model uploaded to it, and then run the octoROS.py file, changing the file name in the 59th line to the uploaded file name. 
+
+So it will start printing the model and outputting the progress and some printer measurements to the ```/printer3d``` ROS topic until finish printing. When it happens the file will send a boolean to ```printer3d/finishedPrinting```.
+
+Example of usage:
+```
+$ roscore
+# in another terminal run 
+$ rosrun octoROS octoROS.py 
+
+
+```
+```
+Give an example
+```
+
+
+## Authors
+
+* **Daniel Mascarenhas** - *Initial work* - [ielson](https://github.com/ielson)
+
+See also the list of [contributors](https://github.com/ielson/octoROS/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+Many thank to the octoprint team, that made this awesome software

src/messenger.py

@@ -1,5 +1,11 @@
 #!/usr/bin/env python2.7
 
+""" octoROS - integrating octoprint with ROS, so it's possible to control your 3d printer from your robot
+This library is based in the octoprint api, more info can be found here:
+http://docs.octoprint.org/en/master/api/index.html
+"""
+
+
 import requests
 
 octoIP = "http://127.0.0.1"
@@ -9,14 +15,14 @@
 
 standardHeader = {'X-Api-Key': apiKey}
 
-
+# Connection handling
 def connectToPrinter():
     connectionData = {"command": "connect", "port": "/dev/ttyACM0", "baudrate": 115200, "printerProfile": "_default",
                       "save": True, "autoconnect": True}
     return requests.post(_url("connection"), json=connectionData, headers=standardHeader, timeout=5)
 
 
-
+# File operations
 def modelSelection():
     pass
 
@@ -28,10 +34,30 @@ def printModel(modelName):
     return requests.post(url, json=printData, headers=standardHeader, timeout=5)
 
 
+# Job operations
 def progressTracking():
     response = requests.get(_url('job'), headers=standardHeader, timeout=5)
     return (response.json()['progress']['completion'])
 
+def cancelPrinting():
+    jsonData = {'command':'cancel'}
+    return requests.post(_url('job'), headers=standardHeader, timeout=5, json=jsonData)
+
+def pausePrinting():
+    jsonData = {'command':'pause', 'action':'pause'}
+    return requests.post(_url('job'), headers=standardHeader, timeout=5, json=jsonData)
+
+def resumePrinting():
+    jsonData = {'command':'pause', 'action':'resume'}
+    return requests.post(_url('job'), headers=standardHeader, timeout=5, json=jsonData)
+
+# Printer operations
+def getprinterInfo():
+    response = requests.get(_url('printer'), headers=standardHeader, timeout=5)
+    tool0Temp = response.json()['temperature']['tool0']['actual']
+    tool1Temp = response.json()['temperature']['tool1']['actual']
+    bedTemp = response.json()['temperature']['bed']['actual']
+    return tool0Temp, tool1Temp, bedTemp
 
 
 def _url(path):

src/octoROS.py

@@ -53,9 +53,10 @@ def printAndGetStatus(self, modelName):
 
 
 def main(args):
+    # Ros was not catching interrupt exceptions, so I had to disable signals and use the KeyboardInterrupt exception
     rospy.init_node('printerWatcher', anonymous=True, disable_signals=True)
     interf = interface()
-    interf.printAndGetStatus('Teste.gcode')
+    interf.printAndGetStatus('FlexiRexColor1.gcode')
 
 
 if __name__ == '__main__':