pioled-display-plugin 0.3.0__tar.gz

pioled_display_plugin-0.3.0/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright Pioreactor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pioled_display_plugin-0.3.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include pioled_display_plugin/post_install.sh
+include pioled_display_plugin/pre_uninstall.sh

pioled_display_plugin-0.3.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: pioled-display-plugin
+Version: 0.3.0
+Summary: Use an OLED display with your Pioreactor
+Home-page: https://github.com/Pioreactor/PiOLED-display-plugin
+Author: Pioreactor
+Author-email: hello@pioreactor.com
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: adafruit-circuitpython-ssd1306==2.12.16
+Requires-Dist: Pillow==10.1.0
+
+## PiOLED display plugin for the Pioreactor
+
+Display growth rate, normalized OD, and temperature for each Pioreactor using the [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+
+
+### Hardware required
+
+ - [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+ - [0.1" 2x20-pin Strip Right Angle Female Header](https://www.adafruit.com/product/2823)
+
+
+### Software installation
+
+Install from the UI, or run:
+```
+pio plugins install pioled-display-plugin
+```
+
+You may get a "hardware not installed" error. That's okay, we'll do that next.
+
+### Hardware installation
+
+With the Pioreactor turned off (you can pull the plug), install the 2x20 right-angle header onto the the 2x20 header on the Pioreactor HAT. Attach the PiOLED display onto the right-hand side of the new header, with the orientation as shown in the image below:
+
+<img width="462" alt="Screenshot 2023-06-21 at 2 40 14 PM" alt="PiOLD attached to the right-angle headers." src="https://github.com/Pioreactor/PiOLED-display-plugin/assets/884032/3b3096d0-4cfa-4a74-8ff1-36cff2fb4d99">
+
+Power back on the Pioreactor.

pioled_display_plugin-0.3.0/README.md

@@ -0,0 +1,27 @@
+## PiOLED display plugin for the Pioreactor
+
+Display growth rate, normalized OD, and temperature for each Pioreactor using the [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+
+
+### Hardware required
+
+ - [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+ - [0.1" 2x20-pin Strip Right Angle Female Header](https://www.adafruit.com/product/2823)
+
+
+### Software installation
+
+Install from the UI, or run:
+```
+pio plugins install pioled-display-plugin
+```
+
+You may get a "hardware not installed" error. That's okay, we'll do that next.
+
+### Hardware installation
+
+With the Pioreactor turned off (you can pull the plug), install the 2x20 right-angle header onto the the 2x20 header on the Pioreactor HAT. Attach the PiOLED display onto the right-hand side of the new header, with the orientation as shown in the image below:
+
+<img width="462" alt="Screenshot 2023-06-21 at 2 40 14 PM" alt="PiOLD attached to the right-angle headers." src="https://github.com/Pioreactor/PiOLED-display-plugin/assets/884032/3b3096d0-4cfa-4a74-8ff1-36cff2fb4d99">
+
+Power back on the Pioreactor.

pioled_display_plugin-0.3.0/pioled_display_plugin/__init__.py

@@ -0,0 +1,177 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+from typing import Optional
+
+import adafruit_ssd1306
+import busio
+import click
+from msgspec.json import decode
+from PIL import Image
+from PIL import ImageDraw
+from PIL import ImageFont
+from pioreactor import structs
+from pioreactor import types as pt
+from pioreactor.background_jobs.base import BackgroundJobContrib
+from pioreactor.cli.pio import JOBS_TO_SKIP_KILLING
+from pioreactor.hardware import SCL
+from pioreactor.hardware import SDA
+from pioreactor.utils.networking import get_ip
+from pioreactor.whoami import get_unit_name
+from pioreactor.whoami import UNIVERSAL_EXPERIMENT
+
+# since this is a long-running job, we don't want it to be killed by pio kill --all-jobs.
+
+JOBS_TO_SKIP_KILLING.append("pioled_display")
+
+
+class PiOLEDDisplay(BackgroundJobContrib):
+
+    job_name = "pioled_display"
+
+    growth_rate: Optional[float] = None
+    od: Optional[float] = None
+    temp: Optional[float] = None
+
+    def __init__(self, unit: str, experiment: str) -> None:
+        super().__init__(unit=unit, experiment=experiment, plugin_name="pioled_display_plugin")
+
+        # Create the I2C interface.
+        i2c = busio.I2C(SCL, SDA)
+
+        try:
+            self.disp = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c)
+        except Exception as e:
+            self.logger.error("Unable to find PiOLED hardware. Is it attached?")
+            self.clean_up()
+            raise e
+
+        # get ip for displaying
+        self._ip = get_ip()
+
+        # rotate the screen since we are flipping it
+        self.disp.rotation = 2
+
+        # Clear display.
+        self.disp.fill(0)
+        self.disp.show()
+
+        # Create blank image for drawing.
+        # Make sure to create image with mode '1' for 1-bit color.
+        self.width = self.disp.width
+        self.height = self.disp.height
+        self.image = Image.new("1", (self.width, self.height))
+
+        # Get drawing object to draw on image.
+        self.draw = ImageDraw.Draw(self.image)
+
+        # Draw some shapes.
+        # First define some constants to allow easy resizing of shapes.
+        padding = -2
+        self.top = padding
+        self.bottom = self.height - padding
+        # Move left to right keeping track of the current x position for drawing shapes.
+        self.x = 0
+
+        # Load default font.
+        self.font = ImageFont.load_default()
+
+        self.update_display()
+        self.start_passive_listeners()
+
+    def update_od(self, msg: pt.MQTTMessage) -> None:
+        if msg.payload:
+            self.od = decode(msg.payload, type=structs.ODFiltered).od_filtered
+        else:
+            self.od = None
+        self.update_display()
+
+    def update_growth_rate(self, msg: pt.MQTTMessage) -> None:
+        if msg.payload:
+            self.growth_rate = decode(msg.payload, type=structs.GrowthRate).growth_rate
+        else:
+            self.growth_rate = None
+        self.update_display()
+
+    def update_temp(self, msg: pt.MQTTMessage) -> None:
+        if msg.payload:
+            self.temp = decode(msg.payload, type=structs.Temperature).temperature
+        else:
+            self.temp = None
+        self.update_display()
+
+    def start_passive_listeners(self) -> None:
+        self.subscribe_and_callback(
+            self.update_od,
+            f"pioreactor/{self.unit}/+/growth_rate_calculating/od_filtered",
+            allow_retained=False,
+        )
+        self.subscribe_and_callback(
+            self.update_growth_rate,
+            f"pioreactor/{self.unit}/+/growth_rate_calculating/growth_rate",
+            allow_retained=False,
+        )
+        self.subscribe_and_callback(
+            self.update_temp,
+            f"pioreactor/{self.unit}/+/temperature_automation/temperature",
+            allow_retained=False,
+        )
+
+    def clear_display(self) -> None:
+        self.draw.rectangle((0, 0, self.width, self.height), outline=0, fill=0)
+        self.disp.image(self.image)
+        self.disp.show()
+
+    def on_disconnected(self) -> None:
+        try:
+            self.clear_display()
+        except Exception:
+            pass
+
+    def update_display(self) -> None:
+        # Draw a black filled box to clear the image.
+        self.draw.rectangle((0, 0, self.width, self.height), outline=0, fill=0)
+        # Write four lines of text.
+        self.draw.text((self.x, self.top + 0), self.unit, font=self.font, fill=255)
+        if self.growth_rate:
+            self.draw.text(
+                (self.x, self.top + 8),
+                f" Growth rate: {self.growth_rate:.2f}/h",
+                font=self.font,
+                fill=255,
+            )
+        if self.od:
+            self.draw.text(
+                (self.x, self.top + 16),
+                f" nOD:         {self.od:.2f} AU",
+                font=self.font,
+                fill=255,
+            )
+        if self.temp:
+            self.draw.text(
+                (self.x, self.top + 25),
+                f" Temperature: {self.temp:.1f} C",
+                font=self.font,
+                fill=255,
+            )
+
+        if not self.temp and not self.od and not self.growth_rate:
+            self.draw.text(
+                (self.x, self.top + 8),
+                f" IP: {self._ip}",
+                font=self.font,
+                fill=255,
+            )
+
+        # Display image.
+        self.disp.image(self.image)
+        self.disp.show()
+
+
+@click.command(name="pioled_display")
+def click_pioled_display() -> None:
+    """
+    Turn on the OLED display
+    """
+    lg = PiOLEDDisplay(unit=get_unit_name(), experiment=UNIVERSAL_EXPERIMENT)
+    lg.block_until_disconnected()

pioled_display_plugin-0.3.0/pioled_display_plugin/post_install.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -x
+set -e
+
+export LC_ALL=C
+
+sudo systemctl start pioreactor_startup_run@pioled_display.service
+sudo systemctl enable pioreactor_startup_run@pioled_display.service

pioled_display_plugin-0.3.0/pioled_display_plugin/pre_uninstall.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -x
+set -e
+
+export LC_ALL=C
+
+sudo systemctl stop pioreactor_startup_run@pioled_display.service
+sudo systemctl disable pioreactor_startup_run@pioled_display.service

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.1
+Name: pioled-display-plugin
+Version: 0.3.0
+Summary: Use an OLED display with your Pioreactor
+Home-page: https://github.com/Pioreactor/PiOLED-display-plugin
+Author: Pioreactor
+Author-email: hello@pioreactor.com
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: adafruit-circuitpython-ssd1306==2.12.16
+Requires-Dist: Pillow==10.1.0
+
+## PiOLED display plugin for the Pioreactor
+
+Display growth rate, normalized OD, and temperature for each Pioreactor using the [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+
+
+### Hardware required
+
+ - [Adafruit PiOLED display](https://www.adafruit.com/product/3527)
+ - [0.1" 2x20-pin Strip Right Angle Female Header](https://www.adafruit.com/product/2823)
+
+
+### Software installation
+
+Install from the UI, or run:
+```
+pio plugins install pioled-display-plugin
+```
+
+You may get a "hardware not installed" error. That's okay, we'll do that next.
+
+### Hardware installation
+
+With the Pioreactor turned off (you can pull the plug), install the 2x20 right-angle header onto the the 2x20 header on the Pioreactor HAT. Attach the PiOLED display onto the right-hand side of the new header, with the orientation as shown in the image below:
+
+<img width="462" alt="Screenshot 2023-06-21 at 2 40 14 PM" alt="PiOLD attached to the right-angle headers." src="https://github.com/Pioreactor/PiOLED-display-plugin/assets/884032/3b3096d0-4cfa-4a74-8ff1-36cff2fb4d99">
+
+Power back on the Pioreactor.

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE.txt
+MANIFEST.in
+README.md
+setup.py
+pioled_display_plugin/__init__.py
+pioled_display_plugin/post_install.sh
+pioled_display_plugin/pre_uninstall.sh
+pioled_display_plugin.egg-info/PKG-INFO
+pioled_display_plugin.egg-info/SOURCES.txt
+pioled_display_plugin.egg-info/dependency_links.txt
+pioled_display_plugin.egg-info/entry_points.txt
+pioled_display_plugin.egg-info/requires.txt
+pioled_display_plugin.egg-info/top_level.txt

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pioreactor.plugins]
+pioled_display_plugin = pioled_display_plugin

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/requires.txt

@@ -0,0 +1,2 @@
+adafruit-circuitpython-ssd1306==2.12.16
+Pillow==10.1.0

pioled_display_plugin-0.3.0/pioled_display_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+pioled_display_plugin

pioled_display_plugin-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pioled_display_plugin-0.3.0/setup.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+from setuptools import find_packages
+from setuptools import setup
+
+setup(
+    name="pioled-display-plugin",
+    version="0.3.0",
+    license_files=("LICENSE.txt",),
+    description="Use an OLED display with your Pioreactor",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author_email="hello@pioreactor.com",
+    author="Pioreactor",
+    url="https://github.com/Pioreactor/PiOLED-display-plugin",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=["adafruit-circuitpython-ssd1306==2.12.16", "Pillow==10.1.0"],
+    entry_points={"pioreactor.plugins": "pioled_display_plugin = pioled_display_plugin"},
+)