naeural-client 2.0.0__py3-none-any.whl

naeural_client/const/comms.py

@@ -0,0 +1,80 @@
+from . import base as BASE_CT
+# BC Consts:
+from ..bc.base import BCct as BC_CT
+
+SB_ID = BASE_CT.SB_ID
+EE_ID = BASE_CT.EE_ID
+EE_ADDR = 'EE_ADDR'
+
+HOST = 'HOST'
+TOPIC = 'TOPIC'
+BROKER = 'BROKER'
+PORT = 'PORT'
+USER = 'USER'
+PASS = 'PASS'
+CERT_PATH = 'CERT_PATH'
+VHOST = 'VHOST'
+DEVICE_ID = 'DEVICE_ID'
+ROUTING_KEY = 'ROUTING_KEY'
+QOS = 'QOS'
+SECURED = 'SECURED'
+
+EXCHANGE = 'EXCHANGE'
+EXCHANGE_TYPE = 'EXCHANGE_TYPE'
+QUEUE = 'QUEUE'
+QUEUE_DURABLE = 'QUEUE_DURABLE'
+QUEUE_EXCLUSIVE = 'QUEUE_EXCLUSIVE'
+QUEUE_DEVICE_SPECIFIC = 'QUEUE_DEVICE_SPECIFIC'
+
+COMMUNICATION_CONFIG_CHANNEL = 'CONFIG_CHANNEL'
+COMMUNICATION_PAYLOADS_CHANNEL = 'PAYLOADS_CHANNEL'
+COMMUNICATION_CTRL_CHANNEL = 'CTRL_CHANNEL'
+COMMUNICATION_NOTIF_CHANNEL = 'NOTIF_CHANNEL'
+COMMUNICATION_VALID_CHANNELS = [
+    COMMUNICATION_CONFIG_CHANNEL, COMMUNICATION_PAYLOADS_CHANNEL,
+    COMMUNICATION_CTRL_CHANNEL, COMMUNICATION_NOTIF_CHANNEL
+]
+COMMUNICATION_DEFAULT = 'DEFAULT'
+COMMUNICATION_COMMAND_AND_CONTROL = 'COMMANDCONTROL'
+COMMUNICATION_HEARTBEATS = 'HEARTBEATS'
+COMMUNICATION_NOTIFICATIONS = 'NOTIFICATIONS'
+COMMUNICATION_VALID_TYPES = [
+    COMMUNICATION_DEFAULT, COMMUNICATION_COMMAND_AND_CONTROL,
+    COMMUNICATION_HEARTBEATS, COMMUNICATION_NOTIFICATIONS
+]
+
+
+class TIMERS:
+  TIMER_SEND_BUFFER_PAYLOAD = 'send_buffer_payload'
+
+
+class COMM_SEND_MESSAGE:
+  K_ACTION = 'ACTION'
+  K_PAYLOAD = 'PAYLOAD'
+  K_EE_ID = EE_ID
+  K_INITIATOR_ID = 'INITIATOR_ID'
+  K_SESSION_ID = 'SESSION_ID'
+  K_SENDER_ADDR = BC_CT.SENDER
+  K_TIME = 'TIME'
+  K_EE_IS_ENCRYPTED = "EE_IS_ENCRYPTED"
+  K_EE_ENCRYPTED_DATA = "EE_ENCRYPTED_DATA"
+
+  ACTION_VALUE_PAYLOAD = K_PAYLOAD
+
+
+class COMM_RECV_MESSAGE:
+  K_ACTION = COMM_SEND_MESSAGE.K_ACTION
+  K_PAYLOAD = COMM_SEND_MESSAGE.K_PAYLOAD
+  K_EE_ID = COMM_SEND_MESSAGE.K_EE_ID
+  K_INITIATOR_ID = COMM_SEND_MESSAGE.K_INITIATOR_ID
+  K_SESSION_ID = COMM_SEND_MESSAGE.K_SESSION_ID
+  K_SENDER_ADDR = COMM_SEND_MESSAGE.K_SENDER_ADDR
+  K_EE_IS_ENCRYPTED = COMM_SEND_MESSAGE.K_EE_IS_ENCRYPTED
+  K_EE_ENCRYPTED_DATA = COMM_SEND_MESSAGE.K_EE_ENCRYPTED_DATA
+
+  K_VALIDATED = 'VALIDATED'  # this is a flag to indicate if the message was validated or not
+
+
+COMM_SEND_BUFFER = 100
+COMM_RECV_BUFFER = 100
+COMM_SECS_SHOW_INFO = 180

