Home Information - Your home, your data, organized.
Python
Saving while working out SImulator control UIs. WIP
Anthony Cassandrad279ff53f9e1
diff --git a/src/hi/simulator/models.py b/src/hi/simulator/models.pyindex 85a55339..9c269e2d 100644--- a/src/hi/simulator/models.py+++ b/src/hi/simulator/models.py@@ -27,7 +27,10 @@ class SimProfile(models.Model):verbose_name_plural = 'Simulator Profiles'ordering = [ '-last_switched_to_datetime' ]-+ def __str__(self):+ return f'{self.name} [{self.id}]'++class DbSimEntity(models.Model):sim_profile = models.ForeignKey(diff --git a/src/hi/simulator/services/hass/transient_models.py b/src/hi/simulator/services/hass/transient_models.pyindex d0394e04..3f68c238 100644--- a/src/hi/simulator/services/hass/transient_models.py+++ b/src/hi/simulator/services/hass/transient_models.py@@ -69,11 +69,12 @@ class HassInsteonLightSwitch( HassInsteonEntity ):@classmethoddef get_entity_type(cls) -> EntityType:return EntityType.LIGHT-- def get_sim_state_list(self) -> List[ SimState ]:++ @property+ def sim_state_list(self) -> List[ SimState ]:pass- def entity_list(self):+ def hass_state_list(self):dummy_datetime_iso = datetimeproxy.now().isoformat()hass_light_state = HassState(@@ -106,7 +107,7 @@ class HassInsteonLightSwitch( HassInsteonEntity ):hass_color_state ]def to_api_list(self):- return [ x.to_api_dict() for x in self.entity_list() ]+ return [ x.to_api_dict() for x in self.hass_state_list() ]@dataclass( frozen = True )@@ -120,10 +121,10 @@ class HassInsteonMotionDetector( HassInsteonEntity ):def get_entity_type(cls) -> EntityType:return EntityType.MOTION_SENSOR- def get_sim_state_list(self) -> List[ SimState ]:+ def sim_state_list(self) -> List[ SimState ]:pass- def entity_list(self):+ def hass_state_list(self):dummy_datetime_iso = datetimeproxy.now().isoformat()hass_motion_state = HassState(@@ -167,7 +168,7 @@ class HassInsteonMotionDetector( HassInsteonEntity ):hass_battery_state ]def to_api_list(self):- return [ x.to_api_dict() for x in self.entity_list() ]+ return [ x.to_api_dict() for x in self.hass_state_list() ]@dataclass( frozen = True )@@ -181,10 +182,10 @@ class HassInsteonOpenCloseSensor( HassInsteonEntity ):def get_entity_type(cls) -> EntityType:return EntityType.OPEN_CLOSE_SENSOR- def get_sim_state_list(self) -> List[ SimState ]:+ def sim_state_list(self) -> List[ SimState ]:pass- def entity_list(self):+ def hass_state_list(self):dummy_datetime_iso = datetimeproxy.now().isoformat()hass_state = HassState(@@ -203,7 +204,7 @@ class HassInsteonOpenCloseSensor( HassInsteonEntity ):return [ hass_state ]def to_api_list(self):- return [ x.to_api_dict() for x in self.entity_list() ]+ return [ x.to_api_dict() for x in self.hass_state_list() ]HASS_SIM_ENTITY_LIST = [diff --git a/src/hi/simulator/services/zoneminder/transient_models.py b/src/hi/simulator/services/zoneminder/transient_models.pyindex d449db58..e7394d05 100644--- a/src/hi/simulator/services/zoneminder/transient_models.py+++ b/src/hi/simulator/services/zoneminder/transient_models.py@@ -8,6 +8,14 @@ from hi.apps.entity.enums import EntityType, EntityStateType, EntityStateValuefrom hi.simulator.transient_models import SimEntity, SimState+@dataclass+class ZmServerState( SimState ):++ name : str = 'ZoneMinder State'+ entity_state_type : EntityStateType = EntityStateType.DISCRETE+ state_value : str = 'Home'++@dataclass( frozen = True )class ZmServerEntity( SimEntity ):@@ -21,10 +29,27 @@ class ZmServerEntity( SimEntity ):def get_entity_type(cls) -> EntityType:return EntityType.SERVICE- def get_sim_state_list(self) -> List[ SimState ]:- pass+ @property+ def sim_state_list(self) -> List[ SimState ]:+ return [ ZmServerState() ]+++@dataclass+class ZmMonitorFunctionState( SimState ):++ name : str = 'Monitor Function'+ entity_state_type : EntityStateType = EntityStateType.DISCRETE+ state_value : str = 'Modect'++@dataclass+class ZmMonitorMotionState( SimState ):+ name : str = 'Camera Motion'+ entity_state_type : EntityStateType = EntityStateType.MOVEMENT+ state_value : str = EntityStateValue.IDLE++@dataclass( frozen = True )class ZmMonitorEntity( SimEntity ):@@ -50,8 +75,12 @@ class ZmMonitorEntity( SimEntity ):def get_entity_type(cls) -> EntityType:return EntityType.CAMERA- def get_sim_state_list(self) -> List[ SimState ]:- pass+ @property+ def sim_state_list(self) -> List[ SimState ]:+ return [+ ZmMonitorFunctionState(),+ ZmMonitorMotionState(),+ ]def to_api_dict(self):return {@@ -163,21 +192,6 @@ class ZmMonitorEntity( SimEntity ):}-@dataclass-class ZmMonitorFunctionState( SimState ):-- function : str = None- entity_state_type : EntityStateType = EntityStateType.DISCRETE- state_value : str = '1'---@dataclass-class ZmMonitorMotionState( SimState ):-- entity_state_type : EntityStateType = EntityStateType.MOVEMENT- state_value : str = EntityStateValue.IDLE--@dataclassclass ZmStateDefinition:diff --git a/src/hi/simulator/simulator.py b/src/hi/simulator/simulator.pyindex 8d2302cc..65bd2845 100644--- a/src/hi/simulator/simulator.py+++ b/src/hi/simulator/simulator.py@@ -13,20 +13,26 @@ class Simulator( Singleton ):@propertydef id(self) -> str:+ """ A unique identifier for referencing this simulator implementation. """raise NotImplementedError('Subclasses must override this method.')@propertydef label(self) -> str:+ """ A human-friendly label for this simulatior. """raise NotImplementedError('Subclasses must override this method.')def get_sim_entity_class_list(self) -> List[ Type[ SimEntity ]]:+ """+ A return a list of SimEntity subclasses that define the different types+ of entities that can be define for the simulator.+ """raise NotImplementedError('Subclasses must override this method.')def validate_new_sim_entity( self, sim_entity : SimEntity ):"""- Called before adding a new SimEntity to allow simulator to validate- before addition. Should raise SimEntityValidationError if there is an- issue.+ Called before adding or updating a SimEntity to allow simulator to do+ custom validation checks before add/edit/save. Should raise+ SimEntityValidationError if there is any validation issue."""raise NotImplementedError('Subclasses must override this method.')@@ -56,6 +62,9 @@ class Simulator( Singleton ):self._sim_entity_list.append( sim_entity )return+ def update_sim_entity( self, sim_entity : SimEntity ):+ raise NotImplementedError('Need to work out who owns managing the data: SimulatorManager or Simulator.')+def remove_sim_entity( self, sim_entity : SimEntity ):try:self._sim_entity_list.remove(sim_entity)diff --git a/src/hi/simulator/simulator_manager.py b/src/hi/simulator/simulator_manager.pyindex 0a8d96af..b363072b 100644--- a/src/hi/simulator/simulator_manager.py+++ b/src/hi/simulator/simulator_manager.py@@ -3,7 +3,7 @@ import loggingfrom threading import Lockfrom typing import Dict, List-from django.apps import apps+from django.apps import apps as django_appsimport hi.apps.common.datetimeproxy as datetimeproxyfrom hi.apps.common.module_utils import import_module_safe@@ -35,8 +35,8 @@ class SimulatorManager( Singleton ):return self._current_sim_profiledef set_sim_profile( self, sim_profile : SimProfile ):- should_reinitialize_simulators = bool( not sim_profile- or ( sim_profile != self._current_sim_profile ))+ should_reload_instances = bool( not sim_profile+ or ( sim_profile != self._current_sim_profile ))if not sim_profile:self._initialize_sim_profile()else:@@ -44,8 +44,8 @@ class SimulatorManager( Singleton ):sim_profile.save()self._current_sim_profile = sim_profile- if should_reinitialize_simulators:- self._initialize_simulators()+ if should_reload_instances:+ self._reload_sim_entity_instances()returndef get_simulator( self, simulator_id : str ) -> Simulator:@@ -54,10 +54,10 @@ class SimulatorManager( Singleton ):raise KeyError( f'Simulator id "{simulator_id}" not found.' )return simulator_data.simulator- def get_simulator_list(self) -> List[ Simulator ]:- simulator_list = [ x.simulator for x in self._simulator_data_map.values() ]- simulator_list.sort( key = lambda item : item.label )- return simulator_list+ def get_simulator_data_list(self) -> List[ SimulatorData ]:+ simulator_data_list = [ x for x in self._simulator_data_map.values() ]+ simulator_data_list.sort( key = lambda item : item.simulator.label )+ return simulator_data_listdef add_sim_entity( self,simulator : Simulator,@@ -95,6 +95,23 @@ class SimulatorManager( Singleton ):finally:self._data_lock.release()+ def update_sim_entity( self,+ simulator : Simulator,+ db_sim_entity : DbSimEntity,+ sim_entity : SimEntity ):+ simulator.update_sim_entity( sim_entity = sim_entity )++ self._data_lock.acquire()+ try:+ simulator_data = self._simulator_data_map.get( simulator.id )+ if not simulator_data:+ raise KeyError( f'No data found for simulator id = {simulator.id}' )+ db_sim_entity.editable_fields = sim_entity.to_json_dict()+ db_sim_entity.save()++ finally:+ self._data_lock.release()+async def initialize(self) -> None:self._data_lock.acquire()try:@@ -110,7 +127,7 @@ class SimulatorManager( Singleton ):def _initialize_sim_profile(self):logger.debug("Initialize SimProfile ...")- self._current_sim_profile = SimProfile.objects.all().first() # Default ordering by usage time+ self._current_sim_profile = SimProfile.objects.all().first() # Default ordering is by recency useif not self._current_sim_profile:self._current_sim_profile = SimProfile.objects.create(name = self.DEFAULT_PROFILE_NAME,@@ -122,7 +139,7 @@ class SimulatorManager( Singleton ):logger.debug("Discovering defined simulators ...")self._simulator_data_map = dict()- for app_config in apps.get_app_configs():+ for app_config in django_apps.get_app_configs():if not app_config.name.startswith( 'hi.simulator.services' ):continuemodule_name = f'{app_config.name}.simulator'@@ -163,7 +180,7 @@ class SimulatorManager( Singleton ):simulator = simulator_data.simulatorsim_entity_class_data_list = simulator.sim_entity_class_data_listlogger.debug( f'Adding {len(sim_entity_class_data_list)} entities to simulator {simulator_id}.' )- for sim_entity_class_data in osim_entity_class_data_list:+ for sim_entity_class_data in sim_entity_class_data_list:class_id = sim_entity_class_data.class_idsimulator_data.sim_entity_class_map[class_id] = sim_entity_class_data.sim_entity_classcontinue@@ -185,12 +202,12 @@ class SimulatorManager( Singleton ):sim_entity_class_map = simulator_data.sim_entity_class_mapclass_id = db_sim_entity.entity_class_id- sim_entity_class = sim_entity_class_map.get( class_id )- if not sim_entity_class:+ SimEntitySubclass = sim_entity_class_map.get( class_id )+ if not SimEntitySubclass:logger.warning( f'Entity class "{class_id}" not found for simulator "{simulator_id}"' )continue- sim_entity = sim_entity_class.from_json_dict( db_sim_entity.editable_fields )+ sim_entity = SimEntitySubclass.from_json_dict( db_sim_entity.editable_fields )simulator_data.sim_entity_instance_map[sim_entity] = db_sim_entitycontinuereturn@@ -203,4 +220,16 @@ class SimulatorManager( Singleton ):simulator_data.simulator.initialize( sim_entity_list = sim_entity_list )continuereturn++ def _reload_sim_entity_instances(self):+ self._clear_sim_entity_instances()+ self._load_sim_entity_instances()+ self._initialize_simulators()+ return++ def _clear_sim_entity_instances(self):+ for simulator_id, simulator_data in self._simulator_data_map.items():+ simulator_data.sim_entity_instance_map = dict()+ continue+ returndiff --git a/src/hi/simulator/templates/simulator/modals/sim_entity_delete.html b/src/hi/simulator/templates/simulator/modals/sim_entity_delete.htmlindex 3ac97044..e360491b 100644--- a/src/hi/simulator/templates/simulator/modals/sim_entity_delete.html+++ b/src/hi/simulator/templates/simulator/modals/sim_entity_delete.html@@ -7,7 +7,7 @@{% endblock %}{% block title_text %}-Delete Entity?+Delete {{ sim_entity.name }}?{% endblock %}{% block body %}@@ -15,7 +15,7 @@ Delete Entity?Delete the simulator entity "{{ sim_entity.name }}"?</p><p class="text-danger">- This actionn cannot be undone.+ This action cannot be undone.</p>{% endblock %}diff --git a/src/hi/simulator/templates/simulator/panes/sim_entity.html b/src/hi/simulator/templates/simulator/panes/sim_entity.htmlindex 05307bca..2ee0c1af 100644--- a/src/hi/simulator/templates/simulator/panes/sim_entity.html+++ b/src/hi/simulator/templates/simulator/panes/sim_entity.html@@ -1,3 +1,26 @@-<div class="">- Entity: {{ sim_entity.name }}+<div class="row">+ <div class="col-3">+ {{ sim_entity.name }}+ </div>+ <div class="col-7">+ {% for sim_state in sim_entity.sim_state_list %}+ <div class="row">+ <div class="col-4">+ {{ sim_state.name }}+ </div>+ <div class="col-8">+ CONTROL : {{ sim_state.entity_state_type }}+ VALUE : {{ sim_state.state_value }}+ </div>+ </div>+ {% empty %}+ <div class="alert alert-warning">No simulation states defined.</div>+ {% endfor %}+ </div>+ <div class="col-2">+ <a href="{% url 'simulator_entity_edit' sim_entity_id=db_sim_entity.id %}"+ class="btn btn-info" data-async="modal">EDIT</a>+ <a href="{% url 'simulator_entity_delete' sim_entity_id=db_sim_entity.id %}"+ class="btn btn-danger" data-async="modal">X</a>+ </div></div>diff --git a/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html b/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.htmlindex d4fcbfc9..0c200975 100644--- a/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html+++ b/src/hi/simulator/templates/simulator/panes/simulator_control_tabs.html@@ -1,8 +1,9 @@<div><ul id="hi-simulator-tabs" class="nav nav-tabs" role="tablist">- {% for simulator in simulator_list %}+ {% for simulator_data in simulator_data_list %}+ {% with simulator_data.simulator as simulator %}<li class="nav-item">- <a id="hi-simulator-tab-{{ simulator.id }}" role="tab"+ <a id="hi-simulator-tab-{{ simulator_data.simulator.id }}" role="tab"class="nav-link {% if simulator.id == current_simulator.id %}active{% endif %}"data-toggle="tab"href="#hi-simulator-content-{{ simulator.id }}"@@ -11,11 +12,13 @@aria-selected="{% if simulator.id == current_simulator.id %}true{% else %}false{% endif %}">{{ simulator.label }}</a></li>+ {% endwith %}{% endfor %}</ul><div id="hi-simulator-tab-content" class="tab-content">- {% for simulator in simulator_list %}+ {% for simulator_data in simulator_data_list %}+ {% with simulator_data.simulator as simulator %}<div id="hi-simulator-content-{{ simulator.id }}"class="tab-pane fade {% if simulator.id == current_simulator.id %}show active{% endif %}"role="tabpanel"@@ -44,13 +47,14 @@</div></div>- {% for sim_entity in simulator.sim_entities %}- {% include "simulator/panes/sim_entity.html" with simulator=simulator sim_entity=sim_entity %}+ {% for sim_entity, db_sim_entity in simulator_data.sim_entity_instance_map.items %}+ {% include "simulator/panes/sim_entity.html" with simulator=simulator sim_entity=sim_entity db_sim_entity=db_sim_entity %}{% empty %}<div class="alert alert-info" >No {{ simulator.label }} simulator entities defined.</div>{% endfor %}</div>+ {% endwith %}{% endfor %}</div></div>diff --git a/src/hi/simulator/transient_models.py b/src/hi/simulator/transient_models.pyindex 52954260..f0b46207 100644--- a/src/hi/simulator/transient_models.py+++ b/src/hi/simulator/transient_models.py@@ -55,8 +55,9 @@ class SimEntity:@classmethoddef get_entity_type(cls) -> EntityType:raise NotImplementedError('Subclasses must override this method.')-- def get_sim_state_list(self) -> List[ SimState ]:++ @property+ def sim_state_list(self) -> List[ SimState ]:"""These are defined by the Simulator and used by the SimulatorManager toknow what states exists and can be simulated. The Simulator keeps track ofdiff --git a/src/hi/simulator/view_mixins.py b/src/hi/simulator/view_mixins.pyindex acfc0561..a12030cb 100644--- a/src/hi/simulator/view_mixins.py+++ b/src/hi/simulator/view_mixins.py@@ -38,16 +38,21 @@ class SimulatorViewMixin:raise Http404( 'Simulator profile does not exist.' )def get_simulator( self, request, *args, **kwargs ) -> Simulator:+ """ Side effect of setting current simulator in session. """simulator_id = kwargs.get('simulator_id')+ simulator = self.get_simulator_by_id( simulator_id = simulator_id )+ self.set_current_simulator(+ request = request,+ simulator = simulator,+ )+ return simulator++ def get_simulator_by_id( self, simulator_id : str ) -> Simulator:if not simulator_id:raise BadRequest( 'Missing simulator id.' )simulator = SimulatorManager().get_simulator( simulator_id = simulator_id )if not simulator:raise Http404( 'Unknown simulator id "{simulator_id}".' )- self.set_current_simulator(- request = request,- simulator = simulator,- )return simulatordef get_entity_class_data( self, simulator : Simulator, request, *args, **kwargs ) -> Type[ SimEntity ]:diff --git a/src/hi/simulator/views.py b/src/hi/simulator/views.pyindex d3a38fe1..a86cc76c 100644--- a/src/hi/simulator/views.py+++ b/src/hi/simulator/views.py@@ -1,5 +1,4 @@-from django.core.exceptions import BadRequest-from django.http import Http404, HttpResponseRedirect+from django.http import HttpResponseRedirectfrom django.shortcuts import renderfrom django.urls import reversefrom django.views.generic import View@@ -10,7 +9,6 @@ from .exceptions import SimEntityValidationErrorfrom . import formsfrom .models import DbSimEntityfrom .simulator_manager import SimulatorManager-from .transient_models import SimEntity, SimEntityClassDatafrom .view_mixins import SimulatorViewMixin@@ -20,15 +18,15 @@ class HomeView( View, SimulatorViewMixin ):simulator_manager = SimulatorManager()sim_profile_list = simulator_manager.get_sim_profile_list()current_sim_profile = simulator_manager.current_sim_profile- simulator_list = simulator_manager.get_simulator_list()+ simulator_data_list = simulator_manager.get_simulator_data_list()current_simulator = self.get_current_simulator(request = request,- simulator_list = simulator_list,+ simulator_list = [ x.simulator for x in simulator_data_list ],)context = {'sim_profile_list': sim_profile_list,'current_sim_profile': current_sim_profile,- 'simulator_list': simulator_list,+ 'simulator_data_list': simulator_data_list,'current_simulator': current_simulator,}return render( request, 'simulator/pages/home.html', context )@@ -141,24 +139,31 @@ class SimEntityAddView( View, SimulatorViewMixin ):sim_entity_class_data.sim_entity_class,request.POST,)- if not sim_entity_form.is_valid():++ def error_response():context = {'simulator': simulator,'sim_entity_class_data': sim_entity_class_data,'sim_entity_form': sim_entity_form,}return render( request, self.MODAL_TEMPLATE_NAME, context )++ if not sim_entity_form.is_valid():+ return error_response()cleaned_data = sim_entity_form.clean()- sim_entity = SimEntity.from_form_data( form_data = cleaned_data )+ SimEntitySubclass = sim_entity_class_data.sim_entity_class+ sim_entity = SimEntitySubclass.from_form_data( form_data = cleaned_data )try:SimulatorManager().add_sim_entity(simulator = simulator,sim_entity = sim_entity,)+ return antinode.refresh_response()+except SimEntityValidationError as ve:- raise BadRequest( str(ve) )- return antinode.refresh_response()+ sim_entity_form.add_error( None, str(ve) )+ return error_response()class SimEntityEditView( View, SimulatorViewMixin ):@@ -167,14 +172,13 @@ class SimEntityEditView( View, SimulatorViewMixin ):def get( self, request, *args, **kwargs ):db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )- simulator = SimulatorManager().get_simulator( simulator_id = db_sim_entity.simulator_id )- if not simulator:- raise Http404( 'Unknown simulator id "{simulator_id}".' )+ simulator = self.get_simulator_by_id( simulator_id = db_sim_entity.simulator_id )sim_entity_class_data = self.get_entity_class_data_by_id(simulator = simulator,class_id = db_sim_entity.entity_class_id,)- sim_entity = SimEntity.from_json_dict( db_sim_entity.editable_fields )+ SimEntitySubclass = sim_entity_class_data.sim_entity_class+ sim_entity = SimEntitySubclass.from_json_dict( db_sim_entity.editable_fields )sim_entity_form = forms.SimEntityForm(sim_entity_class = sim_entity_class_data.sim_entity_class,initial = sim_entity.to_initial_form_values(),@@ -189,37 +193,41 @@ class SimEntityEditView( View, SimulatorViewMixin ):def post( self, request, *args, **kwargs ):db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )- simulator = SimulatorManager().get_simulator( simulator_id = db_sim_entity.simulator_id )- if not simulator:- raise Http404( 'Unknown simulator id "{simulator_id}".' )+ simulator = self.get_simulator_by_id( simulator_id = db_sim_entity.simulator_id )sim_entity_class_data = self.get_entity_class_data_by_id(simulator = simulator,class_id = db_sim_entity.entity_class_id,)- previous_sim_entity = SimEntity.from_json_dict( db_sim_entity.editable_fields )sim_entity_form = forms.SimEntityForm(sim_entity_class_data.sim_entity_class,request.POST,)- if not sim_entity_form.is_valid():++ def error_response():context = {'simulator': simulator,'db_sim_entity': db_sim_entity,- 'sim_entity': previous_sim_entity,'sim_entity_form': sim_entity_form,}return render( request, self.MODAL_TEMPLATE_NAME, context )-++ if not sim_entity_form.is_valid():+ return error_response()+cleaned_data = sim_entity_form.clean()- sim_entity = SimEntity.from_form_data( form_data = cleaned_data )+ SimEntitySubclass = sim_entity_class_data.sim_entity_class+ sim_entity = SimEntitySubclass.from_form_data( form_data = cleaned_data )try:SimulatorManager().update_sim_entity(+ simulator = simulator,db_sim_entity = db_sim_entity,sim_entity = sim_entity,)+ return antinode.refresh_response()+except SimEntityValidationError as ve:- raise BadRequest( str(ve) )- return antinode.refresh_response()+ sim_entity_form.add_error( None, str(ve) )+ return error_response()class SimEntityDeleteView( View, SimulatorViewMixin ):@@ -228,8 +236,16 @@ class SimEntityDeleteView( View, SimulatorViewMixin ):def get( self, request, *args, **kwargs ):db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )+ simulator = self.get_simulator_by_id( simulator_id = db_sim_entity.simulator_id )+ sim_entity_class_data = self.get_entity_class_data_by_id(+ simulator = simulator,+ class_id = db_sim_entity.entity_class_id,+ )+ SimEntitySubclass = sim_entity_class_data.sim_entity_class+ sim_entity = SimEntitySubclass.from_json_dict( db_sim_entity.editable_fields )context = {'db_sim_entity': db_sim_entity,+ 'sim_entity': sim_entity,}return render( request, self.MODAL_TEMPLATE_NAME, context )