Skip to content

Commit abbb122

Browse files
author
AndyEveritt
committed
add class docstring
1 parent c732175 commit abbb122

5 files changed

Lines changed: 19 additions & 219 deletions

File tree

DuetWebAPI/api/base.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66

77
class DuetAPI:
8+
api_name = ''
9+
810
def __init__(self, base_url) -> None:
911
self._base_url = base_url
1012

DuetWebAPI/api/dsf_api.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88

99

1010
class DSFAPI(DuetAPI):
11+
"""
12+
Duet Software Framework REST API Interface.
13+
14+
Used with a Duet 3 + SBC.
15+
Must use RRF3.
16+
"""
17+
api_name = 'DSF_REST'
18+
1119
def get_model(self, **_ignored) -> Dict:
1220
url = f'{self._base_url}/machine/status'
1321
r = requests.get(url)

DuetWebAPI/api/dwc_api.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88

99

1010
class DWCAPI(DuetAPI):
11+
"""
12+
Duet Web Control REST API Interface.
13+
14+
Used with a Duet 2/3 in standalone mode.
15+
Must use RRF3.
16+
"""
17+
api_name = 'DWC_REST'
18+
1119
def get_model(self, key: str = None) -> Dict:
1220
url = f'{self._base_url}/rr_model'
1321
r = requests.get(url, {'flags': 'd99vn', 'key': key})

DuetWebAPI/tmp.py

Lines changed: 0 additions & 218 deletions
This file was deleted.

examples.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
riley = DWA('http://riley')
99
force_rig = DWA('http://forcerig')
10-
10+
force_rig.api_name
1111
force_rig.put_file('test.gcode')
1212
riley.put_file('test.gcode')
1313
pass

0 commit comments

Comments
 (0)