1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# Written by Edouard TISSERANT (C) 2024

     5

# This file is part of Beremiz IDE

     6

# See COPYING file for copyrights details.

     7

     8

     9

import os.path

    10

import re

    11

import traceback

    12

from inspect import getmembers, isfunction

    13

    14

    15

import erpc

    16

    17

# eRPC service code

    18

from erpc_interface.erpc_PLCObject.interface import IBeremizPLCObjectService

    19

from erpc_interface.erpc_PLCObject.client import BeremizPLCObjectServiceClient

    20

from erpc_interface.erpc_PLCObject.common import trace_order, extra_file, PLCstatus_enum

    21

    22

import PSKManagement as PSK

    23

from connectors.ERPC.PSK_Adapter import SSLPSKClientTransport

    24

from connectors.ConnectorBase import ConnectorBase

    26

    27

enum_to_PLCstatus = dict(map(lambda t:(t[1],t[0]),getmembers(PLCstatus_enum, lambda x:type(x)==int)))

    28

    29

class MissingCallException(Exception):

    30

    pass

    31

    32

def ExceptionFromERPCReturn(ret):

    33

    return {1:Exception,

    34

            2:MissingCallException}.get(ret,ValueError)

    35

    36

def ReturnAsLastOutput(client_method, obj, args_wrapper, *args):

    37

    retval = erpc.Reference()

    38

    ret = client_method(obj, *args_wrapper(*args), retval)

    39

    if ret != 0:

    40

        raise ExceptionFromERPCReturn(ret)(client_method.__name__)

    41

    return retval.value

    42

    43

def TranslatedReturnAsLastOutput(translator):

    44

    def wrapper(client_method, obj, args_wrapper, *args):

    45

        res = ReturnAsLastOutput(client_method, obj, args_wrapper, *args)

    46

        return translator(res)

    47

    return wrapper

    48

    49

ReturnWrappers = {

    50

    "AppendChunkToBlob":ReturnAsLastOutput,

    51

    "GetLogMessage":TranslatedReturnAsLastOutput(

    52

        lambda res:(res.msg, res.tick, res.sec, res.nsec)),

    53

    "GetPLCID":TranslatedReturnAsLastOutput(

    54

        lambda res:(res.ID, res.PSK)),

    55

    "GetPLCstatus":TranslatedReturnAsLastOutput(

    56

        lambda res:(enum_to_PLCstatus[res.PLCstatus], res.logcounts)),

    57

    "GetTraceVariables":TranslatedReturnAsLastOutput(

    58

        lambda res:(enum_to_PLCstatus[res.PLCstatus],

    59

                    [(sample.tick, bytes(sample.TraceBuffer)) for sample in res.traces])),

    60

    "MatchMD5":ReturnAsLastOutput,

    61

    "NewPLC":ReturnAsLastOutput,

    62

    "SeedBlob":ReturnAsLastOutput,

    63

    "SetTraceVariablesList": ReturnAsLastOutput,

    64

    "StopPLC":ReturnAsLastOutput,

    65

}

    66

    67

ArgsWrappers = {

    68

    "NewPLC":

    69

        lambda md5sum, plcObjectBlobID, extrafiles: (

    70

            md5sum, plcObjectBlobID, [extra_file(*f) for f in extrafiles]),

    71

    "SetTraceVariablesList":

    72

        lambda orders : ([

    73

            trace_order(idx, b"" if force is None else force) 

    74

            for idx, force in orders],)

    75

}

    76

    77

def rpc_wrapper(method_name, confnodesroot):

    78

    client_method = getattr(BeremizPLCObjectServiceClient, method_name)

    79

    return_wrapper = ReturnWrappers.get(

    80

        method_name, 

    81

        lambda client_method, obj, args_wrapper, *args: client_method(obj, *args_wrapper(*args)))

    82

    args_wrapper = ArgsWrappers.get(method_name, lambda *x:x)

    83

    84

    def exception_wrapper(self, *args):

    85

        try:

    86

            return return_wrapper(client_method, self, args_wrapper, *args)

    87

        except erpc.transport.ConnectionClosed as e:

    88

            confnodesroot._SetConnector(None)

    89

            confnodesroot.logger.write_error(_("Connection lost!\n"))

    90

        except erpc.codec.CodecError as e:

    91

            confnodesroot.logger.write_warning(_("ERPC codec error: %s\n") % e)

    92

        except erpc.client.RequestError as e:

    93

            confnodesroot.logger.write_error(_("ERPC request error: %s\n") % e)                

    94

        except MissingCallException as e:

    95

            confnodesroot.logger.write_warning(_("Remote call not supported: %s\n") % e)

    96

        except Exception as e:

    97

            errmess = _("Exception calling remote PLC object fucntion %s:\n") % method_name \

    98

                        + traceback.format_exc()

    99

            confnodesroot.logger.write_error(errmess + "\n")

   100

            confnodesroot._SetConnector(None)

   101

   102

        return self.PLCObjDefaults.get(method_name)

   103

    return exception_wrapper

   104

   105

   106

   107

def ERPC_connector_factory(uri, confnodesroot):

   108

    """

   109

    returns the ERPC connector

   110

    """

   111

    confnodesroot.logger.write(_("ERPC connecting to URI : %s\n") % uri)

   112

   113

    # TODO add parsing for serial URI

   114

    # ERPC:///dev/ttyXX:baudrate or ERPC://:COM4:baudrate

   115

   116

    try:

   120

    except Exception as e:

   121

        confnodesroot.logger.write_error(

   122

            'Malformed URI "%s": %s\n' % (uri, str(e)))

   123

        return None

   124

   125

    PLCObjectERPCProxy = type(

   126

        "PLCObjectERPCProxy",

   127

        (ConnectorBase, BeremizPLCObjectServiceClient),

   128

        {name: rpc_wrapper(name, confnodesroot)

   129

            for name,_func in getmembers(IBeremizPLCObjectService, isfunction)})

   130

   135

                confnodesroot.logger.write_error(

   137

                return None

   139

        else:

   146

   150

   162

   178

        confnodesroot.logger.write_error(

   181

        return None

   182

    # Check connection is effective.

   183

    IDPSK = client.GetPLCID()

   184

    if IDPSK:

   185

        ID, secret = IDPSK

   186

        PSK.UpdateID(confnodesroot.ProjectPath, ID, secret, uri)

   187

    else:

   188

        confnodesroot.logger.write_warning(_("PLC did not provide identity and security infomation.\n"))

   189

   190

    return client