agentlib.modules package
Package containing all modules used by agents. Use the helper functions get_module_type to load module classes from this package.
- agentlib.modules.get_all_module_types(plugins: List[str] | None = None)[source]
Returns all available module types
- Parameters:
List[str] (plugins) – A list of strings being the plugins to consider in the search.
- Returns:
Module types, with the key as the types name and the value being the ModuleImport instance
- Return type:
dict
- agentlib.modules.get_module_type(module_type) Dict | Iterable [source]
Return and load the given module type
- Parameters:
str (module_type) – The string identifier to load the module.
- Returns:
The module specified by the given module_type
- Return type:
module BaseModuleType
Subpackages
- agentlib.modules.communicator package
- Submodules
- agentlib.modules.communicator.clonemap module
- agentlib.modules.communicator.communicator module
CommunicationDict
Communicator
CommunicatorConfig
LocalCommunicator
LocalCommunicatorConfig
LocalCommunicatorConfig.log_level
LocalCommunicatorConfig.module_id
LocalCommunicatorConfig.parse_json
LocalCommunicatorConfig.shared_variable_fields
LocalCommunicatorConfig.type
LocalCommunicatorConfig.use_orjson
LocalCommunicatorConfig.validate_incoming_values
LocalCommunicatorConfig.model_post_init()
SubscriptionCommunicatorConfig
SubscriptionCommunicatorConfig.log_level
SubscriptionCommunicatorConfig.module_id
SubscriptionCommunicatorConfig.shared_variable_fields
SubscriptionCommunicatorConfig.subscriptions
SubscriptionCommunicatorConfig.type
SubscriptionCommunicatorConfig.use_orjson
SubscriptionCommunicatorConfig.validate_incoming_values
SubscriptionCommunicatorConfig.model_post_init()
- agentlib.modules.communicator.local module
LocalClient
LocalSubscriptionCommunicatorConfig
LocalSubscriptionCommunicatorConfig.log_level
LocalSubscriptionCommunicatorConfig.module_id
LocalSubscriptionCommunicatorConfig.parse_json
LocalSubscriptionCommunicatorConfig.shared_variable_fields
LocalSubscriptionCommunicatorConfig.subscriptions
LocalSubscriptionCommunicatorConfig.type
LocalSubscriptionCommunicatorConfig.use_orjson
LocalSubscriptionCommunicatorConfig.validate_incoming_values
LocalSubscriptionCommunicatorConfig.model_post_init()
- agentlib.modules.communicator.local_broadcast module
- agentlib.modules.communicator.local_multiprocessing module
MultiProcessingBroadcastClient
MultiProcessingBroadcastClientConfig
MultiProcessingBroadcastClientConfig.authkey
MultiProcessingBroadcastClientConfig.ipv4
MultiProcessingBroadcastClientConfig.log_level
MultiProcessingBroadcastClientConfig.module_id
MultiProcessingBroadcastClientConfig.port
MultiProcessingBroadcastClientConfig.shared_variable_fields
MultiProcessingBroadcastClientConfig.type
MultiProcessingBroadcastClientConfig.use_orjson
MultiProcessingBroadcastClientConfig.validate_incoming_values
MultiProcessingBroadcastClientConfig.model_post_init()
- agentlib.modules.communicator.mqtt module
BaseMQTTClientConfig
BaseMQTTClientConfig.clean_start
BaseMQTTClientConfig.client_id
BaseMQTTClientConfig.connection_timeout
BaseMQTTClientConfig.keepalive
BaseMQTTClientConfig.log_level
BaseMQTTClientConfig.module_id
BaseMQTTClientConfig.password
BaseMQTTClientConfig.prefix
BaseMQTTClientConfig.qos
BaseMQTTClientConfig.shared_variable_fields
BaseMQTTClientConfig.subscriptions
BaseMQTTClientConfig.subtopics
BaseMQTTClientConfig.tls_ca_certs
BaseMQTTClientConfig.type
BaseMQTTClientConfig.use_orjson
BaseMQTTClientConfig.use_tls
BaseMQTTClientConfig.username
BaseMQTTClientConfig.validate_incoming_values
BaseMQTTClientConfig.model_post_init()
BaseMqttClient
MQTTClientConfig
MQTTClientConfig.clean_start
MQTTClientConfig.client_id
MQTTClientConfig.connection_timeout
MQTTClientConfig.keepalive
MQTTClientConfig.log_level
MQTTClientConfig.module_id
MQTTClientConfig.password
MQTTClientConfig.prefix
MQTTClientConfig.qos
MQTTClientConfig.shared_variable_fields
MQTTClientConfig.subscriptions
MQTTClientConfig.subtopics
MQTTClientConfig.tls_ca_certs
MQTTClientConfig.type
MQTTClientConfig.url
MQTTClientConfig.use_orjson
MQTTClientConfig.use_tls
MQTTClientConfig.username
MQTTClientConfig.validate_incoming_values
MQTTClientConfig.check_url
MQTTClientConfig.model_post_init()
MqttClient
- agentlib.modules.controller package
- Submodules
- agentlib.modules.controller.bangbang module
BangBang
BangBangConfig
BangBangConfig.gain
BangBangConfig.input
BangBangConfig.lb
BangBangConfig.log_level
BangBangConfig.module_id
BangBangConfig.output
BangBangConfig.reverse
BangBangConfig.shared_variable_fields
BangBangConfig.type
BangBangConfig.ub
BangBangConfig.validate_incoming_values
BangBangConfig.model_post_init()
- agentlib.modules.controller.controller module
Controller
SISOController
SISOControllerConfig
SISOControllerConfig.input
SISOControllerConfig.lb
SISOControllerConfig.log_level
SISOControllerConfig.module_id
SISOControllerConfig.output
SISOControllerConfig.reverse
SISOControllerConfig.shared_variable_fields
SISOControllerConfig.type
SISOControllerConfig.ub
SISOControllerConfig.validate_incoming_values
SISOControllerConfig.check_bounds
SISOControllerConfig.check_value_type
SISOControllerConfig.model_post_init()
- agentlib.modules.controller.pid module
PID
PIDConfig
PIDConfig.Kp
PIDConfig.Td
PIDConfig.Ti
PIDConfig.input
PIDConfig.lb
PIDConfig.log_level
PIDConfig.module_id
PIDConfig.output
PIDConfig.reverse
PIDConfig.setpoint
PIDConfig.shared_variable_fields
PIDConfig.type
PIDConfig.ub
PIDConfig.validate_incoming_values
PIDConfig.convert_to_variable
PIDConfig.model_post_init()
- agentlib.modules.simulation package
- Submodules
- agentlib.modules.simulation.csv_data_source module
CSVDataSource
CSVDataSourceConfig
CSVDataSourceConfig.data
CSVDataSourceConfig.data_offset
CSVDataSourceConfig.extrapolation
CSVDataSourceConfig.outputs
CSVDataSourceConfig.shared_variable_fields
CSVDataSourceConfig.t_sample
CSVDataSourceConfig.check_data
CSVDataSourceConfig.model_post_init()
CSVDataSourceConfig.transform_to_numeric_index()
CSVDataSourceConfig.validate_data
- agentlib.modules.simulation.simulator module
Simulator
SimulatorConfig
SimulatorConfig.inputs
SimulatorConfig.measurement_uncertainty
SimulatorConfig.model
SimulatorConfig.outputs
SimulatorConfig.overwrite_result_file
SimulatorConfig.parameters
SimulatorConfig.result_causalities
SimulatorConfig.result_filename
SimulatorConfig.result_sep
SimulatorConfig.save_results
SimulatorConfig.shared_variable_fields
SimulatorConfig.states
SimulatorConfig.t_sample
SimulatorConfig.t_start
SimulatorConfig.t_stop
SimulatorConfig.update_inputs_on_callback
SimulatorConfig.validate_incoming_values
SimulatorConfig.write_results_delay
SimulatorConfig.check_model
SimulatorConfig.check_nonexisting_csv
SimulatorConfig.check_t_sample
SimulatorConfig.check_t_stop
SimulatorConfig.model_post_init()
SimulatorConfig.set_default_t_sample
SimulatorResults
convert_agent_vars_to_list_of_dicts()
read_simulator_results()
- agentlib.modules.utils package
- Submodules
- agentlib.modules.utils.agent_logger module
AgentLogger
AgentLoggerConfig
AgentLoggerConfig.clean_up
AgentLoggerConfig.filename
AgentLoggerConfig.log_level
AgentLoggerConfig.module_id
AgentLoggerConfig.overwrite_log
AgentLoggerConfig.shared_variable_fields
AgentLoggerConfig.t_sample
AgentLoggerConfig.type
AgentLoggerConfig.validate_incoming_values
AgentLoggerConfig.values_only
AgentLoggerConfig.check_existence_of_file
AgentLoggerConfig.model_post_init()
- agentlib.modules.utils.try_sensor module