openpectus.aggregator.routers.process_unit

Attributes

logger

router

Functions

map_pu(engine_data)

get_registered_engine_data_or_fail(engine_id, ...)

get_unit(user_roles, unit_id[, agg])

get_units(user_roles[, agg])

get_process_values(user_roles, engine_id, response[, agg])

get_all_process_values(user_roles, engine_id, response)

get_all_process_values_of_all_available_engines(...[, agg])

Returns all process value for all online process units (engines)

execute_command(user_name, user_id, user_roles, ...[, agg])

execute_control_button_command(user_name, user_id, ...)

get_process_diagram(user_roles, unit_id[, agg])

get_command_examples(user_roles, unit_id[, agg])

get_run_log(user_roles, unit_id[, agg])

get_method_and_state(user_roles, unit_id[, agg])

get_method(user_roles, unit_id[, agg])

save_method(user_name, user_id, user_roles, unit_id, ...)

get_plot_configuration(user_roles, unit_id[, agg])

get_plot_log(user_roles, unit_id[, agg])

get_control_state(user_roles, unit_id[, agg])

get_error_log(user_roles, unit_id[, agg])

force_run_log_line(user_name, user_id, user_roles, ...)

cancel_run_log_line(user_name, user_id, user_roles, ...)

expose_system_state_enum()

get_active_users(user_roles, unit_id, response[, agg])

register_active_user(user_id_from_token, user_name, ...)

unregister_active_user(user_id_from_token, user_roles, ...)

Module Contents

openpectus.aggregator.routers.process_unit.logger
openpectus.aggregator.routers.process_unit.router
openpectus.aggregator.routers.process_unit.map_pu(engine_data)
Parameters:

engine_data (openpectus.aggregator.models.EngineData)

Return type:

openpectus.aggregator.routers.dto.ProcessUnit

openpectus.aggregator.routers.process_unit.get_registered_engine_data_or_fail(engine_id, user_roles, agg)
Parameters:
Return type:

openpectus.aggregator.models.EngineData

openpectus.aggregator.routers.process_unit.get_unit(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.ProcessUnit

openpectus.aggregator.routers.process_unit.get_units(user_roles, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

list[openpectus.aggregator.routers.dto.ProcessUnit]

openpectus.aggregator.routers.process_unit.get_process_values(user_roles, engine_id, response, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

list[openpectus.aggregator.routers.dto.ProcessValue]

openpectus.aggregator.routers.process_unit.get_all_process_values(user_roles, engine_id, response, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

list[openpectus.aggregator.routers.dto.ProcessValue]

openpectus.aggregator.routers.process_unit.get_all_process_values_of_all_available_engines(user_roles, response, agg=Depends(agg_deps.get_aggregator))

Returns all process value for all online process units (engines) that the current user has access to.

Parameters:
Return type:

list[openpectus.aggregator.routers.dto.ProcessUnitAllProcessValues]

async openpectus.aggregator.routers.process_unit.execute_command(user_name, user_id, user_roles, unit_id, command, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.ServerErrorResponse | openpectus.aggregator.routers.dto.ServerSuccessResponse

async openpectus.aggregator.routers.process_unit.execute_control_button_command(user_name, user_id, user_roles, unit_id, command, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.ServerErrorResponse | openpectus.aggregator.routers.dto.ServerSuccessResponse

openpectus.aggregator.routers.process_unit.get_process_diagram(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.ProcessDiagram

openpectus.aggregator.routers.process_unit.get_command_examples(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

list[openpectus.aggregator.routers.dto.CommandExample]

openpectus.aggregator.routers.process_unit.get_run_log(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.RunLog

openpectus.aggregator.routers.process_unit.get_method_and_state(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.MethodAndState

openpectus.aggregator.routers.process_unit.get_method(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.Method

async openpectus.aggregator.routers.process_unit.save_method(user_name, user_id, user_roles, unit_id, method_dto, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.MethodVersion

openpectus.aggregator.routers.process_unit.get_plot_configuration(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.PlotConfiguration

openpectus.aggregator.routers.process_unit.get_plot_log(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.PlotLog

openpectus.aggregator.routers.process_unit.get_control_state(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.ControlState

openpectus.aggregator.routers.process_unit.get_error_log(user_roles, unit_id, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

openpectus.aggregator.routers.dto.AggregatedErrorLog

async openpectus.aggregator.routers.process_unit.force_run_log_line(user_name, user_id, user_roles, unit_id, line_id, agg=Depends(agg_deps.get_aggregator))
Parameters:

  • user_name (openpectus.aggregator.routers.auth.UserNameValue)

  • user_id (openpectus.aggregator.routers.auth.UserIdValue)

  • user_roles (openpectus.aggregator.routers.auth.UserRolesValue)

  • unit_id (str)

  • line_id (str)

  • agg (openpectus.aggregator.aggregator.Aggregator)

async openpectus.aggregator.routers.process_unit.cancel_run_log_line(user_name, user_id, user_roles, unit_id, line_id, agg=Depends(agg_deps.get_aggregator))
Parameters:

  • user_name (openpectus.aggregator.routers.auth.UserNameValue)

  • user_id (openpectus.aggregator.routers.auth.UserIdValue)

  • user_roles (openpectus.aggregator.routers.auth.UserRolesValue)

  • unit_id (str)

  • line_id (str)

  • agg (openpectus.aggregator.aggregator.Aggregator)

openpectus.aggregator.routers.process_unit.expose_system_state_enum()
Return type:

openpectus.aggregator.routers.dto.SystemStateEnum

async openpectus.aggregator.routers.process_unit.get_active_users(user_roles, unit_id, response, agg=Depends(agg_deps.get_aggregator))
Parameters:
Return type:

list[openpectus.aggregator.routers.dto.ActiveUser]

async openpectus.aggregator.routers.process_unit.register_active_user(user_id_from_token, user_name, user_roles, unit_id, user_id=None, agg=Depends(agg_deps.get_aggregator))
Parameters:

  • user_id_from_token (openpectus.aggregator.routers.auth.UserIdValue)

  • user_name (openpectus.aggregator.routers.auth.UserNameValue)

  • user_roles (openpectus.aggregator.routers.auth.UserRolesValue)

  • unit_id (str)

  • user_id (str | pydantic.json_schema.SkipJsonSchema[None])

  • agg (openpectus.aggregator.aggregator.Aggregator)

async openpectus.aggregator.routers.process_unit.unregister_active_user(user_id_from_token, user_roles, unit_id, user_id=None, agg=Depends(agg_deps.get_aggregator))
Parameters:

  • user_id_from_token (openpectus.aggregator.routers.auth.UserIdValue)

  • user_roles (openpectus.aggregator.routers.auth.UserRolesValue)

  • unit_id (str)

  • user_id (str | pydantic.json_schema.SkipJsonSchema[None])

  • agg (openpectus.aggregator.aggregator.Aggregator)