Source code for pymodbus.pdu

'''
Contains base classes for modbus request/response/error packets
'''
from pymodbus.interfaces import Singleton
from pymodbus.exceptions import NotImplementedException
from pymodbus.constants import Defaults
from pymodbus.utilities import rtuFrameSize
from pymodbus.compat import iteritems, int2byte, byte2int

#---------------------------------------------------------------------------#
# Logging
#---------------------------------------------------------------------------#
import logging
_logger = logging.getLogger(__name__)


#---------------------------------------------------------------------------#
# Base PDU's
#---------------------------------------------------------------------------#
[docs]class ModbusPDU(object): ''' Base class for all Modbus mesages .. attribute:: transaction_id This value is used to uniquely identify a request response pair. It can be implemented as a simple counter .. attribute:: protocol_id This is a constant set at 0 to indicate Modbus. It is put here for ease of expansion. .. attribute:: unit_id This is used to route the request to the correct child. In the TCP modbus, it is used for routing (or not used at all. However, for the serial versions, it is used to specify which child to perform the requests against. The value 0x00 represents the broadcast address (also 0xff). .. attribute:: check This is used for LRC/CRC in the serial modbus protocols .. attribute:: skip_encode This is used when the message payload has already been encoded. Generally this will occur when the PayloadBuilder is being used to create a complicated message. By setting this to True, the request will pass the currently encoded message through instead of encoding it again. '''
[docs] def __init__(self, **kwargs): ''' Initializes the base data for a modbus request ''' self.transaction_id = kwargs.get('transaction', Defaults.TransactionId) self.protocol_id = kwargs.get('protocol', Defaults.ProtocolId) self.unit_id = kwargs.get('unit', Defaults.UnitId) self.skip_encode = kwargs.get('skip_encode', False) self.check = 0x0000
[docs] def encode(self): ''' Encodes the message :raises: A not implemented exception ''' raise NotImplementedException()
[docs] def decode(self, data): ''' Decodes data part of the message. :param data: is a string object :raises: A not implemented exception ''' raise NotImplementedException()
@classmethod
[docs] def calculateRtuFrameSize(cls, buffer): ''' Calculates the size of a PDU. :param buffer: A buffer containing the data that have been received. :returns: The number of bytes in the PDU. ''' if hasattr(cls, '_rtu_frame_size'): return cls._rtu_frame_size elif hasattr(cls, '_rtu_byte_count_pos'): return rtuFrameSize(buffer, cls._rtu_byte_count_pos) else: raise NotImplementedException( "Cannot determine RTU frame size for %s" % cls.__name__)
[docs]class ModbusRequest(ModbusPDU): ''' Base class for a modbus request PDU '''
[docs] def __init__(self, **kwargs): ''' Proxy to the lower level initializer ''' ModbusPDU.__init__(self, **kwargs)
[docs] def doException(self, exception): ''' Builds an error response based on the function :param exception: The exception to return :raises: An exception response ''' _logger.error("Exception Response F(%d) E(%d)" % (self.function_code, exception)) return ExceptionResponse(self.function_code, exception)
[docs]class ModbusResponse(ModbusPDU): ''' Base class for a modbus response PDU .. attribute:: should_respond A flag that indicates if this response returns a result back to the client issuing the request .. attribute:: _rtu_frame_size Indicates the size of the modbus rtu response used for calculating how much to read. ''' should_respond = True
[docs] def __init__(self, **kwargs): ''' Proxy to the lower level initializer ''' ModbusPDU.__init__(self, **kwargs)
#---------------------------------------------------------------------------# # Exception PDU's #---------------------------------------------------------------------------#
[docs]class ModbusExceptions(Singleton): ''' An enumeration of the valid modbus exceptions ''' IllegalFunction = 0x01 IllegalAddress = 0x02 IllegalValue = 0x03 SlaveFailure = 0x04 Acknowledge = 0x05 SlaveBusy = 0x06 MemoryParityError = 0x08 GatewayPathUnavailable = 0x0A GatewayNoResponse = 0x0B @classmethod
[docs] def decode(cls, code): ''' Given an error code, translate it to a string error name. :param code: The code number to translate ''' values = dict((v, k) for k, v in iteritems(cls.__dict__) if not k.startswith('__') and not callable(v)) return values.get(code, None)
[docs]class ExceptionResponse(ModbusResponse): ''' Base class for a modbus exception PDU ''' ExceptionOffset = 0x80 _rtu_frame_size = 5
[docs] def __init__(self, function_code, exception_code=None, **kwargs): ''' Initializes the modbus exception response :param function_code: The function to build an exception response for :param exception_code: The specific modbus exception to return ''' ModbusResponse.__init__(self, **kwargs) self.original_code = function_code self.function_code = function_code | self.ExceptionOffset self.exception_code = exception_code
[docs] def encode(self): ''' Encodes a modbus exception response :returns: The encoded exception packet ''' return int2byte(self.exception_code)
[docs] def decode(self, data): ''' Decodes a modbus exception response :param data: The packet data to decode ''' self.exception_code = byte2int(data[0])
[docs] def __str__(self): ''' Builds a representation of an exception response :returns: The string representation of an exception response ''' message = ModbusExceptions.decode(self.exception_code) parameters = (self.function_code, self.original_code, message) return "Exception Response(%d, %d, %s)" % parameters
[docs]class IllegalFunctionRequest(ModbusRequest): ''' Defines the Modbus slave exception type 'Illegal Function' This exception code is returned if the slave:: - does not implement the function code **or** - is not in a state that allows it to process the function ''' ErrorCode = 1
[docs] def __init__(self, function_code, **kwargs): ''' Initializes a IllegalFunctionRequest :param function_code: The function we are erroring on ''' ModbusRequest.__init__(self, **kwargs) self.function_code = function_code
[docs] def decode(self, data): ''' This is here so this failure will run correctly :param data: Not used ''' pass
[docs] def execute(self, context): ''' Builds an illegal function request error response :param context: The current context for the message :returns: The error response packet ''' return ExceptionResponse(self.function_code, self.ErrorCode)
#---------------------------------------------------------------------------# # Exported symbols #---------------------------------------------------------------------------# __all__ = [ 'ModbusRequest', 'ModbusResponse', 'ModbusExceptions', 'ExceptionResponse', 'IllegalFunctionRequest', ]