naeural_client/const/environment.py

@@ -0,0 +1,26 @@
+class ENVIRONMENT:
+  AIXP_USERNAME = 'AIXP_USERNAME'
+  AIXP_USER = 'AIXP_USER'
+  EE_USERNAME = 'EE_USERNAME'
+  EE_USER = 'EE_USER'
+
+  AIXP_PASSWORD = 'AIXP_PASSWORD'
+  AIXP_PASS = 'AIXP_PASS'
+  AIXP_PWD = 'AIXP_PWD'
+  EE_PASSWORD = 'EE_PASSWORD'
+  EE_PASS = 'EE_PASS'
+  EE_PWD = 'EE_PWD'
+
+  AIXP_HOSTNAME = 'AIXP_HOSTNAME'
+  AIXP_HOST = 'AIXP_HOST'
+  EE_HOSTNAME = 'EE_HOSTNAME'
+  EE_HOST = 'EE_HOST'
+
+  AIXP_PORT = 'AIXP_PORT'
+  EE_PORT = 'EE_PORT'
+
+  AIXP_CERT_PATH = 'AIXP_CERT_PATH'
+  EE_CERT_PATH = 'EE_CERT_PATH'
+
+  EE_SECURED = 'EE_SECURED'
+  AIXP_SECURED = 'AIXP_SECURED'

naeural_client/const/formatter.py

@@ -0,0 +1,7 @@
+class FORMATTER_DATA:
+  NAME = 'NAME'
+  SIGNATURE = 'SIGNATURE'
+  STREAM = 'STREAM'
+  ID = 'ID'  # ??
+  DESCRIPTION = 'DESCRIPTION'
+  PLUGIN_INSTANCE_PARAMETER_LIST = 'PLUGIN_INSTANCE_PARAMETER_LIST'

naeural_client/const/heartbeat.py

