Restructure the modules splitting them out for reuse

README.md

@@ -19,18 +19,13 @@ A device contains a protocol, and can utilise modules
 
 1. Fix: Bug: The script startup gets an incorrect time (Hasn't yet got the internet time)
 2. Instructions on pinout
-
-# TODO: General Integration test for the logger using a fake module
-
-# TODO: Test default endpoint address settings work in theory, because the test above overrides them
-
-# TODO: Device startup and shutdown needs a unit test
-
-# TOOD: Temp probe should be a fixture
-
-# TOOD: CPU temp probe should be a fixture
-
-# TODO: Split the RPI and custom temp module, they will be standalone modules, New RPI module with it's own CPU temp component
+3. Tests for the utils and base protocol
+4. Extend Baseprotocol with a reusable run method
+5. General Integration test for the logger using a fake module
+6. Test default endpoint address settings work in theory, because the test above overrides them
+7. Device startup and shutdown needs a unit test
+8. Temp probe should be a fixture
+9. CPU temp probe should be a fixture
 
 ### Wish list:
 

shedpi_hub_dashboard/tests/integration/test_module_reading_submission.py

@@ -11,12 +11,12 @@
 from standalone_modules.shed_pi_module_utils.data_submission import (
     ReadingSubmissionService,
 )
-from standalone_modules.temperature_module.temp_logger import (
+from standalone_modules.temperature_module.temperature_probe import (
     TempProbe,
 )
 
 
-@patch("standalone_modules.temperature_module.temp_logger.Path")
+@patch("standalone_modules.temperature_module.temperature_probe.Path")
 @pytest.mark.django_db
 def test_temperature_module_reading_submission(mocked_path, live_server):
     schema = {

standalone_modules/rpi/device_protocol.py

@@ -0,0 +1,55 @@
+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 (
+    ReadingSubmissionService,
+)
+from standalone_modules.shed_pi_module_utils.utils import check_arch_is_arm, logger
+
+TIME_TO_SLEEP = 60  # time in seconds
+
+
+class DeviceProtocol(BaseProtocol):
+    def __init__(self, submission_service: ReadingSubmissionService):
+        # Installed modules
+        self.rpi_device = RPIDevice(
+            submission_service=submission_service,
+            device_module_id=None,
+            cpu_module_id=None,
+        )
+        self.submission_delay = TIME_TO_SLEEP
+
+    def stop(self):
+        return False
+
+    def startup(self):
+        self.rpi_device.submit_device_startup()
+
+    def run(self):
+        while not self.stop():
+            self.rpi_device.submit_reading()
+
+            time.sleep(self.submission_delay)
+
+    def shutdown(self):
+        self.rpi_device.submit_device_shutdown()
+
+
+def main():
+    if not check_arch_is_arm():
+        logger.error("only rasbian os supported")
+        return
+
+    submission_service = ReadingSubmissionService()
+    device = DeviceProtocol(submission_service=submission_service)
+
+    try:
+        device.startup()
+        device.run()
+    finally:
+        device.shutdown()
+
+
+if __name__ == "__main__":
+    main()

standalone_modules/rpi/tests/unit/test_device_protocol.py

@@ -0,0 +1,44 @@
+from unittest.mock import Mock
+
+import pytest
+
+from shedpi_hub_dashboard.models import DeviceModuleReading
+from shedpi_hub_dashboard.tests.utils.factories import (
+    DeviceModuleFactory,
+)
+from standalone_modules.rpi.device_protocol import (
+    DeviceProtocol,
+)
+from standalone_modules.shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
+
+
+@pytest.mark.django_db
+def test_device_protocol(live_server):
+    # Submission service
+    submission_service = ReadingSubmissionService()
+    submission_service.base_url = live_server.url
+    # Device Protocol
+    device_protocol = DeviceProtocol(submission_service=submission_service)
+    # Override the loop timer for the test to end instantly
+    device_protocol.submission_delay = 0
+    device_protocol.stop = Mock(side_effect=[False, True])
+    # RPI CPU temp probe
+    rpi_schema = {
+        "$id": "https://example.com/person.schema.json",
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "title": "Reading",
+        "type": "object",
+        "properties": {
+            "temperature": {"type": "string", "description": "The Temperature"},
+        },
+    }
+    rpi_cpu_temp = DeviceModuleFactory(schema=rpi_schema)
+    device_protocol.rpi_device.device_module_id = rpi_cpu_temp.id
+    device_protocol.rpi_device.get_cpu_temp = Mock(return_value=10.0)
+
+    device_protocol.run()
+
+    # Check that the data was submitted
+    assert DeviceModuleReading.objects.filter(device_module=rpi_cpu_temp).count() == 1

standalone_modules/shed_pi_example_device_installation/device_protocol.py

@@ -0,0 +1,59 @@
+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 (
+    ReadingSubmissionService,
+)
+from standalone_modules.shed_pi_module_utils.utils import check_arch_is_arm, logger
+from standalone_modules.temperature_module.temperature_probe import TempProbe
+
+TIME_TO_SLEEP = 60  # time in seconds
+
+
+class DeviceProtocol(BaseProtocol):
+    def __init__(self, submission_service: ReadingSubmissionService):
+        # Installed modules
+        self.temp_probe = TempProbe(submission_service=submission_service)
+        self.rpi_device = RPIDevice(
+            submission_service=submission_service,
+            device_module_id=None,
+            cpu_module_id=None,
+        )
+        self.submission_delay = TIME_TO_SLEEP
+
+    def stop(self):
+        return False
+
+    def startup(self):
+        self.rpi_device.submit_device_startup()
+
+    def run(self):
+        while not self.stop():
+            # TODO: Would be nice to be able to bundle multiple calls into 1, less of an issue initially
+            self.temp_probe.submit_reading()
+            self.rpi_device.submit_reading()
+
+            time.sleep(self.submission_delay)
+
+    def shutdown(self):
+        self.rpi_device.submit_device_shutdown()
+
+
+def main():
+    if not check_arch_is_arm():
+        logger.error("only rasbian os supported")
+        return
+
+    submission_service = ReadingSubmissionService()
+    device = DeviceProtocol(submission_service=submission_service)
+
+    try:
+        device.startup()
+        device.run()
+    finally:
+        device.shutdown()
+
+
+if __name__ == "__main__":
+    main()

standalone_modules/shed_pi_example_device_installation/tests/unit/test_device_protocol.py

@@ -0,0 +1,64 @@
+from unittest.mock import Mock, patch
+
+import pytest
+
+from shedpi_hub_dashboard.models import DeviceModuleReading
+from shedpi_hub_dashboard.tests.utils.factories import (
+    DeviceModuleFactory,
+)
+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")
+@pytest.mark.django_db
+def test_device_protocol(mocked_path, live_server):
+    # Submission service
+    submission_service = ReadingSubmissionService()
+    submission_service.base_url = live_server.url
+    # Device Protocol
+    device_protocol = DeviceProtocol(submission_service=submission_service)
+    # Override the loop timer for the test to end instantly
+    device_protocol.submission_delay = 0
+    device_protocol.stop = Mock(side_effect=[False, True])
+    # Temp probe
+    schema = {
+        "$id": "https://example.com/person.schema.json",
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "title": "Reading",
+        "type": "object",
+        "properties": {
+            "temperature": {"type": "string", "description": "The Temperature"},
+        },
+    }
+    temp_probe = DeviceModuleFactory(schema=schema)
+    device_protocol.temp_probe.device_id = temp_probe.id
+    device_protocol.temp_probe.read_temp_raw = Mock(
+        return_value=[
+            "YES",
+            "t=12345",
+        ]
+    )
+    # RPI CPU temp probe
+    rpi_schema = {
+        "$id": "https://example.com/person.schema.json",
+        "$schema": "https://json-schema.org/draft/2020-12/schema",
+        "title": "Reading",
+        "type": "object",
+        "properties": {
+            "temperature": {"type": "string", "description": "The Temperature"},
+        },
+    }
+    rpi_cpu_temp = DeviceModuleFactory(schema=rpi_schema)
+    device_protocol.rpi_device.device_module_id = rpi_cpu_temp.id
+    device_protocol.rpi_device.get_cpu_temp = Mock(return_value=10.0)
+
+    device_protocol.run()
+
+    # Check that the data was submitted
+    assert DeviceModuleReading.objects.filter(device_module=rpi_cpu_temp).count() == 1
+    assert DeviceModuleReading.objects.filter(device_module=temp_probe).count() == 1

standalone_modules/shed_pi_module_utils/base_protocol.py

@@ -0,0 +1,20 @@
+from standalone_modules.shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
+
+
+class BaseProtocol:
+    def __init__(self, submission_service: ReadingSubmissionService):
+        self.submission_service = submission_service
+
+    def stop(self):
+        ...
+
+    def startup(self):
+        ...
+
+    def run(self):
+        raise NotImplementedError
+
+    def shutdown(self):
+        ...

standalone_modules/shed_pi_module_utils/utils.py

@@ -1,3 +1,4 @@
+import logging
 import os
 from datetime import datetime, timezone
 
@@ -15,3 +16,11 @@ def get_time():
     now = datetime.now(timezone.utc)
     current_time = now.strftime("%H:%M:%S")  # 24-Hour:Minute:Second
     return current_time
+
+
+logging.basicConfig(
+    filename="/var/log/shed-pi.log",
+    level=logging.INFO,
+    format="%(asctime)s:%(levelname)s:%(name)s:%(message)s",
+)
+logger = logging.getLogger("parent")

standalone_modules/temperature_module/device_protocol.py

@@ -0,0 +1,45 @@
+import time
+
+from standalone_modules.shed_pi_module_utils.base_protocol import BaseProtocol
+from standalone_modules.shed_pi_module_utils.data_submission import (
+    ReadingSubmissionService,
+)
+from standalone_modules.shed_pi_module_utils.utils import check_arch_is_arm, logger
+from standalone_modules.temperature_module.temperature_probe import TempProbe
+
+TIME_TO_SLEEP = 60  # time in seconds
+
+
+class DeviceProtocol(BaseProtocol):
+    def __init__(self, submission_service: ReadingSubmissionService):
+        # Installed modules
+        self.temp_probe = TempProbe(submission_service=submission_service)
+        self.submission_delay = TIME_TO_SLEEP
+
+    def stop(self):
+        return False
+
+    def run(self):
+        while not self.stop():
+            self.temp_probe.submit_reading()
+
+            time.sleep(self.submission_delay)
+
+
+def main():
+    if not check_arch_is_arm():
+        logger.error("only rasbian os supported")
+        return
+
+    submission_service = ReadingSubmissionService()
+    device = DeviceProtocol(submission_service=submission_service)
+
+    try:
+        device.startup()
+        device.run()
+    finally:
+        device.shutdown()
+
+
+if __name__ == "__main__":
+    main()