1

#!/usr/bin/env python

     2

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

     3

     4

# Written by Edouard TISSERANT (C) 2024

     5

# This file is part of Beremiz runtime

     6

# See COPYING.Runtime file for copyrights details.

     7

     8

import sys

     9

import traceback

    10

from inspect import getmembers, isfunction

    11

    12

import erpc

    13

    14

# eRPC service code

    15

from erpc_interface.erpc_PLCObject.common import PSKID, PLCstatus, TraceVariables, trace_sample, PLCstatus_enum, log_message

    16

from erpc_interface.erpc_PLCObject.interface import IBeremizPLCObjectService

    17

from erpc_interface.erpc_PLCObject.server import BeremizPLCObjectServiceService

    18

    19

from runtime import GetPLCObjectSingleton as PLC

    20

from runtime.loglevels import LogLevelsDict

    21

from runtime.ServicePublisher import ServicePublisher

    22

    23

    24

def ReturnAsLastOutput(method, args_wrapper, *args):

    25

    args[-1].value = method(*args_wrapper(*args[:-1]))

    26

    return 0

    27

    28

def TranslatedReturnAsLastOutput(translator):

    29

    def wrapper(method, args_wrapper, *args):

    30

        args[-1].value = translator(method(*args_wrapper(*args[:-1])))

    31

        return 0

    32

    return wrapper

    33

    34

    35

ReturnWrappers = {

    36

    "AppendChunkToBlob":ReturnAsLastOutput,

    37

    "GetLogMessage":TranslatedReturnAsLastOutput(

    38

        lambda res:log_message(*res)),

    39

    "GetPLCID":TranslatedReturnAsLastOutput(

    40

        lambda res:PSKID(*res)),

    41

    "GetPLCstatus":TranslatedReturnAsLastOutput(

    42

        lambda res:PLCstatus(getattr(PLCstatus_enum, res[0]),res[1])),

    43

    "GetTraceVariables":TranslatedReturnAsLastOutput(

    44

        lambda res:TraceVariables(getattr(PLCstatus_enum, res[0]),[trace_sample(*sample) for sample in res[1]])),

    45

    "MatchMD5":ReturnAsLastOutput,

    46

    "NewPLC":ReturnAsLastOutput,

    47

    "SeedBlob":ReturnAsLastOutput,

    48

    "SetTraceVariablesList": ReturnAsLastOutput,

    49

    "StopPLC":ReturnAsLastOutput,

    50

}

    51

    52

ArgsWrappers = {

    53

    "AppendChunkToBlob":

    54

        lambda data, blobID:(data, bytes(blobID)),

    55

    "NewPLC":

    56

        lambda md5sum, plcObjectBlobID, extrafiles: (

    57

            md5sum, bytes(plcObjectBlobID), [(f.fname, bytes(f.blobID)) for f in extrafiles]),

    58

    "SetTraceVariablesList": 

    59

        lambda orders : ([(order.idx, None if len(order.force)==0 else bytes(order.force)) for order in orders],)

    60

}

    61

    62

def rpc_wrapper(method_name):

    63

    PLCobj = PLC()

    64

    method=getattr(PLCobj, method_name)

    65

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

    66

    return_wrapper = ReturnWrappers.get(method_name,

    67

        lambda method, args_wrapper, *args: method(*args_wrapper(*args)))

    68

    69

    def exception_wrapper(self, *args):

    70

        try:

    71

            return_wrapper(method, args_wrapper, *args)

    72

            return 0

    73

        except Exception as e:

    74

            print(traceback.format_exc())

    75

            PLCobj.LogMessage(CRITICAL_LOG_LEVEL, f'eRPC call {method_name} Exception "{str(e)}"')

    76

            raise

    77

    78

    return exception_wrapper

    79

    80

    81

class eRPCServer(object):

    82

    def __init__(self, servicename, ip_addr, port):

    83

        self.continueloop = True

    84

        self.server = None

    85

        self.transport = None

    86

        self.servicename = servicename

    87

        self.ip_addr = ip_addr

    88

        self.port = port

    89

        self.servicepublisher = None

    90

    91

    def _to_be_published(self):

    92

        return self.servicename is not None and \

    93

               self.ip_addr not in ["", "localhost", "127.0.0.1"]

    94

    95

    def PrintServerInfo(self):

    96

        print(_("eRPC port :"), self.port)

    97

    98

        if self._to_be_published():

    99

            print(_("Publishing service on local network"))

   100

   101

        if sys.stdout:

   102

            sys.stdout.flush()

   103

   104

    def Loop(self, when_ready):

   105

        if self._to_be_published():

   106

            self.Publish()

   107

   108

        # service handler calls PLC object though erpc_stubs's wrappers

   109

        handler = type(

   110

            "PLCObjectServiceHandlder", 

   111

            (IBeremizPLCObjectService,),

   112

            {name: rpc_wrapper(name)              

   113

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

   114

   115

        service = BeremizPLCObjectServiceService(handler)

   116

   117

        # TODO initialize Serial transport layer if selected

   118

        # transport = erpc.transport.SerialTransport(device, baudrate)

   119

   120

        # initialize TCP transport layer

   121

        self.transport = erpc.transport.TCPTransport(self.ip_addr, int(self.port), True)

   122

   123

        self.server = erpc.simple_server.SimpleServer(self.transport, erpc.basic_codec.BasicCodec)

   124

        self.server.add_service(service)

   125

   126

        when_ready()

   127

   128

        while self.continueloop:

   129

   130

            try:

   131

                self.server.run()

   132

            except erpc.transport.ConnectionClosed:

   133

                PLC().LogMessage(LogLevelsDict["DEBUG"], 'eRPC client disconnected')

   134

            except Exception as e:

   135

                self.Unpublish()

   136

                #TODO crash better

   137

                raise e

   138

   139

   140

    def Restart(self):

   141

        self.server.stop()

   142

   143

    def Quit(self):

   144

        self.continueloop = False

   145

        self.server.stop()

   146

   147

    def Publish(self):

   148

        self.servicepublisher = ServicePublisher("ERPC")

   149

        self.servicepublisher.RegisterService(self.servicename,

   150

                                              self.ip_addr, self.port)

   151

   152

    def Unpublish(self):

   153

        if self.servicepublisher is not None:

   154

            self.servicepublisher.UnRegisterService()

   155

            self.servicepublisher = None