@@ -0,0 +1,111 @@
+"""
+This is the inter-repo portable constant file for heartbeats 
+"""
+
+HEARTBEAT_VERSION = 'HEARTBEAT_VERSION'
+V1 = 'v1'
+V2 = 'v2'
+
+# ALERTS
+IS_ALERT_RAM = 'IS_ALERT_RAM'
+
+# End ALERTS
+
+TIMESTAMP_FORMAT = "%Y-%m-%d %H:%M:%S.%f"
+TIMESTAMP_FORMAT_SHORT = "%Y-%m-%d %H:%M:%S"
+
+ENCODED_DATA = 'ENCODED_DATA'
+
+INITIATOR_ID = 'INITIATOR_ID'
+
+EE_HB_TIME = 'EE_HB_TIME'
+EE_ADDR = 'EE_ADDR'
+EE_WHITELIST = 'EE_WHITELIST'
+EE_IS_SUPER = 'EE_IS_SUPER'
+EE_FORMATTER = 'EE_FORMATTER'
+
+SECURED = 'SECURED'
+
+DEVICE_STATUS = 'DEVICE_STATUS'
+MACHINE_IP = 'MACHINE_IP'
+MACHINE_MEMORY = 'MACHINE_MEMORY'
+AVAILABLE_MEMORY = 'AVAILABLE_MEMORY'
+PROCESS_MEMORY = 'PROCESS_MEMORY'
+CPU_USED = 'CPU_USED'
+GPUS = 'GPUS'
+GPU_INFO = 'GPU_INFO'
+DEFAULT_CUDA = 'DEFAULT_CUDA'
+CPU = 'CPU'
+TIMESTAMP = 'TIMESTAMP'
+CURRENT_TIME = 'CURRENT_TIME'
+RECEIVED_TIME = 'RECEIVED_TIME'
+UPTIME = 'UPTIME'
+VERSION = 'VERSION'
+TOTAL_DISK = 'TOTAL_DISK'
+AVAILABLE_DISK = 'AVAILABLE_DISK'
+ACTIVE_PLUGINS = 'ACTIVE_PLUGINS'
+NR_INFERENCES = 'NR_INFERENCES'
+NR_PAYLOADS = 'NR_PAYLOADS'
+NR_STREAMS_DATA = 'NR_STREAMS_DATA'
+GIT_BRANCH = 'GIT_BRANCH'
+CONDA_ENV = 'CONDA_ENV'
+SERVING_PIDS = 'SERVING_PIDS'
+DCT_STATS = 'DCT_STATS'
+COMM_STATS = 'COMM_STATS'
+
+STOP_LOG = 'STOP_LOG'
+
+TIMERS = 'TIMERS'
+CONFIG_STREAMS = 'CONFIG_STREAMS'
+PIPELINES = CONFIG_STREAMS
+LOOPS_TIMINGS = 'LOOPS_TIMINGS'
+DEVICE_LOG = 'DEVICE_LOG'
+ERROR_LOG = 'ERROR_LOG'
+
+LOGGER_VERSION = 'LOGGER_VERSION'
+PY_VER = 'PY_VER'
+
+TEMPERATURE_INFO = 'TEMPERATURE_INFO'
+
+
+class COMM_INFO:
+  IN_KB = 'IN_KB'
+  OUT_KB = 'OUT_KB'
+
+
+class ACTIVE_PLUGINS_INFO:
+  STREAM_ID = "STREAM_ID"
+  SIGNATURE = "SIGNATURE"
+  INSTANCE_ID = "INSTANCE_ID"
+  FREQUENCY = "FREQUENCY"
+  INIT_TIMESTAMP = "INIT_TIMESTAMP"
+  EXEC_TIMESTAMP = "EXEC_TIMESTAMP"
+  PROCESS_DELAY = "PROCESS_DELAY"
+  LAST_CONFIG_TIMESTAMP = "LAST_CONFIG_TIMESTAMP"
+  FIRST_ERROR_TIME = "FIRST_ERROR_TIME"
+  LAST_ERROR_TIME = "LAST_ERROR_TIME"
+  OUTSIDE_WORKING_HOURS = "OUTSIDE_WORKING_HOURS"
+  CURRENT_PROCESS_ITERATION = "CURRENT_PROCESS_ITERATION"
+  CURRENT_EXEC_ITERATION = "CURRENT_EXEC_ITERATION"
+  LAST_PAYLOAD_TIME = "LAST_PAYLOAD_TIME"
+  TOTAL_PAYLOAD_COUNT = "TOTAL_PAYLOAD_COUNT"
+  INFO = "INFO"
+
+  ACTIVE_PLUGINS_FIELDS = [
+     STREAM_ID,
+     SIGNATURE,
+     INSTANCE_ID,
+
+     FREQUENCY,
+     INIT_TIMESTAMP,
+     EXEC_TIMESTAMP,
+     LAST_CONFIG_TIMESTAMP,
+     FIRST_ERROR_TIME,
+     LAST_ERROR_TIME,
+     OUTSIDE_WORKING_HOURS,
+     CURRENT_PROCESS_ITERATION,
+     CURRENT_EXEC_ITERATION,
+     LAST_PAYLOAD_TIME,
+     TOTAL_PAYLOAD_COUNT,
+     INFO,
+  ]

naeural_client/const/misc.py

@@ -0,0 +1,20 @@
+class COLORS:
+  DCT = 'g'
+  MAIN = None
+  TIMERS = 'd'
+  STATUS = 'n'
+  SERVING = 'm'
+  BIZ = 'b'
+  COMM = 'y'
+  TIMERS = 'd'
+
+
+WEEKDAYS_SHORT = [
+  'MON',
+  'TUE',
+  'WED',
+  'THU',
+  'FRI',
+  'SAT',
+  'SUN'
+]

naeural_client/const/payload.py

