search

Salandora / octoprint-customControl

This plugin makes Custom Controls editable through the OctoPrint WebUI
GNU Affero General Public License v3.0
26 stars 15 forks source link

Idea: canned recipe import/export support ? #9

Open fiveangle opened 7 years ago

fiveangle commented 7 years ago

Awesome plug-in thanks !

I was recently introduced to the versatility of Custom Controls and your plugin and using it I was able to rapidly prototype an entire UI for managing Marlin Mesh Bed Leveling in probably 30 minutes:

mbl_cust_controls mbl_cust_controls.yaml.txt

but it's quite difficult to explain to others how to implement the same on their OP instances, which gave me an idea...

Have you considered implementing a recipe feature where users could create a container and once complete, could hit an "Export" function to download the recipe through the browser, and submit to a repository here on your github page ? In the above picture, if the top level "Mesh Bed Leveling" section were turned-down, to the far right of the container name, you could have a small "Export" button. And in your plug-in you could have a single corresponding "Import" button somewhere so users could import recipes.

You could perhaps even implement a in-plug-in mechanism where users could automatically download/install recipes that have been submitted to your github repo.

I'm not sure how feasible that part is, but I do know that even without the automatic repo idea, the ability to easily export/import through the UI without having to dig into the config.yaml would be a huge win and open up your plugin to many more users who are less technically inclined.

Thanks for considering, and for making such a great and versatile plugin !

-=dave

Salandora commented 7 years ago

Nice Idea, I don't think I will make a repo for that, it would take too much time which I actually don't have.

But the Import/Export Idea is great, I think it would be best to add the buttons to the settings page. both could be part of the context menu. The exported data should be in yaml format, so it could theoretically also be paste into the yaml patcher with a bit of surroundgins. (I wouldn't start from config root, but from the container, button, etc as root) Would you like to tackle this?

fiveangle commented 7 years ago

I come more from the scripting/project manager side, where I know enough about coding at least to know when my developers are lying to me ;) I honestly would have already done it if I knew where to start. If you were up to implement the rough blocky start of it I could do the tedious work to finalize the easier/tedious parts to make it work correctly, I would be game. But I'm just starting to cut my teeth on this stuff and I'm not sure how the GET, POST, or whatever is required to get the import/export to actually work would even go and it would probably take me a week of my spare time to figure out even just that part (which I don't really have atm).

But I guess isn't that always the case - so many great ideas, so little time to figure out how to implement :)

Salandora commented 7 years ago

Well if I'm not mistaken it is a plain javascript part with 2-3 lines of HTML ^^

Basic beginning here is: add the Import, Export buttons to the context menu, they must open a file dialog (check the upload button, it is a bit of jquery behind that, I believe in the viewmodel/files.js).

Well I guess it would be easier to use a JSON Object instead of yaml.