Skip to content

Home Information - Your home, your data, organized.

Python

Working on base flows for simulators.

Anthony Cassandra0bdd7fdbc944
diff --git a/src/hi/settings/simulator.py b/src/hi/settings/simulator.py
index 8f97ba45..c7a96f8d 100644
--- a/src/hi/settings/simulator.py
+++ b/src/hi/settings/simulator.py
@@ -29,6 +29,23 @@ MIDDLEWARE = [
ROOT_URLCONF = 'hi.simulator.urls'
+TEMPLATES = [
+ {
+ 'BACKEND': 'django.template.backends.django.DjangoTemplates',
+ 'DIRS': [ os.path.join(BASE_DIR, "templates") ],
+ 'APP_DIRS': True,
+ 'OPTIONS': {
+ 'context_processors': [
+ 'django.template.context_processors.debug',
+ 'django.template.context_processors.request',
+ 'django.contrib.auth.context_processors.auth',
+ 'django.contrib.messages.context_processors.messages',
+ ],
+ },
+ },
+]
+
+
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
diff --git a/src/hi/simulator/apps.py b/src/hi/simulator/apps.py
index 4be78f98..232034d9 100644
--- a/src/hi/simulator/apps.py
+++ b/src/hi/simulator/apps.py
@@ -1,6 +1,51 @@
+import asyncio
+import os
+import signal
+import threading
+
from django.apps import AppConfig
class SimulatorConfig(AppConfig):
default_auto_field = "django.db.models.BigAutoField"
name = "hi.simulator"
+
+ def ready(self):
+ from hi.simulator.simulator_manager import SimulatorManager
+ if os.getenv( "RUN_MAIN", None ) != "true":
+ # Avoid double initialization when using the reloader in development
+ return
+
+ # This app.py initialization runs in synchronous mode, so we
+ # need to defer the background simulator manager tasks
+ # creation by creating a separate thread.
+ #
+ # This is for development only as simulator only runs in DEBUG
+ #
+ thread = threading.Thread( target = self._start_simulators, daemon = True )
+ thread.start()
+
+ def handle_signal(signal_number, frame):
+ SimulatorManager().shutdown()
+ import sys
+ sys.exit(0)
+
+ signal.signal(signal.SIGINT, handle_signal)
+ signal.signal(signal.SIGTERM, handle_signal)
+
+ return
+
+ def _start_simulators(self):
+ from hi.simulator.simulator_manager import SimulatorManager
+ loop = asyncio.new_event_loop()
+ asyncio.set_event_loop( loop )
+ simulator_manager = SimulatorManager()
+ try:
+ loop.create_task( simulator_manager.initialize() )
+ loop.run_forever()
+ except Exception as e:
+ print(f"Error in event loop: {e}")
+
+ finally:
+ loop.close()
+ return
diff --git a/src/hi/simulator/enums.py b/src/hi/simulator/enums.py
new file mode 100644
index 00000000..9e68a436
--- /dev/null
+++ b/src/hi/simulator/enums.py
@@ -0,0 +1,5 @@
+from hi.apps.common.enums import LabeledEnum
+
+
+class SimEntityStateType(LabeledEnum):
+ pass
diff --git a/src/hi/simulator/models.py b/src/hi/simulator/models.py
new file mode 100644
index 00000000..600dfc69
--- /dev/null
+++ b/src/hi/simulator/models.py
@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from typing import List
+
+from .enums import SimEntityStateType
+
+
+@dataclass
+class SimEntity:
+
+ entity_id : str
+ name : str
+ state_type : SimEntityStateType
+ state_value : str
+
+
+@dataclass
+class SimDevice:
+
+ device_id : str
+ name : str
+ sim_entity_list : List[ SimEntity ]
+
diff --git a/src/hi/simulator/service_simulator.py b/src/hi/simulator/service_simulator.py
new file mode 100644
index 00000000..7b406898
--- /dev/null
+++ b/src/hi/simulator/service_simulator.py
@@ -0,0 +1,27 @@
+from typing import List
+
+from hi.apps.common.singleton import Singleton
+
+from .models import SimDevice
+
+
+class ServiceSimulator( Singleton ):
+
+ def __init_singleton__( self ):
+ return
+
+ @property
+ def id(self) -> str:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ @property
+ def label(self) -> str:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ @property
+ def sim_devices(self) -> List[ SimDevice ]:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ def set_state( self, device_id : int, value : str ):
+ raise NotImplementedError('Subclasses must override this method.')
+
diff --git a/src/hi/simulator/services/hass/simulator.py b/src/hi/simulator/services/hass/simulator.py
new file mode 100644
index 00000000..a9c5de70
--- /dev/null
+++ b/src/hi/simulator/services/hass/simulator.py
@@ -0,0 +1,23 @@
+from typing import List
+
+from hi.simulator.models import SimDevice
+from hi.simulator.service_simulator import ServiceSimulator
+
+
+class HassSimulator( ServiceSimulator ):
+
+ @property
+ def id(self):
+ return 'hass'
+
+ @property
+ def label(self):
+ return 'Home Assistant'
+
+ @property
+ def sim_devices(self) -> List[ SimDevice ]:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ def set_state( self, device_id : int, value : str ):
+ raise NotImplementedError('Subclasses must override this method.')
+
diff --git a/src/hi/simulator/services/zoneminder/simulator.py b/src/hi/simulator/services/zoneminder/simulator.py
new file mode 100644
index 00000000..ad41e913
--- /dev/null
+++ b/src/hi/simulator/services/zoneminder/simulator.py
@@ -0,0 +1,23 @@
+from typing import List
+
+from hi.simulator.models import SimDevice
+from hi.simulator.service_simulator import ServiceSimulator
+
+
+class ZoneMinderSimulator( ServiceSimulator ):
+
+ @property
+ def id(self):
+ return 'zm'
+
+ @property
+ def label(self) -> str:
+ return 'ZoneMinder'
+
+ @property
+ def sim_devices(self) -> List[ SimDevice ]:
+ raise NotImplementedError('Subclasses must override this method.')
+
+ def set_state( self, device_id : int, value : str ):
+ raise NotImplementedError('Subclasses must override this method.')
+
diff --git a/src/hi/simulator/simulator_manager.py b/src/hi/simulator/simulator_manager.py
new file mode 100644
index 00000000..1b838488
--- /dev/null
+++ b/src/hi/simulator/simulator_manager.py
@@ -0,0 +1,72 @@
+import logging
+from threading import Lock
+from typing import Dict
+
+from django.apps import apps
+
+from hi.apps.common.module_utils import import_module_safe
+from hi.apps.common.singleton import Singleton
+
+from .service_simulator import ServiceSimulator
+
+logger = logging.getLogger(__name__)
+
+
+class SimulatorManager( Singleton ):
+
+ def __init_singleton__( self ):
+ self._id_to_simulator_map : Dict[ str, ServiceSimulator ] = dict()
+ self._data_lock = Lock()
+ return
+
+ def get_simulator( self, simulator_id : str ) -> ServiceSimulator:
+ return self._id_to_simulator_map.get( simulator_id )
+
+ def get_simulator_list(self):
+ simulator_list = [ x for x in self._id_to_simulator_map.values() ]
+ simulator_list.sort( key = lambda item : item.label )
+ return simulator_list
+
+ async def initialize(self) -> None:
+ self._data_lock.acquire()
+ try:
+ await self._load_simulator_data()
+ finally:
+ self._data_lock.release()
+ return
+
+ async def _load_simulator_data(self) -> None:
+ logger.debug("Discovering defined simulators ...")
+ self._id_to_simulator_map = self._discover_defined_simulators()
+ return
+
+ def _discover_defined_simulators(self) -> Dict[ str, ServiceSimulator ]:
+
+ simulator_id_to_simulator = dict()
+ for app_config in apps.get_app_configs():
+ if not app_config.name.startswith( 'hi.simulator.services' ):
+ continue
+ module_name = f'{app_config.name}.simulator'
+ try:
+ app_module = import_module_safe( module_name = module_name )
+ if not app_module:
+ logger.debug( f'No simulator module for {app_config.name}' )
+ continue
+
+ logger.debug( f'Found simulator module for {app_config.name}' )
+
+ for attr_name in dir(app_module):
+ attr = getattr( app_module, attr_name )
+ if ( isinstance( attr, type )
+ and issubclass( attr, ServiceSimulator )
+ and attr is not ServiceSimulator ):
+ logger.debug(f'Found simulator: {attr_name}')
+ simulator = attr()
+ simulator_id_to_simulator[simulator.id] = simulator
+ continue
+
+ except Exception as e:
+ logger.exception( f'Problem getting simulator for {module_name}.', e )
+ continue
+
+ return simulator_id_to_simulator
diff --git a/src/hi/simulator/templates/simulator/modals/add_device.html b/src/hi/simulator/templates/simulator/modals/add_device.html
new file mode 100644
index 00000000..bf8ab876
--- /dev/null
+++ b/src/hi/simulator/templates/simulator/modals/add_device.html
@@ -0,0 +1,28 @@
+{% extends "modals/action_with_cancel.html" %}
+
+{% block preamble %}
+<form action="{% url 'simulator_add_device' %}" method="post"
+ class="form" data-async="modal">
+ {% csrf_token %}
+{% endblock %}
+
+{% block title_text %}
+Add {{ simulator.label }} Device
+{% endblock %}
+
+{% block body %}
+<div>
+ZZZZ
+</div>
+{% endblock %}
+
+{% block action_right %}
+<button id="hi-simulator-add-device-submit" type="submit" class="btn btn-lg btn-success"
+ name="action" value="add">
+ ADD
+</button>
+{% endblock %}
+
+{% block postamble %}
+</form>
+{% endblock %}
diff --git a/src/hi/simulator/templates/simulator/pages/base.html b/src/hi/simulator/templates/simulator/pages/base.html
new file mode 100644
index 00000000..bcc16b74
--- /dev/null
+++ b/src/hi/simulator/templates/simulator/pages/base.html
@@ -0,0 +1,32 @@
+{% load static %}
+{% load pipeline %}
+<!doctype html>
+<html class="no-js" lang="en">
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+ <title>{% block head_title %}Service Simulators{% endblock %}</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <link rel="shortcut icon" type="image/png" href="{% static 'favicon.png' %}"/>
+ <link rel="icon" type="image/png" href="{% static 'img/hi-icon-16x16.png' %}" sizes="16x16">
+ <link rel="icon" type="image/png" href="{% static 'img/hi-icon-32x32.png' %}" sizes="32x32">
+ <link rel="icon" type="image/png" href="{% static 'img/hi-icon-96x96.png' %}" sizes="96x96">
+ <link rel="icon" type="image/png" href="{% static 'img/hi-icon-128x128.png' %}" sizes="128x128">
+ <link rel="icon" type="image/png" href="{% static 'img/hi-icon-196x196.png' %}" sizes="196x196">
+ <link href="{% static 'bootstrap/css/bootstrap.css' %}" rel="stylesheet" type="text/css" media="all" />
+ <link href="{% static 'css/main.css" rel="stylesheet' %}" type="text/css" media="all" />
+ </head>
+ <body>
+ <script type="text/javascript" src="{% static 'js/jquery-3.7.0.min.js' %}" charset="utf-8"></script>
+ <script type="text/javascript" src="{% static 'js/cookie.js' %}" charset="utf-8"></script>
+ <script type="text/javascript" src="{% static 'js/antinode.js' %}" charset="utf-8"></script>
+ <script type="text/javascript" src="{% static 'js/autosize.min.js' %}" charset="utf-8"></script>
+ <script type="text/javascript" src="{% static 'js/main.js' %}" charset="utf-8"></script>
+
+ {% block content %}{% endblock %}
+
+ <script type="text/javascript" src="{% static 'js/popper.min.js' %}" charset="utf-8"></script>
+ <script type="text/javascript" src="{% static 'bootstrap/js/bootstrap.js' %}" charset="utf-8"></script>
+
+ </body>
+</html>
diff --git a/src/hi/simulator/templates/simulator/pages/home.html b/src/hi/simulator/templates/simulator/pages/home.html
new file mode 100644
index 00000000..7dfbf393
--- /dev/null
+++ b/src/hi/simulator/templates/simulator/pages/home.html
@@ -0,0 +1,48 @@
+{% extends "simulator/pages/base.html" %}
+
+{% block content %}
+<div class="container-fluid">
+ <div class="h3">Service Simulators</div>
+
+ <ul id="hi-simulator-tabs" class="nav nav-tabs" role="tablist">
+ {% for simulator in simulator_list %}
+ <li class="nav-item">
+ <a id="hi-simulator-tab-{{ simulator.id }}" role="tab"
+ class="nav-link {% if simulator.id == current_simulator.id %}active{% endif %}"
+ data-toggle="tab"
+ href="#hi-simulator-content-{{ simulator.id }}"
+ role="tab"
+ aria-controls="hi-simulator-content-{{ simulator.id }}"
+ aria-selected="{% if simulator.id == current_simulator.id %}true{% else %}false{% endif %}">
+ {{ simulator.label }}</a>
+ </li>
+ {% endfor %}
+ </ul>
+
+ <div id="hi-simulator-tab-content" class="tab-content">
+ {% for simulator in simulator_list %}
+ <div id="hi-simulator-content-{{ simulator.id }}"
+ class="tab-pane fade {% if simulator.id == current_simulator.id %}show active{% endif %}"
+ role="tabpanel"
+ aria-labelledby="hi-simulator-tab-{{ simulator.id }}">
+
+ <div>
+ <a id="hi-sim-device-add-button"
+ href="{% url 'simulator_add_device' %}" data-async="modal"
+ class="btn btn-info">
+ ADD {{ simulator.label }} DEVICE
+ </a>
+ </div>
+
+ {% for sim_device in simulator.devices %}
+ {% include "panes/sim_device.html" with simulator=simulator sim_device=sim_device %}
+ {% empty %}
+ <div class="alert alert-info" >No {{ simulator.label }} devices defined.</div>
+ {% endfor %}
+
+ </div>
+ {% endfor %}
+ </div>
+
+</div>
+{% endblock %}
diff --git a/src/hi/simulator/templates/simulator/panes/add_device_button.html b/src/hi/simulator/templates/simulator/panes/add_device_button.html
new file mode 100644
index 00000000..e69de29b
diff --git a/src/hi/simulator/templates/simulator/panes/sim_device.html b/src/hi/simulator/templates/simulator/panes/sim_device.html
new file mode 100644
index 00000000..70c13962
--- /dev/null
+++ b/src/hi/simulator/templates/simulator/panes/sim_device.html
@@ -0,0 +1,3 @@
+<div class="">
+ Device: {{ sim_device.name }}
+</div>
diff --git a/src/hi/simulator/urls.py b/src/hi/simulator/urls.py
index aa382ea7..905ba876 100644
--- a/src/hi/simulator/urls.py
+++ b/src/hi/simulator/urls.py
@@ -6,8 +6,8 @@ from hi.apps.common.module_utils import import_module_safe
from . import views
urlpatterns = [
- re_path( r'^$', views.simulate, name = 'home' ),
- re_path( r'^setup$', views.setup, name = 'setup' ),
+ re_path( r'^$', views.HomeView.as_view(), name = 'simulator_home' ),
+ re_path( r'^add-device$', views.AddDeviceView.as_view(), name = 'simulator_add_device' ),
]
diff --git a/src/hi/simulator/views.py b/src/hi/simulator/views.py
index 54ee0355..df477225 100644
--- a/src/hi/simulator/views.py
+++ b/src/hi/simulator/views.py
@@ -1,9 +1,35 @@
-from django.http import JsonResponse
+from django.shortcuts import render
+from django.views.generic import View
-def simulate(request):
- # Simulate an API response
- return JsonResponse({'message': 'Simulated response'})
+from .simulator_manager import SimulatorManager
-def setup(request):
- # Handle simulator setup
- return JsonResponse({'message': 'Simulator setup complete'})
+
+class HomeView( View ):
+
+ def get(self, request, *args, **kwargs):
+ simulator_manager = SimulatorManager()
+ simulator_list = simulator_manager.get_simulator_list()
+ current_simulator = simulator_list[0]
+ context = {
+ 'current_simulator': current_simulator,
+ 'simulator_list': simulator_list,
+ }
+ return render( request, 'simulator/pages/home.html', context )
+
+
+class AddDeviceView( View ):
+
+ def get(self, request, *args, **kwargs):
+ simulator_id = kwargs.get('simulator_id')
+ simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )
+ context = {
+ 'simulator': simulator,
+ }
+ return render( request, 'simulator/modals/add_device.html', context )
+
+ def post(self, request, *args, **kwargs):
+ simulator_id = kwargs.get('simulator_id')
+ device_id = kwargs.get('device_id')
+ simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )
+ simulator.add_device( device_id = device_id )
+