plantstar-shared 2.0.3.0.2.15__tar.gz → 2.0.3.0.2.16__tar.gz

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.15
+Version: 2.0.3.0.2.16
 Summary: Shared code used in plantstar_apu and plantstar_dcm
 Home-page: https://github.com/SYSCON-International/plantstar_shared
 Author: SYSCON International

plantstar_shared-2.0.3.0.2.16/plantstar_shared/HmiKeyConstants.py

@@ -0,0 +1,9 @@
+class HmiKeyConstants:
+    APU_IP_ADDRESS = "apu_ip_address"
+    HMI_HOSTNAME = "hmi_hostname"
+    HMI_HOMEPAGE = "hmi_homepage"
+    HMI_IP_ADDRESS_TYPE = "hmi_ip_address_type"
+    HMI_IP_ADDRESS = "hmi_ip_address"
+    HMI_NETMASK = "hmi_netmask"
+    HMI_DEFAULT_GATEWAY = "hmi_default_gateway"
+    HMI_DNS = "hmi_dns"

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/plantstar_shared/api_types.py

@@ -97,7 +97,16 @@ class DataCollectionModuleApiTypes(SysconType):
 class ApuApiTypes(SysconType):
     SET_IS_INITIALIZING_STATUS = ("data_collection_module_manager/set_is_initializing_status", "data_collection_module_manager/set_is_initializing_status", True)
     SET_IS_COLDBOOTING_STATUS = ("data_collection_module_manager/set_is_coldbooting_status", "data_collection_module_manager/set_is_coldbooting_status", True)
+    REGISTER_HMI = ("data_collection_module_manager/register_hmi", "data_collection_module_manager/register_hmi", True)
+    REGISTER_DCM = ("data_collection_module_manager/register_dcm", "data_collection_module_manager/register_dcm", True)
 
 
 class CosmosApiTypes(SysconType):
     SEND_DATA_DICTIONARY = ("send_data_dictionary", "send_data_dictionary", True)
+
+
+class HmiApiTypes(SysconType):
+    GET_HMI_SYSTEM_INFORMATION = ("get_hmi_system_information", "get_hmi_system_information", True)
+    SET_HMI_SYSTEM_INFORMATION = ("set_hmi_system_information", "set_hmi_system_information", True)
+    REBOOT_HMI = ("reboot_hmi", "reboot_hmi", True)
+

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/plantstar_shared/convert_bytes_to_object.py

@@ -2,9 +2,9 @@ import msgpack
 
 from plantstar_shared.errors import SocketConnectionError
 
-
 # Converts bytes into an object using msgpack, with a parameter for strict_map_key
 def convert_bytes_to_object(object_as_bytes, strict_map_key=False):
+    
     if not object_as_bytes:
         raise SocketConnectionError
     

plantstar_shared-2.0.3.0.2.16/plantstar_shared/tcp_socket_utils.py

@@ -0,0 +1,68 @@
+import struct
+
+from plantstar_shared.convert_bytes_to_object import convert_bytes_to_object
+from plantstar_shared.convert_object_to_bytes import convert_object_to_bytes
+from plantstar_shared.errors import SocketConnectionError
+
+SIZE_OF_UNSIGNED_INT_STRUCT = 4
+
+
+def read_size_value_from_socket(*, remote_socket):
+    size_struct = remote_socket.recv(SIZE_OF_UNSIGNED_INT_STRUCT)
+
+    if not size_struct:
+        return None
+
+    try:
+        message_length = struct.unpack('>I', size_struct)[0]
+    except struct.error as error:
+        raise SocketConnectionError
+
+    return message_length
+
+
+def get_message_from_socket(*, remote_socket):
+    message_length = read_size_value_from_socket(remote_socket=remote_socket)
+
+    if not message_length:
+        return None
+
+    packets = []
+    bytes_received = 0
+
+    # While loop that will stream in data if the full request is not available yet
+    while bytes_received < message_length:
+        buffer_size = message_length - bytes_received
+        packet = remote_socket.recv(buffer_size)
+
+        if not packet:
+            return None
+
+        packets.append(packet)
+        bytes_received = bytes_received + len(packet)
+
+    data = b''.join(packets)
+    return data
+
+
+def send_message_on_socket(*, remote_socket, dumpsable_object):
+    message_encoded_as_bytes = convert_object_to_bytes(dumpsable_object)
+    send_encoded_message_on_socket(remote_socket=remote_socket, encoded_message=message_encoded_as_bytes)
+
+
+def send_encoded_message_on_socket(*, remote_socket, encoded_message):
+    size_of_string = len(encoded_message)
+    encoded_message_with_size = struct.pack('>I', size_of_string) + encoded_message
+
+    bytes_sent = remote_socket.send(encoded_message_with_size)
+
+    while bytes_sent < size_of_string + SIZE_OF_UNSIGNED_INT_STRUCT:
+        remaining_encoded_message_to_send = encoded_message_with_size[bytes_sent:]
+        new_bytes_sent = remote_socket.send(remaining_encoded_message_to_send)
+        bytes_sent += new_bytes_sent
+
+
+def get_object_from_socket(*, remote_socket):
+    object_from_interface_as_bytes = get_message_from_socket(remote_socket=remote_socket)
+    object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
+    return object_from_interface

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/plantstar_shared.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plantstar-shared
-Version: 2.0.3.0.2.15
+Version: 2.0.3.0.2.16
 Summary: Shared code used in plantstar_apu and plantstar_dcm
 Home-page: https://github.com/SYSCON-International/plantstar_shared
 Author: SYSCON International

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/plantstar_shared.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 README.md
 setup.py
 plantstar_shared/DataCollectionModuleProcessNames.py