@@ -0,0 +1,190 @@
+# BC Consts:
+from ..bc.base import BCct as BC_CT
+
+TLBR_POS = 'TLBR_POS'
+PROB_PRC = 'PROB_PRC'
+TYPE = 'TYPE'
+
+NOTIFICATION_TYPE = 'NOTIFICATION_TYPE'
+STATUS_TYPE_KEY = NOTIFICATION_TYPE
+
+# Notification types
+
+
+class STATUS_TYPE:
+  NOTIFICATION_TYPE = NOTIFICATION_TYPE
+  STATUS_NORMAL = 'NORMAL'
+  STATUS_EXCEPTION = 'EXCEPTION'
+  STATUS_EMAIL = 'EMAIL'
+  STATUS_ABNORMAL_FUNCTIONING = 'ABNORMAL FUNCTIONING'
+
+
+class NOTIFICATION_CODES:
+  # pipelines from 1 to 99
+  PIPELINE_OK = 1  # basic config is ok
+  PIPELINE_FAILED = -PIPELINE_OK
+
+  PIPELINE_DATA_OK = PIPELINE_OK + 1  # data seems to flow
+  PIPELINE_DATA_FAILED = -PIPELINE_DATA_OK
+
+  PIPELINE_DCT_CONFIG_OK = PIPELINE_DATA_OK + 1  # dct config is ok
+  PIPELINE_DCT_CONFIG_FAILED = -PIPELINE_DCT_CONFIG_OK
+
+  PIPELINE_ARCHIVE_OK = PIPELINE_DCT_CONFIG_OK + 1  # archiving is ok
+  PIPELINE_ARCHIVE_FAILED = -PIPELINE_ARCHIVE_OK
+
+  # plugins from 100 to 999
+  PLUGIN_CONFIG_OK = 100
+  PLUGIN_CONFIG_FAILED = -PLUGIN_CONFIG_OK
+
+  PLUGIN_INSTANCE_COMMAND_OK = 101
+  PLUGIN_INSTANCE_COMMAND_FAILED = -PLUGIN_INSTANCE_COMMAND_OK
+
+  PLUGIN_PAUSE_OK = 110
+  PLUGIN_PAUSE_FAILED = -PLUGIN_PAUSE_OK
+
+  PLUGIN_RESUME_OK = 111
+  PLUGIN_RESUME_FAILED = -PLUGIN_RESUME_OK
+
+  PLUGIN_WORKING_HOURS_SHIFT_START = 112
+  PLUGIN_WORKING_HOURS_SHIFT_START_FAILED = -PLUGIN_WORKING_HOURS_SHIFT_START
+
+  PLUGIN_WORKING_HOURS_SHIFT_END = 113
+  PLUGIN_WORKING_HOURS_SHIFT_END_FAILED = -PLUGIN_WORKING_HOURS_SHIFT_END
+
+  PLUGIN_CONFIG_IN_PAUSE_OK = 120
+  PLUGIN_CONFIG_IN_PAUSE_FAILED = -PLUGIN_CONFIG_IN_PAUSE_OK
+
+  # BUSINESS NOTIFICATIONS FROM 500 to 899
+
+  # Example:
+  # PLUGIN_SOMETHING_OK = 610
+  # PLUGIN_SOMETHING_FAILED = -PLUGIN_SOMETHING_OK
+
+  # END BUSINESS NOTIFICATIONS FROM 500 to 899
+
+  PLUGIN_DELAYED = -999
+
+  # comms from 1000
+  COMMS_OK = 1000
+  
+  COMM_RECEIVED_BAD_COMMAND = -5000
+
+  # serving from 10000
+  SERVING_START_OK = 10000
+  SERVING_START_FAILED = -SERVING_START_OK
+  SERVING_START_FATAL_FAIL = -99999
+  
+  
+  
+
+  TAGS = {
+    PIPELINE_OK: "PIPELINE_OK",
+    PIPELINE_FAILED: "PIPELINE_FAILED",
+    PIPELINE_DATA_OK: "PIPELINE_DATA_OK",
+    PIPELINE_DATA_FAILED: "PIPELINE_DATA_FAILED",
+    PIPELINE_DCT_CONFIG_OK: "PIPELINE_DCT_CONFIG_OK",
+    PIPELINE_DCT_CONFIG_FAILED: "PIPELINE_DCT_CONFIG_FAILED",
+    PIPELINE_ARCHIVE_OK: "PIPELINE_ARCHIVE_OK",
+    PIPELINE_ARCHIVE_FAILED: "PIPELINE_ARCHIVE_FAILED",
+
+    PLUGIN_CONFIG_OK: "PLUGIN_CONFIG_OK",
+    PLUGIN_CONFIG_FAILED: "PLUGIN_CONFIG_FAILED",
+    PLUGIN_INSTANCE_COMMAND_OK: "PLUGIN_INSTANCE_COMMAND_OK",
+    PLUGIN_INSTANCE_COMMAND_FAILED: "PLUGIN_INSTANCE_COMMAND_FAILED",
+    PLUGIN_PAUSE_OK: "PLUGIN_PAUSE_OK",
+    PLUGIN_PAUSE_FAILED: "PLUGIN_PAUSE_FAILED",
+    PLUGIN_RESUME_OK: "PLUGIN_RESUME_OK",
+    PLUGIN_RESUME_FAILED: "PLUGIN_RESUME_FAILED",
+    PLUGIN_DELAYED: "PLUGIN_DELAYED",
+    PLUGIN_WORKING_HOURS_SHIFT_START: "PLUGIN_WORKING_HOURS_SHIFT_START",
+    PLUGIN_WORKING_HOURS_SHIFT_START_FAILED: "PLUGIN_WORKING_HOURS_SHIFT_START_FAILED",
+    PLUGIN_WORKING_HOURS_SHIFT_END: "PLUGIN_WORKING_HOURS_SHIFT_END",
+    PLUGIN_WORKING_HOURS_SHIFT_END_FAILED: "PLUGIN_WORKING_HOURS_SHIFT_END_FAILED",
+
+    PLUGIN_CONFIG_IN_PAUSE_OK: "PLUGIN_CONFIG_IN_PAUSE_OK",
+    PLUGIN_CONFIG_IN_PAUSE_FAILED: "PLUGIN_CONFIG_IN_PAUSE_FAILED",
+
+    SERVING_START_OK: "SERVING_START_OK",
+    SERVING_START_FAILED: "SERVING_START_FAILED",
+    SERVING_START_FATAL_FAIL: "SERVING_START_FATAL_FAIL",
+    
+    COMM_RECEIVED_BAD_COMMAND: "COMM_RECEIVED_BAD_COMMAND",
+
+  }
+  CODES = {v: k for k, v in TAGS.items()}
+
+  # next section could be missing
+  PIPELINE_OK_TAG = TAGS[PIPELINE_OK]
+  PIPELINE_FAILED_TAG = TAGS[PIPELINE_FAILED]
+
+  PLUGIN_CONFIG_OK_TAG = TAGS[PLUGIN_CONFIG_OK]
+  PLUGIN_CONFIG_FAILED_TAG = TAGS[PLUGIN_CONFIG_FAILED]
+
+
+class COMMANDS:
+  COMMANDS = 'COMMANDS'
+  RESTART = 'RESTART'
+  STATUS = 'STATUS'
+  STOP = 'STOP'
+  UPDATE_CONFIG = 'UPDATE_CONFIG'
+  DELETE_CONFIG = 'DELETE_CONFIG'
+  UPDATE_PIPELINE_INSTANCE = 'UPDATE_PIPELINE_INSTANCE'
+  BATCH_UPDATE_PIPELINE_INSTANCE = 'BATCH_UPDATE_PIPELINE_INSTANCE'
+  PIPELINE_COMMAND = 'PIPELINE_COMMAND'
+  ARCHIVE_CONFIG = 'ARCHIVE_CONFIG'
+  DELETE_CONFIG_ALL = 'DELETE_CONFIG_ALL'
+  ARCHIVE_CONFIG_ALL = 'ARCHIVE_CONFIG_ALL'
+  ACTIVE_PLUGINS = 'ACTIVE_PLUGINS'
+  RELOAD_CONFIG_FROM_DISK = 'RELOAD_CONFIG_FROM_DISK'
+  FULL_HEARTBEAT = 'FULL_HEARTBEAT'
+  TIMERS_ONLY_HEARTBEAT = 'TIMERS_ONLY_HEARTBEAT'
+  SIMPLE_HEARTBEAT = 'SIMPLE_HEARTBEAT'
+  INSTANCE_COMMAND = 'INSTANCE_COMMAND'
+  COMMAND_PARAMS = 'COMMAND_PARAMS'
+
+  FINISH_ACQUISITION = 'FINISH_ACQUISITION'
+
+
+class PAYLOAD_DATA:
+  EE_ENCRYPTED_DATA = 'EE_ENCRYPTED_DATA'
+  EE_IS_ENCRYPTED = 'EE_IS_ENCRYPTED'
+  INITIATOR_ID = 'INITIATOR_ID'
+  INITIATOR_ADDR = 'INITIATOR_ADDR'
+  MODIFIED_BY_ID = 'MODIFIED_BY_ID'
+  MODIFIED_BY_ADDR = 'MODIFIED_BY_ADDR'
+  SESSION_ID = 'SESSION_ID'
+  STREAM_NAME = 'STREAM_NAME'
+  NAME = 'NAME'
+  INSTANCE_CONFIG = 'INSTANCE_CONFIG'
+  SIGNATURE = 'SIGNATURE'
+  INSTANCE_ID = 'INSTANCE_ID'
+  TIME = 'TIME'
+  EE_TIMESTAMP = 'EE_TIMESTAMP'
+  EE_TIMEZONE = 'EE_TIMEZONE'
+  EE_TZ = 'EE_TZ'
+  SB_TIMESTAMP = EE_TIMESTAMP
+  EE_MESSAGE_ID = 'EE_MESSAGE_ID'
+  EE_MESSAGE_SEQ = 'EE_MESSAGE_SEQ'
+  SB_MESSAGE_ID = EE_MESSAGE_ID
+  EE_TOTAL_MESSAGES = 'EE_TOTAL_MESSAGES'
+  SB_TOTAL_MESSAGES = EE_TOTAL_MESSAGES
+  EE_FORMATTER = 'EE_FORMATTER'
+  SB_IMPLEMENTATION = 'SB_IMPLEMENTATION'
+  EE_EVENT_TYPE = 'EE_EVENT_TYPE'
+  SB_EVENT_TYPE = 'SB_EVENT_TYPE'
+  EE_PAYLOAD_PATH = 'EE_PAYLOAD_PATH'
+  EE_PAYLOAD_INFO = 'EE_PAYLOAD_INFO'
+  EE_VERSION = 'EE_VERSION'
+  EE_ID = 'EE_ID'
+  EE_PIPELINE_NAME = 'EE_PIPELINE_NAME'
+  EE_SENDER = BC_CT.SENDER
+  EE_HASH = BC_CT.HASH
+  EE_SIGN = BC_CT.SIGN
+
+  NOTIFICATION = 'NOTIFICATION'
+  INFO = 'INFO'
+
+  TAGS = 'TAGS'
+
+  ID_TAGS = 'ID_TAGS'

