Commit graph

92 commits

Author SHA1 Message Date
Gina Häußge
2e134ba8b0 Merge pull request #2162 from jcbelanger/patch-1
Update gettingstarted.rst
2017-10-20 20:02:01 +02:00
Joshua Belanger
76f4ffc0a1 Update gettingstarted.rst 2017-10-20 13:54:11 -04:00
Gina Häußge
e7b455f880 New hook octoprint.accesscontrol.keyvalidator
Allows plugins to provide their own API keys which then can be
validated/translated into a User instance via this hook.
2017-10-19 13:15:18 +02:00
Gina Häußge
bfe5bc179c New hook octoprint.comm.protocol.temperatures.received
Allows preprocessing/sanitizing temperatures as received from the
printer.

Workaround for printers that occasionally report garbage temperature
data, e.g. #2050
2017-08-22 11:32:47 +02:00
Daniele Forsi
edb4d0fe04 Fix warnings about duplicated names in rst files
Replacing a single underscore (which creates a named target) with a double
underscore creates an anonymous target.

Fixes:
/home/daniele/OctoPrint/docs/bundledplugins/cura.rst:4: WARNING: Duplicate explicit target name: "here".
/home/daniele/OctoPrint/docs/plugins/hooks.rst:370: WARNING: Invalid caption: /home/daniele/OctoPrint/docs/plugins/hooks.rst:4: (INFO/1) Duplicate explicit target name: "custom_action_command.py".
2017-07-30 23:18:08 +02:00
Gina Häußge
a6d3299b91 Add user manager factory hook 2017-07-20 20:03:05 +02:00
Gina Häußge
187c09e7da Centralized online connectivity check
See also #2011
2017-07-19 18:42:27 +02:00
Gina Häußge
ee2d644239 Remove support for multi command expansion in sending phase
We won't support this after all, it's too much of a headache with
regards to the sending queue. Pausing takes longer, cancelling takes
longer, resends get more complicated and so on.

Command expansion in the queuing phase needs to suffice.
2017-07-17 16:26:32 +02:00
Gina Häußge
f8d225a768 Support for parsing GCODE subcodes
Hook handlers will get any parsed subcode as optional keyword argument
"subcode".
2017-07-05 17:56:46 +02:00
Gina Häußge
5fc194accd Docs: Added sequence diagrams for web interface lifecycle
For now only startup and reconnect to server.
2017-06-30 18:28:49 +02:00
Gina Häußge
35c45df86c Allow multi line commands in sending phase
(cherry picked from commit 1018946)
2017-06-23 14:55:34 +02:00
Gina Häußge
39c87d19b7 Fixed a left-over typo. 2017-05-17 17:47:58 +02:00
Gina Häußge
d029abc8f3 Updated docs with an example of multi command expansion 2017-05-17 17:47:58 +02:00
Goswin von Brederlow
917c9e54ba Allow octoprint.comm.protocol.gcode.queuing hook to return a list of commands 2017-05-17 17:46:58 +02:00
Gina Häußge
f1254622c5 Docs: Link to Jinja 2.8.1 documentation mirror at jinja.octoprint.org
The official docs are only 2.9+, that doesn't help us as long as we are
stuck with 2.8.

Fixes #1900
2017-05-03 11:56:25 +02:00
Gina Häußge
251a1ea4b5 "a couple" => "a few"/"some"
Because apparently I was using it wrong, at least for some parts of the
world :)
2017-04-12 14:54:32 +02:00
Gina Häußge
9bcce4e56a docs: plugin tutorial requires 2017-04-12 13:00:56 +02:00
Parker K
c6623c8883 added missing period and space so works 2017-04-10 21:35:46 -04:00
Gina Häußge
f7eb12a3ee Docs for {Reload|Restart}NeedingPlugin 2016-10-14 14:15:33 +02:00
Gina Häußge
71c2789fe7 Docs: fixed duplicated "injected properties" section 2016-10-13 14:25:24 +02:00
Gina Häußge
9de78001dd Merge branch 'maintenance' into devel
# Conflicts:
#	CHANGELOG.md
#	docs/plugins/concepts.rst
#	src/octoprint/__init__.py
#	src/octoprint/server/__init__.py
#	src/octoprint/templates/javascripts.jinja2
#	src/octoprint/timelapse.py

Merge branch 'devel' into dev/wizard

# Conflicts:
#	octoprint_octobullet/__init__.py
#	octoprint_octobullet/templates/octobullet_settings.jinja2

Merge branch 'devel' into dev/wizard

