Skip to content

Home Information - Your home, your data, organized.

Python

First main model migrationg and WIP for ZM integration.

Anthony Cassandrab88f84a5d285
diff --git a/src/hi/apps/collection/migrations/0001_initial.py b/src/hi/apps/collection/migrations/0001_initial.py
new file mode 100644
index 00000000..f56b20d1
--- /dev/null
+++ b/src/hi/apps/collection/migrations/0001_initial.py
@@ -0,0 +1,94 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ ("entity", "0001_initial"),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name="Collection",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ (
+ "collection_type_str",
+ models.CharField(max_length=32, verbose_name="Collection Type"),
+ ),
+ (
+ "svg_path",
+ models.TextField(blank=True, null=True, verbose_name="Path"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ ],
+ options={
+ "verbose_name": "Collection",
+ "verbose_name_plural": "Collections",
+ },
+ ),
+ migrations.CreateModel(
+ name="CollectionEntity",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "order_id",
+ models.PositiveIntegerField(default=0, verbose_name="Order Id"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "collection",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ to="collection.collection",
+ verbose_name="Collection",
+ ),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ ],
+ options={
+ "ordering": ["order_id"],
+ "indexes": [
+ models.Index(
+ fields=["collection", "entity"],
+ name="collection__collect_04e3d8_idx",
+ )
+ ],
+ },
+ ),
+ ]
diff --git a/src/hi/apps/common/admin.py b/src/hi/apps/common/admin.py
index 8c38f3f3..9aa7dc7d 100644
--- a/src/hi/apps/common/admin.py
+++ b/src/hi/apps/common/admin.py
@@ -1,3 +1,13 @@
from django.contrib import admin
-# Register your models here.
+from . import models
+
+
[email protected](models.DatabaseLock)
+class LocationAdmin(admin.ModelAdmin):
+ show_full_result_count = False
+
+ list_display = (
+ 'name',
+ 'acquired_at',
+ )
diff --git a/src/hi/apps/common/database_lock.py b/src/hi/apps/common/database_lock.py
index 87279a7e..dd8e13cd 100644
--- a/src/hi/apps/common/database_lock.py
+++ b/src/hi/apps/common/database_lock.py
@@ -1,16 +1,20 @@
from .models import DatabaseLock
-class DatabaseLockContext:
-
+class ExclusionLockContext:
+ """ Basic mutual exclusion lock using the database. """
+
def __init__( self, name, timeout_seconds = 300 ):
self.name = name
self.timeout_seconds = timeout_seconds
self.lock = None
def __enter__(self):
- self.lock = DatabaseLock( name = self.name )
- if self.lock.acquire( self.timeout_seconds ):
+
+ self.lock = DatabaseLock.acquire( name = self.name,
+ timeout_seconds = self.timeout_seconds,
+ for_initialization = False )
+ if self.lock:
return self.lock
else:
raise RuntimeError(f'Could not acquire lock: {self.name}')
@@ -19,3 +23,31 @@ class DatabaseLockContext:
if self.lock:
self.lock.release()
return
+
+
+class InitializationLockContext:
+ """
+ Grabs a lock for a specific duration so that only one thread performs
+ an operation in the given time period.
+ """
+
+ def __init__( self, name, timeout_seconds = 300 ):
+ self.name = name
+ self.timeout_seconds = timeout_seconds
+ self.lock = None
+
+ def __enter__(self):
+
+ self.lock = DatabaseLock.acquire( name = self.name,
+ timeout_seconds = self.timeout_seconds,
+ for_initialization = True )
+ if self.lock:
+ return self.lock
+ else:
+ raise RuntimeError(f'Could not acquire lock: {self.name}')
+
+ def __exit__( self, exc_type, exc_val, exc_tb ):
+ if self.lock:
+ self.lock.mark_initialized()
+ return
+
diff --git a/src/hi/apps/common/migrations/0001_initial.py b/src/hi/apps/common/migrations/0001_initial.py
new file mode 100644
index 00000000..361c4e97
--- /dev/null
+++ b/src/hi/apps/common/migrations/0001_initial.py
@@ -0,0 +1,29 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = []
+
+ operations = [
+ migrations.CreateModel(
+ name="DatabaseLock",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, unique=True)),
+ ("acquired_at", models.DateTimeField()),
+ ],
+ ),
+ ]
diff --git a/src/hi/apps/common/migrations/0002_alter_databaselock_options.py b/src/hi/apps/common/migrations/0002_alter_databaselock_options.py
new file mode 100644
index 00000000..1a172a07
--- /dev/null
+++ b/src/hi/apps/common/migrations/0002_alter_databaselock_options.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:28
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("common", "0001_initial"),
+ ]
+
+ operations = [
+ migrations.AlterModelOptions(
+ name="databaselock",
+ options={
+ "verbose_name": "Database Lock",
+ "verbose_name_plural": "Database Locks",
+ },
+ ),
+ ]
diff --git a/src/hi/apps/common/migrations/0003_databaselock_initialized.py b/src/hi/apps/common/migrations/0003_databaselock_initialized.py
new file mode 100644
index 00000000..a980e4a1
--- /dev/null
+++ b/src/hi/apps/common/migrations/0003_databaselock_initialized.py
@@ -0,0 +1,18 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("common", "0002_alter_databaselock_options"),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name="databaselock",
+ name="initialized",
+ field=models.BooleanField(default=False),
+ ),
+ ]
diff --git a/src/hi/apps/common/models.py b/src/hi/apps/common/models.py
index a84aae16..a24440c3 100644
--- a/src/hi/apps/common/models.py
+++ b/src/hi/apps/common/models.py
@@ -8,29 +8,56 @@ class DatabaseLock(models.Model):
name = models.CharField(
max_length = 64,
- unique = True
+ unique = True,
)
- acquired_at = models.DateTimeField()
+ acquired_at = models.DateTimeField(
+ )
+ initialized = models.BooleanField(
+ default = False,
+ )
+
+ class Meta:
+ verbose_name = 'Database Lock'
+ verbose_name_plural = 'Database Locks'
def is_expired( self, timeout_seconds = 300 ):
return timezone.now() > self.acquired_at + timedelta( seconds = timeout_seconds )
- def acquire( self, timeout_seconds = 300 ):
- """
- Attempt to acquire the lock. Returns True if the lock is acquired, False otherwise.
- """
+ @classmethod
+ def acquire( cls,
+ name : str,
+ timeout_seconds : int = 300,
+ for_initialization : bool = False ):
+
with transaction.atomic():
lock, created = DatabaseLock.objects.get_or_create(
- name = self.name,
- defaults={ "acquired_at": timezone.now() }
+ name = name,
+ defaults = {
+ 'acquired_at': timezone.now(),
+ 'initialized': False,
+ }
)
- if not created and not lock.is_expired( timeout_seconds ):
- return False
- lock.acquired_at = timezone.now()
- lock.save()
- return True
+ if created:
+ return lock
+
+ if lock.is_expired( timeout_seconds ):
+ lock.acquired_at = timezone.now()
+ lock.initialized = False
+ lock.save()
+ return lock
+
+ if for_initialization and lock.initialized:
+ return None
+
+ return lock
def release(self):
self.delete()
return
+
+ def mark_initialized(self):
+ self.initialized = True
+ self.save()
+ return
+
diff --git a/src/hi/apps/control/migrations/0001_initial.py b/src/hi/apps/control/migrations/0001_initial.py
new file mode 100644
index 00000000..276cc5a8
--- /dev/null
+++ b/src/hi/apps/control/migrations/0001_initial.py
@@ -0,0 +1,120 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ ("entity", "0001_initial"),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name="Controller",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ (
+ "controller_type_str",
+ models.CharField(max_length=32, verbose_name="Controller Type"),
+ ),
+ (
+ "entity_state",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="controllers",
+ to="entity.entitystate",
+ verbose_name="Entity State",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Controller",
+ "verbose_name_plural": "Controllers",
+ },
+ ),
+ migrations.CreateModel(
+ name="ControllerHistory",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("value", models.CharField(max_length=255, verbose_name="Value")),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "controller",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="history",
+ to="control.controller",
+ verbose_name="Controller",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Controller History",
+ "verbose_name_plural": "Controller History",
+ },
+ ),
+ migrations.CreateModel(
+ name="ControlledEntity",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "controller",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="+",
+ to="control.controller",
+ verbose_name="Controller",
+ ),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="controlled_by",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Controlled Entity",
+ "verbose_name_plural": "Controlled Entities",
+ },
+ ),
+ ]
diff --git a/src/hi/apps/entity/migrations/0001_initial.py b/src/hi/apps/entity/migrations/0001_initial.py
new file mode 100644
index 00000000..b75adc60
--- /dev/null
+++ b/src/hi/apps/entity/migrations/0001_initial.py
@@ -0,0 +1,276 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ (
+ "location",
+ "0003_locationview_view_type_str_alter_location_order_id_and_more",
+ ),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name="Entity",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ (
+ "entity_type_str",
+ models.CharField(max_length=32, verbose_name="Type"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ ],
+ options={
+ "verbose_name": "Entity",
+ "verbose_name_plural": "Entities",
+ },
+ ),
+ migrations.CreateModel(
+ name="EntityState",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "entity_state_type_str",
+ models.CharField(max_length=32, verbose_name="State Type"),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ ("value_range", models.TextField(verbose_name="Value Range")),
+ (
+ "units",
+ models.CharField(
+ blank=True, max_length=32, null=True, verbose_name="Units"
+ ),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="states",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Entity State",
+ "verbose_name_plural": "Entity States",
+ },
+ ),
+ migrations.CreateModel(
+ name="EntityPosition",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "svg_x",
+ models.DecimalField(
+ decimal_places=6, max_digits=12, verbose_name="X"
+ ),
+ ),
+ (
+ "svg_y",
+ models.DecimalField(
+ decimal_places=6, max_digits=12, verbose_name="Y"
+ ),
+ ),
+ (
+ "svg_scale",
+ models.DecimalField(
+ decimal_places=6,
+ default=1.0,
+ max_digits=12,
+ verbose_name="Scale",
+ ),
+ ),
+ (
+ "svg_rotation",
+ models.DecimalField(
+ decimal_places=6,
+ default=0.0,
+ max_digits=12,
+ verbose_name="Rotation",
+ ),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "updated_datetime",
+ models.DateTimeField(auto_now=True, verbose_name="Updated"),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="positions",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ (
+ "location",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="positions",
+ to="location.location",
+ verbose_name="Location",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Entity Position",
+ "verbose_name_plural": "Entity Positions",
+ "indexes": [
+ models.Index(
+ fields=["location", "entity"],
+ name="entity_enti_locatio_0402a2_idx",
+ )
+ ],
+ },
+ ),
+ migrations.CreateModel(
+ name="EntityPath",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("svg_path", models.TextField(verbose_name="Path")),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="paths",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ (
+ "location",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="paths",
+ to="location.location",
+ verbose_name="Location",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Entity Path",
+ "verbose_name_plural": "Entity Paths",
+ "indexes": [
+ models.Index(
+ fields=["location", "entity"],
+ name="entity_enti_locatio_15cbf9_idx",
+ )
+ ],
+ },
+ ),
+ migrations.CreateModel(
+ name="Attribute",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "attribute_value_type_str",
+ models.CharField(
+ max_length=32, verbose_name="Attribute Value Type"
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ ("value", models.TextField(verbose_name="Value")),
+ (
+ "attribute_type_str",
+ models.CharField(max_length=32, verbose_name="Attribute Type"),
+ ),
+ (
+ "is_editable",
+ models.BooleanField(default=True, verbose_name="Editable?"),
+ ),
+ (
+ "is_required",
+ models.BooleanField(default=False, verbose_name="Required?"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "updated_datetime",
+ models.DateTimeField(auto_now=True, verbose_name="Updated"),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="attributes",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Attribute",
+ "verbose_name_plural": "Attributes",
+ "indexes": [
+ models.Index(
+ fields=["name", "value"], name="entity_attr_name_820790_idx"
+ )
+ ],
+ },
+ ),
+ ]
diff --git a/src/hi/apps/location/migrations/0003_locationview_view_type_str_alter_location_order_id_and_more.py b/src/hi/apps/location/migrations/0003_locationview_view_type_str_alter_location_order_id_and_more.py
new file mode 100644
index 00000000..29e33f78
--- /dev/null
+++ b/src/hi/apps/location/migrations/0003_locationview_view_type_str_alter_location_order_id_and_more.py
@@ -0,0 +1,42 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("location", "0002_alter_location_latitude_alter_location_longitude"),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name="locationview",
+ name="view_type_str",
+ field=models.CharField(
+ default="information", max_length=32, verbose_name="View Type"
+ ),
+ preserve_default=False,
+ ),
+ migrations.AlterField(
+ model_name="location",
+ name="order_id",
+ field=models.PositiveIntegerField(default=0, verbose_name="Order Id"),
+ ),
+ migrations.AlterField(
+ model_name="locationview",
+ name="location",
+ field=models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="views",
+ to="location.location",
+ verbose_name="Location",
+ ),
+ ),
+ migrations.AlterField(
+ model_name="locationview",
+ name="order_id",
+ field=models.PositiveIntegerField(default=0, verbose_name="Order Id"),
+ ),
+ ]
diff --git a/src/hi/apps/sense/migrations/0001_initial.py b/src/hi/apps/sense/migrations/0001_initial.py
new file mode 100644
index 00000000..38d0eb0e
--- /dev/null
+++ b/src/hi/apps/sense/migrations/0001_initial.py
@@ -0,0 +1,120 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = [
+ ("entity", "0001_initial"),
+ ]
+
+ operations = [
+ migrations.CreateModel(
+ name="Sensor",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ (
+ "sensor_type_str",
+ models.CharField(max_length=32, verbose_name="Sensor Type"),
+ ),
+ (
+ "entity_state",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="sensors",
+ to="entity.entitystate",
+ verbose_name="Entity State",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Sensor",
+ "verbose_name_plural": "Sensors",
+ },
+ ),
+ migrations.CreateModel(
+ name="SensorHistory",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("value", models.CharField(max_length=255, verbose_name="Value")),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "sensor",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="history",
+ to="sense.sensor",
+ verbose_name="Sensor",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Sensor History",
+ "verbose_name_plural": "Sensor History",
+ },
+ ),
+ migrations.CreateModel(
+ name="SensedEntity",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "entity",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="sensed_by",
+ to="entity.entity",
+ verbose_name="Entity",
+ ),
+ ),
+ (
+ "sensor",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="+",
+ to="sense.sensor",
+ verbose_name="Sensor",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Sensed Entity",
+ "verbose_name_plural": "Sensed Entities",
+ },
+ ),
+ ]
diff --git a/src/hi/integrations/core/admin.py b/src/hi/integrations/core/admin.py
index 8c38f3f3..07393426 100644
--- a/src/hi/integrations/core/admin.py
+++ b/src/hi/integrations/core/admin.py
@@ -1,3 +1,23 @@
from django.contrib import admin
-# Register your models here.
+from . import models
+
+
+class IntegrationPropertyInLine(admin.TabularInline):
+ model = models.IntegrationProperty
+ extra = 0
+ show_change_link = True
+
+
[email protected](models.Integration)
+class IntegrationAdmin(admin.ModelAdmin):
+ show_full_result_count = False
+
+ list_display = (
+ 'integration_type_str',
+ 'is_enabled',
+ 'created_datetime',
+ 'updated_datetime',
+ )
+
+ inlines = [ IntegrationPropertyInLine, ]
diff --git a/src/hi/integrations/core/apps.py b/src/hi/integrations/core/apps.py
index 58f2e11e..0e6f7038 100644
--- a/src/hi/integrations/core/apps.py
+++ b/src/hi/integrations/core/apps.py
@@ -1,29 +1,38 @@
+import logging
import asyncio
import sys
import threading
from django.apps import AppConfig
+logger = logging.getLogger(__name__)
-class IntegrationCommonConfig(AppConfig):
+
+class CoreConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "hi.integrations.core"
INITIALIZATION_LOCK_NAME = 'integration_initialization'
+ INITIALIZATION_LOCK_TIME_SECS = 10
def ready(self):
if not self.is_runserver_command():
return
- threading.Thread( target = self.initialize_integrations ).start()
+ threading.Thread( target = self.initialize ).start()
return
- def initialize_integrations(self):
- from hi.apps.common.database_lock import DatabaseLockContext
+ def initialize(self):
+ from hi.apps.common.database_lock import InitializationLockContext
from .initialize import initialize_integrations # Need to be inside this method
try:
- with DatabaseLockContext( name = self.INITIALIZATION_LOCK_NAME ):
+ # Ensure this only runs once on startup. The ready() method
+ # could be called multiple times and there could be multiple
+ # processes / threads.
+ with InitializationLockContext( name = self.INITIALIZATION_LOCK_NAME,
+ timeout_seconds = self.INITIALIZATION_LOCK_TIME_SECS ):
+ logger.info( 'Initializing integrations ...' )
loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
loop.run_until_complete( initialize_integrations() )
diff --git a/src/hi/integrations/core/initialize.py b/src/hi/integrations/core/initialize.py
index 877e4c1e..45392996 100644
--- a/src/hi/integrations/core/initialize.py
+++ b/src/hi/integrations/core/initialize.py
@@ -2,7 +2,7 @@ from asgiref.sync import sync_to_async
import logging
import traceback
-from hi.integrations.zoneminder.zm_manager import ZoneMinderManager
+from hi.integrations.zoneminder.zm_integration import ZoneMinderIntegration
logger = logging.getLogger(__name__)
@@ -15,9 +15,9 @@ async def initialize_integrations():
- sanity check their configuration properties.
"""
try:
- await sync_to_async( ZoneMinderManager().initialize)() # Need wrapper for ORM operations
+ await sync_to_async( ZoneMinderIntegration().sync)() # Need wrapper for ORM operations
except Exception as e:
- logger.error( 'ZM initialization error: {}'.format(str(e)) )
+ logger.error( 'ZM sync error: {}'.format(str(e)) )
logger.info( traceback.format_exc() )
# Add other integration initializations here.
diff --git a/src/hi/integrations/core/migrations/0001_initial.py b/src/hi/integrations/core/migrations/0001_initial.py
new file mode 100644
index 00000000..7f6c2a99
--- /dev/null
+++ b/src/hi/integrations/core/migrations/0001_initial.py
@@ -0,0 +1,99 @@
+# Generated by Django 4.2.15 on 2024-08-23 19:12
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+ initial = True
+
+ dependencies = []
+
+ operations = [
+ migrations.CreateModel(
+ name="Integration",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ (
+ "integration_type_str",
+ models.CharField(
+ max_length=64, unique=True, verbose_name="Integration Type"
+ ),
+ ),
+ (
+ "is_enabled",
+ models.BooleanField(default=False, verbose_name="Enabled?"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "updated_datetime",
+ models.DateTimeField(auto_now=True, verbose_name="Updated"),
+ ),
+ ],
+ options={
+ "verbose_name": "Integration",
+ "verbose_name_plural": "Integrations",
+ },
+ ),
+ migrations.CreateModel(
+ name="IntegrationProperty",
+ fields=[
+ (
+ "id",
+ models.BigAutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name="ID",
+ ),
+ ),
+ ("name", models.CharField(max_length=64, verbose_name="Name")),
+ ("value", models.TextField(verbose_name="Value")),
+ (
+ "value_type_str",
+ models.CharField(max_length=32, verbose_name="Value Type"),
+ ),
+ (
+ "is_editable",
+ models.BooleanField(default=True, verbose_name="Editable?"),
+ ),
+ (
+ "is_required",
+ models.BooleanField(default=False, verbose_name="Required?"),
+ ),
+ (
+ "created_datetime",
+ models.DateTimeField(auto_now_add=True, verbose_name="Created"),
+ ),
+ (
+ "updated_datetime",
+ models.DateTimeField(auto_now=True, verbose_name="Updated"),
+ ),
+ (
+ "integration",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="properties",
+ to="core.integration",
+ verbose_name="Integration",
+ ),
+ ),
+ ],
+ options={
+ "verbose_name": "Property",
+ "verbose_name_plural": "Properties",
+ },
+ ),
+ ]
diff --git a/src/hi/integrations/zoneminder/zm_integration.py b/src/hi/integrations/zoneminder/zm_integration.py
new file mode 100644
index 00000000..526bde6a
--- /dev/null
+++ b/src/hi/integrations/zoneminder/zm_integration.py
@@ -0,0 +1,80 @@
+import logging
+import pyzm.api as pyzm_api
+
+from hi.apps.common.database_lock import ExclusionLockContext
+
+from hi.integrations.core.enums import IntegrationType
+from hi.integrations.core.exceptions import IntegrationPropertyError
+from hi.integrations.core.integration_manager import IntegrationManager
+
+from .enums import ZmPropertyName
+
+logger = logging.getLogger(__name__)
+
+
+class ZoneMinderIntegration:
+
+ SYNCHRONIZATION_LOCK_NAME = 'zm_integration_sync'
+
+ @classmethod
+ def create_zm_client(cls):
+
+ zm_integration = IntegrationManager().get_integration( IntegrationType.ZONEMINDER )
+ if not zm_integration.is_enabled:
+ logger.debug( 'ZoneMinder integration is not enabled.' )
+ return None
+
+ # Verify integration
+ property_dict = zm_integration.property_dict
+ for zm_prop_name in ZmPropertyName:
+ zm_prop = property_dict.get( zm_prop_name.name )
+ if not zm_prop:
+ raise IntegrationPropertyError( f'Missing ZM property {zm_prop_name.name}' )
+ if zm_prop.is_required and not zm_prop.value.strip():
+ raise IntegrationPropertyError( f'Missing ZM property value for {zm_prop_name.name}' )
+
+ continue
+
+ api_options = {
+ 'apiurl': property_dict.get( ZmPropertyName.API_URL.name ).value,
+ 'portalurl': property_dict.get( ZmPropertyName.PORTAL_URL.name ).value,
+ 'user': property_dict.get( ZmPropertyName.API_USER.name ).value,
+ 'password': property_dict.get( ZmPropertyName.API_PASSWORD.name ).value,
+ # 'disable_ssl_cert_check': True
+ }
+
+ return pyzm_api.ZMApi( options = api_options )
+
+ @classmethod
+ def sync( cls ):
+ try:
+ with ExclusionLockContext( name = cls.SYNCHRONIZATION_LOCK_NAME ):
+ logger.debug( 'ZoneMinder integration sync started.' )
+ cls._sync_helper()
+ except RuntimeError:
+ pass
+ finally:
+ logger.debug( 'ZoneMinder integration sync ended.' )
+ return
+
+ @classmethod
+ def _sync_helper( cls ):
+ logger.debug( 'Getting ZM monitors.' )
+ zm_client = cls.create_zm_client()
+ if not zm_client:
+ logger.debug( 'ZoneMinder client not created. ZM integration disabled?.' )
+ return
+
+ ms = zm_client.monitors()
+ for m in ms.list():
+
+ logger.debug('Name:{} Enabled:{} Type:{} Dims:{}'.format( m.name(),
+ m.enabled(),
+ m.type(),
+ m.dimensions()) )
+ logger.debug( m.status() )
+
+ # TODO: Add new cameras if needed
+
+ continue
+ return
diff --git a/src/hi/integrations/zoneminder/zm_manager.py b/src/hi/integrations/zoneminder/zm_manager.py
index 2bcbf1d2..8b07e66a 100644
--- a/src/hi/integrations/zoneminder/zm_manager.py
+++ b/src/hi/integrations/zoneminder/zm_manager.py
@@ -1,13 +1,8 @@
import logging
-import pyzm.api as zmapi
from hi.apps.common.singleton import Singleton
-from hi.integrations.core.enums import IntegrationType
-from hi.integrations.core.exceptions import IntegrationPropertyError
-from hi.integrations.core.integration_manager import IntegrationManager
-
-from .enums import ZmPropertyName
+from .zm_integration import ZoneMinderIntegration
logger = logging.getLogger(__name__)
@@ -15,57 +10,24 @@ logger = logging.getLogger(__name__)
class ZoneMinderManager( Singleton ):
def __init_singleton__( self ):
- self.zmClient = None
self._is_loading = False
+ self._zm_client = None
+ self.reload()
return
- def initialize( self ):
+ @property
+ def zm_client(self):
+ return self._zm_client
+
+ def reload( self ):
if self._is_loading:
- logger.warning( 'ZoneMinder initialization already started.' )
+ logger.warning( 'ZoneMinder is already loading.' )
return
try:
- logger.debug( 'Loading ZoneMinder data ...' )
self._is_loading = True
- self.zmClient = None
- zm_integration = IntegrationManager().get_integration( IntegrationType.ZONEMINDER )
- if not zm_integration.is_enabled:
- logger.debug( 'ZoneMinder integration is not enabled.' )
- return
-
- property_dict = zm_integration.property_dict
- for zm_prop_name in ZmPropertyName:
- zm_prop = property_dict.get( zm_prop_name.label )
- if not zm_prop:
- raise IntegrationPropertyError( f'Missing ZM property {zm_prop_name.label}' )
- if zm_prop.is_required and not zm_prop.value.strip():
- raise IntegrationPropertyError( f'Missing ZM property value for {zm_prop_name.label}' )
-
- continue
-
- api_options = {
- 'apiurl': property_dict.get( ZmPropertyName.API_URL.label ).value,
- 'portalurl': property_dict.get( ZmPropertyName.PORTAL_URL.label ).value,
- 'user': property_dict.get( ZmPropertyName.API_USER.label ).value,
- 'password': property_dict.get( ZmPropertyName.API_PASSWORD.label ).value,
- # 'disable_ssl_cert_check': True
- }
-
- self.zmClient = zmapi.ZMApi(options=api_options)
-
- logger.debug("Getting ZM Monitors")
- ms = self.zmClient.monitors()
- for m in ms.list():
- logger.debug('Name:{} Enabled:{} Type:{} Dims:{}'.format( m.name(),
- m.enabled(),
- m.type(),
- m.dimensions()) )
- logger.debug( m.status() )
-
- # TODO: Add new cameras if needed
-
- continue
+ self._zm_client = ZoneMinderIntegration.create_zm_client()
finally:
self._is_loading = False
- logger.debug( 'ZoneMinder initialization completed.' )
+ logger.debug( 'ZoneMinder loading completed.' )
return