[P] Add container logs printout on crash

[L4] SCRUM-81: implementation data processing function

MapView/datasource.py

@@ -72,8 +72,8 @@ class Datasource:
         )
         new_points = [
             (
-                processed_agent_data.latitude,
                 processed_agent_data.longitude,
+                processed_agent_data.latitude,
                 processed_agent_data.road_state,
                 processed_agent_data.user_id
             )

MapView/domain/accelerometer.py

@@ -2,6 +2,6 @@ from dataclasses import dataclass
 
 @dataclass
 class Accelerometer:
-  x: int
-  y: int
-  z: int
+  x: float
+  y: float
+  z: float

MapView/main.py

@@ -32,7 +32,7 @@ class MapViewApp(App):
         Встановлює необхідні маркери, викликає функцію для оновлення мапи
         """
         self.update()
-        Clock.schedule_interval(self.update, 5)
+        Clock.schedule_interval(self.update, 0.1)
 
     def update(self, *args):
         """
@@ -87,7 +87,8 @@ class MapViewApp(App):
             self.car_markers[user_id].lat = lat
             self.car_markers[user_id].lon = lon
 
-        self.mapview.center_on(lat, lon)
+        if user_id == 1:
+            self.mapview.center_on(lat, lon)
 
     def set_pothole_marker(self, point):
         if isinstance(point, dict):

agent/src/config.py

@@ -8,7 +8,7 @@ def try_parse(type, value: str):
         return None
 
 
-USER_ID = 1
+USER_ID = try_parse(int, os.environ.get("USER_ID")) or 1
 # MQTT config
 MQTT_BROKER_HOST = os.environ.get("MQTT_BROKER_HOST") or "mqtt"
 MQTT_BROKER_PORT = try_parse(int, os.environ.get("MQTT_BROKER_PORT")) or 1883

agent/src/domain/accelerometer.py

@@ -3,6 +3,6 @@ from dataclasses import dataclass
 
 @dataclass
 class Accelerometer:
-    x: int
-    y: int
-    z: int
+    x: float
+    y: float
+    z: float

agent/src/file_datasource.py

@@ -15,6 +15,7 @@ class FileDatasource:
 
     def __init__(
             self,
+            acc_divisor: float,
             accelerometer_filename: str,
             gps_filename: str,
             park_filename: str,
@@ -34,6 +35,8 @@ class FileDatasource:
 
         self._started = False
 
+        self.acc_divisor = acc_divisor
+
     def startReading(self, *args, **kwargs):
         """Must be called before read()"""
         if self._started:
@@ -160,15 +163,14 @@ class FileDatasource:
 
             return row
 
-    @staticmethod
-    def _parse_acc(row: List[str]) -> Accelerometer:
+    def _parse_acc(self, row: List[str]) -> Accelerometer:
         if len(row) < 3:
             raise ValueError(f"Accelerometer row must have 3 values (x,y,z). Got: {row}")
 
         try:
-            x = int(row[0])
-            y = int(row[1])
-            z = int(row[2])
+            x = int(row[0]) / self.acc_divisor
+            y = int(row[1]) / self.acc_divisor
+            z = int(row[2]) / self.acc_divisor
         except ValueError as e:
             raise ValueError(f"Invalid accelerometer values (expected integers): {row}") from e
 

agent/src/main.py

@@ -1,6 +1,7 @@
 from paho.mqtt import client as mqtt_client
 from schema.aggregated_data_schema import AggregatedDataSchema
 from file_datasource import FileDatasource
+import logging
 import config
 
 
@@ -15,6 +16,8 @@ def connect_mqtt(broker, port):
             print("Failed to connect {broker}:{port}, return code %d\n", rc)
             exit(rc)  # Stop execution
 
+    logging.info(f"Acting as USER_ID = {config.USER_ID}")
+
     client = mqtt_client.Client()
     client.on_connect = on_connect
     client.connect(broker, port)
@@ -28,16 +31,18 @@ def publish(client, topic, datasource):
         data = datasource.read()
         msg = AggregatedDataSchema().dumps(data)
         result = client.publish(topic, msg)
+        logging.debug(f"Published to {topic}: {msg[:50]}...")
         status = result[0]
         if status != 0:
-            print(f"Failed to send message to topic {topic}")
+            logging.error(f"Failed to send message to topic {topic}")
 
 
 def run():
+    logging.basicConfig(level = logging.INFO)
     # Prepare mqtt client
     client = connect_mqtt(config.MQTT_BROKER_HOST, config.MQTT_BROKER_PORT)
     # Prepare datasource
-    datasource = FileDatasource("data/accelerometer.csv", "data/gps.csv", "data/parking.csv")
+    datasource = FileDatasource(16384.0, "data/accelerometer.csv", "data/gps.csv", "data/parking.csv")
     # Infinity publish data
     publish(client, config.MQTT_TOPIC, datasource)
 

agent/src/schema/accelerometer_schema.py

@@ -2,6 +2,6 @@ from marshmallow import Schema, fields
 
 
 class AccelerometerSchema(Schema):
-    x = fields.Int()
-    y = fields.Int()
-    z = fields.Int()
+    x = fields.Float()
+    y = fields.Float()
+    z = fields.Float()

diagrams/sequence.puml

@@ -1,30 +0,0 @@
-@startuml
-participant Agent as agent
-participant "MQTT Broker (raw\ntopic)" as mqtt1
-participant "Edge Service" as edge
-participant "MQTT\nBroker (processed\ntopic)" as mqtt2
-participant "Hub Service" as hub
-participant "Redis" as redis
-participant "Store API" as store
-participant "PostgreSQL" as db
-participant "MapView Client" as mapview
-
-agent -> mqtt1 : Publish raw\ntelemetry
-mqtt1 -> edge : Deliver raw\nmessage
-edge -> edge : Validate\nAgentData
-edge -> edge : Process\ntelemetry
-edge -> mqtt2 : Publish\nprocessed data
-mqtt2 -> hub : Deliver processed\nmessage
-hub -> hub : Validate\nProcessedAgentData
-hub -> redis : LPUSH to buffer
-hub -> redis : LPOP batch item
-redis -> hub : Return item
-hub -> store : POST batch
-store -> db : INSERT records
-db --> store : Return created\nrecords
-store -> mapview : WebSocket push
-mapview -> mapview : Sort by timestamp
-mapview -> mapview : Update vehicle\nmarker
-mapview -> mapview : Add pothole/bump\nmarker
-store --> hub : Success response
-@enduml

diagrams/use-case.puml

@@ -1,23 +0,0 @@
-@startuml
-rectangle IoT-Systems {
-  usecase "Collect telemetry (accelerometer + GPS)" as uc1
-  usecase "Send telemetry" as uc2
-  usecase "Process telemetry" as uc3
-  usecase "Determine road condition (pothole / bump /\nnormal)" as uc4
-  usecase "View road defect marks" as uc5
-  usecase "View route on map" as uc6
-}
-
-rectangle "The user is the card operator" as uc10
-rectangle "Sensor Agent\n(Device/STM32/Emulator)" as uc11
-
-uc11 - uc1
-uc11 - uc2
-
-uc10 - uc5
-uc10 - uc6
-
-uc2 -.|> uc3 : <<include>>
-uc3 -.|> uc4 : <<include>>
-
-@enduml

docker-compose.yaml

@@ -22,6 +22,7 @@ services:
     depends_on:
       - mqtt
     environment:
+      PYTHONUNBUFFERED: 1
       MQTT_BROKER_HOST: "mqtt"
       MQTT_BROKER_PORT: 1883
       MQTT_TOPIC: "agent_data_topic"
@@ -39,9 +40,10 @@ services:
     environment:
       MQTT_BROKER_HOST: "mqtt"
       MQTT_BROKER_PORT: 1883
-      MQTT_TOPIC: " "
-      HUB_HOST: "store"
+      MQTT_TOPIC: "agent_data_topic"
+      HUB_HOST: "hub"
       HUB_PORT: 8000
+      HUB_CONNECTION_TYPE: "http"
       HUB_MQTT_BROKER_HOST: "mqtt"
       HUB_MQTT_BROKER_PORT: 1883
       HUB_MQTT_TOPIC: "processed_data_topic"
@@ -89,6 +91,7 @@ services:
       - postgres_db
     restart: always
     environment:
+      PYTHONUNBUFFERED: 1
       POSTGRES_USER: user
       POSTGRES_PASSWORD: pass
       POSTGRES_DB: test_db
@@ -120,6 +123,7 @@ services:
       - redis
       - store
     environment:
+      PYTHONUNBUFFERED: 1
       STORE_API_HOST: "store"
       STORE_API_PORT: 8000
       REDIS_HOST: "redis"

edge/app/adapters/agent_mqtt_adapter.py

@@ -13,9 +13,7 @@ class AgentMQTTAdapter(AgentGateway):
         broker_port,
         topic,
         hub_gateway: HubGateway,
-        batch_size=10,
     ):
-        self.batch_size = batch_size
         # MQTT
         self.broker_host = broker_host
         self.broker_port = broker_port
@@ -35,42 +33,21 @@ class AgentMQTTAdapter(AgentGateway):
         """Processing agent data and sent it to hub gateway"""
         try:
             payload: str = msg.payload.decode("utf-8")
-            # Create AgentData instance with the received data
+
             agent_data = AgentData.model_validate_json(payload, strict=True)
-            # Process the received data (you can call a use case here if needed)
             processed_data = process_agent_data(agent_data)
-            # Store the agent_data in the database (you can send it to the data processing module)
-            if not self.hub_gateway.save_data(processed_data):
-                logging.error("Hub is not available")
+
+            if self.hub_gateway.save_data(processed_data):
+                logging.info("Processed data successfully forwarded to the Hub.")
+            else:
+                logging.error("Failed to send data: Hub gateway is unavailable.")
         except Exception as e:
-            logging.info(f"Error processing MQTT message: {e}")
+            logging.error(f"Error processing MQTT message: {e}")
 
     def connect(self):
         self.client.on_connect = self.on_connect
         self.client.on_message = self.on_message
         self.client.connect(self.broker_host, self.broker_port, 60)
 
-    def start(self):
-        self.client.loop_start()
-
-    def stop(self):
-        self.client.loop_stop()
-
-
-# Usage example:
-if __name__ == "__main__":
-    broker_host = "localhost"
-    broker_port = 1883
-    topic = "agent_data_topic"
-    # Assuming you have implemented the StoreGateway and passed it to the adapter
-    store_gateway = HubGateway()
-    adapter = AgentMQTTAdapter(broker_host, broker_port, topic, store_gateway)
-    adapter.connect()
-    adapter.start()
-    try:
-        # Keep the adapter running in the background
-        while True:
-            pass
-    except KeyboardInterrupt:
-        adapter.stop()
-        logging.info("Adapter stopped.")
+    def loop_forever(self):
+        self.client.loop_forever()

edge/app/entities/agent_data.py

@@ -14,6 +14,7 @@ class GpsData(BaseModel):
 
 
 class AgentData(BaseModel):
+    user_id: int
     accelerometer: AccelerometerData
     gps: GpsData
     timestamp: datetime

edge/app/interfaces/agent_gateway.py

@@ -26,15 +26,8 @@ class AgentGateway(ABC):
         pass
 
     @abstractmethod
-    def start(self):
+    def loop_forever(self):
         """
-        Method to start listening for messages from the agent.
-        """
-        pass
-
-    @abstractmethod
-    def stop(self):
-        """
-        Method to stop the agent gateway and clean up resources.
+        Method to await for new messages.
         """
         pass

edge/app/usecases/data_processing.py

@@ -1,6 +1,7 @@
 from app.entities.agent_data import AgentData
 from app.entities.processed_agent_data import ProcessedAgentData
 
+_last_detection_state = {}
 
 def process_agent_data(
     agent_data: AgentData,
@@ -12,4 +13,24 @@ def process_agent_data(
     Returns:
         processed_data_batch (ProcessedAgentData): Processed data containing the classified state of the road surface and agent data.
     """
-    # Implement it
+    user_id = agent_data.user_id
+    road_state = "normal"
+
+    last_detection_state = _last_detection_state.get(user_id, False)
+
+    if (agent_data.accelerometer.z < 0.6):
+        road_state = "pothole"
+    elif (agent_data.accelerometer.z > 1.2):
+        road_state = "bump"
+
+    detection_happened = road_state != "normal"
+
+    if not (not last_detection_state and detection_happened):
+        road_state = "normal"
+
+    _last_detection_state[user_id] = detection_happened
+
+    return ProcessedAgentData(
+        road_state=road_state,
+        agent_data=agent_data
+    )

edge/config.py

@@ -16,9 +16,12 @@ MQTT_TOPIC = os.environ.get("MQTT_TOPIC") or "agent_data_topic"
 # Configuration for hub MQTT
 HUB_MQTT_BROKER_HOST = os.environ.get("HUB_MQTT_BROKER_HOST") or "localhost"
 HUB_MQTT_BROKER_PORT = try_parse_int(os.environ.get("HUB_MQTT_BROKER_PORT")) or 1883
-HUB_MQTT_TOPIC = os.environ.get("HUB_MQTT_TOPIC") or "processed_agent_data_topic"
+HUB_MQTT_TOPIC = os.environ.get("HUB_MQTT_TOPIC") or "processed_data_topic"
 
 # Configuration for the Hub
 HUB_HOST = os.environ.get("HUB_HOST") or "localhost"
-HUB_PORT = try_parse_int(os.environ.get("HUB_PORT")) or 12000
+HUB_PORT = try_parse_int(os.environ.get("HUB_PORT")) or 8000
 HUB_URL = f"http://{HUB_HOST}:{HUB_PORT}"
+
+# For choosing type of connection
+HUB_CONNECTION_TYPE = os.environ.get("HUB_CONNECTION_TYPE") or "mqtt"

edge/main.py

@@ -10,42 +10,51 @@ from config import (
     HUB_MQTT_BROKER_HOST,
     HUB_MQTT_BROKER_PORT,
     HUB_MQTT_TOPIC,
+    HUB_CONNECTION_TYPE,
 )
 
 if __name__ == "__main__":
     # Configure logging settings
     logging.basicConfig(
-        level=logging.INFO,  # Set the log level to INFO (you can use logging.DEBUG for more detailed logs)
+        level=logging.INFO,
         format="[%(asctime)s] [%(levelname)s] [%(module)s] %(message)s",
         handlers=[
-            logging.StreamHandler(),  # Output log messages to the console
-            logging.FileHandler("app.log"),  # Save log messages to a file
+            logging.StreamHandler(),
+            logging.FileHandler("app.log"),
         ],
     )
-    # Create an instance of the StoreApiAdapter using the configuration
-    # hub_adapter = HubHttpAdapter(
-    #     api_base_url=HUB_URL,
-    # )
-    hub_adapter = HubMqttAdapter(
-        broker=HUB_MQTT_BROKER_HOST,
-        port=HUB_MQTT_BROKER_PORT,
-        topic=HUB_MQTT_TOPIC,
-    )
-    # Create an instance of the AgentMQTTAdapter using the configuration
+
+    # Logic to select the adapter based on configuration (SCRUM-93 & SCRUM-94)
+    # This allows easy switching between HTTP and MQTT protocols
+    if HUB_CONNECTION_TYPE.lower() == "http":
+        logging.info("Initializing HubHttpAdapter (SCRUM-93 integration)")
+        hub_adapter = HubHttpAdapter(
+            api_base_url=HUB_URL,
+        )
+    else:
+        logging.info("Initializing HubMqttAdapter (SCRUM-94 integration)")
+        hub_adapter = HubMqttAdapter(
+            broker=HUB_MQTT_BROKER_HOST,
+            port=HUB_MQTT_BROKER_PORT,
+            topic=HUB_MQTT_TOPIC,
+        )
+
+    # Create an instance of the AgentMQTTAdapter using the selected hub adapter
+    # This adapter acts as a bridge between the Agent and the Hub
     agent_adapter = AgentMQTTAdapter(
         broker_host=MQTT_BROKER_HOST,
         broker_port=MQTT_BROKER_PORT,
         topic=MQTT_TOPIC,
         hub_gateway=hub_adapter,
     )
+
     try:
-        # Connect to the MQTT broker and start listening for messages
+        logging.info(f"Connecting to MQTT broker at {MQTT_BROKER_HOST}:{MQTT_BROKER_PORT}")
         agent_adapter.connect()
-        agent_adapter.start()
-        # Keep the system running indefinitely (you can add other logic as needed)
-        while True:
-            pass
+
+        logging.info("Broker connection success. Waiting for data...")
+        agent_adapter.loop_forever()
     except KeyboardInterrupt:
-        # Stop the MQTT adapter and exit gracefully if interrupted by the user
-        agent_adapter.stop()
-        logging.info("System stopped.")
+        logging.info("Interrupt signal received. Shutting down...")
+        agent_adapter.disconnect()
+        logging.info("Disconnected from MQTT broker.")

store/main.py

@@ -33,7 +33,7 @@ processed_agent_data = Table(
 )
 
 # WebSocket subscriptions
-subscriptions: Dict[int, Set[WebSocket]] = {}
+subscriptions: Set[WebSocket] = set()
 
 
 # FastAPI WebSocket endpoint
@@ -41,10 +41,7 @@ subscriptions: Dict[int, Set[WebSocket]] = {}
 async def websocket_endpoint(websocket: WebSocket, user_id: int):
     await websocket.accept()
 
-    if user_id not in subscriptions:
-        subscriptions[user_id] = set()
-
-    subscriptions[user_id].add(websocket)
+    subscriptions.add(websocket)
 
     try:
         # send already available data
@@ -55,20 +52,20 @@ async def websocket_endpoint(websocket: WebSocket, user_id: int):
         for i in jsonable_data:
             i['timestamp'] = i['timestamp'].strftime("%Y-%m-%dT%H:%M:%SZ")
 
-        await websocket.send_json(json.dumps(jsonable_data))
+        for i in jsonable_data:
+            await websocket.send_json(json.dumps([i]))
 
         # receive forever
         while True:
             await websocket.receive_text()
     except WebSocketDisconnect:
-        subscriptions[user_id].remove(websocket)
+        subscriptions.remove(websocket)
 
 
 # Function to send data to subscribed users
-async def send_data_to_subscribers(user_id: int, data):
-    if user_id in subscriptions:
-        for websocket in subscriptions[user_id]:
-            await websocket.send_json(json.dumps(data))
+async def send_data_to_subscribers(data):
+    for websocket in subscriptions:
+        await websocket.send_json(json.dumps([data]))
 
 
 # FastAPI CRUDL endpoints
@@ -100,7 +97,7 @@ async def create_processed_agent_data(data: List[ProcessedAgentData], user_id: i
         session.commit()
 
         for record in created_records:
-            await send_data_to_subscribers(user_id, jsonable_encoder(record))
+            await send_data_to_subscribers(jsonable_encoder(record))
         return created_records
     except Exception as err:
         session.rollback()

utils/check-up.py

@@ -1,4 +1,5 @@
 import sys
+import os
 
 print("Checking for dead containers...")
 
@@ -14,6 +15,9 @@ for i in statuses:
     if not i[status_index:].startswith("Up "):
         service_name = i[name_index:]
         print(f"Crash detected in {service_name}")
+        print(f"docker logs for the container:\n")
+        os.system(f"docker logs {i.split(' ')[0]}")
+        print()
         exit_code = 1
 
 sys.exit(exit_code)