naeural_client/default/__init__.py

@@ -0,0 +1 @@
+from .session.mqtt_session import MqttSession

naeural_client/default/instance/__init__.py

@@ -0,0 +1,4 @@
+from .net_mon_01_plugin import NetMon01
+from .view_scene_01_plugin import ViewScene01
+from .custom_web_app_01_plugin import CustomWebApp01
+from .chain_dist_custom_job_01_plugin import ChainDistCustomJob01

naeural_client/default/instance/chain_dist_custom_job_01_plugin.py

@@ -0,0 +1,54 @@
+from ...base import Instance
+
+
+class ChainDistCustomJob01(Instance):
+  signature = "PROCESS_REAL_TIME_COLLECTED_DATA_CUSTOM_EXEC_CHAIN_DIST"
+
+  def add_custom_code_callbacks(
+      self,
+      main_node_process_real_time_collected_data: callable,
+      main_node_finish_condition: callable,
+      main_node_finish_condition_kwargs: dict,
+      main_node_aggregate_collected_data: callable,
+      worker_node_code: callable,
+    ):
+    self.update_instance_config(
+      config={
+        "CUSTOM_CODE_PROCESS_REAL_TIME_COLLECTED_DATA": self.pipeline._get_base64_code(main_node_process_real_time_collected_data),
+        "CUSTOM_CODE_FINISH_CONDITION": self.pipeline._get_base64_code(main_node_finish_condition),
+        "CUSTOM_CODE_AGGREGATE_COLLECTED_DATA": self.pipeline._get_base64_code(main_node_aggregate_collected_data),
+        "CUSTOM_CODE_REMOTE_NODE": self.pipeline._get_base64_code(worker_node_code),
+        "FINISH_CONDITION_KWARGS": main_node_finish_condition_kwargs
+      }
+    )
+    return
+
+  def add_worker_node_configuration(
+      self,
+      worker_node_pipeline_config: dict = None,
+      worker_node_plugin_config: dict = None,
+    ):
+    self.update_instance_config(
+      config={
+        "NODE_PIPELINE_CONFIG": worker_node_pipeline_config or {'stream_type': "Void", },
+        "NODE_PLUGIN_CONFIG": worker_node_plugin_config or {},
+      }
+    )
+    return
+
+  def add_main_node_configuration(
+      self,
+      nr_worker_nodes: int,
+      specific_worker_nodes: list = None,
+      worker_node_timeout: int = 150,
+      cancel_all_jobs_on_exception: bool = False,
+    ):
+    self.update_instance_config(
+      config={
+        "NR_REMOTE_NODES": nr_worker_nodes,
+        "SPECIFIC_REMOTE_NODES": specific_worker_nodes,
+        "REMOTE_NODE_TIMEOUT": worker_node_timeout,
+        "CANCEL_ALL_JOBS_ON_EXCEPTION": cancel_all_jobs_on_exception,
+      }
+    )
+    return