+plantstar_shared/HmiKeyConstants.py
 plantstar_shared/HuskyInterfacePacketTypes.py
 plantstar_shared/MockRawDataProcessor.py
 plantstar_shared/RawDataProcessorInterfaceActions.py

{plantstar-shared-2.0.3.0.2.15 → plantstar_shared-2.0.3.0.2.16}/setup.py

@@ -7,7 +7,7 @@ setuptools.setup(
     name="plantstar-shared",
     # MAJOR_MILESTONE_VERSION.MINOR_MILESTONE_VERSION.MAJOR_VERSION.MINOR_VERSION.HOTFIX_VERSION.SUBVERSION
     # The main version should stay as v2.0.3.0.x until we have passed that in the plantstar_apu/plantstar_dcm projects
-    version="2.0.3.0.2.15",
+    version="2.0.3.0.2.16",
     author="SYSCON International",
     author_email="dev@syscon-intl.com",
     description="Shared code used in plantstar_apu and plantstar_dcm",

plantstar-shared-2.0.3.0.2.15/plantstar_shared/tcp_socket_utils.py

@@ -1,132 +0,0 @@
-import struct
-
-from plantstar_shared.convert_bytes_to_object import convert_bytes_to_object
-from plantstar_shared.convert_object_to_bytes import convert_object_to_bytes
-from plantstar_shared.errors import SocketConnectionError, SysconProgrammingError
-
-SIZE_OF_UNSIGNED_INT_FOR_HUSKY = 2  # size of the integer value that precedes data coming from Husky OIs
-SIZE_OF_UNSIGNED_INT_STRUCT = 4  # size of the integer value that precedes data coming from most sockets (DeviceController, DCM, etc)
-
-
-def read_size_value_from_socket(*, remote_socket, is_big_endian, number_of_bytes_for_size_prefix, size_value_includes_size_prefix_bytes=False):
-    size_bytes = remote_socket.recv(number_of_bytes_for_size_prefix)
-
-    if not size_bytes:
-        raise SocketConnectionError
-
-    if number_of_bytes_for_size_prefix == SIZE_OF_UNSIGNED_INT_FOR_HUSKY:
-        size_for_message = int.from_bytes(size_bytes, 'big') if is_big_endian else int.from_bytes(size_bytes, 'little')
-    elif number_of_bytes_for_size_prefix == SIZE_OF_UNSIGNED_INT_STRUCT:
-        number_format = ">I" if is_big_endian else "<I"
-
-        try:
-            size_for_message = struct.unpack(number_format, size_bytes)[0]
-        except struct.error as error:
-            raise SocketConnectionError
-    else:
-        raise SysconProgrammingError("A size prefix was set to something other than 2 or 4")
-
-    if size_value_includes_size_prefix_bytes:
-        size_for_message = size_for_message - number_of_bytes_for_size_prefix
-
-    return size_for_message, size_bytes
-
-
-def get_bytes_from_socket(
-    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=0, size_value_includes_size_prefix_bytes=False,
-    size_value_should_be_included_in_final_message=False
-):
-    """Obtains a number of bytes from a provided socket, with options for different configurations and situations.
-    Returns byte sequence, and the size value that was obtained from the prefix bytes.
-
-    Keywords / Example Configurations:
-        remote_socket -- the connection that bytes will be read from
-
-        number_of_bytes_to_read -- the number of bytes to read on the socket, if this is known, this is the only optional parameter needed (default: 0)
-
-        is_big_endian -- bool: what format string should be used for unpacking the size value (default: True)
-
-        number_of_bytes_for_size_prefix -- the number of bytes to read to determine the total size of the message to pass (default: 0)
-
-        size_value_includes_size_prefix_bytes -- bool: if size value includes the size_prefix_bytes based on the systems implementation
-
-        size_value_should_be_included_in_final_message  -- bool: if size value should be prepended to the byte sequence, likely only Husky logic wants this (default: False)
-
-        -----
-
-        get_bytes_from_socket(remote_socket=conn, number_of_bytes_to_read=100) - likely would not be called directly, in most cases
-
-        get_bytes_from_socket(remote_socket=conn, is_big_endian=True, number_of_bytes_for_size_prefix=4) - reads 4 bytes to get the size, then reads that amount (DCM socket, etc)
-
-        get_bytes_from_socket(remote_socket=conn, is_big_endian=False, number_of_bytes_for_size_prefix=2, should_remove_prefix_size_from_read=True) - reads 2 bytes to get the size,
-        then reads that calculated amount minus 2 (Husky socket, etc)
-
-    """
-
-    packets = []
-
-    if not number_of_bytes_to_read:
-        if number_of_bytes_for_size_prefix:
-            number_of_bytes_to_read, size_bytes = read_size_value_from_socket(
-                remote_socket=remote_socket, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix,
-                size_value_includes_size_prefix_bytes=size_value_includes_size_prefix_bytes
-            )
-
-            if not number_of_bytes_to_read:
-                raise SocketConnectionError
-
-            if size_value_should_be_included_in_final_message:
-                packets.append(size_bytes)
-
-        else:
-            raise SysconProgrammingError("get_bytes_from_socket was called with no parameters for number_of_bytes_to_read or number_of_bytes_for_size_prefix")
-
-    bytes_received = 0
-
-    # While loop that will stream in data if the full request is not available yet
-    while bytes_received < number_of_bytes_to_read:
-        buffer_size = number_of_bytes_to_read - bytes_received
-        packet = remote_socket.recv(buffer_size)
-
-        if not packet:
-            raise SocketConnectionError
-
-        packets.append(packet)
-        bytes_received = bytes_received + len(packet)
-
-    data = b''.join(packets)
-    return data, number_of_bytes_to_read
-
-
-def send_message_on_socket(*, remote_socket, dumpsable_object):
-    message_encoded_as_bytes = convert_object_to_bytes(dumpsable_object)
-    send_encoded_message_on_socket(remote_socket=remote_socket, encoded_message=message_encoded_as_bytes)
-
-
-def send_encoded_message_on_socket(*, remote_socket, encoded_message):
-    size_of_string = len(encoded_message)
-    encoded_message_with_size = struct.pack('>I', size_of_string) + encoded_message
-
-    bytes_sent = remote_socket.send(encoded_message_with_size)
-
-    while bytes_sent < size_of_string + SIZE_OF_UNSIGNED_INT_STRUCT:
-        remaining_encoded_message_to_send = encoded_message_with_size[bytes_sent:]
-        new_bytes_sent = remote_socket.send(remaining_encoded_message_to_send)
-        bytes_sent += new_bytes_sent
-
-
-def get_object_from_socket(
-    *, remote_socket, number_of_bytes_to_read=None, is_big_endian=True, number_of_bytes_for_size_prefix=SIZE_OF_UNSIGNED_INT_STRUCT,
-    size_value_includes_size_prefix_bytes=False
-):
-    """Function that is used between the APU and DCM to send dictionaries. Returns a tuple of the object and its size in bytes."""
-    object_from_interface_as_bytes, size_of_object_in_bytes = get_bytes_from_socket(
-        remote_socket=remote_socket, number_of_bytes_to_read=number_of_bytes_to_read, is_big_endian=is_big_endian, number_of_bytes_for_size_prefix=number_of_bytes_for_size_prefix,
-        size_value_includes_size_prefix_bytes=size_value_includes_size_prefix_bytes
-    )
-
-    if not object_from_interface_as_bytes:
-        raise SocketConnectionError
-
-    object_from_interface = convert_bytes_to_object(object_from_interface_as_bytes)
-    return object_from_interface, size_of_object_in_bytes