init

Author: CyberSensei1

.editorconfig

@@ -0,0 +1,18 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[**.py]
+indent_style = space
+indent_size = 4
+
+[**.js]
+indent_style = space
+indent_size = 4

.gitignore

@@ -0,0 +1,9 @@
+*.pyc
+*.swp
+.idea
+*.iml
+build
+dist
+*.egg*
+.DS_Store
+*.zip

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+recursive-include octoprint_esp32camUI/templates *
+recursive-include octoprint_esp32camUI/translations *
+recursive-include octoprint_esp32camUI/static *

README.md

@@ -0,0 +1,17 @@
+# OctoPrint-Esp32CamUI
+
+**TODO:** Describe what your plugin does.
+
+## Setup
+
+Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)
+or manually using this URL:
+
+    https://github.com/CyberSensei1/OctoPrint-Esp32CamUI/archive/master.zip
+
+**TODO:** Describe how to install your plugin, if more needs to be done than just installing it via pip or through
+the plugin manager.
+
+## Configuration
+
+**TODO:** Describe your plugin's configuration options (if any).

babel.cfg

@@ -0,0 +1,8 @@
+[python: */**.py]
+
+[jinja2: */**.jinja2]
+silent=false
+extensions=jinja2.ext.do, octoprint.util.jinja.trycatch
+
+[javascript: */**.js]
+extract_messages = gettext, ngettext

extras/README.txt

@@ -0,0 +1,16 @@
+Currently Cookiecutter generates the following helpful extras to this folder:
+
+esp32camUI.md
+    Data file for plugins.octoprint.org. Fill in the missing TODOs once your
+    plugin is ready for release and file a PR as described at
+    https://plugins.octoprint.org/help/registering/ to get it published.
+
+github/bug_report.yml
+    A GitHub issue form for bug reports. Adjust as desired & place in your
+    repository as `.github/bug_report.yml` to activate.
+
+github/feature_request.yml
+    A GitHub issue form for feature requests. Adjust as desired and place in
+    your repository as `.github/feature_request.yml` to activate.
+
+This folder may be safely removed if you don't need it.

extras/esp32camUI.md

@@ -0,0 +1,101 @@
+---
+layout: plugin
+
+id: esp32camUI
+title: OctoPrint-Esp32CamUI
+description: TODO
+authors:
+- CyberSensei
+license: AGPLv3
+
+# TODO
+date: today's date in format YYYY-MM-DD, e.g. 2015-04-21
+
+homepage: https://github.com/CyberSensei1/OctoPrint-Esp32CamUI
+source: https://github.com/CyberSensei1/OctoPrint-Esp32CamUI
+archive: https://github.com/CyberSensei1/OctoPrint-Esp32CamUI/archive/master.zip
+
+# TODO
+# Set this to true if your plugin uses the dependency_links setup parameter to include
+# library versions not yet published on PyPi. SHOULD ONLY BE USED IF THERE IS NO OTHER OPTION!
+#follow_dependency_links: false
+
+# TODO
+tags:
+- a list
+- of tags
+- that apply
+- to your plugin
+- (take a look at the existing plugins for what makes sense here)
+
+# TODO
+# When registering a plugin on plugins.octoprint.org, all screenshots should be uploaded not linked from external sites.
+screenshots:
+- url: url of a screenshot, /assets/img/...
+  alt: alt-text of a screenshot
+  caption: caption of a screenshot
+- url: url of another screenshot, /assets/img/...
+  alt: alt-text of another screenshot
+  caption: caption of another screenshot
+- ...
+
+# TODO
+featuredimage: url of a featured image for your plugin, /assets/img/...
+
+# TODO
+# You only need the following if your plugin requires specific OctoPrint versions or
+# specific operating systems to function - you can safely remove the whole
+# "compatibility" block if this is not the case.
+
+compatibility:
+
+  # List of compatible versions
+  #
+  # A single version number will be interpretated as a minimum version requirement,
+  # e.g. "1.3.1" will show the plugin as compatible to OctoPrint versions 1.3.1 and up.
+  # More sophisticated version requirements can be modelled too by using PEP440
+  # compatible version specifiers.
+  #
+  # You can also remove the whole "octoprint" block. Removing it will default to all
+  # OctoPrint versions being supported.
+
+  octoprint:
+  - 1.4.0
+
+  # List of compatible operating systems
+  #
+  # Valid values:
+  #
+  # - windows
+  # - linux
+  # - macos
+  # - freebsd
+  #
+  # There are also two OS groups defined that get expanded on usage:
+  #
+  # - posix: linux, macos and freebsd
+  # - nix: linux and freebsd
+  #
+  # You can also remove the whole "os" block. Removing it will default to all
+  # operating systems being supported.
+
+  os:
+  - linux
+  - windows
+  - macos
+  - freebsd
+
+  # Compatible Python version
+  #
+  # It is recommended to only support Python 3 for new plugins, in which case this should be ">=3,<4"
+  # 
+  # Plugins that wish to support both Python 2 and 3 should set it to ">=2.7,<4".
+  #
+  # Plugins that only support Python 2 will not be accepted into the plugin repository.
+
+  python: ">=3,<4"
+
+---
+
+**TODO**: Longer description of your plugin, configuration examples etc. This part will be visible on the page at
+http://plugins.octoprint.org/plugin/esp32camUI/

extras/github/bug_report.yml

@@ -0,0 +1,96 @@
+name: 🐛 Report a bug
+description: Create a bug report to help improve OctoPrint-Esp32CamUI
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        **Thank you for wanting to report a bug in OctoPrint-Esp32CamUI!**
+
+          * First, be sure you are running the [latest version of the OctoPrint-Esp32CamUI plugin](https://github.com/CyberSensei1/OctoPrint-Esp32CamUI/releases).
+          * You will also need to [enable debugging on the plugin](https://docs.octoprint.org/en/master/configuration/logging_yaml.html).
+            * This may be done through the *Settings* > *OctoPrint* > *Logging* > *Logging Levels* section.
+            * Select the "octoprint.plugins.esp32camUI" name, and make sure Level is "DEBUG".
+            * Save, then restart OctoPrint, which allows the developers to see debug information from the moment the plugin is loaded.
+          * Finally, when submitting a bug report, you **must** [include a Systeminfo Bundle](https://community.octoprint.org/t/what-is-a-systeminfo-bundle-and-how-can-i-obtain-one/29887), generated after the point the bug occurs. This allows the developers to examine the debug logs produced from your plugin installation.
+
+        Thank you for your help!
+  - type: textarea
+    attributes:
+      label: The problem
+      description: >-
+        Describe the issue you are experiencing here. Tell us what you were trying to do
+        step by step, and what happened that you did not expect.
+
+        Provide a clear and concise description of what the problem is and include as many
+        details as possible.
+      placeholder: |
+        1. ...
+        2. ...
+        3. ...
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+  - type: input
+    attributes:
+      label: Version of OctoPrint-Esp32CamUI
+      description: Can be found in *Settings* > *Plugin Manager*, next to "OctoPrint-Esp32CamUI".
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Version of OctoPrint
+      description: Can be found in the lower left corner of the web interface.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating system running OctoPrint
+      description: >-
+        OctoPi, Linux, Windows, MacOS, something else? With version please? OctoPi's
+        version can be found in `/etc/octopi_version` or in the lower left corner of the
+        web interface.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Printer model & used firmware incl. version
+      description: If applicable, always include if unsure
+  - type: input
+    attributes:
+      label: Browser and version of browser, operating system running browser
+      description: If applicable, always include if unsure
+  - type: markdown
+    attributes:
+      value: |
+        ## Logs and other files needed for analysis
+  - type: markdown
+    attributes:
+      value: >-
+        Please also be sure to upload the following files below:
+
+          * Systeminfo Bundle: See [here](https://community.octoprint.org/t/what-is-a-systeminfo-bundle-and-how-can-i-obtain-one/29887) if you don't know where to find that. Just attach down below as-is. Note that you'll need at least OctoPrint 1.6.0 for this to be available - we no longer accept bug reports created for older versions than this.
+            * If you are reporting an issue that involves communicating with you printer, **be sure to enable `serial.log` before reproducing and creating the Systeminfo Bundle**!
+          * Your browser's JavaScript console, if you are reporting a problem with the
+            user interface. See [here](https://webmasters.stackexchange.com/questions/8525/how-to-open-the-javascript-console-in-different-browsers) on where to find that.
+          * If possible, screenshots or videos showing the problem, especially if you
+            are reporting a problem with the user interface!
+          * GCODE files with which to reproduce, if you are reporting an issue with
+            GCODE file analysis or printing behaviour.
+
+        Please be aware that unless at least Systeminfo Bundle is included, your bug report
+        will not be processed and closed after a while.
+  - type: checkboxes
+    attributes:
+      label: Checklist of files to include below
+      options:
+        - label: Systeminfo Bundle (always include!)
+          required: true
+        - label: Contents of the JavaScript browser console (always include in cases of issues with the user interface)
+        - label: Screenshots and/or videos showing the problem (always include in case of issues with the user interface)
+        - label: GCODE file with which to reproduce (always include in case of issues with GCODE analysis or printing behaviour)
+  - type: textarea
+    attributes:
+      label: Additional information & file uploads

extras/github/feature_request.yml

@@ -0,0 +1,26 @@
+name: ✨ Request a feature
+description: Request a new feature to implement in OctoPrint-Esp32CamUI
+title: "[Request]"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        **Thank you for wanting to request a feature in OctoPrint-Esp32CamUI!**
+  - type: textarea
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Eg, "I'm always frustrated when [...]".
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

octoprint_esp32camUI/__init__.py

@@ -0,0 +1,85 @@
+# coding=utf-8
+from __future__ import absolute_import
+
+### (Don't forget to remove me)
+# This is a basic skeleton for your plugin's __init__.py. You probably want to adjust the class name of your plugin
+# as well as the plugin mixins it's subclassing from. This is really just a basic skeleton to get you started,
+# defining your plugin as a template plugin, settings and asset plugin. Feel free to add or remove mixins
+# as necessary.
+#
+# Take a look at the documentation on what other plugin mixins are available.
+
+import octoprint.plugin
+
+class Esp32camuiPlugin(octoprint.plugin.SettingsPlugin,
+    octoprint.plugin.AssetPlugin,
+    octoprint.plugin.TemplatePlugin
+):
+
+    ##~~ SettingsPlugin mixin
+
+    def get_settings_defaults(self):
+        return {
+            # put your plugin's default settings here
+            "url":"http://192.168.1.10"
+        }
+
+    ##~~ AssetPlugin mixin
+
+    def get_assets(self):
+        # Define your plugin's asset files to automatically include in the
+        # core UI here.
+        return {
+            "js": ["js/esp32camUI.js"],
+            "css": ["css/esp32camUI.css"],
+            "less": ["less/esp32camUI.less"]
+        }
+
+    ##~~ Softwareupdate hook
+
+    def get_update_information(self):
+        # Define the configuration for your plugin to use with the Software Update
+        # Plugin here. See https://docs.octoprint.org/en/master/bundledplugins/softwareupdate.html
+        # for details.
+        return {
+            "esp32camUI": {
+                "displayName": "Esp32CamUI Plugin",
+                "displayVersion": self._plugin_version,
+
+                # version check: github repository
+                "type": "github_release",
+                "user": "CyberSensei1",
+                "repo": "OctoPrint-Esp32CamUI",
+                "current": self._plugin_version,
+
+                # update method: pip
+                "pip": "https://github.com/CyberSensei1/OctoPrint-Esp32CamUI/archive/{target_version}.zip",
+            }
+        }
+    def get_template_vars(self):
+        return dict(url=self._settings.get(["url"]))
+        
+    def get_template_configs(self):
+        return [
+            dict(type="settings", custom_bindings=False),
+            dict(type="tab", custom_bindings=False)
+        ]
+# If you want your plugin to be registered within OctoPrint under a different name than what you defined in setup.py
+# ("OctoPrint-PluginSkeleton"), you may define that here. Same goes for the other metadata derived from setup.py that
+# can be overwritten via __plugin_xyz__ control properties. See the documentation for that.
+__plugin_name__ = "Esp32CamUI Plugin"
+
+
+# Set the Python version your plugin is compatible with below. Recommended is Python 3 only for all new plugins.
+# OctoPrint 1.4.0 - 1.7.x run under both Python 3 and the end-of-life Python 2.
+# OctoPrint 1.8.0 onwards only supports Python 3.
+__plugin_pythoncompat__ = ">=3,<4"  # Only Python 3
+
+def __plugin_load__():
+    global __plugin_implementation__
+    __plugin_implementation__ = Esp32camuiPlugin()
+
+    global __plugin_hooks__
+    __plugin_hooks__ = {
+        "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information
+    }