naeural_client/default/instance/custom_web_app_01_plugin.py

@@ -0,0 +1,118 @@
+from ...base import Instance, Pipeline
+
+
+class CustomWebApp01(Instance):
+  signature = "CUSTOM_CODE_FASTAPI_01"
+
+  def get_proposed_endpoints(self):
+    from copy import deepcopy
+    proposed_config = self._get_proposed_config_dictionary(full=True)
+    if "ENDPOINTS" in proposed_config:
+      return deepcopy(proposed_config["ENDPOINTS"])
+    return deepcopy(self.config.get("ENDPOINTS", []))
+
+  def get_endpoint_fields(self, method: callable):
+    import inspect
+
+    name = method.__name__
+    args = list(map(str, inspect.signature(method).parameters.values()))[1:]
+    base64_code = self.pipeline._get_base64_code(method)
+
+    return name, args, base64_code
+
+  def add_new_endpoint(self, function, method="get"):
+    name, args, base64_code = self.get_endpoint_fields(function)
+    dct_endpoint = {
+      "NAME": name
+    }
+
+    proposed_endpoints = self.get_proposed_endpoints()
+    lst_pos = [pos for pos, endpoint in enumerate(proposed_endpoints) if endpoint["NAME"] == name]
+
+    if len(lst_pos) > 0:
+      dct_endpoint = proposed_endpoints[lst_pos[0]]
+    else:
+      proposed_endpoints.append(dct_endpoint)
+    # endif
+
+    dct_endpoint["CODE"] = base64_code
+    dct_endpoint["METHOD"] = method
+    dct_endpoint["ARGS"] = args
+
+    self.update_instance_config(config={"ENDPOINTS": proposed_endpoints})
+
+  def get_proposed_assets(self):
+    from copy import deepcopy
+    proposed_config = self._get_proposed_config_dictionary(full=True)
+    if "ASSETS" in proposed_config:
+      return deepcopy(proposed_config["ASSETS"])
+    return deepcopy(self.config.get("ASSETS", {}))
+
+  def get_proposed_jinja_args(self):
+    from copy import deepcopy
+    proposed_config = self._get_proposed_config_dictionary(full=True)
+    if "JINJA_ARGS" in proposed_config:
+      return deepcopy(proposed_config["JINJA_ARGS"])
+    return deepcopy(self.config.get("JINJA_ARGS", {}))
+
+  def add_new_file_endpoint(self, str_code, file_name, endpoint_name):
+    raise NotImplementedError("This method is not implemented yet.")
+
+  def add_new_html_endpoint(self, html_path, web_app_file_name, endpoint_route):
+    str_code = None
+    with open(html_path, "r") as file:
+      str_code = file.read()
+
+    if str_code is None:
+      raise ValueError(f"Could not read the file {html_path}")
+    self.pipeline: Pipeline
+    base64_html = self.pipeline.str_to_base64(str_code, compress=True)
+
+    proposed_assets = self.get_proposed_assets()
+    proposed_jinja_args = self.get_proposed_jinja_args()
+
+    if isinstance(proposed_assets, str):
+      proposed_assets = {
+        "url": [],
+        "operation": "decode",
+      }
+    elif isinstance(proposed_assets, dict):
+      if proposed_assets.get("operation") != "decode":
+        proposed_assets["operation"] = "decode"
+        proposed_assets["url"] = []
+
+    lst_pos = [pos
+               for pos, code_name_pair
+               in enumerate(proposed_assets["url"])
+               if code_name_pair[1] == 'assets/' + web_app_file_name]
+
+    if len(lst_pos) > 0:
+      proposed_assets["url"][lst_pos[0]][0] = base64_html
+    else:
+      proposed_assets["url"].append([base64_html, 'assets/' + web_app_file_name])
+    # endif
+
+    if proposed_jinja_args is None:
+      proposed_jinja_args = {
+        'html_files': [],
+      }
+    elif proposed_jinja_args.get('html_files') is None:
+      proposed_jinja_args['html_files'] = []
+
+    lst_pos = [pos
+               for pos, dict_name_route_method,
+               in enumerate(proposed_jinja_args['html_files'])
+               if dict_name_route_method['name'] == web_app_file_name]
+
+    dict_name_route_method = {
+      "name": web_app_file_name,
+      "method": "get"
+    }
+    if len(lst_pos) > 0:
+      dict_name_route_method = proposed_jinja_args['html_files'][lst_pos[0]]
+    else:
+      proposed_jinja_args['html_files'].append(dict_name_route_method)
+
+    dict_name_route_method["route"] = endpoint_route
+
+    self.update_instance_config(config={"ASSETS": proposed_assets, "JINJA_ARGS": proposed_jinja_args})

naeural_client/default/instance/net_mon_01_plugin.py

@@ -0,0 +1,45 @@
+from ...base import Instance
+
+
+class NetMon01(Instance):
+  signature = "NET_MON_01"
+
+  def get_node_history(self, node_id=None, node_addr=None, time_window_hours=1, steps=20):
+    """
+    Get the performance history of a node.
+
+    Parameters
+    ----------
+    node_id : str, optional
+        The node id, by default None
+    node_addr : str, optional
+        The node address, by default None
+    time_window_hours: int, optional
+        The time window in hours to retrieve, by default 1
+    steps : int, optional
+        Retrieve only each `steps` data point from the time window, by default 20
+
+    Returns
+    -------
+    """
+    result = None
+
+    if node_id is None:
+      node_id = self.pipeline.node_id
+
+    if node_addr is None:
+      node_addr = self.pipeline.node_addr
+
+    command = {
+      "node": node_id,
+      "addr": node_addr,
+      "options": {"step": steps, "time_window_hours": time_window_hours},
+      "request": "history",
+    }
+
+    result_payload = self.send_instance_command_and_wait_for_response_payload(command)
+
+    if result_payload is not None:
+      result = result_payload.get("NODE_HISTORY", None)
+
+    return result

naeural_client/default/instance/view_scene_01_plugin.py

@@ -0,0 +1,28 @@
+from ...base import Instance
+
+
+class ViewScene01(Instance):
+  signature = "VIEW_SCENE_01"
+
+  def get_last_witness(self, response_params_key="COMMAND_PARAMS"):
+    """
+    Get the performance history of a node.
+
+    Parameters
+    ----------
+    response_params_key : str
+      The key in the response payload that contains the command parameters
+    Returns
+    -------
+    """
+    images = []
+
+    result_payload = self.send_instance_command_and_wait_for_response_payload(
+      command="GET_LAST_WITNESS",
+      response_params_key=response_params_key,
+    )
+
+    if result_payload is not None:
+      images = result_payload.get_images_as_PIL()
+
+    return images