arthexis 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

ocpp/admin.py

@@ -1,10 +1,11 @@
-from django.contrib import admin
+from django.contrib import admin, messages
 from django import forms
 
 import asyncio
 from datetime import timedelta
 import json
 
+from django.shortcuts import redirect
 from django.utils import timezone
 from django.urls import path
 from django.http import HttpResponse, HttpResponseRedirect
@@ -13,10 +14,9 @@ from django.template.response import TemplateResponse
 from .models import (
     Charger,
     Simulator,
-    MeterReading,
+    MeterValue,
     Transaction,
     Location,
-    ElectricVehicle,
 )
 from .simulator import ChargePointSimulator
 from . import store
@@ -24,8 +24,7 @@ from .transactions_io import (
     export_transactions,
     import_transactions as import_transactions_data,
 )
-from core.admin import RFIDAdmin
-from .models import RFID
+from core.user_data import EntityModelAdmin
 
 
 class LocationAdminForm(forms.ModelForm):
@@ -39,9 +38,7 @@ class LocationAdminForm(forms.ModelForm):
         }
 
     class Media:
-        css = {
-            "all": ("https://unpkg.com/leaflet@1.9.4/dist/leaflet.css",)
-        }
+        css = {"all": ("https://unpkg.com/leaflet@1.9.4/dist/leaflet.css",)}
         js = (
             "https://unpkg.com/leaflet@1.9.4/dist/leaflet.js",
             "ocpp/charger_map.js",
@@ -60,29 +57,91 @@ class TransactionImportForm(forms.Form):
     file = forms.FileField()
 
 
+class LogViewAdminMixin:
+    """Mixin providing an admin view to display charger or simulator logs."""
+
+    log_type = "charger"
+    log_template_name = "admin/ocpp/log_view.html"
+
+    def get_log_identifier(self, obj):  # pragma: no cover - mixin hook
+        raise NotImplementedError
+
+    def get_log_title(self, obj):
+        return f"Log for {obj}"
+
+    def get_urls(self):
+        urls = super().get_urls()
+        info = self.model._meta.app_label, self.model._meta.model_name
+        custom = [
+            path(
+                "<path:object_id>/log/",
+                self.admin_site.admin_view(self.log_view),
+                name=f"{info[0]}_{info[1]}_log",
+            ),
+        ]
+        return custom + urls
+
+    def log_view(self, request, object_id):
+        obj = self.get_object(request, object_id)
+        if obj is None:
+            self.message_user(request, "Log is not available.", messages.ERROR)
+            return redirect("..")
+        identifier = self.get_log_identifier(obj)
+        log_entries = store.get_logs(identifier, log_type=self.log_type)
+        log_file = store._file_path(identifier, log_type=self.log_type)
+        context = {
+            **self.admin_site.each_context(request),
+            "opts": self.model._meta,
+            "original": obj,
+            "title": self.get_log_title(obj),
+            "log_entries": log_entries,
+            "log_file": str(log_file),
+            "log_identifier": identifier,
+        }
+        return TemplateResponse(request, self.log_template_name, context)
+
+
 @admin.register(Location)
-class LocationAdmin(admin.ModelAdmin):
+class LocationAdmin(EntityModelAdmin):
     form = LocationAdminForm
     list_display = ("name", "latitude", "longitude")
+    change_form_template = "admin/ocpp/location/change_form.html"
 
 
 @admin.register(Charger)
-class ChargerAdmin(admin.ModelAdmin):
+class ChargerAdmin(LogViewAdminMixin, EntityModelAdmin):
     fieldsets = (
         (
             "General",
             {
                 "fields": (
                     "charger_id",
+                    "display_name",
                     "connector_id",
-                    "require_rfid",
+                    "location",
+                    "last_path",
                     "last_heartbeat",
                     "last_meter_values",
-                    "last_path",
-                    "location",
+                    "firmware_status",
+                    "firmware_status_info",
+                    "firmware_timestamp",
                 )
             },
         ),
+        (
+            "Diagnostics",
+            {
+                "fields": (
+                    "diagnostics_status",
+                    "diagnostics_timestamp",
+                    "diagnostics_location",
+                )
+            },
+        ),
+        (
+            "Configuration",
+            {"fields": ("public_display", "require_rfid")},
+        ),
         (
             "References",
             {
@@ -90,13 +149,22 @@ class ChargerAdmin(admin.ModelAdmin):
             },
         ),
     )
-    readonly_fields = ("last_heartbeat", "last_meter_values")
+    readonly_fields = (
+        "last_heartbeat",
+        "last_meter_values",
+        "firmware_status",
+        "firmware_status_info",
+        "firmware_timestamp",
+    )
     list_display = (
         "charger_id",
         "connector_id",
         "location_name",
-        "require_rfid",
+        "require_rfid_display",
+        "public_display",
         "last_heartbeat",
+        "firmware_status",
+        "firmware_timestamp",
         "session_kw",
         "total_kw_display",
         "page_link",
@@ -109,6 +177,12 @@ class ChargerAdmin(admin.ModelAdmin):
     def get_view_on_site_url(self, obj=None):
         return obj.get_absolute_url() if obj else None
 
+    def require_rfid_display(self, obj):
+        return obj.require_rfid
+
+    require_rfid_display.boolean = True
+    require_rfid_display.short_description = "RFID Auth"
+
     def page_link(self, obj):
         from django.utils.html import format_html
 
@@ -116,7 +190,7 @@ class ChargerAdmin(admin.ModelAdmin):
             '<a href="{}" target="_blank">open</a>', obj.get_absolute_url()
         )
 
-    page_link.short_description = "Landing Page"
+    page_link.short_description = "Landing"
 
     def qr_link(self, obj):
         from django.utils.html import format_html
@@ -133,19 +207,25 @@ class ChargerAdmin(admin.ModelAdmin):
         from django.utils.html import format_html
         from django.urls import reverse
 
-        url = reverse("charger-log", args=[obj.charger_id]) + "?type=charger"
+        url = reverse("admin:ocpp_charger_log", args=[obj.pk])
         return format_html('<a href="{}" target="_blank">view</a>', url)
 
     log_link.short_description = "Log"
-    
+
+    def get_log_identifier(self, obj):
+        return store.identity_key(obj.charger_id, obj.connector_id)
+
     def status_link(self, obj):
         from django.utils.html import format_html
         from django.urls import reverse
 
-        url = reverse("charger-status", args=[obj.charger_id])
+        url = reverse(
+            "charger-status-connector",
+            args=[obj.charger_id, obj.connector_slug],
+        )
         return format_html('<a href="{}" target="_blank">status</a>', url)
 
-    status_link.short_description = "Status Page"
+    status_link.short_description = "Status"
 
     def location_name(self, obj):
         return obj.location.name if obj.location else ""
@@ -169,7 +249,7 @@ class ChargerAdmin(admin.ModelAdmin):
     total_kw_display.short_description = "Total kW"
 
     def session_kw(self, obj):
-        tx = store.transactions.get(obj.charger_id)
+        tx = store.get_transaction(obj.charger_id, obj.connector_id)
         if tx:
             return round(tx.kw, 2)
         return 0.0
@@ -178,7 +258,7 @@ class ChargerAdmin(admin.ModelAdmin):
 
 
 @admin.register(Simulator)
-class SimulatorAdmin(admin.ModelAdmin):
+class SimulatorAdmin(LogViewAdminMixin, EntityModelAdmin):
     list_display = (
         "name",
         "cp_path",
@@ -197,28 +277,100 @@ class SimulatorAdmin(admin.ModelAdmin):
         "rfid",
         ("duration", "interval", "pre_charge_delay"),
         "kw_max",
-        "repeat",
+        ("repeat", "door_open"),
         ("username", "password"),
     )
-    actions = ("start_simulator", "stop_simulator")
+    actions = ("start_simulator", "stop_simulator", "send_open_door")
+
+    log_type = "simulator"
+
+    def save_model(self, request, obj, form, change):
+        previous_door_open = False
+        if change and obj.pk:
+            previous_door_open = (
+                type(obj)
+                .objects.filter(pk=obj.pk)
+                .values_list("door_open", flat=True)
+                .first()
+                or False
+            )
+        super().save_model(request, obj, form, change)
+        if obj.door_open and not previous_door_open:
+            triggered = self._queue_door_open(request, obj)
+            if not triggered:
+                type(obj).objects.filter(pk=obj.pk).update(door_open=False)
+                obj.door_open = False
+
+    def _queue_door_open(self, request, obj) -> bool:
+        sim = store.simulators.get(obj.pk)
+        if not sim:
+            self.message_user(
+                request,
+                f"{obj.name}: simulator is not running",
+                level=messages.ERROR,
+            )
+            return False
+        type(obj).objects.filter(pk=obj.pk).update(door_open=True)
+        obj.door_open = True
+        store.add_log(
+            obj.cp_path,
+            "Door open event requested from admin",
+            log_type="simulator",
+        )
+        if hasattr(sim, "trigger_door_open"):
+            sim.trigger_door_open()
+        else:  # pragma: no cover - unexpected condition
+            self.message_user(
+                request,
+                f"{obj.name}: simulator cannot send door open event",
+                level=messages.ERROR,
+            )
+            type(obj).objects.filter(pk=obj.pk).update(door_open=False)
+            obj.door_open = False
+            return False
+        type(obj).objects.filter(pk=obj.pk).update(door_open=False)
+        obj.door_open = False
+        self.message_user(
+            request,
+            f"{obj.name}: DoorOpen status notification sent",
+        )
+        return True
 
     def running(self, obj):
         return obj.pk in store.simulators
 
     running.boolean = True
 
+    @admin.action(description="Send Open Door")
+    def send_open_door(self, request, queryset):
+        for obj in queryset:
+            self._queue_door_open(request, obj)
+
     def start_simulator(self, request, queryset):
+        from django.urls import reverse
+        from django.utils.html import format_html
+
         for obj in queryset:
             if obj.pk in store.simulators:
                 self.message_user(request, f"{obj.name}: already running")
                 continue
+            type(obj).objects.filter(pk=obj.pk).update(door_open=False)
+            obj.door_open = False
             store.register_log_name(obj.cp_path, obj.name, log_type="simulator")
             sim = ChargePointSimulator(obj.as_config())
             started, status, log_file = sim.start()
             if started:
                 store.simulators[obj.pk] = sim
+            log_url = reverse("admin:ocpp_simulator_log", args=[obj.pk])
             self.message_user(
-                request, f"{obj.name}: {status}. Log: {log_file}"
+                request,
+                format_html(
+                    '{}: {}. Log: <code>{}</code> (<a href="{}" target="_blank">View Log</a>)',
+                    obj.name,
+                    status,
+                    log_file,
+                    log_url,
+                ),
             )
 
     start_simulator.short_description = "Start selected simulators"
@@ -239,22 +391,35 @@ class SimulatorAdmin(admin.ModelAdmin):
         from django.utils.html import format_html
         from django.urls import reverse
 
-        url = reverse("charger-log", args=[obj.cp_path]) + "?type=simulator"
+        url = reverse("admin:ocpp_simulator_log", args=[obj.pk])
         return format_html('<a href="{}" target="_blank">view</a>', url)
 
     log_link.short_description = "Log"
 
+    def get_log_identifier(self, obj):
+        return obj.cp_path
 
-class MeterReadingInline(admin.TabularInline):
-    model = MeterReading
+
+class MeterValueInline(admin.TabularInline):
+    model = MeterValue
     extra = 0
-    fields = ("timestamp", "value", "unit", "measurand", "connector_id")
+    fields = (
+        "timestamp",
+        "context",
+        "energy",
+        "voltage",
+        "current_import",
+        "current_offered",
+        "temperature",
+        "soc",
+        "connector_id",
+    )
     readonly_fields = fields
     can_delete = False
 
 
 @admin.register(Transaction)
-class TransactionAdmin(admin.ModelAdmin):
+class TransactionAdmin(EntityModelAdmin):
     change_list_template = "admin/ocpp/transaction/change_list.html"
     list_display = (
         "charger",
@@ -269,7 +434,7 @@ class TransactionAdmin(admin.ModelAdmin):
     readonly_fields = ("kw",)
     list_filter = ("charger", "account")
     date_hierarchy = "start_time"
-    inlines = [MeterReadingInline]
+    inlines = [MeterValueInline]
 
     def get_urls(self):
         urls = super().get_urls()
@@ -301,17 +466,15 @@ class TransactionAdmin(admin.ModelAdmin):
                     json.dumps(data, indent=2, ensure_ascii=False),
                     content_type="application/json",
                 )
-                response[
-                    "Content-Disposition"
-                ] = "attachment; filename=transactions.json"
+                response["Content-Disposition"] = (
+                    "attachment; filename=transactions.json"
+                )
                 return response
         else:
             form = TransactionExportForm()
         context = self.admin_site.each_context(request)
         context["form"] = form
-        return TemplateResponse(
-            request, "admin/ocpp/transaction/export.html", context
-        )
+        return TemplateResponse(request, "admin/ocpp/transaction/export.html", context)
 
     def import_view(self, request):
         if request.method == "POST":
@@ -325,12 +488,10 @@ class TransactionAdmin(admin.ModelAdmin):
             form = TransactionImportForm()
         context = self.admin_site.each_context(request)
         context["form"] = form
-        return TemplateResponse(
-            request, "admin/ocpp/transaction/import.html", context
-        )
+        return TemplateResponse(request, "admin/ocpp/transaction/import.html", context)
 
 
-class MeterReadingDateFilter(admin.SimpleListFilter):
+class MeterValueDateFilter(admin.SimpleListFilter):
     title = "Timestamp"
     parameter_name = "timestamp_range"
 
@@ -361,32 +522,20 @@ class MeterReadingDateFilter(admin.SimpleListFilter):
         return queryset
 
 
-@admin.register(MeterReading)
-class MeterReadingAdmin(admin.ModelAdmin):
+@admin.register(MeterValue)
+class MeterValueAdmin(EntityModelAdmin):
     list_display = (
         "charger",
         "timestamp",
-        "value",
-        "unit",
+        "context",
+        "energy",
+        "voltage",
+        "current_import",
+        "current_offered",
+        "temperature",
+        "soc",
         "connector_id",
         "transaction",
     )
     date_hierarchy = "timestamp"
-    list_filter = ("charger", MeterReadingDateFilter)
-
-
-@admin.register(ElectricVehicle)
-class ElectricVehicleAdmin(admin.ModelAdmin):
-    list_display = ("vin", "license_plate", "brand", "model", "account")
-    search_fields = (
-        "vin",
-        "license_plate",
-        "brand__name",
-        "model__name",
-        "account__name",
-    )
-    fields = ("account", "vin", "license_plate", "brand", "model")
-
-
-admin.site.register(RFID, RFIDAdmin)
-
+    list_filter = ("charger", MeterValueDateFilter)

ocpp/apps.py

@@ -6,7 +6,7 @@ from django.conf import settings
 class OcppConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
     name = "ocpp"
-    verbose_name = "3. Protocols"
+    verbose_name = "3. Protocol"
 
     def ready(self):  # pragma: no cover - startup side effects
         control_lock = Path(settings.BASE_DIR) / "locks" / "control.lck"