Design a Smart Street Light Outage Reporting System Using Object-Oriented Design

Smart Street Light Outage Reporting System

In this design, we will focus on creating a system that allows users to report street light outages, track issues, and monitor the status of repair work in real time. The system will be built using Object-Oriented Design (OOD) principles to ensure scalability, modularity, and maintainability.

Key Requirements:

1. User Interface: Citizens or users should be able to report street light outages via a web or mobile app.

2. Admin Dashboard: Administrators can view reported issues, assign technicians, and track the status of repairs.

3. Technician Interface: Technicians should be able to mark tasks as completed or in progress and update the status of repairs.

4. Data Management: The system should store information related to street light locations, outage statuses, technician assignments, etc.

5. Real-Time Updates: Users should be notified of the status of the repair process.

Class Design Overview

Using object-oriented design, we can break the system down into the following classes:

1. StreetLight

2. OutageReport

3. User

4. Admin

5. Technician

6. RepairTask

7. Notification

Class Definitions

1. StreetLight Class

Represents each streetlight in the system.

python
CopyEdit
class StreetLight:
    def __init__(self, id, location, status="functional"):
        self.id = id
        self.location = location
        self.status = status  # "functional" or "outage"

    def update_status(self, status):
        self.status = status

    def get_status(self):
        return self.status

• Attributes:

  • id: Unique identifier for the streetlight.

  • location: Geographic location of the streetlight.

  • status: Status of the streetlight (functional or outage).

• Methods:

  • update_status(): Updates the status of the streetlight.

  • get_status(): Retrieves the current status.

2. OutageReport Class

Represents a report of an outage for a particular streetlight.

python
CopyEdit
class OutageReport:
    def __init__(self, streetlight, user, description):
        self.streetlight = streetlight
        self.user = user
        self.description = description
        self.reported_at = datetime.now()
        self.status = "reported"  # Can be "reported", "in-progress", or "resolved"

    def update_status(self, status):
        self.status = status

• Attributes:

  • streetlight: The streetlight experiencing the outage.

  • user: The user who reported the outage.

  • description: Additional details about the outage.

  • reported_at: Timestamp of when the report was made.

  • status: Current status of the report.

• Methods:

  • update_status(): Updates the status of the outage report.

3. User Class

Represents a general user who can report outages.

python
CopyEdit
class User:
    def __init__(self, id, name, email):
        self.id = id
        self.name = name
        self.email = email

    def report_outage(self, streetlight, description):
        return OutageReport(streetlight, self, description)

• Attributes:

  • id: Unique identifier for the user.

  • name: Name of the user.

  • email: Email of the user.

• Methods:

  • report_outage(): Allows the user to report an outage.

4. Admin Class

Represents an administrator who can manage outage reports and technician assignments.

python
CopyEdit
class Admin(User):
    def __init__(self, id, name, email):
        super().__init__(id, name, email)

    def assign_task(self, report, technician):
        task = RepairTask(report, technician)
        task.assign()
        return task

    def resolve_report(self, report):
        report.update_status("resolved")

• Methods:

  • assign_task(): Assigns a technician to handle a report.

  • resolve_report(): Marks a report as resolved.

5. Technician Class

Represents a technician who is assigned to fix outages.

python
CopyEdit
class Technician(User):
    def __init__(self, id, name, email):
        super().__init__(id, name, email)

    def update_task_status(self, task, status):
        task.update_status(status)

• Methods:

  • update_task_status(): Updates the status of the repair task (e.g., in-progress, completed).

6. RepairTask Class

Represents a repair task assigned to a technician.

python
CopyEdit
class RepairTask:
    def __init__(self, report, technician):
        self.report = report
        self.technician = technician
        self.status = "assigned"  # "assigned", "in-progress", "completed"

    def assign(self):
        self.status = "assigned"

    def update_status(self, status):
        self.status = status

• Attributes:

  • report: The outage report this task is associated with.

  • technician: The technician assigned to the task.

  • status: The current status of the repair task.

7. Notification Class

Handles notifications to users regarding the status of the repair task.

python
CopyEdit
class Notification:
    def __init__(self, user, message):
        self.user = user
        self.message = message
        self.timestamp = datetime.now()

    def send(self):
        # This is where the notification would be sent (email, SMS, etc.)
        print(f"Notification to {self.user.name}: {self.message}")

• Attributes:

  • user: The user receiving the notification.

  • message: The message to be sent.

  • timestamp: The time when the notification is sent.

• Methods:

  • send(): Sends the notification.

System Workflow

1. User Reporting: A user notices a streetlight outage and reports it through the application. The system creates an OutageReport associated with that particular streetlight.

2. Admin Handling: The admin monitors all reported outages, assigns a technician to each report, and changes the report status accordingly. They can also resolve issues once the technician marks the repair as complete.

3. Technician Work: The technician is notified of their assigned tasks, updates the task status as they progress, and finally marks the task as completed once repairs are done.

4. Notification: Each user (admin, technician, and the person reporting the outage) receives real-time updates via notifications whenever the status of a report or repair task changes.

UML Diagram Overview

Here is a simple overview of how the classes interact with each other:

• StreetLight → OutageReport → User

• OutageReport → Admin → RepairTask

• RepairTask → Technician

• Technician → Notification

Conclusion

This Smart Street Light Outage Reporting System efficiently manages the reporting and repair of streetlight outages using OOD principles. The system allows users to report issues, admins to manage tasks, and technicians to complete repairs, all while keeping users informed via real-time notifications. The design ensures modularity, scalability, and ease of maintenance, enabling easy future expansions (e.g., adding new user roles, integrating more sensors for automatic outage detection).