Home Information - Your home, your data, organized.
Python
import logging
from django.core.exceptions import BadRequest
from django.http import Http404, HttpResponseRedirect, JsonResponse
from django.shortcuts import render
from django.urls import reverse
from django.views.generic import View
import hi.apps.common.antinode as antinode
from hi.simulator.profile.profile_manager import ProfileManager
from hi.simulator.settings.enums import SimTemperatureUnit
from hi.simulator.settings.runtime_settings import SimulatorRuntimeSettings
from .enums import ServiceFaultMode
from .exceptions import SimEntityValidationError
from . import forms
from .service_simulator_manager import ServiceSimulatorManager
from .sim_entity import SimEntity
from hi.simulator.services.view_mixins import ServiceSimulatorViewMixin
logger = logging.getLogger(__name__)
def _build_service_tab_specs( active_simulator_id : str ):
"""Tab strip data for the Services section. Each entry routes to
its own URL (``simulator_service``); the active one is matched by
``simulator.id``."""
specs = []
for sim_data in ServiceSimulatorManager().get_simulator_data_list():
simulator = sim_data.simulator
specs.append({
'label': simulator.label,
'url': reverse( 'simulator_service',
kwargs = { 'simulator_id': simulator.id } ),
'is_active': ( simulator.id == active_simulator_id ),
})
continue
return specs
class ServicesIndexView( View ):
"""Default ``/services/`` route — redirects to the first registered
service's per-tab URL so the URL bar always reflects which tab is
showing."""
def get(self, request, *args, **kwargs):
sim_data_list = ServiceSimulatorManager().get_simulator_data_list()
if not sim_data_list:
return render( request, 'services/pages/empty.html',
{ 'active_section': 'services',
'tab_specs': [] } )
first_simulator = sim_data_list[0].simulator
return HttpResponseRedirect(
reverse( 'simulator_service',
kwargs = { 'simulator_id': first_simulator.id } )
)
class ServiceView( View ):
"""Renders a single service simulator's tab body. Tab switching is
a full page navigation between sibling ``simulator_service``
routes."""
def get(self, request, simulator_id, *args, **kwargs):
try:
simulator = ServiceSimulatorManager().get_simulator(
simulator_id = simulator_id,
)
except KeyError:
raise Http404( f'Unknown simulator: {simulator_id!r}' )
profile_manager = ProfileManager()
module_key = simulator.module_key
runtime_settings = SimulatorRuntimeSettings()
context = {
'active_section': 'services',
'tab_specs': _build_service_tab_specs( active_simulator_id = simulator.id ),
'simulator': simulator,
'module': {
'module_key': module_key,
'label': simulator.label,
},
'profile_list': profile_manager.list_profiles( module_key ),
'current_profile': profile_manager.get_current( module_key ),
'fault_mode_choices': list( ServiceFaultMode ),
'temperature_unit_choices': list( SimTemperatureUnit ),
'temperature_unit_override': runtime_settings.temperature_unit_override,
}
context.update( simulator.extras_context )
return render( request, 'services/pages/service.html', context )
class SimStatesView( View ):
"""Periodic-poll endpoint returning a flat map of every service
simulator state's current value, keyed by the same DOM id used in
sim_state.html so the client can update in place."""
def get(self, request, *args, **kwargs):
states = {}
simulator_data_list = ServiceSimulatorManager().get_simulator_data_list()
for simulator_data in simulator_data_list:
simulator = simulator_data.simulator
for sim_entity in simulator.sim_entities:
for sim_state in sim_entity.sim_state_list:
key = (
f'hi-sim-state-{simulator.id}'
f'-{sim_state.sim_entity_id}'
f'-{sim_state.sim_state_id}'
)
states[key] = str( sim_state.value )
return JsonResponse( { 'states': states } )
class SimEntityAddView( View, ServiceSimulatorViewMixin ):
MODAL_TEMPLATE_NAME = 'services/modals/sim_entity_add.html'
def get( self, request, *args, **kwargs ):
simulator = self.get_simulator( request, *args, **kwargs)
sim_entity_definition = self.get_entity_definition( simulator, request, *args, **kwargs )
sim_entity_fields_form = forms.SimEntityFieldsForm( sim_entity_definition.sim_entity_fields_class )
context = {
'simulator': simulator,
'sim_entity_definition': sim_entity_definition,
'sim_entity_fields_form': sim_entity_fields_form,
}
return render( request, self.MODAL_TEMPLATE_NAME, context )
def post( self, request, *args, **kwargs ):
simulator = self.get_simulator( request, *args, **kwargs)
sim_entity_definition = self.get_entity_definition( simulator, request, *args, **kwargs )
sim_entity_fields_form = forms.SimEntityFieldsForm(
sim_entity_definition.sim_entity_fields_class,
request.POST,
)
def error_response():
context = {
'simulator': simulator,
'sim_entity_definition': sim_entity_definition,
'sim_entity_fields_form': sim_entity_fields_form,
}
return render( request, self.MODAL_TEMPLATE_NAME, context )
if not sim_entity_fields_form.is_valid():
return error_response()
cleaned_data = sim_entity_fields_form.clean()
SimEntityFieldsSubclass = sim_entity_definition.sim_entity_fields_class
sim_entity_fields = SimEntityFieldsSubclass.from_form_data( form_data = cleaned_data )
try:
ServiceSimulatorManager().add_sim_entity(
simulator = simulator,
sim_entity_definition = sim_entity_definition,
sim_entity_fields = sim_entity_fields,
)
return antinode.refresh_response()
except SimEntityValidationError as ve:
sim_entity_fields_form.add_error( None, str(ve) )
return error_response()
class SimEntityEditView( View, ServiceSimulatorViewMixin ):
MODAL_TEMPLATE_NAME = 'services/modals/sim_entity_edit.html'
def get( self, request, *args, **kwargs ):
db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )
simulator = self._get_simulator_for_entity( db_sim_entity )
sim_entity_definition = self.get_entity_definition_by_id(
simulator = simulator,
class_id = db_sim_entity.entity_fields_class_id,
)
sim_entity = SimEntity(
db_sim_entity = db_sim_entity,
sim_entity_definition = sim_entity_definition,
)
sim_entity_fields_form = forms.SimEntityFieldsForm(
sim_entity_fields_class = sim_entity_definition.sim_entity_fields_class,
initial = sim_entity.sim_entity_fields.to_initial_form_values(),
)
context = {
'simulator': simulator,
'db_sim_entity': db_sim_entity,
'sim_entity_fields_form': sim_entity_fields_form,
}
return render( request, self.MODAL_TEMPLATE_NAME, context )
def post( self, request, *args, **kwargs ):
db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )
simulator = self._get_simulator_for_entity( db_sim_entity )
sim_entity_definition = self.get_entity_definition_by_id(
simulator = simulator,
class_id = db_sim_entity.entity_fields_class_id,
)
sim_entity_fields_form = forms.SimEntityFieldsForm(
sim_entity_definition.sim_entity_fields_class,
request.POST,
)
def error_response():
context = {
'simulator': simulator,
'db_sim_entity': db_sim_entity,
'sim_entity_fields_form': sim_entity_fields_form,
}
return render( request, self.MODAL_TEMPLATE_NAME, context )
if not sim_entity_fields_form.is_valid():
return error_response()
cleaned_data = sim_entity_fields_form.clean()
SimEntityFieldsSubclass = sim_entity_definition.sim_entity_fields_class
sim_entity_fields = SimEntityFieldsSubclass.from_form_data( form_data = cleaned_data )
try:
ServiceSimulatorManager().update_sim_entity_fields(
simulator = simulator,
sim_entity_definition= sim_entity_definition,
db_sim_entity = db_sim_entity,
sim_entity_fields = sim_entity_fields,
)
return antinode.refresh_response()
except SimEntityValidationError as ve:
sim_entity_fields_form.add_error( None, str(ve) )
return error_response()
def _get_simulator_for_entity( self, db_sim_entity ):
"""The DbSimEntity row is tied to a SimProfile (with
module_key) — derive the owning simulator by matching
module_key against the discovered service simulators."""
module_key = db_sim_entity.sim_profile.module_key
for sim_data in ServiceSimulatorManager().get_simulator_data_list():
if sim_data.simulator.module_key == module_key:
return sim_data.simulator
continue
raise BadRequest(
f'No service simulator registered for module {module_key!r}'
)
class SimEntityDeleteView( View, ServiceSimulatorViewMixin ):
MODAL_TEMPLATE_NAME = 'services/modals/sim_entity_delete.html'
def get( self, request, *args, **kwargs ):
db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )
simulator = self._get_simulator_for_entity( db_sim_entity )
sim_entity_definition = self.get_entity_definition_by_id(
simulator = simulator,
class_id = db_sim_entity.entity_fields_class_id,
)
sim_entity = SimEntity(
db_sim_entity = db_sim_entity,
sim_entity_definition = sim_entity_definition,
)
context = {
'sim_entity': sim_entity,
'sim_entity_field': sim_entity.sim_entity_fields,
}
return render( request, self.MODAL_TEMPLATE_NAME, context )
def post( self, request, *args, **kwargs ):
db_sim_entity = self.get_db_sim_entity( request, *args, **kwargs )
simulator = self._get_simulator_for_entity( db_sim_entity )
ServiceSimulatorManager().delete_sim_entity(
simulator = simulator,
db_sim_entity = db_sim_entity,
)
return antinode.refresh_response()
def _get_simulator_for_entity( self, db_sim_entity ):
module_key = db_sim_entity.sim_profile.module_key
for sim_data in ServiceSimulatorManager().get_simulator_data_list():
if sim_data.simulator.module_key == module_key:
return sim_data.simulator
continue
raise BadRequest(
f'No service simulator registered for module {module_key!r}'
)
class SetServiceFaultModeView( View, ServiceSimulatorViewMixin ):
"""Operator-driven control to flip a simulator into a fault-
injection mode (or back to HEALTHY). Lives at a top-level URL —
outside the /services/<short_name>/ subtree — so the fault-
injection middleware never intercepts requests to it. This is the
operator's escape hatch when a simulator is in any non-HEALTHY
mode.
Returns the fault-mode form HTML fragment so antinode.js can swap
it in place (data-async + data-mode=replace), avoiding a full
page reload on each toggle.
"""
TEMPLATE_NAME = 'services/panes/fault_mode_form.html'
def post( self, request, *args, **kwargs ):
simulator = self.get_simulator_by_id(
simulator_id = kwargs.get('simulator_id'),
)
fault_mode_name = request.POST.get('fault_mode')
try:
fault_mode = ServiceFaultMode[ fault_mode_name ]
except (KeyError, TypeError):
raise BadRequest( f'Invalid fault mode: {fault_mode_name}' )
simulator.set_fault_mode( fault_mode )
context = {
'simulator': simulator,
'fault_mode_choices': list( ServiceFaultMode ),
}
return render( request, self.TEMPLATE_NAME, context )
class SimStateSetView( View, ServiceSimulatorViewMixin ):
TEMPLATE_NAME = 'services/panes/sim_state.html'
def post( self, request, *args, **kwargs ):
simulator = self.get_simulator( request, *args, **kwargs)
sim_entity_id = int( kwargs.get( 'sim_entity_id' ))
sim_state_id = kwargs.get( 'sim_state_id' )
value_str = request.POST.get('value')
sim_state = simulator.set_sim_state(
sim_entity_id = sim_entity_id,
sim_state_id = sim_state_id,
value_str = value_str,
)
self._record_if_active( simulator, sim_entity_id, sim_state_id, value_str )
context = {
'simulator': simulator,
'sim_state': sim_state,
}
return render( request, self.TEMPLATE_NAME, context )
def _record_if_active( self, simulator, sim_entity_id, sim_state_id, value_str ):
"""Append this operator state change to the active scene recording,
if any. Lazy import keeps the services app decoupled from scenes."""
from hi.simulator.scenes.recorder import SimRecorder
recorder = SimRecorder()
if not recorder.is_recording():
return
try:
entity_name = simulator.get_sim_entity_by_id(
sim_entity_id = sim_entity_id,
).name
except Exception:
logger.exception( 'Recorder: failed to resolve entity for capture.' )
return
recorder.record_step(
module_key = simulator.module_key,
entity_name = entity_name,
sim_state_id = sim_state_id,
value_str = value_str,
)
return