diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e75ccaa --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +venv +.vscode diff --git a/API.md b/API.md new file mode 100644 index 0000000..dbee16d --- /dev/null +++ b/API.md @@ -0,0 +1,343 @@ +# API Reference v2.0 + +The API is located at \/plugin/enclosure. This needs to be added before each endpoint in order for the API to function properly. The API either returns a `application/json` body or an empty body for a successful request. + +A failed request will return an error code as well as a short error description. + +## List all inputs + +Endpoint: **GET** `/inputs` + +Response (200): + +``` +[ + { + "index_id": number, + "label": string + } +] +``` + +Error Responses: + - none + +## List a specific input + +Endpoint: **GET** `/inputs/` + +*Note: id needs to be int (index_id)* + +Response (200): +``` +{ + "controlled_io": null, + "filament_sensor_timeout": number, + "filament_sensor_enabled": boolean, + "temp_sensor_address": string, + "printer_action": string, + "controlled_io_set_value": string, + "temp_sensor_type": string, + "temp_sensor_navbar": boolean, + "temp_sensor_humidity": number, + "edge": string, + "ds18b20_serial": string, + "action_type": string, + "input_pull_resistor": string, + "input_type": string, + "temp_sensor_temp": number, + "label": string, + "index_id": number, + "use_fahrenheit": boolean, + "gpio_pin": string +} +``` + +Error Responses: + - 404 if specified id cannot be found + +## List all outputs + +Endpoint: **GET** `/outputs` + +Response (200): +``` +[ + { + "index_id": number, + "label": string + } +] +``` + +Error Responses: + - none + +## List a specific output + +Endpoint: **GET** `/outputs/` + +*Note: id needs to be int (index_id)* + + +Response (200): +``` +{ + "linked_temp_sensor": string, + "ledstrip_gpio_dat": string, + "startup_time": number, + "temp_ctr_deadband": number, + "neopixel_brightness": number, + "new_duty_cycle": string, + "gpio_pin": number, + "default_duty_cycle": number, + "neopixel_color": string, + "hide_btn_ui": boolean, + "temp_ctr_set_value": number, + "temp_ctr_default_value": number, + "default_neopixel_color": string, + "controlled_io_set_value": string, + "auto_shutdown": boolean, + "shell_script": string, + "label": string, + "default_ledstrip_color": string, + "duty_a": number, + "toggle_timer_off": number, + "alarm_set_temp": number, + "ledstrip_gpio_clk": string, + "auto_startup": boolean, + "controlled_io": number, + "shutdown_time": number, + "temp_ctr_type": string, + "gcode": string, + "current_value": boolean, + "shutdown_on_failed": boolean, + "temperature_b": number, + "ledstrip_color": string, + "temperature_a": number, + "neopixel_count": number, + "duty_cycle": number, + "toggle_timer_on": number, + "show_on_navbar": boolean, + "duty_b": number, + "toggle_timer": boolean, + "pwm_status": number, + "gpio_status": boolean, + "pwm_frequency": number, + "new_ledstrip_color": string, + "startup_with_server": boolean, + "active_low": boolean, + "temp_ctr_max_temp": number, + "pwm_temperature_linked": boolean, + "temp_ctr_new_set_value": string, + "output_type": string, + "microcontroller_address": number, + "index_id": number, + "new_neopixel_color": string +} +``` + +Error Responses: + - 404 if specified id cannot be found + +## Control specific output + +Endpoint: **PATCH** `/outputs/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "status": boolean +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Enable/Disable Output auto-startup + +Endpoint: **PATCH** `/outputs//auto-startup` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "status": boolean +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Control auto-shutdown for specific output + +Endpoint: **PATCH** `/outputs//auto-shutdown` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "status": boolean +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Control temperature + +Endpoint: **PATCH** `/temperature/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "temperature": number +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Control filament sensor + +Endpoint: **PATCH** `/filament/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "status": boolean +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Set PWM value + +Endpoint: **PATCH** `/pwm/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "duty_cycle": number +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Set RGB LED color + +Endpoint: **PATCH** `/rgb-led/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "rgb": string (rgb(r,g,b)) +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Set neopixel color + +Endpoint: **PATCH** `/neopixel/` + +*Note: id needs to be int (index_id)* + +Body (Content-Type: `application/json`): +``` +{ + "red": number, + "green": number, + "blue": number +} +``` + +Response (204): No-Content + +Error Responses: +- 400 - wrong Content-Type or malformed request +- 406 - missing information (missing attribute given in response body) + +## Clear GPIO Pins + +Endpoint: **POST** `/clear-gpio` + +Body: empty + +Response (204): No-Content + +Error Responses: +- none + +## Update UI + +Endpoint: **POST** `/update` + +Body: empty + +Response (204): No-Content + +Error Responses: +- none + +## Send shell command + +Endpoint: **POST** `/shell/` + +*Note: id needs to be int (index_id)* + +Body: empty + +Response (204): No-Content + +Error Responses: +- none + +## Send gcode command + +Endpoint: **POST** `/gcode/` + +*Note: id needs to be int (index_id)* + +Body: empty + +Response (204): No-Content + +Error Responses: +- none \ No newline at end of file diff --git a/README.md b/README.md index 3c6bb57..5e75eba 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Start by adding the following line to /boot/config.txt
dtoverlay=w1-gpio
After rebooting, you can check if the OneWire device was found properly with -
dmesg | grep w1-gpip
+
dmesg | grep w1-gpio
You should see something like
[    3.030368] w1-gpio onewire@0: gpio pin 4, external pullup pin -1, parasitic power 0
@@ -86,7 +86,7 @@ The response will either have YES or NO at the end of the first line. If it is y Copy the serial number, you will need to configure the plugin. Note that for the serial number includes the 28-, for example 28-0000069834ff. -* For the SI7021, BME280 and TMP102 sensors +* For the SI7021, BME280, TMP102 and MCP9808 sensors Enable I2C on your raspberry pi, depending on raspi-config version, step by step can be different: @@ -107,6 +107,27 @@ Find the address of the sensor:
i2cdetect -y 1
+* For Neopixel + +If your setup does not have pip install pip: +`sudo apt-get install python-pip` + +Install the required library: +`sudo pip install rpi_ws281x` + +rpi_ws281x really needs sudo, and you need to setup up so your rpi does not ask for a password when runing a python script, so run: + +`sudo visudo` + +and add `pi ALL=(ALL) NOPASSWD: ALL` to the end of the file. + +Also backlist the audio kernel: + +`sudo nano /etc/modprobe.d/snd-blacklist.conf` + +add the `blacklist snd_bcm2835` to the end of the file: + + * GPIO This release uses RPi.GPIO to control IO of raspberry pi, it should install and work automatically. If it doesn't please update your octoprint with the latest release of octopi. @@ -201,4 +222,4 @@ You just need to add the following section: - gcodeviewer - terminal - plugin_enclosure - \ No newline at end of file + diff --git a/octoprint_enclosure/__init__.py b/octoprint_enclosure/__init__.py index 0650294..e128788 100644 --- a/octoprint_enclosure/__init__.py +++ b/octoprint_enclosure/__init__.py @@ -3,9 +3,12 @@ from __future__ import absolute_import from octoprint.events import eventManager, Events from octoprint.util import RepeatedTimer from subprocess import Popen, PIPE +from .ledstrip import LEDStrip import octoprint.plugin import RPi.GPIO as GPIO -import flask +from flask import jsonify, request, make_response, Response +from octoprint.server.util.flask import restricted_access +from werkzeug.exceptions import BadRequest import time import sys import glob @@ -17,20 +20,18 @@ import requests import inspect import threading import json +import copy -class EnclosurePlugin(octoprint.plugin.StartupPlugin, - octoprint.plugin.TemplatePlugin, - octoprint.plugin.SettingsPlugin, - octoprint.plugin.AssetPlugin, - octoprint.plugin.BlueprintPlugin, +class EnclosurePlugin(octoprint.plugin.StartupPlugin, octoprint.plugin.TemplatePlugin, octoprint.plugin.SettingsPlugin, + octoprint.plugin.AssetPlugin, octoprint.plugin.BlueprintPlugin, octoprint.plugin.EventHandlerPlugin): rpi_outputs = [] rpi_inputs = [] waiting_temperature = [] rpi_outputs_not_changed = [] notifications = [] - pwm_intances = [] + pwm_instances = [] event_queue = [] temp_hum_control_status = [] temperature_sensor_data = [] @@ -45,8 +46,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, Function to start timer that checks enclosure temperature """ - self._check_temp_timer = RepeatedTimer( - 10, self.check_enclosure_temp, None, None, True) + self._check_temp_timer = RepeatedTimer(10, self.check_enclosure_temp, None, None, True) self._check_temp_timer.start() @staticmethod @@ -84,8 +84,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, @staticmethod def create_date(value): - temp_string = datetime.now().strftime( - '%m/%d/%Y') + " " + value + temp_string = datetime.now().strftime('%m/%d/%Y') + " " + value return datetime.strptime(temp_string, '%m/%d/%Y %H:%M') @staticmethod @@ -106,7 +105,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, # ~~ StartupPlugin mixin def on_after_startup(self): - self.pwm_intances = [] + self.pwm_instances = [] self.event_queue = [] self.rpi_outputs_not_changed = [] self.rpi_outputs = self._settings.get(["rpi_outputs"]) @@ -125,24 +124,19 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, return 6 def on_settings_migrate(self, target, current=None): - self._logger.warn( - "######### current settings version %s target settings version %s #########", current, target) - + self._logger.warn("######### current settings version %s target settings version %s #########", current, target) + self._logger.info("######### Current settings #########") + self._logger.info("rpi_outputs: %s", self.rpi_outputs) + self._logger.info("rpi_inputs: %s", self.rpi_inputs) + self._logger.info("######### End Current Settings #########") if current >= 4 and target == 6: - self._logger.warn( - "######### migrating settings to v6 #########") + self._logger.warn("######### migrating settings to v6 #########") old_outputs = self._settings.get(["rpi_outputs"]) for rpi_output in old_outputs: if 'shutdown_on_failed' not in rpi_output: rpi_output['shutdown_on_failed'] = False if 'shell_script' not in rpi_output: rpi_output['shell_script'] = "" - if current == 4 and target == 5: - self._logger.warn( - "######### migrating settings from v4 to v5 #########") - old_outputs = self._settings.get(["rpi_outputs"]) - for rpi_output in old_outputs: - rpi_output['shutdown_on_failed'] = False self._settings.set(["rpi_outputs"], old_outputs) else: self._logger.warn("######### settings not compatible #########") @@ -150,135 +144,410 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, self._settings.set(["rpi_inputs"], []) self.rpi_inputs = self._settings.get(["rpi_inputs"]) + # ~~ Blueprintplugin mixin + @octoprint.plugin.BlueprintPlugin.route("/inputs", methods=["GET"]) + def get_inputs(self): + inputs = [] + for rpi_input in self.rpi_inputs: + index = self.to_int(rpi_input['index_id']) + label = rpi_input['label'] + inputs.append(dict(index_id=index, label=label)) + return Response(json.dumps(inputs), mimetype='application/json') + + + @octoprint.plugin.BlueprintPlugin.route("/inputs/", methods=["GET"]) + def get_input_status(self, identifier): + for rpi_input in self.rpi_inputs: + if identifier == self.to_int(rpi_input['index_id']): + return Response(json.dumps(rpi_input), mimetype='application/json') + return make_response('', 404) + + + @octoprint.plugin.BlueprintPlugin.route("/temperature/", methods=["PATCH"]) + @restricted_access + def set_enclosure_temp_humidity(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'temperature' not in data: + return make_response("missing temperature attribute", 406) + + set_value = data["temperature"] + + for temp_hum_control in [item for item in self.rpi_outputs if item['index_id'] == identifier]: + temp_hum_control['temp_ctr_set_value'] = set_value + + self.handle_temp_hum_control() + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/filament/", methods=["PATCH"]) + @restricted_access + def set_filament_sensor(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'status' not in data: + return make_response("missing status attribute", 406) + + value = data["status"] + + for sensor in self.rpi_inputs: + if identifier == self.to_int(sensor['index_id']): + sensor['filament_sensor_enabled'] = value + self._logger.info("Setting filament sensor for input %s to : %s", str(identifier), value) + self._settings.set(["rpi_inputs"], self.rpi_inputs) + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/outputs", methods=["GET"]) + def get_outputs(self): + outputs = [] + for rpi_output in self.rpi_outputs: + if rpi_output['output_type'] == 'regular': + index = self.to_int(rpi_output['index_id']) + label = rpi_output['label'] + outputs.append(dict(index_id=index, label=label)) + return Response(json.dumps(outputs), mimetype='application/json') + + + @octoprint.plugin.BlueprintPlugin.route("/outputs/", methods=["GET"]) + def get_output_status(self, identifier): + for rpi_output in self.rpi_outputs: + if identifier == self.to_int(rpi_output['index_id']): + out = copy.deepcopy(rpi_output) + pin = self.to_int(rpi_output['gpio_pin']) + out['current_value'] = GPIO.input(pin) if not rpi_output['active_low'] else (not GPIO.input(pin)) + return Response(json.dumps(out), mimetype='application/json') + return make_response('', 404) + + + @octoprint.plugin.BlueprintPlugin.route("/outputs/", methods=["PATCH"]) + @restricted_access + def set_io(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'status' not in data: + return make_response("missing status attribute", 406) + + value = data["status"] + + for rpi_output in self.rpi_outputs: + if identifier == self.to_int(rpi_output['index_id']): + val = (not value) if rpi_output['active_low'] else value + self.write_gpio(self.to_int(rpi_output['gpio_pin']), val) + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/outputs//auto-startup", methods=["PATCH"]) + @restricted_access + def set_auto_startup(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'status' not in data: + return make_response("missing status attribute", 406) + + value = data["status"] + + if not value: + suffix = 'auto_startup' + queue_id = '{0!s}_{1!s}'.format(str(identifier), suffix) + self.stop_queue_item(queue_id) + for output in self.rpi_outputs: + if identifier == self.to_int(output['index_id']): + output['auto_startup'] = value + self._logger.info("Setting auto startup for output %s to : %s", str(identifier), value) + self._settings.set(["rpi_outputs"], self.rpi_outputs) + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/outputs//auto-shutdown", methods=["PATCH"]) + @restricted_access + def set_auto_shutdown(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'status' not in data: + return make_response("missing status attribute", 406) + + value = data["status"] + + if not value: + suffix = 'auto_shutdown' + queue_id = '{0!s}_{1!s}'.format(str(identifier), suffix) + self.stop_queue_item(queue_id) + + for output in self.rpi_outputs: + if identifier == self.to_int(output['index_id']): + output['auto_shutdown'] = value + self._logger.info("Setting auto shutdown for output %s to : %s", str(identifier), value) + self._settings.set(["rpi_outputs"], self.rpi_outputs) + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/pwm/", methods=["PATCH"]) + @restricted_access + def set_pwm(self, identifier): + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'duty_cycle' not in data: + return make_response("missing duty_cycle attribute", 406) + + set_value = self.to_int(data['duty_cycle']) + for rpi_output in [item for item in self.rpi_outputs if item['index_id'] == identifier]: + rpi_output['duty_cycle'] = set_value + rpi_output['new_duty_cycle'] = "" + gpio = self.to_int(rpi_output['gpio_pin']) + self.write_pwm(gpio, set_value) + return make_response('', 204) + + @octoprint.plugin.BlueprintPlugin.route("/rgb-led/", methods=["PATCH"]) + @restricted_access + def set_ledstrip_color(self, identifier): + """ set_ledstrip_color method get request from octoprint and send the command to Open-Smart RGB LED Strip""" + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'rgb' not in data: + return make_response("missing rgb attribute", 406) + rgb = data['rgb'] + + for rpi_output in self.rpi_outputs: + if identifier == self.to_int(rpi_output['index_id']): + self.ledstrip_set_rgb(rpi_output, rgb) + + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/neopixel/", methods=["PATCH"]) + @restricted_access + def set_neopixel(self, identifier): + """ set_neopixel method get request from octoprint and send the command to arduino or neopixel""" + if "application/json" not in request.headers["Content-Type"]: + return make_response("expected json", 400) + try: + data = request.json + except BadRequest: + return make_response("malformed request", 400) + + if 'red' not in data: + return make_response("missing red attribute", 406) + if 'green' not in data: + return make_response("missing green attribute", 406) + if 'blue' not in data: + return make_response("missing blue attribute", 406) + + red = data['red'] + green = data['green'] + blue = data['blue'] + + for rpi_output in self.rpi_outputs: + if identifier == self.to_int(rpi_output['index_id']): + led_count = rpi_output['neopixel_count'] + led_brightness = rpi_output['neopixel_brightness'] + address = rpi_output['microcontroller_address'] + + neopixel_dirrect = rpi_output['output_type'] == 'neopixel_direct' + + self.send_neopixel_command(self.to_int(rpi_output['gpio_pin']), led_count, led_brightness, red, green, + blue, address, neopixel_dirrect, identifier) + + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/clear-gpio", methods=["POST"]) + @restricted_access + def clear_gpio_mode(self): + GPIO.cleanup() + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/update", methods=["POST"]) + @restricted_access + def update_ui_requested(self): + self.update_ui() + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/shell/", methods=["POST"]) + @restricted_access + def send_shell_command(self, identifier): + rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int(r_out['index_id']) == identifier].pop() + + command = rpi_output['shell_script'] + self.shell_command(command) + return make_response('', 204) + + + @octoprint.plugin.BlueprintPlugin.route("/gcode/", methods=["POST"]) + @restricted_access + def requested_gcode_command(self, identifier): + rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int(r_out['index_id']) == identifier].pop() + self.send_gcode_command(rpi_output['gcode']) + return make_response('', 204) + + + + + + """ + DEPRECATION + This API will be deprecated in a future version + """ + # ~~ Blueprintplugin mixin @octoprint.plugin.BlueprintPlugin.route("/setEnclosureTempHum", methods=["GET"]) - def set_enclosure_temp_humidity(self): - set_value = self.to_float( - flask.request.values["set_temperature"]) - index_id = self.to_int(flask.request.values["index_id"]) + def set_enclosure_temp_humidity_old(self): + set_value = self.to_float(request.values["set_temperature"]) + index_id = self.to_int(request.values["index_id"]) for temp_hum_control in [item for item in self.rpi_outputs if item['index_id'] == index_id]: temp_hum_control['temp_ctr_set_value'] = set_value self.handle_temp_hum_control() - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/clearGPIOMode", methods=["GET"]) - def clear_gpio_mode(self): + def clear_gpio_mode_old(self): GPIO.cleanup() - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/updateUI", methods=["GET"]) - def update_ui_requested(self): + def update_ui_requested_old(self): self.update_ui() - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/getOutputStatus", methods=["GET"]) - def get_output_status(self): + def get_output_status_old(self): gpio_status = [] for rpi_output in self.rpi_outputs: if rpi_output['output_type'] == 'regular': pin = self.to_int(rpi_output['gpio_pin']) - val = GPIO.input(pin) if not rpi_output['active_low'] else ( - not GPIO.input(pin)) + val = GPIO.input(pin) if not rpi_output['active_low'] else (not GPIO.input(pin)) index = self.to_int(rpi_output['index_id']) gpio_status.append(dict(index_id=index, status=val)) - return flask.Response(json.dumps(gpio_status), mimetype='application/json') + return Response(json.dumps(gpio_status), mimetype='application/json') @octoprint.plugin.BlueprintPlugin.route("/setIO", methods=["GET"]) - def set_io(self): - index = flask.request.values["index_id"] - value = True if flask.request.values["status"] == 'true' else False + def set_io_old(self): + index = request.values["index_id"] + value = True if request.values["status"] == 'true' else False for rpi_output in self.rpi_outputs: if self.to_int(index) == self.to_int(rpi_output['index_id']): val = (not value) if rpi_output['active_low'] else value self.write_gpio(self.to_int(rpi_output['gpio_pin']), val) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/sendShellCommand", methods=["GET"]) - def send_shell_command(self): - output_index = self.to_int(flask.request.values["index_id"]) + def send_shell_command_old(self): + output_index = self.to_int(request.values["index_id"]) - rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int( - r_out['index_id']) == output_index].pop() + rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int(r_out['index_id']) == output_index].pop() command = rpi_output['shell_script'] self.shell_command(command) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/setAutoStartUp", methods=["GET"]) - def set_auto_startup(self): - index = flask.request.values["index_id"] - value = True if flask.request.values["status"] == 'true' else False + def set_auto_startup_old(self): + index = request.values["index_id"] + value = True if request.values["status"] == 'true' else False if not value: - sufix = 'auto_startup' - queue_id = '{0!s}_{1!s}'.format(index, sufix) + suffix = 'auto_startup' + queue_id = '{0!s}_{1!s}'.format(index, suffix) self.stop_queue_item(queue_id) for output in self.rpi_outputs: if self.to_int(index) == self.to_int(output['index_id']): output['auto_startup'] = value - self._logger.info( - "Setting auto startup for output %s to : %s", index, value) + self._logger.info("Setting auto startup for output %s to : %s", index, value) self._settings.set(["rpi_outputs"], self.rpi_outputs) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/setAutoShutdown", methods=["GET"]) - def set_auto_shutdown(self): - index = flask.request.values["index_id"] - value = True if flask.request.values["status"] == 'true' else False + def set_auto_shutdown_old(self): + index = request.values["index_id"] + value = True if request.values["status"] == 'true' else False if not value: - sufix = 'auto_shutdown' - queue_id = '{0!s}_{1!s}'.format(index, sufix) + suffix = 'auto_shutdown' + queue_id = '{0!s}_{1!s}'.format(index, suffix) self.stop_queue_item(queue_id) for output in self.rpi_outputs: if self.to_int(index) == self.to_int(output['index_id']): output['auto_shutdown'] = value - self._logger.info( - "Setting auto shutdown for output %s to : %s", index, value) + self._logger.info("Setting auto shutdown for output %s to : %s", index, value) self._settings.set(["rpi_outputs"], self.rpi_outputs) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/setFilamentSensor", methods=["GET"]) - def set_filament_sensor(self): - index = flask.request.values["index_id"] - value = True if flask.request.values["status"] == 'true' else False + def set_filament_sensor_old(self): + index = request.values["index_id"] + value = True if request.values["status"] == 'true' else False for sensor in self.rpi_inputs: if self.to_int(index) == self.to_int(sensor['index_id']): sensor['filament_sensor_enabled'] = value - self._logger.info( - "Setting filament sensor for input %s to : %s", index, value) + self._logger.info("Setting filament sensor for input %s to : %s", index, value) self._settings.set(["rpi_inputs"], self.rpi_inputs) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/setPWM", methods=["GET"]) - def set_pwm(self): - set_value = self.to_int(flask.request.values["new_duty_cycle"]) - index_id = self.to_int(flask.request.values["index_id"]) + def set_pwm_old(self): + set_value = self.to_int(request.values["new_duty_cycle"]) + index_id = self.to_int(request.values["index_id"]) for rpi_output in [item for item in self.rpi_outputs if item['index_id'] == index_id]: rpi_output['duty_cycle'] = set_value rpi_output['new_duty_cycle'] = "" gpio = self.to_int(rpi_output['gpio_pin']) self.write_pwm(gpio, set_value) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/sendGcodeCommand", methods=["GET"]) - def requested_gcode_command(self): - gpio_index = self.to_int(flask.request.values["index_id"]) - rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int( - r_out['index_id']) == gpio_index].pop() + def requested_gcode_command_old(self): + gpio_index = self.to_int(request.values["index_id"]) + rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int(r_out['index_id']) == gpio_index].pop() self.send_gcode_command(rpi_output['gcode']) - return flask.jsonify(success=True) + return jsonify(success=True) @octoprint.plugin.BlueprintPlugin.route("/setNeopixel", methods=["GET"]) - def set_neopixel(self): - """ set_neopixel method get request from octoprint and send the comand to arduino or neopixel""" - gpio_index = self.to_int(flask.request.values["index_id"]) - red = flask.request.values["red"] - green = flask.request.values["green"] - blue = flask.request.values["blue"] + def set_neopixel_old(self): + """ set_neopixel method get request from octoprint and send the command to arduino or neopixel""" + gpio_index = self.to_int(request.values["index_id"]) + red = request.values["red"] + green = request.values["green"] + blue = request.values["blue"] for rpi_output in self.rpi_outputs: if gpio_index == self.to_int(rpi_output['index_id']): led_count = rpi_output['neopixel_count'] @@ -287,14 +556,30 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, neopixel_dirrect = rpi_output['output_type'] == 'neopixel_direct' - self.send_neopixel_command( - self.to_int(rpi_output['gpio_pin']), - led_count, led_brightness, red, green, blue, address, neopixel_dirrect, gpio_index) + self.send_neopixel_command(self.to_int(rpi_output['gpio_pin']), led_count, led_brightness, red, green, + blue, address, neopixel_dirrect, gpio_index) - return flask.jsonify(success=True) + return jsonify(success=True) - def send_neopixel_command(self, led_pin, led_count, led_brightness, red, green, blue, address, - neopixel_dirrect, index_id, queue_id=None): + @octoprint.plugin.BlueprintPlugin.route("/setLedstripColor", methods=["GET"]) + def set_ledstrip_color_old(self): + """ set_ledstrip_color method get request from octoprint and send the command to Open-Smart RGB LED Strip""" + gpio_index = self.to_int(request.values["index_id"]) + rgb = request.values["rgb"] + for rpi_output in self.rpi_outputs: + if gpio_index == self.to_int(rpi_output['index_id']): + self.ledstrip_set_rgb(rpi_output, rgb) + + return jsonify(success=True) + + # DEPREACTION END + + + + + + def send_neopixel_command(self, led_pin, led_count, led_brightness, red, green, blue, address, neopixel_dirrect, + index_id, queue_id=None): """Send neopixel command Arguments: @@ -302,27 +587,24 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, ledCount {int} -- number of LEDS ledBrightness {int} -- brightness from 0 to 255 red {int} -- red value from 0 to 255 - green {int} -- gren value from 0 to 255 + green {int} -- green value from 0 to 255 blue {int} -- blue value from 0 to 255 - address {int} -- i2c address from microcontroler + address {int} -- i2c address from microcontroller """ try: for rpi_output in self.rpi_outputs: if self.to_int(index_id) == self.to_int(rpi_output['index_id']): - rpi_output['neopixel_color'] = 'rgb({0!s},{1!s},{2!s})'.format( - red, green, blue) + rpi_output['neopixel_color'] = 'rgb({0!s},{1!s},{2!s})'.format(red, green, blue) if address == '': address = 0 if neopixel_dirrect: - script = os.path.dirname( - os.path.realpath(__file__)) + "/neopixel_direct.py " + script = os.path.dirname(os.path.realpath(__file__)) + "/neopixel_direct.py " else: - script = os.path.dirname( - os.path.realpath(__file__)) + "/neopixel_indirect.py " + script = os.path.dirname(os.path.realpath(__file__)) + "/neopixel_indirect.py " if self._settings.get(["use_sudo"]): sudo_str = "sudo " @@ -338,10 +620,9 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, else: cmd = cmd + str(address) - if self._settings.get(["debug"]) is True: if queue_id is not None: - self._logger.info("Runing scheduled queue id %s", queue_id) - self._logger.info("Sending neopixel cmd: %s", cmd) + self._logger.debug("running scheduled queue id %s", queue_id) + self._logger.debug("Sending neopixel cmd: %s", cmd) Popen(cmd, shell=True) if queue_id is not None: self.stop_queue_item(queue_id) @@ -353,12 +634,10 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, sensor_data = [] for sensor in list(filter(lambda item: item['input_type'] == 'temperature_sensor', self.rpi_inputs)): temp, hum = self.get_sensor_data(sensor) - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info( - "Sensor %s Temperature: %s humidity %s", sensor['label'], temp, hum) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Sensor %s Temperature: %s humidity %s", sensor['label'], temp, hum) if temp is not None and hum is not None: - sensor_data.append( - dict(index_id=sensor['index_id'], temperature=temp, humidity=hum)) + sensor_data.append(dict(index_id=sensor['index_id'], temperature=temp, humidity=hum)) self.temperature_sensor_data = sensor_data self.handle_temp_hum_control() self.handle_temperature_events() @@ -376,8 +655,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if first_run: current_value = False else: - current_value = (not GPIO.input( - gpio_pin)) if output['active_low'] else GPIO.input(gpio_pin) + current_value = (not GPIO.input(gpio_pin)) if output['active_low'] else GPIO.input(gpio_pin) if current_value: time_delay = self.to_int(output['toggle_timer_off']) @@ -386,9 +664,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if not self.print_complete: self.write_gpio(gpio_pin, not current_value) - thread = threading.Timer(time_delay, - self.toggle_output, - args=[index_id]) + thread = threading.Timer(time_delay, self.toggle_output, args=[index_id]) thread.start() else: off_value = True if output['active_low'] else False @@ -397,32 +673,27 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, return if output['output_type'] == 'pwm': - for pwm in self.pwm_intances: + for pwm in self.pwm_instances: if gpio_pin in pwm: if first_run: current_pwm_value = 0 else: if 'duty_cycle' in pwm: current_pwm_value = pwm['duty_cycle'] - current_pwm_value = self.to_int( - current_pwm_value) + current_pwm_value = self.to_int(current_pwm_value) else: current_pwm_value = 0 if not current_pwm_value == 0: - time_delay = self.to_int( - output['toggle_timer_off']) + time_delay = self.to_int(output['toggle_timer_off']) write_value = 0 else: time_delay = self.to_int(output['toggle_timer_on']) - write_value = self.to_int( - output['default_duty_cycle']) + write_value = self.to_int(output['default_duty_cycle']) if not self.print_complete: self.write_pwm(gpio_pin, write_value) - thread = threading.Timer(time_delay, - self.toggle_output, - args=[index_id]) + thread = threading.Timer(time_delay, self.toggle_output, args=[index_id]) thread.start() else: self.write_pwm(self.to_int(output['gpio_pin']), 0) @@ -436,37 +707,27 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, self.update_ui_inputs() def update_ui_current_temperature(self): - self._plugin_manager.send_plugin_message( - self._identifier, dict(sensor_data=self.temperature_sensor_data)) + self._plugin_manager.send_plugin_message(self._identifier, dict(sensor_data=self.temperature_sensor_data)) def update_ui_set_temperature(self): result = [] - for temp_crt_output in list(filter(lambda item: - item['output_type'] == 'temp_hum_control', - self.rpi_outputs)): - set_temperature = self.to_float( - temp_crt_output['temp_ctr_set_value']) - result.append( - dict(index_id=temp_crt_output['index_id'], set_temperature=set_temperature)) + for temp_crt_output in list(filter(lambda item: item['output_type'] == 'temp_hum_control', self.rpi_outputs)): + set_temperature = self.to_float(temp_crt_output['temp_ctr_set_value']) + result.append(dict(index_id=temp_crt_output['index_id'], set_temperature=set_temperature)) result.append(set_temperature) - self._plugin_manager.send_plugin_message( - self._identifier, dict(set_temperature=result)) + self._plugin_manager.send_plugin_message(self._identifier, dict(set_temperature=result)) def stop_queue_item(self, queue_id): old_list = self.event_queue - if self._settings.get(["debug"]) is True: - self._logger.info("Stoping queue id %s...", queue_id) + self._logger.debug("Stopping queue id %s...", queue_id) for task in self.event_queue: - if self._settings.get(["debug"]) is True: - self._logger.info("Queue id found...") + self._logger.debug("Queue id found...") if task['queue_id'] == queue_id: task['thread'].cancel() self.event_queue.remove(task) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Queue id stoped and removed from list...") - self._logger.info("Old queue list: %s", old_list) - self._logger.info("New queue list: %s", self.event_queue) + self._logger.debug("Queue id stopped and removed from list...") + self._logger.debug("Old queue list: %s", old_list) + self._logger.debug("New queue list: %s", self.event_queue) def update_ui_outputs(self): try: @@ -481,13 +742,11 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, shutdown = output['auto_shutdown'] if output['output_type'] == 'regular': - val = GPIO.input(pin) if not output['active_low'] else ( - not GPIO.input(pin)) + val = GPIO.input(pin) if not output['active_low'] else (not GPIO.input(pin)) regular_status.append( dict(index_id=index, status=val, auto_startup=startup, auto_shutdown=shutdown)) if output['output_type'] == 'temp_hum_control': - val = GPIO.input(pin) if not output['active_low'] else ( - not GPIO.input(pin)) + val = GPIO.input(pin) if not output['active_low'] else (not GPIO.input(pin)) temp_control_status.append( dict(index_id=index, status=val, auto_startup=startup, auto_shutdown=shutdown)) if output['output_type'] == 'neopixel_indirect' or output['output_type'] == 'neopixel_direct': @@ -495,7 +754,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, neopixel_status.append( dict(index_id=index, color=val, auto_startup=startup, auto_shutdown=shutdown)) if output['output_type'] == 'pwm': - for pwm in self.pwm_intances: + for pwm in self.pwm_instances: if pin in pwm: if 'duty_cycle' in pwm: pwm_val = pwm['duty_cycle'] @@ -504,10 +763,10 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, val = 0 pwm_status.append( dict(index_id=index, pwm_value=val, auto_startup=startup, auto_shutdown=shutdown)) - self._plugin_manager.send_plugin_message(self._identifier, dict(rpi_output_regular=regular_status, - rpi_output_pwm=pwm_status, - rpi_output_neopixel=neopixel_status, - rpi_output_temp_hum_ctrl=temp_control_status)) + self._plugin_manager.send_plugin_message(self._identifier, + dict(rpi_output_regular=regular_status, rpi_output_pwm=pwm_status, + rpi_output_neopixel=neopixel_status, + rpi_output_temp_hum_ctrl=temp_control_status)) except Exception as ex: self.log_error(ex) @@ -515,13 +774,12 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, try: sensor_status = [] for sensor in self.rpi_inputs: - if sensor['input_type'] == 'gpio' and sensor['action_type'] == 'printer_control' and sensor['printer_action'] == 'filament': + if sensor['input_type'] == 'gpio' and sensor['action_type'] == 'printer_control' and sensor[ + 'printer_action'] == 'filament': index = self.to_int(sensor['index_id']) value = sensor['filament_sensor_enabled'] - sensor_status.append( - dict(index_id=index, filament_sensor_enabled=value)) - self._plugin_manager.send_plugin_message( - self._identifier, dict(filament_sensor_status=sensor_status)) + sensor_status.append(dict(index_id=index, filament_sensor_enabled=value)) + self._plugin_manager.send_plugin_message(self._identifier, dict(filament_sensor_status=sensor_status)) except Exception as ex: self.log_error(ex) @@ -531,28 +789,30 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, temp, hum = self.read_dummy_temp() else: if sensor['temp_sensor_type'] in ["11", "22", "2302"]: - temp, hum = self.read_dht_temp( - sensor['temp_sensor_type'], sensor['gpio_pin']) + temp, hum = self.read_dht_temp(sensor['temp_sensor_type'], sensor['gpio_pin']) elif sensor['temp_sensor_type'] == "18b20": temp = self.read_18b20_temp(sensor['ds18b20_serial']) hum = 0 elif sensor['temp_sensor_type'] == "bme280": - temp, hum = self.read_bme280_temp( - sensor['temp_sensor_address']) + temp, hum = self.read_bme280_temp(sensor['temp_sensor_address']) elif sensor['temp_sensor_type'] == "si7021": - temp, hum = self.read_si7021_temp( - sensor['temp_sensor_address']) + temp, hum = self.read_si7021_temp(sensor['temp_sensor_address']) elif sensor['temp_sensor_type'] == "tmp102": - temp = self.read_tmp102_temp( - sensor['temp_sensor_address']) + temp = self.read_tmp102_temp(sensor['temp_sensor_address']) + hum = 0 + elif sensor['temp_sensor_type'] == "max31855": + temp = self.read_max31855_temp(sensor['temp_sensor_address']) + hum = 0 + elif sensor['temp_sensor_type'] == "mcp9808": + temp = self.read_mcp_temp(sensor['temp_sensor_address']) hum = 0 else: self._logger.info("temp_sensor_type no match") temp = None hum = None if temp != -1 and hum != -1: - temp = round(self.to_float( - temp), 1) if not sensor['use_fahrenheit'] else round(self.to_float(temp) * 1.8 + 32, 1) + temp = round(self.to_float(temp), 1) if not sensor['use_fahrenheit'] else round( + self.to_float(temp) * 1.8 + 32, 1) hum = round(self.to_float(hum), 1) return temp, hum return None, None @@ -561,23 +821,22 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def handle_temperature_events(self): for temperature_alarm in [item for item in self.rpi_outputs if item['output_type'] == 'temperature_alarm']: - set_temperature = self.to_float( - temperature_alarm['alarm_set_temp']) + set_temperature = self.to_float(temperature_alarm['alarm_set_temp']) if int(set_temperature) is 0: continue - linked_data = [item for item in self.temperature_sensor_data if item['index_id'] == - temperature_alarm['linked_temp_sensor']].pop() + linked_data = [item for item in self.temperature_sensor_data if + item['index_id'] == temperature_alarm['linked_temp_sensor']].pop() sensor_temperature = self.to_float(linked_data['temperature']) if set_temperature < sensor_temperature: for rpi_controlled_output in self.rpi_outputs: - if self.to_int(temperature_alarm['controlled_io']) == self.to_int(rpi_controlled_output['index_id']): + if self.to_int(temperature_alarm['controlled_io']) == self.to_int( + rpi_controlled_output['index_id']): val = GPIO.LOW if rpi_controlled_output['active_low'] else GPIO.HIGH - self.write_gpio(self.to_int( - rpi_controlled_output['gpio_pin']), val) + self.write_gpio(self.to_int(rpi_controlled_output['gpio_pin']), val) for notification in self.notifications: if notification['temperatureAction']: - msg = ("Temperature action: enclosure temperature exceed " + - temperature_alarm['alarm_set_temp']) + msg = ("Temperature action: enclosure temperature exceed " + temperature_alarm[ + 'alarm_set_temp']) self.send_notification(msg) def read_dummy_temp(self): @@ -591,69 +850,82 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, return return_value, return_value + def read_mcp_temp(self, address): + try: + script = os.path.dirname(os.path.realpath(__file__)) + "/mcp9808.py" + args = ["python", script, str(address)] + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature MCP9808 cmd: %s", " ".join(args)) + proc = Popen(args, stdout=PIPE) + stdout, _ = proc.communicate() + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("MCP9808 result: %s", stdout) + return self.to_float(stdout.strip()) + except Exception as ex: + self._logger.info("Failed to execute python scripts, try disabling use SUDO on advanced section.") + self.log_error(ex) + return 0 + def read_dht_temp(self, sensor, pin): try: - script = os.path.dirname( - os.path.realpath(__file__)) + "/getDHTTemp.py " + script = os.path.dirname(os.path.realpath(__file__)) + "/getDHTTemp.py " if self._settings.get(["use_sudo"]): sudo_str = "sudo " else: sudo_str = "" cmd = sudo_str + "python " + script + str(sensor) + " " + str(pin) - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("Temperature dht cmd: %s", cmd) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature dht cmd: %s", cmd) stdout = (Popen(cmd, shell=True, stdout=PIPE).stdout).read() - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("Dht result: %s", stdout) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Dht result: %s", stdout) temp, hum = stdout.split("|") return (self.to_float(temp.strip()), self.to_float(hum.strip())) except Exception as ex: self._logger.info( - "Failed to excecute python scripts, try disabling use SUDO on advanced section of the plugin.") + "Failed to execute python scripts, try disabling use SUDO on advanced section of the plugin.") self.log_error(ex) return (0, 0) def read_bme280_temp(self, address): try: - script = os.path.dirname( - os.path.realpath(__file__)) + "/BME280.py " + script = os.path.dirname(os.path.realpath(__file__)) + "/BME280.py " if self._settings.get(["use_sudo"]): sudo_str = "sudo " else: sudo_str = "" cmd = sudo_str + "python " + script + str(address) - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("Temperature BME280 cmd: %s", cmd) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature BME280 cmd: %s", cmd) stdout = (Popen(cmd, shell=True, stdout=PIPE).stdout).read() - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("BME280 result: %s", stdout) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("BME280 result: %s", stdout) temp, hum = stdout.split("|") return (self.to_float(temp.strip()), self.to_float(hum.strip())) except Exception as ex: self._logger.info( - "Failed to excecute python scripts, try disabling use SUDO on advanced section of the plugin.") + "Failed to execute python scripts, try disabling use SUDO on advanced section of the plugin.") self.log_error(ex) return (0, 0) def read_si7021_temp(self, address): try: - script = os.path.dirname( - os.path.realpath(__file__)) + "/SI7021.py " + script = os.path.dirname(os.path.realpath(__file__)) + "/SI7021.py " if self._settings.get(["use_sudo"]): sudo_str = "sudo " else: sudo_str = "" cmd = sudo_str + "python " + script + str(address) - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("Temperature SI7021 cmd: %s", cmd) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature SI7021 cmd: %s", cmd) stdout = (Popen(cmd, shell=True, stdout=PIPE).stdout).read() - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("SI7021 result: %s", stdout) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("SI7021 result: %s", stdout) temp, hum = stdout.split("|") return (self.to_float(temp.strip()), self.to_float(hum.strip())) except Exception as ex: self._logger.info( - "Failed to excecute python scripts, try disabling use SUDO on advanced section of the plugin.") + "Failed to execute python scripts, try disabling use SUDO on advanced section of the plugin.") self.log_error(ex) return (0, 0) @@ -669,8 +941,8 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if equals_pos != -1: temp_string = lines[1][equals_pos + 2:] temp_c = float(temp_string) / 1000. - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("DS18B20 result: %s", temp_c) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("DS18B20 result: %s", temp_c) return '{0:0.1f}'.format(temp_c) return 0 @@ -687,30 +959,44 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, try: script = os.path.dirname(os.path.realpath(__file__)) + "/tmp102.py" args = ["python", script, str(address)] - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("Temperature TMP102 cmd: %s", " ".join(args)) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature TMP102 cmd: %s", " ".join(args)) proc = Popen(args, stdout=PIPE) stdout, _ = proc.communicate() - if self._settings.get(["debug"]) is True and self._settings.get(["debug_temperature_log"]) is True: - self._logger.info("TMP102 result: %s", stdout) + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("TMP102 result: %s", stdout) return self.to_float(stdout.strip()) except Exception as ex: - self._logger.info( - "Failed to excecute python scripts, try disabling use SUDO on advanced section.") + self._logger.info("Failed to execute python scripts, try disabling use SUDO on advanced section.") + self.log_error(ex) + return 0 + + def read_max31855_temp(self, address): + try: + script = os.path.dirname(os.path.realpath(__file__)) + "/max31855.py" + args = ["python", script, str(address)] + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("Temperature MAX31855 cmd: %s", " ".join(args)) + proc = Popen(args, stdout=PIPE) + stdout, _ = proc.communicate() + if self._settings.get(["debug_temperature_log"]) is True: + self._logger.debug("MAX31855 result: %s", stdout) + return self.to_float(stdout.strip()) + except Exception as ex: + self._logger.info("Failed to execute python scripts, try disabling use SUDO on advanced section.") self.log_error(ex) return 0 def handle_pwm_linked_temperature(self): try: - for pwm_output in list(filter(lambda item: item['output_type'] == 'pwm' and item['pwm_temperature_linked'], self.rpi_outputs)): + for pwm_output in list(filter(lambda item: item['output_type'] == 'pwm' and item['pwm_temperature_linked'], + self.rpi_outputs)): gpio_pin = self.to_int(pwm_output['gpio_pin']) if self._printer.is_printing(): index_id = self.to_int(pwm_output['index_id']) linked_id = self.to_int(pwm_output['linked_temp_sensor']) - linked_data = self.get_linked_temp_sensor_data( - linked_id) - current_temp = self.to_float( - linked_data['temperature']) + linked_data = self.get_linked_temp_sensor_data(linked_id) + current_temp = self.to_float(linked_data['temperature']) duty_a = self.to_float(pwm_output['duty_a']) duty_b = self.to_float(pwm_output['duty_b']) @@ -718,57 +1004,50 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, temp_b = self.to_float(pwm_output['temperature_b']) try: - calculated_duty = ((current_temp - temp_a) * - (duty_b - duty_a) / (temp_b - temp_a)) + duty_a + calculated_duty = ((current_temp - temp_a) * (duty_b - duty_a) / (temp_b - temp_a)) + duty_a + + if current_temp < temp_a: + calculated_duty = 0 except: calculated_duty = 0 - if self._settings.get(["debug"]) is True: - self._logger.info( - "Calculated duty for PWM %s is %s", index_id, calculated_duty) + self._logger.debug("Calculated duty for PWM %s is %s", index_id, calculated_duty) elif self.print_complete: calculated_duty = self.to_int(pwm_output['duty_cycle']) else: calculated_duty = 0 - self.write_pwm(gpio_pin, self.constrain( - calculated_duty, 0, 100)) + self.write_pwm(gpio_pin, self.constrain(calculated_duty, 0, 100)) except Exception as ex: self.log_error(ex) def get_linked_temp_sensor_data(self, linked_id): try: - linked_data = [ - data for data in self.temperature_sensor_data if data['index_id'] == linked_id].pop() + linked_data = [data for data in self.temperature_sensor_data if data['index_id'] == linked_id].pop() return linked_data except: - self._logger.warn( - "No linked temperature sensor found for %s", linked_id) + self._logger.warn("No linked temperature sensor found for %s", linked_id) return None def handle_temp_hum_control(self): try: - for temp_hum_control in list(filter(lambda item: item['output_type'] == 'temp_hum_control', self.rpi_outputs)): + for temp_hum_control in list( + filter(lambda item: item['output_type'] == 'temp_hum_control', self.rpi_outputs)): - set_temperature = self.to_float( - temp_hum_control['temp_ctr_set_value']) - temp_deadband = self.to_float( - temp_hum_control['temp_ctr_deadband']) - max_temp = self.to_float( - temp_hum_control['temp_ctr_max_temp']) + set_temperature = self.to_float(temp_hum_control['temp_ctr_set_value']) + temp_deadband = self.to_float(temp_hum_control['temp_ctr_deadband']) + max_temp = self.to_float(temp_hum_control['temp_ctr_max_temp']) linked_id = temp_hum_control['linked_temp_sensor'] - previous_status = list(filter( - lambda item: item['index_id'] == temp_hum_control['index_id'], + previous_status = list(filter(lambda item: item['index_id'] == temp_hum_control['index_id'], self.temp_hum_control_status)).pop()['status'] if set_temperature == 0: current_status = False else: - linked_data = self.get_linked_temp_sensor_data( - linked_id) + linked_data = self.get_linked_temp_sensor_data(linked_id) control_type = str(temp_hum_control['temp_ctr_type']) @@ -776,8 +1055,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, current_value = self.to_float(linked_data['humidity']) temp_deadband = 0 else: - current_value = self.to_float( - linked_data['temperature']) + current_value = self.to_float(linked_data['temperature']) if control_type == 'cooler' or control_type == 'dehumidifier': if current_value <= set_temperature and current_value >= (set_temperature - temp_deadband): @@ -795,19 +1073,16 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, current_status = True if control_type == 'heater' and max_temp > 0.0 and max_temp < current_value: - if self._settings.get(["debug"]) is True: - self._logger.info( - "Maximun temperature reached for temperature control %s", temp_hum_control['index_id']) + self._logger.debug("Maximum temperature reached for temperature control %s", + temp_hum_control['index_id']) temp_hum_control['temp_ctr_set_value'] = 0 current_status = False if current_status != previous_status: if current_status: - self._logger.info( - "Turning gpio to control temperature on.") + self._logger.info("Turning gpio to control temperature on.") val = False if temp_hum_control['active_low'] else True - self.write_gpio(self.to_int( - temp_hum_control['gpio_pin']), val) + self.write_gpio(self.to_int(temp_hum_control['gpio_pin']), val) else: index_id = temp_hum_control['index_id'] if index_id in self.waiting_temperature: @@ -816,11 +1091,9 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if not self.waiting_temperature and self._printer.is_paused(): self._printer.resume_print() - self._logger.info( - "Turning gpio to control temperature off.") + self._logger.info("Turning gpio to control temperature off.") val = True if temp_hum_control['active_low'] else False - self.write_gpio(self.to_int( - temp_hum_control['gpio_pin']), val) + self.write_gpio(self.to_int(temp_hum_control['gpio_pin']), val) for control_status in self.temp_hum_control_status: if control_status['index_id'] == temp_hum_control['index_id']: control_status['status'] = current_status @@ -829,22 +1102,19 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def log_error(self, ex): template = "An exception of type {0} occurred on {1}. Arguments:\n{2!r}" - message = template.format( - type(ex).__name__, inspect.currentframe().f_code.co_name, ex.args) + message = template.format(type(ex).__name__, inspect.currentframe().f_code.co_name, ex.args) self._logger.warn(message) def setup_gpio(self): try: current_mode = GPIO.getmode() - set_mode = GPIO.BOARD if self._settings.get( - ["use_board_pin_number"]) else GPIO.BCM + set_mode = GPIO.BOARD if self._settings.get(["use_board_pin_number"]) else GPIO.BCM if current_mode is None: - outputs = list(filter(lambda item: item['output_type'] == 'regular' or - item['output_type'] == 'pwm' or - item['output_type'] == 'temp_hum_control' or - item['output_type'] == 'neopixel_direct', self.rpi_outputs)) - inputs = list(filter( - lambda item: item['input_type'] == 'gpio', self.rpi_inputs)) + outputs = list(filter( + lambda item: item['output_type'] == 'regular' or item['output_type'] == 'pwm' or item[ + 'output_type'] == 'temp_hum_control' or item['output_type'] == 'neopixel_direct', + self.rpi_outputs)) + inputs = list(filter(lambda item: item['input_type'] == 'gpio', self.rpi_inputs)) gpios = outputs + inputs if gpios: GPIO.setmode(set_mode) @@ -853,13 +1123,11 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, elif current_mode != set_mode: GPIO.setmode(current_mode) tempstr = "BOARD" if current_mode == GPIO.BOARD else "BCM" - self._settings.set(["use_board_pin_number"], - True if current_mode == GPIO.BOARD else False) - warn_msg = "GPIO mode was configured before, GPIO mode will be forced to use: " + \ - tempstr + " as pin numbers. Please update GPIO accordingly!" + self._settings.set(["use_board_pin_number"], True if current_mode == GPIO.BOARD else False) + warn_msg = "GPIO mode was configured before, GPIO mode will be forced to use: " + tempstr + " as pin numbers. Please update GPIO accordingly!" self._logger.info(warn_msg) - self._plugin_manager.send_plugin_message( - self._identifier, dict(is_msg=True, msg=warn_msg, msg_type="error")) + self._plugin_manager.send_plugin_message(self._identifier, + dict(is_msg=True, msg=warn_msg, msg_type="error")) GPIO.setwarnings(False) except Exception as ex: self.log_error(ex) @@ -867,18 +1135,17 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def clear_gpio(self): try: - for gpio_out in list(filter(lambda item: item['output_type'] == 'regular' or - item['output_type'] == 'pwm' or - item['output_type'] == 'temp_hum_control' or - item['output_type'] == 'neopixel_direct', self.rpi_outputs)): + for gpio_out in list(filter( + lambda item: item['output_type'] == 'regular' or item['output_type'] == 'pwm' or item[ + 'output_type'] == 'temp_hum_control' or item['output_type'] == 'neopixel_direct', + self.rpi_outputs)): gpio_pin = self.to_int(gpio_out['gpio_pin']) if gpio_pin not in self.rpi_outputs_not_changed: GPIO.cleanup(gpio_pin) for gpio_in in list(filter(lambda item: item['input_type'] == 'gpio', self.rpi_inputs)): try: - GPIO.remove_event_detect( - self.to_int(gpio_in['gpio_pin'])) + GPIO.remove_event_detect(self.to_int(gpio_in['gpio_pin'])) except: pass GPIO.cleanup(self.to_int(gpio_in['gpio_pin'])) @@ -888,41 +1155,40 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def clear_channel(self, channel): try: GPIO.cleanup(self.to_int(channel)) + self._logger.debug("Clearing channel %s", channel) except Exception as ex: self.log_error(ex) def generate_temp_hum_control_status(self): status = [] - for temp_hum_control in list(filter(lambda item: - item['output_type'] == 'temp_hum_control', self.rpi_outputs)): - status.append( - dict(index_id=temp_hum_control['index_id'], status=False)) + for temp_hum_control in list(filter(lambda item: item['output_type'] == 'temp_hum_control', self.rpi_outputs)): + status.append(dict(index_id=temp_hum_control['index_id'], status=False)) self.temp_hum_control_status = status def configure_gpio(self): try: - for gpio_out in list(filter(lambda item: item['output_type'] == 'regular' or - item['output_type'] == 'temp_hum_control', self.rpi_outputs)): + for gpio_out in list( + filter(lambda item: item['output_type'] == 'regular' or item['output_type'] == 'temp_hum_control', + self.rpi_outputs)): initial_value = GPIO.HIGH if gpio_out['active_low'] else GPIO.LOW pin = self.to_int(gpio_out['gpio_pin']) if pin not in self.rpi_outputs_not_changed: - self._logger.info( - "Setting GPIO pin %s as OUTPUT with initial value: %s", pin, initial_value) + self._logger.info("Setting GPIO pin %s as OUTPUT with initial value: %s", pin, initial_value) GPIO.setup(pin, GPIO.OUT, initial=initial_value) for gpio_out_pwm in list(filter(lambda item: item['output_type'] == 'pwm', self.rpi_outputs)): pin = self.to_int(gpio_out_pwm['gpio_pin']) - self._logger.info( - "Setting GPIO pin %s as PWM", pin) - for pwm in (pwm_dict for pwm_dict in self.pwm_intances if pin in pwm_dict): - self.pwm_intances.remove(pwm) + self._logger.info("Setting GPIO pin %s as PWM", pin) + for pwm in (pwm_dict for pwm_dict in self.pwm_instances if pin in pwm_dict): + self.pwm_instances.remove(pwm) self.clear_channel(pin) GPIO.setup(pin, GPIO.OUT) - pwm_instance = GPIO.PWM(pin, self.to_int( - gpio_out_pwm['pwm_frequency'])) + pwm_instance = GPIO.PWM(pin, self.to_int(gpio_out_pwm['pwm_frequency'])) + self._logger.info("starting PWM on pin %s", pin) pwm_instance.start(0) - self.pwm_intances.append({pin: pwm_instance}) - for gpio_out_neopixel in list(filter(lambda item: item['output_type'] == 'neopixel_direct', self.rpi_outputs)): + self.pwm_instances.append({pin: pwm_instance}) + for gpio_out_neopixel in list( + filter(lambda item: item['output_type'] == 'neopixel_direct', self.rpi_outputs)): pin = self.to_int(gpio_out_neopixel['gpio_pin']) self.clear_channel(pin) @@ -942,33 +1208,27 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, edge = GPIO.BOTH if rpi_input['action_type'] == 'output_control': - self._logger.info( - "Adding GPIO event detect on pin %s with edge: %s", gpio_pin, edge) - GPIO.add_event_detect( - gpio_pin, edge, callback=self.handle_gpio_control, bouncetime=200) + self._logger.info("Adding GPIO event detect on pin %s with edge: %s", gpio_pin, edge) + GPIO.add_event_detect(gpio_pin, edge, callback=self.handle_gpio_control, bouncetime=200) if (rpi_input['action_type'] == 'printer_control' and rpi_input['printer_action'] != 'filament'): - GPIO.add_event_detect( - gpio_pin, edge, callback=self.handle_printer_action, bouncetime=200) - self._logger.info( - "Adding PRINTER CONTROL event detect on pin %s with edge: %s", gpio_pin, edge) + GPIO.add_event_detect(gpio_pin, edge, callback=self.handle_printer_action, bouncetime=200) + self._logger.info("Adding PRINTER CONTROL event detect on pin %s with edge: %s", gpio_pin, edge) except Exception as ex: self.log_error(ex) def handle_filamment_detection(self, channel): try: - for filament_sensor in list(filter(lambda item: item['input_type'] == 'gpio' and - item['action_type'] == 'printer_control' and - item['printer_action'] == 'filament' and - self.to_int(item['gpio_pin']) == self.to_int(channel), self.rpi_inputs)): + for filament_sensor in list(filter( + lambda item: item['input_type'] == 'gpio' and item['action_type'] == 'printer_control' and item[ + 'printer_action'] == 'filament' and self.to_int(item['gpio_pin']) == self.to_int(channel), + self.rpi_inputs)): if ((filament_sensor['edge'] == 'fall') ^ (GPIO.input(self.to_int(filament_sensor['gpio_pin']))) and filament_sensor['filament_sensor_enabled']): last_detected_time = list(filter(lambda item: item['index_id'] == filament_sensor['index_id'], self.last_filament_end_detected)).pop()['time'] time_now = time.time() - time_difference = self.to_int( - time_now - last_detected_time) - time_out_value = self.to_int( - filament_sensor['filament_sensor_timeout']) + time_difference = self.to_int(time_now - last_detected_time) + time_out_value = self.to_int(filament_sensor['filament_sensor_timeout']) if time_difference > time_out_value: self._logger.info("Detected end of filament.") for item in self.last_filament_end_detected: @@ -977,48 +1237,43 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, for line in self._settings.get(["filament_sensor_gcode"]).split('\n'): if line: self._printer.commands(line.strip().upper()) - self._logger.info( - "Sending GCODE command: %s", line.strip().upper()) + self._logger.info("Sending GCODE command: %s", line.strip().upper()) time.sleep(0.2) for notification in self.notifications: if notification['filamentChange']: - msg = "Filament change action caused by sensor: " + \ - str(filament_sensor['label']) + msg = "Filament change action caused by sensor: " + str(filament_sensor['label']) self.send_notification(msg) else: - self._logger.info( - "Prevented end of filament detection, filament sensor timeout not elapsed.") + self._logger.info("Prevented end of filament detection, filament sensor timeout not elapsed.") except Exception as ex: self.log_error(ex) def start_filament_detection(self): self.stop_filament_detection() try: - for filament_sensor in list(filter(lambda item: item['input_type'] == 'gpio' and - item['action_type'] == 'printer_control' and - item['printer_action'] == 'filament', self.rpi_inputs)): + for filament_sensor in list(filter( + lambda item: item['input_type'] == 'gpio' and item['action_type'] == 'printer_control' and item[ + 'printer_action'] == 'filament', self.rpi_inputs)): edge = GPIO.RISING if filament_sensor['edge'] == 'rise' else GPIO.FALLING if GPIO.input(self.to_int(filament_sensor['gpio_pin'])) == (edge == GPIO.RISING): self._printer.pause_print() self._logger.info("Started printing with no filament.") else: - self.last_filament_end_detected.append( - dict(index_id=filament_sensor['index_id'], time=0)) - self._logger.info( - "Adding GPIO event detect on pin %s with edge: %s", filament_sensor['gpio_pin'], edge) - GPIO.add_event_detect(self.to_int( - filament_sensor['gpio_pin']), edge, callback=self.handle_filamment_detection, bouncetime=200) + self.last_filament_end_detected.append(dict(index_id=filament_sensor['index_id'], time=0)) + self._logger.info("Adding GPIO event detect on pin %s with edge: %s", filament_sensor['gpio_pin'], + edge) + GPIO.add_event_detect(self.to_int(filament_sensor['gpio_pin']), edge, + callback=self.handle_filamment_detection, bouncetime=200) except Exception as ex: self.log_error(ex) def stop_filament_detection(self): try: self.last_filament_end_detected = [] - for filament_sensor in list(filter(lambda item: item['input_type'] == 'gpio' and - item['action_type'] == 'printer_control' and - item['printer_action'] == 'filament', self.rpi_inputs)): - GPIO.remove_event_detect( - self.to_int(filament_sensor['gpio_pin'])) + for filament_sensor in list(filter( + lambda item: item['input_type'] == 'gpio' and item['action_type'] == 'printer_control' and item[ + 'printer_action'] == 'filament', self.rpi_inputs)): + GPIO.remove_event_detect(self.to_int(filament_sensor['gpio_pin'])) except Exception as ex: self.log_error(ex) @@ -1032,17 +1287,17 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def handle_initial_gpio_control(self): try: - for rpi_input in list(filter(lambda item: item['input_type'] == 'gpio' and - item['action_type'] == 'output_control', self.rpi_inputs)): + for rpi_input in list( + filter(lambda item: item['input_type'] == 'gpio' and item['action_type'] == 'output_control', + self.rpi_inputs)): gpio_pin = self.to_int(rpi_input['gpio_pin']) controlled_io = self.to_int(rpi_input['controlled_io']) if (rpi_input['edge'] == 'fall') ^ GPIO.input(gpio_pin): - rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int( - r_out['index_id']) == controlled_io].pop() + rpi_output = [r_out for r_out in self.rpi_outputs if + self.to_int(r_out['index_id']) == controlled_io].pop() if rpi_output['output_type'] == 'regular': val = GPIO.LOW if rpi_input['controlled_io_set_value'] == 'low' else GPIO.HIGH - self.write_gpio(self.to_int( - rpi_output['gpio_pin']), val) + self.write_gpio(self.to_int(rpi_output['gpio_pin']), val) except Exception as ex: self.log_error(ex) pass @@ -1050,49 +1305,47 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def shell_command(self, command): try: stdout = (Popen(command, shell=True, stdout=PIPE).stdout).read() - self._plugin_manager.send_plugin_message( - self._identifier, dict(is_msg=True, msg=stdout, msg_type="success")) + self._plugin_manager.send_plugin_message(self._identifier, + dict(is_msg=True, msg=stdout, msg_type="success")) except Exception as ex: self.log_error(ex) - self._plugin_manager.send_plugin_message( - self._identifier, dict(is_msg=True, msg="Could not execute shell script", msg_type="error")) + self._plugin_manager.send_plugin_message(self._identifier, + dict(is_msg=True, msg="Could not execute shell script", msg_type="error")) def handle_gpio_control(self, channel): + try: - if self._settings.get(["debug"]) is True: - self._logger.info( - "GPIO event triggered on channel %s", channel) - rpi_input = [r_inp for r_inp in self.rpi_inputs if self.to_int( - r_inp['gpio_pin']) == self.to_int(channel)].pop() - gpio_pin = self.to_int(rpi_input['gpio_pin']) - controlled_io = self.to_int(rpi_input['controlled_io']) - if (rpi_input['edge'] == 'fall') ^ GPIO.input(gpio_pin): - rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int( - r_out['index_id']) == controlled_io].pop() - if rpi_output['output_type'] == 'regular': - if rpi_input['controlled_io_set_value'] == 'toggle': - val = GPIO.LOW if GPIO.input(self.to_int( - rpi_output['gpio_pin'])) == GPIO.HIGH else GPIO.HIGH - else: - val = GPIO.LOW if rpi_input['controlled_io_set_value'] == 'low' else GPIO.HIGH - self.write_gpio(self.to_int( - rpi_output['gpio_pin']), val) - for notification in self.notifications: - if notification['gpioAction']: - msg = "GPIO control action caused by input " + str(rpi_input['label']) + ". Setting GPIO" + str( - rpi_input['controlled_io']) + " to: " + str(rpi_input['controlled_io_set_value']) - self.send_notification(msg) - if rpi_output['output_type'] == 'gcode_output': - self.send_gcode_command(rpi_output['gcode']) - for notification in self.notifications: - if notification['gpioAction']: - msg = "GPIO control action caused by input " + \ - str(rpi_input['label']) + \ - ". Sending GCODE command" - self.send_notification(msg) - if rpi_output['output_type'] == 'shell_output': - command = rpi_output['shell_script'] - self.shell_command(command) + self._logger.debug("GPIO event triggered on channel %s", channel) + for rpi_input in list( + filter(lambda item: self.to_int(item['gpio_pin']) == self.to_int(channel), self.rpi_inputs)): + gpio_pin = self.to_int(rpi_input['gpio_pin']) + controlled_io = self.to_int(rpi_input['controlled_io']) + if (rpi_input['edge'] == 'fall') ^ GPIO.input(gpio_pin): + rpi_output = [r_out for r_out in self.rpi_outputs if + self.to_int(r_out['index_id']) == controlled_io].pop() + if rpi_output['output_type'] == 'regular': + if rpi_input['controlled_io_set_value'] == 'toggle': + val = GPIO.LOW if GPIO.input( + self.to_int(rpi_output['gpio_pin'])) == GPIO.HIGH else GPIO.HIGH + else: + val = GPIO.LOW if rpi_input['controlled_io_set_value'] == 'low' else GPIO.HIGH + self.write_gpio(self.to_int(rpi_output['gpio_pin']), val) + for notification in self.notifications: + if notification['gpioAction']: + msg = "GPIO control action caused by input " + str( + rpi_input['label']) + ". Setting GPIO" + str( + rpi_input['controlled_io']) + " to: " + str(rpi_input['controlled_io_set_value']) + self.send_notification(msg) + if rpi_output['output_type'] == 'gcode_output': + self.send_gcode_command(rpi_output['gcode']) + for notification in self.notifications: + if notification['gpioAction']: + msg = "GPIO control action caused by input " + str( + rpi_input['label']) + ". Sending GCODE command" + self.send_notification(msg) + if rpi_output['output_type'] == 'shell_output': + command = rpi_output['shell_script'] + self.shell_command(command) except Exception as ex: self.log_error(ex) pass @@ -1101,16 +1354,15 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, for line in command.split('\n'): if line: self._printer.commands(line.strip().upper()) - self._logger.info( - "Sending GCODE command: %s", line.strip().upper()) + self._logger.info("Sending GCODE command: %s", line.strip().upper()) time.sleep(0.2) def handle_printer_action(self, channel): try: for rpi_input in self.rpi_inputs: - if (channel == self.to_int(rpi_input['gpio_pin']) and - rpi_input['action_type'] == 'printer_control' and - ((rpi_input['edge'] == 'fall') ^ GPIO.input(self.to_int(rpi_input['gpio_pin'])))): + if (channel == self.to_int(rpi_input['gpio_pin']) and rpi_input[ + 'action_type'] == 'printer_control' and ( + (rpi_input['edge'] == 'fall') ^ GPIO.input(self.to_int(rpi_input['gpio_pin'])))): if rpi_input['printer_action'] == 'resume': self._logger.info("Printer action resume.") self._printer.resume_print() @@ -1139,17 +1391,15 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, else: self._printer.connect() elif rpi_input['printer_action'] == 'stop_temp_hum_control': - self._logger.info( - "Printer action stoping temperature control.") + self._logger.info("Printer action stopping temperature control.") for rpi_output in self.rpi_outputs: if rpi_output['auto_shutdown'] and rpi_output['output_type'] == 'temp_hum_control': rpi_output['temp_ctr_set_value'] = 0 self.handle_temp_hum_control() for notification in self.notifications: if notification['printer_action']: - msg = "Printer action: " + \ - rpi_input['printer_action'] + \ - " caused by input: " + str(rpi_input['label']) + msg = "Printer action: " + rpi_input['printer_action'] + " caused by input: " + str( + rpi_input['label']) self.send_notification(msg) except Exception as ex: self.log_error(ex) @@ -1158,34 +1408,31 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def write_gpio(self, gpio, value, queue_id=None): try: GPIO.output(gpio, value) - if self._settings.get(["debug"]) is True: - if queue_id is not None: - self._logger.info("Runing scheduled queue id %s", queue_id) - self._logger.info("Writing on gpio: %s value %s", gpio, value) + if queue_id is not None: + self._logger.debug("Running scheduled queue id %s", queue_id) + self._logger.debug("Writing on GPIO: %s value %s", gpio, value) self.update_ui() if queue_id is not None: self.stop_queue_item(queue_id) except Exception as ex: template = "An exception of type {0} occurred on {1} when writing on pin {2}. Arguments:\n{3!r}" - message = template.format( - type(ex).__name__, inspect.currentframe().f_code.co_name, gpio, ex.args) + message = template.format(type(ex).__name__, inspect.currentframe().f_code.co_name, gpio, ex.args) self._logger.warn(message) pass def write_pwm(self, gpio, pwm_value, queue_id=None): try: - if queue_id is not None and self._settings.get(["debug"]) is True: - self._logger.info("Runing scheduled queue id %s", queue_id) - for pwm in self.pwm_intances: + if queue_id is not None: + self._logger.debug("running scheduled queue id %s", queue_id) + for pwm in self.pwm_instances: if gpio in pwm: pwm_object = pwm[gpio] old_pwm_value = pwm['duty_cycle'] if 'duty_cycle' in pwm else -1 if not self.to_int(old_pwm_value) == self.to_int(pwm_value): pwm['duty_cycle'] = pwm_value - pwm_object.ChangeDutyCycle(pwm_value) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Writing PWM on gpio: %s value %s", gpio, pwm_value) + pwm_object.start(pwm_value) #should be changed back to pwm_object.ChangeDutyCycle() but this + # was causing errors. + self._logger.debug("Writing PWM on gpio: %s value %s", gpio, pwm_value) self.update_ui() if queue_id is not None: self.stop_queue_item(queue_id) @@ -1207,9 +1454,8 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if provider == 'ifttt': event = self._settings.get(["notification_event_name"]) api_key = self._settings.get(["notification_api_key"]) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Sending notification to: %s with msg: %s with key: %s", provider, message, api_key) + self._logger.debug("Sending notification to: %s with msg: %s with key: %s", provider, message, + api_key) try: res = self.ifttt_notification(message, event, api_key) except requests.exceptions.ConnectionError: @@ -1222,12 +1468,11 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, self._logger.info("Error: Too many redirects") except requests.exceptions.RequestException as reqe: self._logger.info("Error: {e}".format(e=reqe)) - if res.status_code != requests.codes.ok: + if res.status_code != requests.codes['ok']: try: j = res.json() except ValueError: - self._logger.info( - 'Error: Could not parse server response. Event not sent') + self._logger.info('Error: Could not parse server response. Event not sent') for err in j['errors']: self._logger.info('Error: {}'.format(err['message'])) except Exception as ex: @@ -1235,8 +1480,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, pass def ifttt_notification(self, message, event, api_key): - url = "https://maker.ifttt.com/trigger/{e}/with/key/{k}/".format( - e=event, k=api_key) + url = "https://maker.ifttt.com/trigger/{e}/with/key/{k}/".format(e=event, k=api_key) payload = {'value1': message} return requests.post(url, data=payload) @@ -1245,6 +1489,9 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if event == Events.CONNECTED: self.update_ui() + if event == Events.CLIENT_OPENED: + self.update_ui() + if event == Events.PRINT_RESUMED: self.start_filament_detection() @@ -1255,18 +1502,14 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, self.start_filament_detection() for rpi_output in self.rpi_outputs: if rpi_output['auto_startup']: - delay_seconds = self.get_startup_delay_from_output( - rpi_output) - self.schedule_auto_startup_outputs( - rpi_output, delay_seconds) + delay_seconds = self.get_startup_delay_from_output(rpi_output) + self.schedule_auto_startup_outputs(rpi_output, delay_seconds) if rpi_output['toggle_timer']: if rpi_output['output_type'] == 'regular' or rpi_output['output_type'] == 'pwm': self.toggle_output(rpi_output['index_id'], True) if self.is_hour(rpi_output['shutdown_time']): - shutdown_delay_seconds = self.get_shutdown_delay_from_output( - rpi_output) - self.schedule_auto_shutdown_outputs( - rpi_output, shutdown_delay_seconds) + shutdown_delay_seconds = self.get_shutdown_delay_from_output(rpi_output) + self.schedule_auto_shutdown_outputs(rpi_output, shutdown_delay_seconds) self.run_tasks() self.update_ui() @@ -1279,8 +1522,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, rpi_output['duty_cycle'] = rpi_output['default_duty_cycle'] if rpi_output['auto_shutdown'] and not self.is_hour(shutdown_time): delay_seconds = self.to_float(shutdown_time) - self.schedule_auto_shutdown_outputs( - rpi_output, delay_seconds) + self.schedule_auto_shutdown_outputs(rpi_output, delay_seconds) self.run_tasks() self.update_ui() @@ -1295,8 +1537,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, rpi_output['duty_cycle'] = rpi_output['default_duty_cycle'] if rpi_output['auto_shutdown'] and not self.is_hour(shutdown_time): delay_seconds = self.to_float(shutdown_time) - self.schedule_auto_shutdown_outputs( - rpi_output, delay_seconds) + self.schedule_auto_shutdown_outputs(rpi_output, delay_seconds) if rpi_output['output_type'] == 'temp_hum_control': rpi_output['temp_ctr_set_value'] = 0 self.run_tasks() @@ -1306,10 +1547,8 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if notification['printFinish']: file_name = os.path.basename(payload["file"]) elapsed_time_in_seconds = payload["time"] - elapsed_time = octoprint.util.get_formatted_timedelta( - timedelta(seconds=elapsed_time_in_seconds)) - msg = "Print job finished: " + file_name + \ - "finished printing in " + file_name, elapsed_time + elapsed_time = octoprint.util.get_formatted_timedelta(timedelta(seconds=elapsed_time_in_seconds)) + msg = "Print job finished: " + file_name + "finished printing in " + file_name, elapsed_time self.send_notification(msg) def run_tasks(self): @@ -1321,24 +1560,33 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, sufix = 'auto_shutdown' if rpi_output['output_type'] == 'regular': value = True if rpi_output['active_low'] else False - self.add_regular_output_to_queue( - shutdown_delay_seconds, rpi_output, value, sufix) + self.add_regular_output_to_queue(shutdown_delay_seconds, rpi_output, value, sufix) + if rpi_output['output_type'] == 'ledstrip': + self.ledstrip_set_rgb(rpi_output) if rpi_output['output_type'] == 'pwm' and not rpi_output['pwm_temperature_linked']: value = 0 - self.add_pwm_output_to_queue( - shutdown_delay_seconds, rpi_output, value, sufix) + self.add_pwm_output_to_queue(shutdown_delay_seconds, rpi_output, value, sufix) if rpi_output['output_type'] == 'pwm' and rpi_output['pwm_temperature_linked']: - self.schedule_pwm_duty_on_queue( - shutdown_delay_seconds, rpi_output, 0, sufix) + self.schedule_pwm_duty_on_queue(shutdown_delay_seconds, rpi_output, 0, sufix) if (rpi_output['output_type'] == 'neopixel_indirect' or rpi_output['output_type'] == 'neopixel_direct'): - self.add_neopixel_output_to_queue( - rpi_output, shutdown_delay_seconds, 0, 0, 0, sufix) + self.add_neopixel_output_to_queue(rpi_output, shutdown_delay_seconds, 0, 0, 0, sufix) if rpi_output['output_type'] == 'temp_hum_control': value = 0 - self.add_temperature_output_temperature_queue( - shutdown_delay_seconds, rpi_output, value, sufix) - if self._settings.get(["debug"]) is True: - self._logger.info("Events scheduled to run %s", self.event_queue) + self.add_temperature_output_temperature_queue(shutdown_delay_seconds, rpi_output, value, sufix) + self._logger.debug("Events scheduled to run %s", self.event_queue) + + def ledstrip_set_rgb(self, rpi_output, rgb=None): + clk = rpi_output["ledstrip_gpio_clk"] + data = rpi_output["ledstrip_gpio_dat"] + if clk is not None and data is not None: + ledstrip = LEDStrip(self.to_int(clk), self.to_int(data)) + if rgb is None: + red, green, blue = self.get_color_from_rgb(rpi_output['default_ledstrip_color']) + else: + red, green, blue = self.get_color_from_rgb(rgb) + + self._logger.info("LEDSTRIP set rgb color: %s, %s, %s", red, green, blue) + ledstrip.setcolourrgb(self.to_int(red), self.to_int(green), self.to_int(blue)) def start_outpus_with_server(self): for rpi_output in self.rpi_outputs: @@ -1347,19 +1595,20 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if rpi_output['output_type'] == 'regular': value = False if rpi_output['active_low'] else True self.write_gpio(gpio, value) + if rpi_output['output_type'] == 'ledstrip': + self.ledstrip_set_rgb(rpi_output) if rpi_output['output_type'] == 'pwm' and not rpi_output['pwm_temperature_linked']: value = self.to_int(rpi_output['default_duty_cycle']) self.write_pwm(gpio, value) if (rpi_output['output_type'] == 'neopixel_indirect' or rpi_output['output_type'] == 'neopixel_direct'): - red, green, blue = self.get_color_from_rgb( - rpi_output['default_neopixel_color']) + red, green, blue = self.get_color_from_rgb(rpi_output['default_neopixel_color']) led_count = rpi_output['neopixel_count'] led_brightness = rpi_output['neopixel_brightness'] address = rpi_output['microcontroller_address'] index_id = self.to_int(rpi_output['index_id']) - neopixel_dirrect = rpi_output['output_type'] == 'neopixel_direct' - self.send_neopixel_command(self.to_int(rpi_output['gpio_pin']), led_count, led_brightness, red, green, blue, - address, neopixel_dirrect, index_id) + neopixel_direct = rpi_output['output_type'] == 'neopixel_direct' + self.send_neopixel_command(self.to_int(rpi_output['gpio_pin']), led_count, led_brightness, red, + green, blue, address, neopixel_direct, index_id) if rpi_output['output_type'] == 'temp_hum_control': rpi_output['temp_ctr_set_value'] = rpi_output['temp_ctr_default_value'] @@ -1367,23 +1616,19 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, sufix = 'auto_startup' if rpi_output['output_type'] == 'regular': value = False if rpi_output['active_low'] else True - self.add_regular_output_to_queue( - delay_seconds, rpi_output, value, sufix) + self.add_regular_output_to_queue(delay_seconds, rpi_output, value, sufix) + if rpi_output['output_type'] == 'ledstrip': + self.ledstrip_set_rgb(rpi_output) if rpi_output['output_type'] == 'pwm' and not rpi_output['pwm_temperature_linked']: value = self.to_int(rpi_output['default_duty_cycle']) - self.add_pwm_output_to_queue( - delay_seconds, rpi_output, value, sufix) + self.add_pwm_output_to_queue(delay_seconds, rpi_output, value, sufix) if (rpi_output['output_type'] == 'neopixel_indirect' or rpi_output['output_type'] == 'neopixel_direct'): - red, green, blue = self.get_color_from_rgb( - rpi_output['default_neopixel_color']) - self.add_neopixel_output_to_queue( - rpi_output, delay_seconds, red, green, blue, sufix) + red, green, blue = self.get_color_from_rgb(rpi_output['default_neopixel_color']) + self.add_neopixel_output_to_queue(rpi_output, delay_seconds, red, green, blue, sufix) if rpi_output['output_type'] == 'temp_hum_control': value = rpi_output['temp_ctr_default_value'] - self.add_temperature_output_temperature_queue( - delay_seconds, rpi_output, value, sufix) - if self._settings.get(["debug"]) is True: - self._logger.info("Events scheduled to run %s", self.event_queue) + self.add_temperature_output_temperature_queue(delay_seconds, rpi_output, value, sufix) + self._logger.debug("Events scheduled to run %s", self.event_queue) def get_color_from_rgb(self, stringColor): stringColor = stringColor.replace('rgb(', '') @@ -1416,39 +1661,29 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, queue_id = '{0!s}_{1!s}'.format(index_id, sufix) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Scheduling neopixel output id %s for on %s delay_seconds", queue_id, delay_seconds) + self._logger.debug("Scheduling neopixel output id %s for on %s delay_seconds", queue_id, delay_seconds) - thread = threading.Timer(delay_seconds, - self.send_neopixel_command, - args=[gpio_pin, ledCount, ledBrightness, red, green, blue, address, neopixel_direct, index_id, queue_id]) + thread = threading.Timer(delay_seconds, self.send_neopixel_command, + args=[gpio_pin, ledCount, ledBrightness, red, green, blue, address, neopixel_direct, + index_id, queue_id]) self.event_queue.append(dict(queue_id=queue_id, thread=thread)) def add_pwm_output_to_queue(self, delay_seconds, rpi_output, value, sufix): queue_id = '{0!s}_{1!s}'.format(rpi_output['index_id'], sufix) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Scheduling pwm output id %s for on %s delay_seconds", queue_id, delay_seconds) + self._logger.debug("Scheduling pwm output id %s for on %s delay_seconds", queue_id, delay_seconds) - thread = threading.Timer(delay_seconds, - self.write_pwm, + thread = threading.Timer(delay_seconds, self.write_pwm, args=[self.to_int(rpi_output['gpio_pin']), value, queue_id]) self.event_queue.append(dict(queue_id=queue_id, thread=thread)) def schedule_pwm_duty_on_queue(self, delay_seconds, rpi_output, value, sufix): - queue_id = '{0!s}_{1!s}_{2!s}'.format( - rpi_output['index_id'], "pwm_linked_temp", sufix) - thread = threading.Timer(delay_seconds, - self.set_pwm_duty_cycle, - args=[rpi_output, value, queue_id]) + queue_id = '{0!s}_{1!s}_{2!s}'.format(rpi_output['index_id'], "pwm_linked_temp", sufix) + thread = threading.Timer(delay_seconds, self.set_pwm_duty_cycle, args=[rpi_output, value, queue_id]) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Scheduling pwm linked temp output id %s on %s delay_seconds", queue_id, delay_seconds) + self._logger.debug("Scheduling pwm linked temp output id %s on %s delay_seconds", queue_id, delay_seconds) self.event_queue.append(dict(queue_id=queue_id, thread=thread)) @@ -1460,41 +1695,33 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, def add_regular_output_to_queue(self, delay_seconds, rpi_output, value, sufix): queue_id = '{0!s}_{1!s}'.format(rpi_output['index_id'], sufix) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Scheduling regular output id %s on %s delay_seconds", queue_id, delay_seconds) + self._logger.debug("Scheduling regular output id %s on %s delay_seconds", queue_id, delay_seconds) - thread = threading.Timer(delay_seconds, - self.write_gpio, + thread = threading.Timer(delay_seconds, self.write_gpio, args=[self.to_int(rpi_output['gpio_pin']), value, queue_id]) self.event_queue.append(dict(queue_id=queue_id, thread=thread)) def add_temperature_output_temperature_queue(self, delay_seconds, rpi_output, value, sufix): queue_id = '{0!s}_{1!s}'.format(rpi_output['index_id'], sufix) - if self._settings.get(["debug"]) is True: - self._logger.info( - "Scheduling temperature control id %s on %s delay_seconds", queue_id, delay_seconds) + self._logger.debug("Scheduling temperature control id %s on %s delay_seconds", queue_id, delay_seconds) - thread = threading.Timer(delay_seconds, - self.write_temperature_to_output, + thread = threading.Timer(delay_seconds, self.write_temperature_to_output, args=[self.to_int(rpi_output['index_id']), value, queue_id]) self.event_queue.append(dict(queue_id=queue_id, thread=thread)) def write_temperature_to_output(self, rpi_output_index, value, queue_id=None): try: - rpi_output = [r_out for r_out in self.rpi_outputs if self.to_int( - r_out['index_id']) == rpi_output_index].pop() + rpi_output = [r_out for r_out in self.rpi_outputs if + self.to_int(r_out['index_id']) == rpi_output_index].pop() if rpi_output['output_type'] == 'temp_hum_control': rpi_output['temp_ctr_set_value'] = value - if self._settings.get(["debug"]) is True: if queue_id is not None: - self._logger.info("Runing scheduled queue id %s", queue_id) - self._logger.info( - "Setting temperature to output index: %s value %s", rpi_output['index_id'], value) + self._logger.debug("running scheduled queue id %s", queue_id) + self._logger.debug("Setting temperature to output index: %s value %s", rpi_output['index_id'], value) self.update_ui() if queue_id is not None: @@ -1502,8 +1729,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, except Exception as ex: template = "An exception of type {0} occurred on {1}. Arguments:\n{3!r}" - message = template.format( - type(ex).__name__, inspect.currentframe().f_code.co_name, ex.args) + message = template.format(type(ex).__name__, inspect.currentframe().f_code.co_name, ex.args) self._logger.warn(message) pass @@ -1514,11 +1740,9 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, if start_up_date_time < datetime.now(): delay_seconds = 0.0 else: - delay_seconds = (start_up_date_time - - datetime.now()).total_seconds() + delay_seconds = (start_up_date_time - datetime.now()).total_seconds() else: - delay_seconds = self.to_float( - rpi_output['startup_time']) + delay_seconds = self.to_float(rpi_output['startup_time']) return delay_seconds # ~~ SettingsPlugin mixin @@ -1538,84 +1762,50 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, self.rpi_outputs_not_changed = commonPins self.clear_gpio() - if self._settings.get(["debug"]) is True: - self._logger.info("rpi_outputs: %s", self.rpi_outputs) - self._logger.info("rpi_inputs: %s", self.rpi_inputs) + self._logger.debug("rpi_outputs: %s", self.rpi_outputs) + self._logger.debug("rpi_inputs: %s", self.rpi_inputs) self.setup_gpio() self.configure_gpio() self.generate_temp_hum_control_status() def get_settings_defaults(self): - return dict( - rpi_outputs=[], - rpi_inputs=[], - filament_sensor_gcode="G91 ;Set Relative Mode \n" + - "G1 E-5.000000 F500 ;Retract 5mm\n" + - "G1 Z15 F300 ;move Z up 15mm\n" + - "G90 ;Set Absolute Mode\n " + - "G1 X20 Y20 F9000 ;Move to hold position\n" + - "G91 ;Set Relative Mode\n" + - "G1 E-40 F500 ;Retract 40mm\n" + - "M0 ;Idle Hold\n" + - "G90 ;Set Absolute Mode\n" + - "G1 F5000 ;Set speed limits\n" + - "G28 X0 Y0 ;Home X Y\n" + - "M82 ;Set extruder to Absolute Mode\n" + - "G92 E0 ;Set Extruder to 0", - use_sudo=True, - neopixel_dma=10, - debug=False, - gcode_control=False, - debug_temperature_log=False, - use_board_pin_number=False, - notification_provider="disabled", - notification_api_key="", - notification_event_name="printer_event", - notifications=[{'printFinish': True, 'filamentChange': True, - 'printer_action': True, 'temperatureAction': True, 'gpioAction': True}] - ) + return dict(rpi_outputs=[], rpi_inputs=[], + filament_sensor_gcode="G91 ;Set Relative Mode \n" + "G1 E-5.000000 F500 ;Retract 5mm\n" + "G1 Z15 F300 ;move Z up 15mm\n" + "G90 ;Set Absolute Mode\n " + "G1 X20 Y20 F9000 ;Move to hold position\n" + "G91 ;Set Relative Mode\n" + "G1 E-40 F500 ;Retract 40mm\n" + "M0 ;Idle Hold\n" + "G90 ;Set Absolute Mode\n" + "G1 F5000 ;Set speed limits\n" + "G28 X0 Y0 ;Home X Y\n" + "M82 ;Set extruder to Absolute Mode\n" + "G92 E0 ;Set Extruder to 0", + use_sudo=True, neopixel_dma=10, debug=False, gcode_control=False, debug_temperature_log=False, + use_board_pin_number=False, notification_provider="disabled", notification_api_key="", + notification_event_name="printer_event", notifications=[{ + 'printFinish' : True, + 'filamentChange' : True, + 'printer_action' : True, + 'temperatureAction': True, 'gpioAction': True + }]) # ~~ TemplatePlugin def get_template_configs(self): - return [ - dict(type="settings", custom_bindings=True), - dict(type="tab", custom_bindings=True), - dict(type="navbar", custom_bindings=True, - suffix="_1", classes=["dropdown"]), - dict(type="navbar", custom_bindings=True, - template="enclosure_navbar_input.jinja2", suffix="_2", classes=["dropdown"]) - ] + return [dict(type="settings", custom_bindings=True), dict(type="tab", custom_bindings=True), + dict(type="navbar", custom_bindings=True, suffix="_1", classes=["dropdown"]), + dict(type="navbar", custom_bindings=True, template="enclosure_navbar_input.jinja2", suffix="_2", + classes=["dropdown"])] # ~~ AssetPlugin mixin def get_assets(self): - return dict( - js=["js/enclosure.js", "js/bootstrap-colorpicker.min.js"], - css=["css/bootstrap-colorpicker.css", "css/enclosure.css"] - ) + return dict(js=["js/enclosure.js", "js/bootstrap-colorpicker.min.js"], + css=["css/bootstrap-colorpicker.css", "css/enclosure.css"]) # ~~ Softwareupdate hook def get_update_information(self): - return dict( - enclosure=dict( - displayName="Enclosure Plugin", - displayVersion=self._plugin_version, - # version check: github repository - type="github_release", - user="vitormhenrique", - repo="OctoPrint-Enclosure", - current=self._plugin_version, - # update method: pip - pip="https://github.com/vitormhenrique/OctoPrint-Enclosure/archive/{target_version}.zip" - ) - ) + return dict(enclosure=dict(displayName="Enclosure Plugin", displayVersion=self._plugin_version, + # version check: github repository + type="github_release", user="vitormhenrique", repo="OctoPrint-Enclosure", current=self._plugin_version, + # update method: pip + pip="https://github.com/vitormhenrique/OctoPrint-Enclosure/archive/{target_version}.zip")) def hook_gcode_queuing(self, comm_instance, phase, cmd, cmd_type, gcode, *args, **kwargs): if self._settings.get(["gcode_control"]) is False: return if cmd.strip().startswith("ENC"): - if self._settings.get(["debug"]) is True: - self._logger.info("Gcode queuing: %s", cmd) + self._logger.debug("Gcode queuing: %s", cmd) index_id = self.to_int(self.get_gcode_value(cmd, 'O')) for output in [item for item in self.rpi_outputs if item['index_id'] == index_id]: if output['output_type'] == 'regular': @@ -1624,16 +1814,14 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, value = True if set_value == 1 else False value = (not value) if output['active_low'] else value self.write_gpio(self.to_int(output['gpio_pin']), value) - comm_instance._log( - "Setting REGULAR output %s to value %s" % (index_id, value)) + comm_instance._log("Setting REGULAR output %s to value %s" % (index_id, value)) return if output['output_type'] == 'pwm': set_value = self.to_int(self.get_gcode_value(cmd, 'S')) set_value = self.constrain(set_value, 0, 100) output['duty_cycle'] = set_value self.write_pwm(self.to_int(output['gpio_pin']), set_value) - comm_instance._log( - "Setting PWM output %s to value %s" % (index_id, set_value)) + comm_instance._log("Setting PWM output %s to value %s" % (index_id, set_value)) return if output['output_type'] == 'neopixel_indirect' or output['output_type'] == 'neopixel_direct': red = self.get_gcode_value(cmd, 'R') @@ -1646,11 +1834,10 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, index_id = self.to_int(output['index_id']) - neopixel_dirrect = output['output_type'] == 'neopixel_direct' + neopixel_direct = output['output_type'] == 'neopixel_direct' - self.send_neopixel_command( - self.to_int(output['gpio_pin']), - led_count, led_brightness, red, green, blue, address, neopixel_dirrect, index_id) + self.send_neopixel_command(self.to_int(output['gpio_pin']), led_count, led_brightness, red, green, + blue, address, neopixel_direct, index_id) comm_instance._log( "Setting NEOPIXEL output %s to red: %s green: %s blue: %s" % (index_id, red, green, blue)) return @@ -1663,8 +1850,7 @@ class EnclosurePlugin(octoprint.plugin.StartupPlugin, output['temp_ctr_set_value'] = set_value self.update_ui_set_temperature() self.handle_temp_hum_control() - comm_instance._log( - "Setting TEMP/HUM control output %s to value %s" % (index_id, set_value)) + comm_instance._log("Setting TEMP/HUM control output %s to value %s" % (index_id, set_value)) return @@ -1677,7 +1863,6 @@ def __plugin_load__(): global __plugin_hooks__ __plugin_hooks__ = { - "octoprint.comm.protocol.gcode.queuing": __plugin_implementation__.hook_gcode_queuing, + "octoprint.comm.protocol.gcode.queuing" : __plugin_implementation__.hook_gcode_queuing, "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information - } - + } \ No newline at end of file diff --git a/octoprint_enclosure/ledstrip.py b/octoprint_enclosure/ledstrip.py new file mode 100644 index 0000000..6876c32 --- /dev/null +++ b/octoprint_enclosure/ledstrip.py @@ -0,0 +1,143 @@ +""" +copyright 2017 Tim Richardson, github profile: https://github.com/GeekyTim + +This file is part of https://github.com/GeekyTim/Open-Smart-RGB-LED-Strip-Driver-for-Raspberry-Pi +Open-Smart-RGB-LED-Strip-Driver-for-Raspberry-Pi is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +Open-Smart-RGB-LED-Strip-Driver-for-Raspberry-Pi is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with Open-Smart-RGB-LED-Strip-Driver-for-Raspberry-Pi. If not, see . + + +LEDStrip Class +-------------- +A Python class that drives the Open-Smart RGB LED Strip from a Raspberry Pi. +Hardware Obtained from http://www.dx.com/p/full-color-rgb-led-strip-driver-module-for-arduino-blue-black-314667 + +Code originally developed by Philip Leder (https://github.com/schlank/Catalex-Led-Strip-Driver-Raspberry-Pi) + +Pin Connections +Choose any two GPIO Pins; one to provide the Clock signal (CLK), the other the Data (DAT) + +Pi Open-Smart Controller +Gnd Gnd ++5v Vcc +DAT Din +CLK Cin + +Place this file in the same directory as your code. +In your code, import the file: + from ledstrip import LEDStrip + +Create a new LED Strip which uses your chosen pins (CLK and DAT) with, e.g.: + CLK = 17 + DAT = 18 + strip = LEDStrip(CLK, DAT) + +Set the colour of the LED strip with + strip.setcolor(red, green, blue): + +The following methods are public: + setcolourrgb(r, g, b) - Sets the LED strip to colour rgb where r, g, b are in the range 0 to 255 + setcolourwhite() - Sets the strip to white + setcolourred() - Sets the strip to Red + setcolourgreen() - Sets the strip to Green + setcolourblue() - Sets the strip to Blue + setcolouroff() - Turns the strip off + setcolourhex('hex') - Sets the LED strip to the hex colour 'hex' in range '000000' to 'FFFFFF' +""" + +import time +import RPi.GPIO as GPIO + + +class LEDStrip: + def __init__(self, clock, data): + GPIO.setwarnings(False) + GPIO.setmode(GPIO.BCM) + self.__clock = clock + self.__data = data + self.__delay = 0 + GPIO.setup(self.__clock, GPIO.OUT) + GPIO.setup(self.__data, GPIO.OUT) + + def __sendclock(self): + GPIO.output(self.__clock, False) + time.sleep(self.__delay) + GPIO.output(self.__clock, True) + time.sleep(self.__delay) + + def __send32zero(self): + for x in range(32): + GPIO.output(self.__data, False) + self.__sendclock() + + def __senddata(self, dx): + self.__send32zero() + for x in range(32): + if ((dx & 0x80000000) != 0): + GPIO.output(self.__data, True) + else: + GPIO.output(self.__data, False) + dx <<= 1 + self.__sendclock() + self.__send32zero() + + def __getcode(self, dat): + tmp = 0 + if ((dat & 0x80) == 0): + tmp |= 0x02 + if ((dat & 0x40) == 0): + tmp |= 0x01 + return tmp + + def setcolourrgb(self, red, green, blue): + dx = 0 + dx |= 0x03 << 30 + dx |= self.__getcode(blue) + dx |= self.__getcode(green) + dx |= self.__getcode(red) + + dx |= blue << 16 + dx |= green << 8 + dx |= red + + self.__senddata(dx) + + def setcolourwhite(self): + self.setcolourrgb(255, 255, 255) + + def setcolouroff(self): + self.setcolourrgb(0, 0, 0) + + def setcolourred(self): + self.setcolourrgb(255, 0, 0) + + def setcolourgreen(self): + self.setcolourrgb(0, 255, 0) + + def setcolourblue(self): + self.setcolourrgb(0, 0, 255) + + def setcolourhex(self, hex): + print('Hex') + try: + hexcolour = int(hex, 16) + red = int((hexcolour & 255 * 255 * 255) / (255 * 255)) + green = int((hexcolour & 255 * 255) / 255) + blue = hexcolour & 255 + self.setcolourrgb(red, green, blue) + except: + hexcolour = 0 + print("Error converting Hex input (%s) a colour." % hex) + + def cleanup(self): + self.setcolouroff() + GPIO.cleanup() \ No newline at end of file diff --git a/octoprint_enclosure/max31855.py b/octoprint_enclosure/max31855.py new file mode 100644 index 0000000..208d0f9 --- /dev/null +++ b/octoprint_enclosure/max31855.py @@ -0,0 +1,27 @@ +import ctypes +import struct +import sys + +import Adafruit_GPIO.SPI as SPI +import Adafruit_MAX31855.MAX31855 as MAX31855 + + +def main(): + # Get bus address if provided or use default address + SPI_DEVICE = 0 + if len(sys.argv) >= 2: + SPI_DEVICE = int(sys.argv[1], 0) + + if not 0 <= SPI_DEVICE <= 1: + raise ValueError("Invalid address value") + + # Raspberry Pi hardware SPI configuration. + SPI_PORT = 0 + sensor = MAX31855.MAX31855(spi=SPI.SpiDev(SPI_PORT, SPI_DEVICE)) + + temp = sensor.readTempC() + + print('{0:0.1f}'.format(temp)) + +if __name__ == "__main__": + main() diff --git a/octoprint_enclosure/mcp9808.py b/octoprint_enclosure/mcp9808.py new file mode 100644 index 0000000..672045b --- /dev/null +++ b/octoprint_enclosure/mcp9808.py @@ -0,0 +1,67 @@ +import sys +import smbus + +# default I2C address for device. +MCP9808_I2CADDR_DEFAULT = 0x18 + +# register addresses. +MCP9808_REG_CONFIG = 0x01 +MCP9808_REG_UPPER_TEMP = 0x02 +MCP9808_REG_LOWER_TEMP = 0x03 +MCP9808_REG_CRIT_TEMP = 0x04 +MCP9808_REG_AMBIENT_TEMP = 0x05 +MCP9808_REG_MANUF_ID = 0x06 +MCP9808_REG_DEVICE_ID = 0x07 +MCP9808_REG_RESOLUTION = 0x08 + +# configuration register values. +MCP9808_REG_CONFIG_CONTCONV = 0x0000 +MCP9808_REG_CONFIG_SHUTDOWN = 0x0100 +MCP9808_REG_CONFIG_CRITLOCKED = 0x0080 +MCP9808_REG_CONFIG_WINLOCKED = 0x0040 +MCP9808_REG_CONFIG_INTCLR = 0x0020 +MCP9808_REG_CONFIG_ALERTSTAT = 0x0010 +MCP9808_REG_CONFIG_ALERTCTRL = 0x0008 +MCP9808_REG_CONFIG_ALERTSEL = 0x0002 +MCP9808_REG_CONFIG_ALERTPOL = 0x0002 +MCP9808_REG_CONFIG_ALERTMODE = 0x0001 + + +def main(): + # get bus address if provided or use default address + address = MCP9808_I2CADDR_DEFAULT + if len(sys.argv) == 2: + address = int(sys.argv[1], 16) + + # get I2C bus + bus = smbus.SMBus(1) + + # MCP9808 address, default 0x18(24) + # configuration register, 0x01(1) + # continuous conversion mode, power-up default + config = [MCP9808_REG_CONFIG_CONTCONV, 0x00] + bus.write_i2c_block_data(address, MCP9808_REG_CONFIG, config) + + # MCP9808 address, default 0x18(24) + # select resolution rgister, 0x08(8) + # resolution = +0.0625 / C, 0x03(03) + bus.write_byte_data(address, MCP9808_REG_RESOLUTION, 0x03) + + # MCP9808 address, default 0x18(24) + # read data back from 0x05(5), 2 bytes + # temp MSB, TEMP LSB + data = bus.read_i2c_block_data(address, MCP9808_REG_AMBIENT_TEMP, 2) + + # convert the data to 13-bits + ctemp = ((data[0] & 0x1F) * 256) + data[1] + if ctemp > 4095: + ctemp -= 8192 + ctemp = ctemp * 0.0625 + # ftemp = ctemp * 1.8 + 32 + + # output data + print('{0:0.2f}'.format(ctemp)) + + +if __name__ == "__main__": + main() diff --git a/octoprint_enclosure/neopixel_direct.py b/octoprint_enclosure/neopixel_direct.py index c5a4938..3af63f9 100644 --- a/octoprint_enclosure/neopixel_direct.py +++ b/octoprint_enclosure/neopixel_direct.py @@ -1,4 +1,4 @@ -from neopixel import * +from rpi_ws281x import * import sys import time @@ -12,7 +12,7 @@ if len(sys.argv) == 8: red = int(sys.argv[4]) green = int(sys.argv[5]) blue = int(sys.argv[6]) - LED_DMA = int(sys.argv[7], 16) + LED_DMA = int(sys.argv[7]) else: print("fail") sys.exit(1) @@ -20,7 +20,7 @@ else: strip = Adafruit_NeoPixel(LED_COUNT, LED_PIN, LED_FREQ_HZ, LED_DMA, LED_INVERT) strip.begin() -color = Color(green, red, blue) +color = Color(red, green, blue) for i in range(LED_COUNT): strip.setPixelColor(i, color) diff --git a/octoprint_enclosure/static/css/enclosure.css b/octoprint_enclosure/static/css/enclosure.css index 781a8e9..0909952 100644 --- a/octoprint_enclosure/static/css/enclosure.css +++ b/octoprint_enclosure/static/css/enclosure.css @@ -67,7 +67,7 @@ text-decoration: none; } -.neopixel-div{ +.ledstrip-div, .neopixel-div{ width: 25%; } diff --git a/octoprint_enclosure/static/js/enclosure.js b/octoprint_enclosure/static/js/enclosure.js index a0ae30d..383e740 100644 --- a/octoprint_enclosure/static/js/enclosure.js +++ b/octoprint_enclosure/static/js/enclosure.js @@ -225,6 +225,19 @@ $(function () { }) } + if (data.hasOwnProperty("rpi_output_ledstrip")) { + data.rpi_output_ledstrip.forEach(function (output) { + var linked_output = ko.utils.arrayFilter(self.rpi_outputs(), function (item) { + return (output['index_id'] == item.index_id()); + }).pop(); + if (linked_output) { + linked_output.ledstrip_color(output['color']) + linked_output.auto_shutdown(output['auto_shutdown']) + linked_output.auto_startup(output['auto_startup']) + } + }) + } + if (data.hasOwnProperty("filament_sensor_status")) { data.filament_sensor_status.forEach(function (filament_sensor) { var linked_filament_sensor = ko.utils.arrayFilter(self.rpi_inputs(), function (item) { @@ -401,6 +414,11 @@ $(function () { new_neopixel_color: ko.observable(""), neopixel_count: ko.observable(0), neopixel_brightness: ko.observable(255), + ledstrip_color: ko.observable("rgb(0,0,0)"), + default_ledstrip_color: ko.observable(""), + new_ledstrip_color: ko.observable(""), + ledstrip_gpio_clk: ko.observable(""), + ledstrip_gpio_dat: ko.observable(""), microcontroller_address: ko.observable(0), gcode: ko.observable(""), show_on_navbar: ko.observable(false) @@ -638,6 +656,39 @@ $(function () { } }; + self.handleLedstripColor = function (item) { + var index = item.index_id() ; + var or_tempStr = item.new_ledstrip_color(); + var tempStr = or_tempStr.replace("rgb(", ""); + + var r = parseInt(tempStr.substring(0, tempStr.indexOf(","))); + tempStr = tempStr.slice(tempStr.indexOf(",") + 1); + var g = parseInt(tempStr.substring(0, tempStr.indexOf(","))); + tempStr = tempStr.slice(tempStr.indexOf(",") + 1); + var b = parseInt(tempStr.substring(0, tempStr.indexOf(")"))); + if (r < 0 || r > 255 || g < 0 || g > 255 || b < 0 || b > 255 || isNaN(r) || isNaN(g) || isNaN(b)) { + new PNotify({ + title: "Enclosure", + text: "Color needs to follow the format rgb(value_red,value_green,value_blue)!", + type: "error" + }); + } else { + $.ajax({ + type: "GET", + dataType: "json", + data: { + "index_id": index, + "rgb": or_tempStr + }, + url: self.buildPluginUrl("/setLedstripColor"), + success: function (data) { + item.new_ledstrip_color(""); + self.getUpdateUI(); + } + }); + } + }; + self.isNumeric = function (n) { return !isNaN(parseFloat(n)) && isFinite(n); }; diff --git a/octoprint_enclosure/templates/enclosure_settings.jinja2 b/octoprint_enclosure/templates/enclosure_settings.jinja2 index 5bc31d6..29bdc5f 100644 --- a/octoprint_enclosure/templates/enclosure_settings.jinja2 +++ b/octoprint_enclosure/templates/enclosure_settings.jinja2 @@ -35,6 +35,12 @@ +
+ +
- +
@@ -95,8 +101,9 @@ - Attention Neopixel requires a microcontroler (ex: arduino) connected to I2C bus. This is the pin on the - microcontroler that is connected to the Neopixel. + Attention Neopixel requires a microcontroller (ex: arduino) + connected to I2C bus. This is the pin on the + microcontroller that is connected to the Neopixel.
@@ -110,7 +117,7 @@ {{ _('Link PWM to Temperature') }} Link PWM ouput to temperature. PWM output will be interpolated between the point from duty A, temperature A -> duty - B, temperature B. This output will automatomatically start when a print starts and will default to the default + B, temperature B. This output will automatically start when a print starts and will default to the default duty cycle when print is complete.
@@ -150,7 +157,7 @@ - Toggle output every amount of secconds. It will start when the print starts and stop when print is complete. For + Toggle output every amount of seconds. It will start when the print starts and stop when print is complete. For PWM pins it will use the default PWM value when ON. @@ -160,7 +167,7 @@
- Time in secconds that the GPIO will remain ON + Time in seconds that the GPIO will remain ON
@@ -175,14 +182,14 @@ - +
- Choose if output should turn on automatomatically when octoprint starts + Choose if output should turn on automatically when octoprint starts
@@ -190,7 +197,7 @@ - Choose if output should turn on automatomatically when print starts + Choose if output should turn on automatically when print starts
@@ -200,7 +207,7 @@
- Time delay in secconds to turn on GPIO when print starts OR exact time that the event should happen, note that + Time delay in seconds to turn on GPIO when print starts OR exact time that the event should happen, note that events will only be scheduled after a print starts, time should be formated as HH:MM on a 24 hours format, don't forget to check timezone of your Raspberry Pi.
@@ -208,7 +215,7 @@ - +
- +
- +
+ @@ -399,11 +407,32 @@
- Microcontroller address in HEX value, you can find it by runing + Microcontroller address in HEX value, you can find it by running i2cdetect -y 1 on your Raspberry Pi
+ +
+ +
+ + Choose any GPIO pin to provide the Clock signal +
+ +
+ + Choose any GPIO pin to provide the Data +
+
+
+ +
+ + Value needs to follow the format rgb(value_red,value_green,value_blue) where values should be between 0 and 255 +
+
+
@@ -508,6 +537,8 @@ + + Attention You need to install and configure the necessary libraries for the temperature sensor, check @@ -532,7 +563,7 @@
- +
@@ -546,12 +577,35 @@
- Sensor address in HEX value, you can find it by runing + Sensor address in HEX value, you can find it by running i2cdetect -y 1 on your Raspberry Pi
- + +
+ +
+ + GPIO pin for temperature sensor need to connect the sensor to SPI. Serial Clock to GPIO 1 (SCLK) and Master In/Slave Out Data to GPIO + 9 (MISO) + +
+
+
+ +
+ + CE select: CE0 on GPIO 8 or CE1 on GPIO 7 +
+
+ + +
@@ -584,14 +638,14 @@ Info: PRINTER actions when a condition is met, that can be a filament sensor, button, etc. Actions can be Pause \ Resume \ Cancel a printer_control job, change the filament or disable Temperature Control. You can use the "change filament" action and set up the input GPIO acording to your sensor, for example, if your filament - sensor conects to ground when detects the end of the filament, you should choose PULL UP resistors and detect + sensor connects to ground when detects the end of the filament, you should choose PULL UP resistors and detect the event on the falling edge. Info: Action will control GPIO outputs when a condition is met, for example detect a press of a button. You can use this to control any previous configured OUTPUTS, basically beeing able to control your lights / fan - / pritner using mechanical buttons buttons instead of the octoprint interface. You can only control REGULAR outputs. + / printer using mechanical buttons buttons instead of the octoprint interface. You can only control REGULAR outputs.
@@ -606,7 +660,7 @@ Input GPIO that will detect the event that should trigger the action. For example if you have a filament sensor you put the GPIO pin that the sensor is connected. This can also be a press of a button or any other signal that - you want to detect. You can not use GPIO 4 here if you are using temeprature sensor DS18B20 + you want to detect. You can not use GPIO 4 here if you are using temperature sensor DS18B20
diff --git a/octoprint_enclosure/templates/enclosure_tab.jinja2 b/octoprint_enclosure/templates/enclosure_tab.jinja2 index 474041f..9b4feba 100644 --- a/octoprint_enclosure/templates/enclosure_tab.jinja2 +++ b/octoprint_enclosure/templates/enclosure_tab.jinja2 @@ -160,6 +160,19 @@
+ +

+ + ledstrip +

+
+ + +
+ +

@@ -237,7 +250,7 @@ - +
diff --git a/setup.py b/setup.py index f081eb9..71166b0 100644 --- a/setup.py +++ b/setup.py @@ -14,7 +14,7 @@ plugin_package = "octoprint_enclosure" plugin_name = "OctoPrint-Enclosure" # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module -plugin_version = "4.11" +plugin_version = "4.13" # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin # module @@ -33,7 +33,7 @@ plugin_url = "https://github.com/vitormhenrique/OctoPrint-Enclosure" plugin_license = "AGPLv3" # Any additional requirements besides OctoPrint should be listed here -plugin_requires = ["RPi.GPIO>=0.6","requests>=2.7"] +plugin_requires = ["RPi.GPIO>=0.6.5","requests>=2.7"] additional_setup_parameters = {}