Skip to content

Commit 3b6e6be

Browse files
johanohlyjohanohly
committed
Document gcode macros
1 parent acc4401 commit 3b6e6be

File tree

2 files changed

+360
-0
lines changed

2 files changed

+360
-0
lines changed

‎source/includes/gcode_macros.md

+359
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,359 @@
1+
# GCode Macros
2+
3+
## Get overview
4+
5+
```shell
6+
curl https://api.simplyprint.io/{id}/gcode_macros/GetOverview \
7+
-H 'accept: application/json' \
8+
-H 'X-API-KEY: {API_KEY}'
9+
```
10+
11+
> Success response
12+
13+
```json
14+
{
15+
"status": true,
16+
"message": null,
17+
"gcodeCompletions": [
18+
{
19+
"label": "G0",
20+
"type": "variable",
21+
"info": "Add a straight line movement to the planner",
22+
"detail": "X, Y, Z, E, F, S"
23+
}
24+
],
25+
"macro_groups": [
26+
{
27+
"name": "<i class='fas fa-infinity'><\/i> AutoPrint <i>(advanced)<\/i>",
28+
"desc": "The AutoPrint feature can automatically start prints. Here you define what Gcode should be executed to make sure the bed is clear.",
29+
"macros": [
30+
"is_autoprint_clear"
31+
],
32+
"nopersonal": true
33+
}
34+
],
35+
"macros_cards": {
36+
"is_start": {
37+
"name": "Start print",
38+
"description": "GCODE to be executed at start of print when using our slicer"
39+
}
40+
},
41+
"macros": {
42+
"company": [
43+
{
44+
"gcodes": {
45+
"printer_225": [
46+
"{snippet:2731}"
47+
],
48+
"printer_10063": null,
49+
"printer_10372": [
50+
"{snippet:2796}"
51+
]
52+
},
53+
"type": "is_start"
54+
}
55+
],
56+
"personal": null,
57+
"sp": [
58+
{
59+
"gcodes": {
60+
"type_0": [
61+
"{snippet:26}"
62+
],
63+
"type_236": [
64+
"{snippet:1103}",
65+
"{snippet:26}"
66+
]
67+
},
68+
"type": "is_pause"
69+
}
70+
]
71+
},
72+
"snippets": {
73+
"company": [
74+
{
75+
"id": 28,
76+
"name": "Indentify Ender 5",
77+
"description": "Identify printer specifically for Ender 5",
78+
"priority": 0,
79+
"created": "2020-04-22T09:19:37+00:00"
80+
}
81+
]
82+
},
83+
"variables": {
84+
"bed_x": "Printer bed X length in mm",
85+
"bed_y": "Printer bed Y length in mm"
86+
},
87+
"slicerVariables": {
88+
"temp": "Hot end temperature",
89+
"bed_temp": "Bed temperature",
90+
"fan_speed": "Active cooling fan speed (usually 0-255)"
91+
}
92+
}
93+
```
94+
95+
`GET /{id}/gcode_macros/GetOverview`
96+
97+
### Response
98+
99+
See example response.
100+
101+
## Get snippet
102+
103+
```shell
104+
curl https://api.simplyprint.io/{id}/gcode_macros/GetSnippet?id=123 \
105+
-H 'accept: application/json' \
106+
-H 'X-API-KEY: {API_KEY}' \
107+
```
108+
109+
> Success Response
110+
111+
```json
112+
{
113+
"status": true,
114+
"message": null,
115+
"snippet": {
116+
"id": 123,
117+
"name": "Example Snippet",
118+
"description": "This is an example snippet",
119+
"priority": 0,
120+
"gcode": "G1 X10 Y10"
121+
}
122+
}
123+
```
124+
125+
`GET /gcode_macros/GetSnippet`
126+
127+
### Request Parameters
128+
129+
| Parameter | Type | Description |
130+
|-----------|---------|------------------------------------|
131+
| `id` | integer | The ID of the snippet to retrieve. |
132+
133+
### Response
134+
135+
| Parameter | Type | Description |
136+
|-----------------------|---------|----------------------------------------|
137+
| `status` | boolean | `true` if the request was successful. |
138+
| `message` | string | Error message if `status` is `false`. |
139+
| `snippet` | object | The details of the snippet. |
140+
| `snippet.id` | integer | Unique identifier for the snippet. |
141+
| `snippet.name` | string | Name of the snippet. |
142+
| `snippet.description` | string | Description of the snippet. |
143+
| `snippet.priority` | integer | Priority of the snippet. |
144+
| `snippet.gcode` | string? | GCode content of the snippet (if any). |
145+
146+
## Save snippet
147+
148+
```shell
149+
curl -X POST https://api.simplyprint.io/{id}/gcode_macros/SaveSnippet?id=123&type=private \
150+
-H 'accept: application/json' \
151+
-H 'X-API-KEY: {API_KEY}' \
152+
-d '{
153+
"name": "Updated Snippet",
154+
"description": "This is an updated snippet.",
155+
"gcode": ["G1 X10 Y10", "G1 X20 Y20"]
156+
}'
157+
```
158+
159+
> Success Response
160+
161+
```json
162+
{
163+
"status": true,
164+
"message": null,
165+
"new_data": {
166+
// Updated data of the GCODE snippets
167+
}
168+
}
169+
```
170+
171+
`POST /gcode_macros/SaveSnippet`
172+
173+
### Request Parameters
174+
175+
| Parameter | Type | Description |
176+
|-----------|---------|------------------------------------------------------------------------|
177+
| `id` | integer | The ID of the snippet to update (optional for creating a new snippet). |
178+
| `type` | string | The type of the snippet (`org`, `private`, `public`). |
179+
180+
### Request Body
181+
182+
| Parameter | Type | Description |
183+
|---------------|--------|------------------------------------|
184+
| `name` | string | The name of the GCODE snippet. |
185+
| `description` | string | The description of the snippet. |
186+
| `gcode` | array | The GCODE commands of the snippet. |
187+
| `gcode.*` | string | A single GCODE command. |
188+
189+
### Response
190+
191+
| Parameter | Type | Description |
192+
|------------|---------|------------------------------------------------------|
193+
| `status` | boolean | `true` if the request was successful. |
194+
| `message` | string | Error message if `status` is `false`. |
195+
| `created` | integer | The ID of the newly created snippet (if applicable). |
196+
| `new_data` | object | The updated data of the GCODE snippets. |
197+
198+
## Delete snippet
199+
200+
```shell
201+
curl -X POST https://api.simplyprint.io/{id}/gcode_macros/DeleteSnippet?id=123 \
202+
-H 'accept: application/json' \
203+
-H 'X-API-KEY: {API_KEY}'
204+
```
205+
206+
> Success Response
207+
208+
```json
209+
{
210+
"status": true,
211+
"message": null,
212+
"new_data": {
213+
// Updated data of the GCODE snippets
214+
}
215+
}
216+
```
217+
218+
`POST /gcode_macros/DeleteSnippet`
219+
220+
### Request Parameters
221+
222+
| Parameter | Type | Description |
223+
|-----------|---------|---------------------------------------------------------------------------------------|
224+
| `id` | integer | The ID of the snippet to delete (required if `ids` is not provided). |
225+
| `ids` | string | Comma-separated list of IDs of snippets to delete (required if `id` is not provided). |
226+
227+
### Response
228+
229+
| Parameter | Type | Description |
230+
|------------|---------|-----------------------------------------|
231+
| `status` | boolean | `true` if the request was successful. |
232+
| `message` | string | Error message if `status` is `false`. |
233+
| `new_data` | object | The updated data of the GCODE snippets. |
234+
235+
## Get macro
236+
237+
```shell
238+
curl https://api.simplyprint.io/{id}/gcode_macros/GetMacroGcode?macro=is_start&printer=123&model=456&org=true&private=false&public=true \
239+
-H 'accept: application/json' \
240+
-H 'X-API-KEY: {API_KEY}' \
241+
```
242+
243+
> Success Response
244+
245+
```json
246+
{
247+
"status": true,
248+
"message": null,
249+
"gcode": [
250+
"G1 X10 Y10",
251+
"G1 X20 Y20"
252+
],
253+
"multiple": false
254+
}
255+
```
256+
257+
`GET /gcode_macros/GetMacroGcode`
258+
259+
### Request Parameters
260+
261+
| Parameter | Type | Description |
262+
|-----------|---------|------------------------------------------------------------------------------|
263+
| `macro` | string | The type of the macro. Must be one of the enums defined in `GcodeMacroType`. |
264+
| `printer` | integer | The ID of the printer. |
265+
| `model` | integer | The ID of the printer model. |
266+
| `org` | boolean | Whether to include organization macros. |
267+
| `private` | boolean | Whether to include private macros. |
268+
| `public` | boolean | Whether to include public macros. |
269+
270+
### Response
271+
272+
| Parameter | Type | Description |
273+
|------------|---------|---------------------------------------|
274+
| `status` | boolean | `true` if the request was successful. |
275+
| `message` | string | Error message if `status` is `false`. |
276+
| `gcode` | array | The GCODE commands of the macro. |
277+
| `multiple` | boolean | Whether multiple GCODEs are returned. |
278+
279+
## Save macro
280+
281+
```shell
282+
curl -X POST https://api.simplyprint.io/gcode_macros/SaveMacro?type=private \
283+
-H 'accept: application/json' \
284+
-H 'X-API-KEY: {API_KEY}' \
285+
-d '{
286+
"type": "is_start",
287+
"gcodes": {"printer_225": ["G1 X10 Y10"], "type_123": ["G1 X20 Y20", "{snippet:123}"]}
288+
}'
289+
```
290+
291+
> Success Response
292+
293+
```json
294+
{
295+
"status": true,
296+
"message": null
297+
}
298+
```
299+
300+
`POST /gcode_macros/SaveMacro`
301+
302+
### Request Parameters
303+
304+
| Parameter | Type | Description |
305+
|-----------|--------|-------------------------|
306+
| `type` | string | One of `org`, `private` |
307+
308+
### Request Body
309+
310+
| Parameter | Type | Description |
311+
|-----------------------|--------|-----------------------------------------------------------------------------------------|
312+
| `type` | string | One of `is_start`, `is_end`, `is_cancel`, `is_pause`, `is_resume`, `is_autorpint_clear` |
313+
| `gcodes` | object | Content of the macro. |
314+
| `gcodes.printer_{id}` | array | GCODE commands for the printer with ID `{id}`. |
315+
| `gcodes.type_{id}` | array | GCODE commands for the printer model with ID `{id}`. |
316+
| `gcodes.*[]` | string | Can be a GCODE command or `{snippet:{id}}` to reference a snippet. |
317+
318+
### Response
319+
320+
| Parameter | Type | Description |
321+
|-----------|---------|---------------------------------------|
322+
| `status` | boolean | `true` if the request was successful. |
323+
| `message` | string | Error message if `status` is `false`. |
324+
325+
## Arrange gcode order in macro
326+
327+
```shell
328+
curl -X POST https://api.simplyprint.io/gcode_macros/Arrange \
329+
-H 'accept: application/json' \
330+
-H 'X-API-KEY: {API_KEY}' \
331+
-d '{
332+
"order": [4,2,3,1]
333+
}'
334+
```
335+
336+
> Success Response
337+
338+
```json
339+
{
340+
"status": true,
341+
"message": null
342+
}
343+
```
344+
345+
`POST /gcode_macros/Arrange`
346+
347+
### Request Parameters
348+
349+
| Parameter | Type | Description |
350+
|-----------|---------|-----------------------------------------------|
351+
| `order` | array | An array of snippet IDs in the desired order. |
352+
| `order.*` | integer | A single snippet ID. |
353+
354+
### Response
355+
356+
| Parameter | Type | Description |
357+
|-----------|---------|---------------------------------------|
358+
| `status` | boolean | `true` if the request was successful. |
359+
| `message` | string | Error message if `status` is `false`. |

‎source/index.html.md

+1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ includes:
2323
- tags
2424
- custom_fields
2525
- webhooks
26+
- gcode_macros
2627
- permissions_scopes
2728
- errors
2829

0 commit comments

Comments
 (0)