# Conflicts:
#	octoprint_octobullet/__init__.py
#	octoprint_octobullet/templates/octobullet_settings.jinja2
2016-10-13 14:22:40 +02:00
Gina Häußge
1370c7a9cc Inject plugin_info object into plugin implementations as well 2016-10-13 12:03:05 +02:00
Gina Häußge
9845e3b4ea Restored accidentally removed file 2016-09-22 16:32:05 +02:00
Gina Häußge
8e8853c9c3 Lots of documentation updates + some related code fixes 2016-09-22 16:27:06 +02:00
Gina Häußge
0ac3881897 Use better name than "hook" for various plugin hook documentation 2016-09-20 10:29:53 +02:00
Gina Häußge
7b4b638a2b Merge branch 'fix/pluginDocs' into dev/bundledPluginsDocs 2016-09-19 17:15:20 +02:00
Gina Häußge
eb4be89d39 Renamed GcodeFileViewModel to FileViewModel
(Let's be realistic here)

Introduced new "additionalNames" property on viewmodel declaration
to allow for registering alternative lookup names for a view model.

The freshly renamed FileViewModel now resolves as both "filesViewModel"
 and "gcodeFilesViewModel", making the renaming backwards compatible

 Documented all that stuff (and some more)
2016-09-01 10:17:18 +02:00
Gina Häußge
4ff869c2fa Docs for settings overlay & improved hook docs 2016-08-19 15:40:43 +02:00
Gina Häußge
7908f5226f Merge pull request #1384 from docdawning/patch-2
Replaced broken link
2016-07-13 17:53:24 +02:00
Gina Häußge
b41c1d89f4 Docs for octoprint.printer.factory hook 2016-06-28 12:58:08 +02:00
James
87b85ce33a Replaced broken link
Replaced dead url: https://pythonhosted.org/setuptools/setuptools.html#dynamic-discovery-of-services-and-plugins
with what I think is a suitable alternative: http://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins
2016-06-22 00:19:38 -06:00
Gina Häußge
ee185230a4 Refactored plugin docs + improved docs on sortables 2016-03-24 16:42:41 +01:00
Gina Häußge
6d95a5849b Add docs for hook ordering 2016-03-24 09:38:52 +01:00
Gina Häußge
1d3dfffc67 Some documentation fixes 2016-03-23 10:40:36 +01:00
Gina Häußge
780794c466 Merge branch 'development' of https://github.com/bwgan/OctoPrint into pr/bwgan/development
Conflicts:
	src/octoprint/daemon.py
2016-01-29 09:04:58 +01:00
bwgan
f8c0df4e78 Typo and spelling fixes
Fixes various spelling issues and typos.
2016-01-28 18:59:38 +00:00
Gina Häußge
8ed3bcb094 Slight changes in CLI structure for performance reasons
Having the plugin commands on the first level of --help proved to be
a bad idea since it basically kills every chance of lazy loading the (expensive)
plugin context. Using a sub command for anything plugin related allows us
to only fire up the plugin context if a plugin command is expected, saving us
some precious seconds of operation in all other cases.

For conformity reasons the dev sub commands were now restructured
similarly.
2015-10-30 16:28:34 +01:00
Gina Häußge
c6f1088ccf <plugin identifier>:<command> => plugin:<plugin identifier> command 2015-10-30 10:14:21 +01:00
Gina Häußge
ec491c3d0d devel:newplugin => dev:plugin new, +dev:plugin install, +dev:plugin uninstall 2015-10-30 10:10:47 +01:00
Gina Häußge
3c2d2b579d Documention for CLI and its development 2015-10-29 17:37:05 +01:00
Gina Häußge
aeb4c21657 Started documenting octoprint.cli.commands hook 2015-10-27 12:18:01 +01:00
Gina Häußge
f0ab517857 Merge branch 'dev/uiPlugin' into devel 2015-09-10 16:25:34 +02:00
Gina Häußge
19c8b8e905 Documented UiPlugin type and enhanced existing docs 2015-09-10 15:43:30 +02:00
Nicanor Romero Venier
74b0056095 Added info to the hook's docs 2015-09-07 10:52:03 +02:00
Nicanor Romero Venier
fa95507177 Included an early return if ret is None
Also corrected typos, received instead of recieved.
2015-09-07 10:04:06 +02:00
Nicanor Romero Venier
ced18c86e0 Added docs for the gcode.recieved hook 2015-09-03 18:43:07 +02:00
Gina Häußge
08c14e2e45 Wizard templates can now indicate they are mandatory
This will only style them in a special way and influence sorting. Plugins still need
to ensure that a step is not skipped through the use of the onWizardTabChange callback
in the view model.
2015-08-21 18:24:25 +02:00
Gina Häußge
6691cc00a5 Documentation of the wizard plugins & slight refactoring 2015-08-20 12:50:45 +02:00
Gina Häußge
c5b355705a Inject user manager into plugins 2015-08-18 13:30:23 +02:00
Gina Häußge
3995a65f6c WIP: Moving bundled plugin docs to official docs
The wiki is not a prominent enough location for these kind of
things apparently.
2015-07-14 21:26:07 +02:00