pingu_98/MrDraw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs with an example of multi command expansion

Browse source
This commit is contained in:
Gina Häußge 2016-01-05 17:59:50 +01:00 committed by Gina Häußge
parent 7b5848b9c3
commit d029abc8f3
2 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/plugins/hooks.rst
View file

@ -396,12 +396,13 @@ This describes actually four hooks:
* ``queuing``: This phase is triggered just before the command is added to the send queue of the communication layer. This
corresponds to the moment a command is being read from a file that is currently being printed. Handlers
may suppress or change commands or their command type here.
may suppress or change commands or their command type here. This is the only phase that supports multi command
expansion by having the handler return a list, see below for details.
* ``queued``: This phase is triggered just after the command was added to the send queue of the communication layer.
No manipulation is possible here anymore (returned values will be ignored).
* ``sending``: This phase is triggered just before the command is actually being sent to the printer. Right afterwards
a line number will be assigned and the command will be sent. Handlers may suppress or change commands here. The
command type is not taken into account anymore.
command type is not taken into account anymore. Multi
* ``sent``: This phase is triggered just after the command was handed over to the serial connection to the printer.
No manipulation is possible here anymore (returned values will be ignored). A command that reaches the sent phase
must not necessarily have reached the printer yet and it might also still run into communication problems and a
@ -450,12 +451,21 @@ This describes actually four hooks:
should use this option.
* A 2-tuple consisting of a rewritten version of the ``cmd`` and the ``cmd_type``, e.g. ``return "M105", "temperature_poll"``.
Handlers which wish to rewrite both the command and the command type should use this option.
* Queuing only: A list of strings replacing the command with a series of commands of the same ``cmd_type``.
* Queuing only: A list of 2-tuple replacing the command with a series of commands with new ``cmd_type``. This allows
replacing a command with a series of commands of different type.
* **``queuing`` phase only**: A list of any of the above to allow for expanding one command into
many. The following example shows how any queued command could be turned into a sequence of a temperature query,
line number reset, display of the ``gcode`` on the printer's display and finally the actual command (this example
does not make a lot of sense to be quiet honest):
.. code-block:: python
def multi_expansion(*args, **kwargs):
return [("M105", "temperature_poll"),
("M110",),
"M117 GCODE: {}".format(gcode),
(command, command_type)]
Note: Only one command of a given ``cmd_type`` (other than None) may be queued at a time. Trying to rewrite the ``cmd_type``
to one already in the queue will give an error.
to one already in the queue will give an error.
**Example**

2
src/octoprint/util/comm.py
View file

@ -2207,7 +2207,7 @@ class MachineCom(object):
normalized = _normalize_command_handler_result(command, command_type, gcode, hook_results)
# make sure we don't allow multi entry results in sending and sent phase
if phase in ("sending", "sent") and len(normalized) > 1:
if not phase in ("queuing",) and len(normalized) > 1:
self._logger.error("Error while processing hook {name} for phase {phase} and command {command}: Hook returned multi-entry result for phase {phase} and command {command}. That's not supported, if you need to do multi expansion of commands you need to do this in the queuing phase. Ignoring hook result and sending command as-is.".format(**locals()))
new_results.append((command, command_type, gcode))
else: