Reconstruct the modules into installable modules

shedpi_hub_dashboard/tests/integration/test_module_reading_submission.py

@@ -3,16 +3,16 @@
 
 import pytest
 from rest_framework import status
-
-from shedpi_components.temperature_probe import (
-    TempProbe,
+from shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
 )
+
 from shedpi_hub_dashboard.models import DeviceModuleReading
 from shedpi_hub_dashboard.tests.utils.factories import (
     DeviceModuleFactory,
 )
-from standalone_modules.shed_pi_module_utils.data_submission import (
-    ReadingSubmissionService,
+from shedpi_module_utils.shedpi_components.ds18b20 import (
+    TempProbe,
 )
 
 

shedpi_module_utils/pyproject.toml

@@ -0,0 +1,14 @@
+[tool.poetry]
+name = "shedpi-module-utils"
+version = "0.1.0"
+description = ""
+authors = ["Andrew Aikman <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

shedpi_components/temperature_probe.py → shedpi_module_utils/shedpi_components/ds18b20.py

@@ -3,8 +3,7 @@
 from typing import Optional
 
 import requests
-
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
 

standalone_modules/shed_pi_module_utils/base_protocol.py → shedpi_module_utils/shedpi_module_utils/base_protocol.py

@@ -1,4 +1,4 @@
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
 

standalone_modules/shed_pi_module_utils/tests/integration/test_module_data_submission.py → shedpi_module_utils/tests/integration/test_module_data_submission.py

@@ -2,15 +2,15 @@
 
 import pytest
 from rest_framework import status
+from shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
+from shed_pi_module_utils.tests.utils import FakeModule
 
 from shedpi_hub_dashboard.models import DeviceModuleReading
 from shedpi_hub_dashboard.tests.utils.factories import (
     DeviceModuleFactory,
 )
-from standalone_modules.shed_pi_module_utils.data_submission import (
-    ReadingSubmissionService,
-)
-from standalone_modules.shed_pi_module_utils.tests.utils import FakeModule
 
 
 @pytest.mark.django_db

standalone_modules/shed_pi_module_utils/tests/utils.py → shedpi_module_utils/tests/utils.py

@@ -1,6 +1,5 @@
 import requests
-
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
 

standalone_modules/_template_module/device_protocol.py

@@ -1,8 +1,8 @@
-from standalone_modules.shed_pi_module_utils.base_protocol import BaseProtocol
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils import BaseProtocol
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
-from standalone_modules.shed_pi_module_utils.utils import logger
+from shed_pi_module_utils.utils import logger
 
 
 class DeviceProtocol(BaseProtocol):

standalone_modules/rpi/device.py

@@ -2,11 +2,10 @@
 import os
 
 import requests
-
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
-from standalone_modules.shed_pi_module_utils.utils import get_time
+from shed_pi_module_utils.utils import get_time
 
 logger = logging.getLogger(__name__)
 

standalone_modules/rpi/device_protocol.py

@@ -1,11 +1,12 @@
 import time
 
-from standalone_modules.rpi.device import RPIDevice
-from standalone_modules.shed_pi_module_utils.base_protocol import BaseProtocol
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils import BaseProtocol
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
-from standalone_modules.shed_pi_module_utils.utils import check_arch_is_arm, logger
+from shed_pi_module_utils.utils import check_arch_is_arm, logger
+
+from standalone_modules.rpi.device import RPIDevice
 
 TIME_TO_SLEEP = 60  # time in seconds
 

standalone_modules/rpi/tests/unit/test_device_protocol.py

@@ -1,6 +1,9 @@
 from unittest.mock import Mock
 
 import pytest
+from shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
 
 from shedpi_hub_dashboard.models import DeviceModuleReading
 from shedpi_hub_dashboard.tests.utils.factories import (
@@ -9,9 +12,6 @@
 from standalone_modules.rpi.device_protocol import (
     DeviceProtocol,
 )
-from standalone_modules.shed_pi_module_utils.data_submission import (
-    ReadingSubmissionService,
-)
 
 
 @pytest.mark.django_db

standalone_modules/shed_pi_example_device_installation/device_protocol.py

@@ -1,12 +1,13 @@
 import time
 
-from shedpi_components.temperature_probe import TempProbe
-from standalone_modules.rpi.device import RPIDevice
-from standalone_modules.shed_pi_module_utils.base_protocol import BaseProtocol
-from standalone_modules.shed_pi_module_utils.data_submission import (
+from shed_pi_module_utils import BaseProtocol
+from shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
-from standalone_modules.shed_pi_module_utils.utils import check_arch_is_arm, logger
+from shed_pi_module_utils.utils import check_arch_is_arm, logger
+
+from shedpi_module_utils.shedpi_components.ds18b20 import TempProbe
+from standalone_modules.rpi.device import RPIDevice
 
 TIME_TO_SLEEP = 60  # time in seconds
 

standalone_modules/shed_pi_example_device_installation/tests/unit/test_device_protocol.py

@@ -1,6 +1,9 @@
 from unittest.mock import Mock, patch
 
 import pytest
+from shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
 
 from shedpi_hub_dashboard.models import DeviceModuleReading
 from shedpi_hub_dashboard.tests.utils.factories import (
@@ -9,9 +12,6 @@
 from standalone_modules.shed_pi_example_device_installation.device_protocol import (
     DeviceProtocol,
 )
-from standalone_modules.shed_pi_module_utils.data_submission import (
-    ReadingSubmissionService,
-)
 
 
 @patch("standalone_modules.temperature_module.temperature_probe.Path")

standalone_modules/shedpi_module_am2320/README.md

@@ -0,0 +1,19 @@
+# AM2320 temperature and humidity module
+
+Read more at https://learn.adafruit.com/adafruit-am2320-temperature-humidity-i2c-sensor_
+
+## Hardware installation
+
+AM2320 pinout to Raspberry Pi 4B GPIO pins
+
+AM2320 - Type - RPI pin
+Pin 1 - 3.3v - Pin 1
+Pin 2 - SDA - GPIO (SDA) Pin 3
+Pin 3 - gnd - Pin 6
+Pin 4 - SCL - GPIO (SCL) pin 5
+
+## Software instalation
+
+```
+poetry add adafruit-circuitpython-am2320
+```

standalone_modules/shedpi_module_am2320/pyproject.toml

@@ -0,0 +1,14 @@
+[tool.poetry]
+name = "shedpi-module-am2320"
+version = "0.1.0"
+description = ""
+authors = ["Andrew Aikman <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

standalone_modules/shedpi_module_am2320/shedpi_module_am2320/device_protocol.py

@@ -0,0 +1,45 @@
+import time
+
+import adafruit_am2320
+import board
+from shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
+from shed_pi_module_utils.utils import logger
+
+# create the I2C shared bus
+i2c = board.I2C()  # uses board.SCL and board.SDA
+# i2c = board.STEMMA_I2C()  # For using the built-in STEMMA QT connector on a microcontroller
+am = adafruit_am2320.AM2320(i2c)
+
+while True:
+    print("Temperature: ", am.temperature)
+    print("Humidity: ", am.relative_humidity)
+    time.sleep(2)
+
+
+class DeviceProtocol(BaseProtocol):
+    def __init__(self, submission_service: ReadingSubmissionService):
+        ...
+
+    def stop(self):
+        logger.info("Stopping device protocol")
+
+    def start(self):
+        logger.info("Starting device protocol")
+
+
+def main():
+    # The Submission service is used to record any module data
+    submission_service = ReadingSubmissionService()
+    device = DeviceProtocol(submission_service=submission_service)
+
+    try:
+        device.startup()
+        device.start()
+    finally:
+        device.shutdown()
+
+
+if __name__ == "__main__":
+    main()

shedpi_components/AM2302/tests/unit/test_probe.py → standalone_modules/shedpi_module_am2320/tests/unit/test_probe.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from shedpi_components.AM2302 import AM2320
+from shedpi_module_utils.shedpi_components import AM2320
 
 
 @patch("shedpi_components.AM2302.posix")
@@ -28,4 +28,4 @@ def test_probe_reading_happy_path(mocked_posix, mocked_ioctl):
     # )
 
     mocked_posix.read = Mock(return_value="0000000")
-    reading = probe.read_sensor()
+    probe.read_sensor()