Merge pull request #2 from AndyEveritt:dev_v1.1.1

dev_v1.1.1

Author: AndyEveritt

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.1.0
+current_version = 1.1.1
 commit = False
 tag = False
 allow_dirty = False

Makefile

@@ -8,13 +8,14 @@ verbosity=1
 # `bumpversion --tag release
 
 update_dist:
+	rm dist/*
 	python setup.py sdist bdist_wheel
 
 check_dist:
-	twine check dist/*-$(v)*
+	twine check dist/*
 
-upload_test:
-	twine upload --repository testpypi dist/*-$(v)*
+upload_test: check_dist
+	twine upload --repository testpypi dist/*
 
-upload:
-	twine upload dist/*-$(v)*
+upload: check_dist
+	twine upload dist/*

README.md

@@ -24,7 +24,7 @@ pip install -e "git+https://github.com/AndyEveritt/DuetWebAPI.git@master#egg=due
 ```python
 from duetwebapi import DuetWebAPI
 
-printer = DuetWebAPI(f'http://{printer_hostname})
+printer = DuetWebAPI(f'http://{printer_hostname}')
 ```
 
 ## REST API
@@ -48,9 +48,16 @@ An additional wrapper is provided to make repetative tasks easier
 
 Method | Description
 ------ | -----------
-`get_coords()` | return the current position of all the movement axes
-`get_layer()` | return the current layer number of the print
-`get_num_extruders()` | return the number of extruders currently configured
-`get_num_tools()` | return the number of tools currently configured
-`get_status()` | return the current Duet status
-`get_temperature()` | return a list of all the analog sensors and their value
+`emergency_stop() -> None` | Send M112 > M999
+`start_print(filename: str) -> Dict` | start a print on duet
+`pause_print() -> Dict` | pause current print
+`stop_print(leave_heaters: bool) -> Dict` | stop current print, will pause first if not paused
+`get_coords() -> Dict` | return the current position of all the movement axes
+`get_layer() -> int` | return the current layer number of the print
+`get_num_extruders() -> int` | return the number of extruders currently configured
+`get_num_tools() -> int` | return the number of tools currently configured
+`get_status() -> str` | return the current Duet status
+`get_temperature() -> List[Dict]` | return a list of all the analog sensors and their value
+`get_current_tool() -> int` | return the current tool number
+`get_messagebox() -> Dict` | return the details of a message displayed via `M291` if one exists
+`acknowledge_message(response: int) -> Dict` | send an acknowledgement to a message if one exists. Response options are `0` (continue), and `1` (cancel) 

duetwebapi/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 
 from .dwa_factory import DuetWebAPI

duetwebapi/api/base.py

@@ -7,9 +7,14 @@
 class DuetAPI:
     api_name = ''
 
-    def __init__(self, base_url) -> None:
+    def __init__(self, base_url: str) -> None:
+        if not base_url.startswith('http://'):
+            base_url = f'http://{base_url}'
         self._base_url = base_url
 
+    def base_url(self):
+        return self._base_url
+
     def get_model(self, key: str = None) -> Dict:
         """ Get Duet object model. RRF3 only """
         raise NotImplementedError
@@ -45,3 +50,5 @@ def get_directory(self, directory: str) -> List[Dict]:
     def create_directory(self, directory: str) -> Dict:
         """ Create a new directory """
         raise NotImplementedError
+
+pass

duetwebapi/api/wrapper.py

@@ -5,37 +5,72 @@
 
 
 class DuetAPIWrapper(DuetAPI):
-    def get_coords(self):
+    def emergency_stop(self) -> None:
+        self.send_code('M112')
+        self.send_code('M999')
+
+    def start_print(self, filename: str) -> Dict:
+        return self.send_code(f'M32 "{filename}"')
+
+    def pause_print(self) -> Dict:
+        return self.send_code(f'M25')
+
+    def stop_print(self, leave_heaters: bool = True) -> Dict:
+        status = self.get_status()
+        if status == 'idle':
+            return
+        if not status == 'paused':
+            self.pause_print()
+
+        code = 'M0'
+        if leave_heaters:
+            code += ' H1'
+        return self.send_code(code)
+
+    def get_coords(self) -> Dict:
         model = self.get_model()
         axes = model['move']['axes']
         ret = {}
         for i in range(0, len(axes)):
             ret[axes[i]['letter']] = axes[i]['userPosition']
         return(ret)
 
-    def get_layer(self):
+    def get_layer(self) -> int:
         model = self.get_model()
         layer = model['job']['layer']
         if not layer:
             layer = 0
         return(layer)
 
-    def get_num_extruders(self):
+    def get_num_extruders(self) -> int:
         model = self.get_model()
         extruders = model['move']['extruders']
         return len(extruders)
 
-    def get_num_tools(self):
+    def get_num_tools(self) -> int:
         model = self.get_model()
         tools = model['tools']
         return len(tools)
 
-    def get_status(self):
+    def get_status(self) -> str:
         model = self.get_model()
         status = model['state']['status']
         return status
 
-    def get_temperatures(self):
+    def get_temperatures(self) -> List[Dict]:
         model = self.get_model()
         sensors = model['sensors']['analog']
         return sensors
+
+    def get_current_tool(self) -> int:
+        model = self.get_model()
+        tool = model['state']['currentTool']
+        return tool
+
+    def get_messagebox(self) -> Dict:
+        model = self.get_model()
+        messagebox = model['state']['messageBox']
+        return messagebox
+
+    def acknowledge_message(self, response: int = 0) -> Dict:
+        return self.send_code(f'M292 P{response}')

duetwebapi/dwa_factory.py

@@ -31,6 +31,8 @@ def register_api(self, name: str, creator: object, url_suffix: str) -> None:
 
     def get_api(self, base_url) -> DuetAPI:
         for api in self._creators.values():
+            if not base_url.startswith('http://'):
+                base_url = f'http://{base_url}'
             url = base_url + api['url_suffix']
             try:
                 r = requests.get(url, timeout=(2, 60))

setup.py

@@ -9,7 +9,7 @@
 
 setup(
     name="duetwebapi",
-    version="1.1.0",
+    version="1.1.1",
     include_package_data=True,
     packages=find_packages(),