From 792299537d80d91b89aeb49be7ff2124511efdcb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gina=20H=C3=A4u=C3=9Fge?= Date: Mon, 16 Dec 2013 02:11:40 +0100 Subject: [PATCH] Some more documentation --- docs/api/printer.rst | 52 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/docs/api/printer.rst b/docs/api/printer.rst index 887e5e05..c4898026 100644 --- a/docs/api/printer.rst +++ b/docs/api/printer.rst @@ -67,6 +67,7 @@ Issue a print head command :statuscode 200: No error :statuscode 400: Invalid axis specified, invalid value for travel amount for a jog command or otherwise invalid request. + :statuscode 403: If the printer is not operational or currently printing. .. _sec-api-printer-hotend: @@ -139,9 +140,56 @@ Issue a heater command :statuscode 400: If ``temps`` or ``offsets`` contains a property other than ``hotend`` or ``bed``, the target or offset temperature is not a valid number or outside of the supported range, or if the request is otherwise invalid. + :statuscode 403: If the printer is not operational. .. _sec-api-printer-feeder: -Feeder Control -============== +Issue a feeder command +====================== +.. http:post:: /api/control/printer/feeder + + Feeder commands allow extrusion/extraction of filament. Available commands are: + + extrude + Extrudes the given amount of filament. Additional parameters: + + * ``amount``: The amount of filament to extrude in mm. May be negative to retract. + + **Example Extrude Request** + + Extrudes 1mm of filament + + .. sourcecode:: http + + POST /api/control/printer/feeder HTTP/1.1 + Host: example.com + Content-Type: application/json + X-Api-Key: abcdef... + + { + "command": "extrude", + "amount": 1 + } + + **Example Retract Request** + + Retracts 3mm of filament + + .. sourcecode:: http + + POST /api/control/printer/feeder HTTP/1.1 + Host: example.com + Content-Type: application/json + X-Api-Key: abcdef... + + { + "command": "extrude", + "amount": -3 + } + + :json string command: The command to issue, only ``extrude`` is supported right now. + :json number amount: ``extrude`` command: The amount of filament to extrude/retract in mm. + :statuscode 200: No error + :statuscode 400: If the value given for `amount` is not a valid number or the request is otherwise invalid. + :statuscode 403: If the printer is not operational or currently printing. \ No newline at end of file