Skip to content

Commit 92e8c72

Browse files
author
AndyEveritt
committed
update readme
1 parent 63fd998 commit 92e8c72

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,31 @@ Python interface to Duet RepRap V3 firmware via Http REST API.
1414

1515
# Usage
1616
* See 'examples.py' for examples.
17+
18+
## REST API
19+
The REST API allows for the following operations:
20+
21+
Method | Description
22+
------ | -----------
23+
`get_model(key: str = None) -> Dict` | Get Duet object model. RRF3 only
24+
`post_code(code: str) -> Dict` | Send G/M/T-code to Duet
25+
`get_file(filename: str, directory: str = 'gcodes') -> str` | Download file from Duet
26+
`put_file(file: str, directory: str = 'gcodes') -> Dict` | Upload file to Duet
27+
`get_fileinfo(filename: str = None, directory: str = 'gcodes') -> Dict` | Get file info
28+
`delete_file(filename: str, directory: str = 'gcodes') -> Dict` | Delete file on Duet
29+
`move_file(from_path: str, to_path: str, force: bool = False) -> Dict` | Move file on Duet, can be used to rename files
30+
`get_directory(directory: str) -> List[Dict]` | Get a list of all the files & directories in a directory
31+
`put_directory(directory: str) -> Dict` | Create a new directory
32+
33+
34+
## Wrapper
35+
An additional wrapper is provided to make repetative tasks easier
36+
37+
Method | Description
38+
------ | -----------
39+
`get_coords()` | return the current position of all the movement axes
40+
`get_layer()` | return the current layer number of the print
41+
`get_num_extruders()` | return the number of extruders currently configured
42+
`get_num_tools()` | return the number of tools currently configured
43+
`get_status()` | return the current Duet status
44+
`get_temperature()` | return a list of all the analog sensors and their value

0 commit comments

Comments
 (0)