/usr/lib/python2.7/dist-packages/pymodbus/transaction.py is in python-pymodbus 1.3.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 | '''
Collection of transaction based abstractions
'''
import sys
import struct
import socket
from binascii import b2a_hex, a2b_hex
from pymodbus.exceptions import ModbusIOException, NotImplementedException
from pymodbus.exceptions import InvalidMessageRecievedException
from pymodbus.constants import Defaults
from pymodbus.interfaces import IModbusFramer
from pymodbus.utilities import checkCRC, computeCRC
from pymodbus.utilities import checkLRC, computeLRC
from pymodbus.compat import iterkeys, imap, byte2int
#---------------------------------------------------------------------------#
# Logging
#---------------------------------------------------------------------------#
import logging
_logger = logging.getLogger(__name__)
#---------------------------------------------------------------------------#
# The Global Transaction Manager
#---------------------------------------------------------------------------#
class ModbusTransactionManager(object):
''' Impelements a transaction for a manager
The transaction protocol can be represented by the following pseudo code::
count = 0
do
result = send(message)
if (timeout or result == bad)
count++
else break
while (count < 3)
This module helps to abstract this away from the framer and protocol.
'''
def __init__(self, client, **kwargs):
''' Initializes an instance of the ModbusTransactionManager
:param client: The client socket wrapper
:param retry_on_empty: Should the client retry on empty
:param retries: The number of retries to allow
'''
self.tid = Defaults.TransactionId
self.client = client
self.retry_on_empty = kwargs.get('retry_on_empty', Defaults.RetryOnEmpty)
self.retries = kwargs.get('retries', Defaults.Retries)
if client:
self._set_adu_size()
def _set_adu_size(self):
# base ADU size of modbus frame in bytes
if isinstance(self.client.framer, ModbusSocketFramer):
self.base_adu_size = 7 # tid(2), pid(2), length(2), uid(1)
elif isinstance(self.client.framer, ModbusRtuFramer):
self.base_adu_size = 3 # address(1), CRC(2)
elif isinstance(self.client.framer, ModbusAsciiFramer):
self.base_adu_size = 7 # start(1)+ Address(2), LRC(2) + end(2)
elif isinstance(self.client.framer, ModbusBinaryFramer):
self.base_adu_size = 3 #, Address(1), CRC(2)
else:
self.base_adu_size = -1
def _calculate_response_length(self, expected_pdu_size):
if self.base_adu_size == -1:
return None
else:
return self.base_adu_size + expected_pdu_size
def _calculate_exception_length(self):
''' Returns the length of the Modbus Exception Response according to
the type of Framer.
'''
if isinstance(self.client.framer, ModbusSocketFramer):
return self.base_adu_size + 2 # Fcode(1), ExcecptionCode(1)
elif isinstance(self.client.framer, ModbusAsciiFramer):
return self.base_adu_size + 4 # Fcode(2), ExcecptionCode(2)
elif isinstance(self.client.framer, (ModbusRtuFramer, ModbusBinaryFramer)):
return self.base_adu_size + 2 # Fcode(1), ExcecptionCode(1)
return None
def _check_response(self, response):
''' Checks if the response is a Modbus Exception.
'''
if isinstance(self.client.framer, ModbusSocketFramer):
if len(response) >= 8 and byte2int(response[7]) > 128:
return False
elif isinstance(self.client.framer, ModbusAsciiFramer):
if len(response) >= 5 and int(response[3:5], 16) > 128:
return False
elif isinstance(self.client.framer, (ModbusRtuFramer,
ModbusBinaryFramer)):
if len(response) >= 2 and byte2int(response[1]) > 128:
return False
return True
def execute(self, request):
''' Starts the producer to send the next request to
consumer.write(Frame(request))
'''
retries = self.retries
request.transaction_id = self.getNextTID()
_logger.debug("Running transaction %d" % request.transaction_id)
self.client.framer.resetFrame()
expected_response_length = None
if hasattr(request, "get_response_pdu_size"):
response_pdu_size = request.get_response_pdu_size()
if isinstance(self.client.framer, ModbusAsciiFramer):
response_pdu_size = response_pdu_size * 2
if response_pdu_size:
expected_response_length = self._calculate_response_length(response_pdu_size)
while retries > 0:
try:
last_exception = None
self.client.connect()
packet = self.client.framer.buildPacket(request)
if _logger.isEnabledFor(logging.DEBUG):
_logger.debug("send: " + " ".join([hex(byte2int(x)) for x in packet]))
self._send(packet)
# exception = False
result = self._recv(expected_response_length or 1024)
if not result and self.retry_on_empty:
retries -= 1
continue
if _logger.isEnabledFor(logging.DEBUG):
_logger.debug("recv: " + " ".join([hex(byte2int(x)) for x in result]))
self.client.framer.processIncomingPacket(result, self.addTransaction)
break
except (socket.error, ModbusIOException, InvalidMessageRecievedException) as msg:
self.client.close()
_logger.debug("Transaction failed. (%s) " % msg)
retries -= 1
last_exception = msg
response = self.getTransaction(request.transaction_id)
if not response:
if len(self.transactions):
response = self.getTransaction(tid=0)
else:
last_exception = last_exception or ("No Response "
"received from the remote unit")
response = ModbusIOException(last_exception)
return response
def _send(self, packet):
return self.client._send(packet)
def _recv(self, expected_response_length):
retries = self.retries
exception = False
while retries:
result = self.client._recv(expected_response_length or 1024)
while result and expected_response_length and len(
result) < expected_response_length:
if not exception and not self._check_response(result):
exception = True
expected_response_length = self._calculate_exception_length()
continue
if isinstance(self.client.framer, ModbusSocketFramer):
break
r = self.client._recv(expected_response_length - len(result))
if not r:
# If no response being recived there is no point in conitnuing
break
result += r
if result:
break
retries -= 1
return result
def addTransaction(self, request, tid=None):
''' Adds a transaction to the handler
This holds the requets in case it needs to be resent.
After being sent, the request is removed.
:param request: The request to hold on to
:param tid: The overloaded transaction id to use
'''
raise NotImplementedException("addTransaction")
def getTransaction(self, tid):
''' Returns a transaction matching the referenced tid
If the transaction does not exist, None is returned
:param tid: The transaction to retrieve
'''
raise NotImplementedException("getTransaction")
def delTransaction(self, tid):
''' Removes a transaction matching the referenced tid
:param tid: The transaction to remove
'''
raise NotImplementedException("delTransaction")
def getNextTID(self):
''' Retrieve the next unique transaction identifier
This handles incrementing the identifier after
retrieval
:returns: The next unique transaction identifier
'''
self.tid = (self.tid + 1) & 0xffff
return self.tid
def reset(self):
''' Resets the transaction identifier '''
self.tid = Defaults.TransactionId
self.transactions = type(self.transactions)()
class DictTransactionManager(ModbusTransactionManager):
''' Impelements a transaction for a manager where the
results are keyed based on the supplied transaction id.
'''
def __init__(self, client, **kwargs):
''' Initializes an instance of the ModbusTransactionManager
:param client: The client socket wrapper
'''
self.transactions = {}
super(DictTransactionManager, self).__init__(client, **kwargs)
def __iter__(self):
''' Iterater over the current managed transactions
:returns: An iterator of the managed transactions
'''
return iterkeys(self.transactions)
def addTransaction(self, request, tid=None):
''' Adds a transaction to the handler
This holds the requets in case it needs to be resent.
After being sent, the request is removed.
:param request: The request to hold on to
:param tid: The overloaded transaction id to use
'''
tid = tid if tid != None else request.transaction_id
_logger.debug("adding transaction %d" % tid)
self.transactions[tid] = request
def getTransaction(self, tid):
''' Returns a transaction matching the referenced tid
If the transaction does not exist, None is returned
:param tid: The transaction to retrieve
'''
_logger.debug("getting transaction %d" % tid)
return self.transactions.pop(tid, None)
def delTransaction(self, tid):
''' Removes a transaction matching the referenced tid
:param tid: The transaction to remove
'''
_logger.debug("deleting transaction %d" % tid)
self.transactions.pop(tid, None)
class FifoTransactionManager(ModbusTransactionManager):
''' Impelements a transaction for a manager where the
results are returned in a FIFO manner.
'''
def __init__(self, client, **kwargs):
''' Initializes an instance of the ModbusTransactionManager
:param client: The client socket wrapper
'''
super(FifoTransactionManager, self).__init__(client, **kwargs)
self.transactions = []
def __iter__(self):
''' Iterater over the current managed transactions
:returns: An iterator of the managed transactions
'''
return iter(self.transactions)
def addTransaction(self, request, tid=None):
''' Adds a transaction to the handler
This holds the requets in case it needs to be resent.
After being sent, the request is removed.
:param request: The request to hold on to
:param tid: The overloaded transaction id to use
'''
tid = tid if tid != None else request.transaction_id
_logger.debug("adding transaction %d" % tid)
self.transactions.append(request)
def getTransaction(self, tid):
''' Returns a transaction matching the referenced tid
If the transaction does not exist, None is returned
:param tid: The transaction to retrieve
'''
_logger.debug("getting transaction %s" % str(tid))
return self.transactions.pop(0) if self.transactions else None
def delTransaction(self, tid):
''' Removes a transaction matching the referenced tid
:param tid: The transaction to remove
'''
_logger.debug("deleting transaction %d" % tid)
if self.transactions: self.transactions.pop(0)
#---------------------------------------------------------------------------#
# Modbus TCP Message
#---------------------------------------------------------------------------#
class ModbusSocketFramer(IModbusFramer):
''' Modbus Socket Frame controller
Before each modbus TCP message is an MBAP header which is used as a
message frame. It allows us to easily separate messages as follows::
[ MBAP Header ] [ Function Code] [ Data ]
[ tid ][ pid ][ length ][ uid ]
2b 2b 2b 1b 1b Nb
while len(message) > 0:
tid, pid, length`, uid = struct.unpack(">HHHB", message)
request = message[0:7 + length - 1`]
message = [7 + length - 1:]
* length = uid + function code + data
* The -1 is to account for the uid byte
'''
def __init__(self, decoder):
''' Initializes a new instance of the framer
:param decoder: The decoder factory implementation to use
'''
self.__buffer = b''
self.__header = {'tid':0, 'pid':0, 'len':0, 'uid':0}
self.__hsize = 0x07
self.decoder = decoder
#-----------------------------------------------------------------------#
# Private Helper Functions
#-----------------------------------------------------------------------#
def checkFrame(self):
'''
Check and decode the next frame Return true if we were successful
'''
if len(self.__buffer) > self.__hsize:
self.__header['tid'], self.__header['pid'], \
self.__header['len'], self.__header['uid'] = struct.unpack(
'>HHHB', self.__buffer[0:self.__hsize])
# someone sent us an error? ignore it
if self.__header['len'] < 2:
self.advanceFrame()
# we have at least a complete message, continue
elif len(self.__buffer) - self.__hsize + 1 >= self.__header['len']:
return True
# we don't have enough of a message yet, wait
return False
def advanceFrame(self):
''' Skip over the current framed message
This allows us to skip over the current message after we have processed
it or determined that it contains an error. It also has to reset the
current frame header handle
'''
length = self.__hsize + self.__header['len'] - 1
self.__buffer = self.__buffer[length:]
self.__header = {'tid':0, 'pid':0, 'len':0, 'uid':0}
def isFrameReady(self):
''' Check if we should continue decode logic
This is meant to be used in a while loop in the decoding phase to let
the decoder factory know that there is still data in the buffer.
:returns: True if ready, False otherwise
'''
return len(self.__buffer) > self.__hsize
def addToFrame(self, message):
''' Adds new packet data to the current frame buffer
:param message: The most recent packet
'''
self.__buffer += message
def getFrame(self):
''' Return the next frame from the buffered data
:returns: The next full frame buffer
'''
length = self.__hsize + self.__header['len'] - 1
return self.__buffer[self.__hsize:length]
def populateResult(self, result):
'''
Populates the modbus result with the transport specific header
information (pid, tid, uid, checksum, etc)
:param result: The response packet
'''
result.transaction_id = self.__header['tid']
result.protocol_id = self.__header['pid']
result.unit_id = self.__header['uid']
#-----------------------------------------------------------------------#
# Public Member Functions
#-----------------------------------------------------------------------#
def processIncomingPacket(self, data, callback):
''' The new packet processing pattern
This takes in a new request packet, adds it to the current
packet stream, and performs framing on it. That is, checks
for complete messages, and once found, will process all that
exist. This handles the case when we read N + 1 or 1 / N
messages at a time instead of 1.
The processed and decoded messages are pushed to the callback
function to process and send.
:param data: The new packet data
:param callback: The function to send results to
'''
_logger.debug(' '.join([hex(byte2int(x)) for x in data]))
self.addToFrame(data)
while True:
if self.isFrameReady():
if self.checkFrame():
self._process(callback)
else: self.resetFrame()
else:
if len(self.__buffer):
# Possible error ???
if self.__header['len'] < 2:
self._process(callback, error=True)
break
def _process(self, callback, error=False):
"""
Process incoming packets irrespective error condition
"""
data = self.getRawFrame() if error else self.getFrame()
result = self.decoder.decode(data)
if result is None:
raise ModbusIOException("Unable to decode request")
elif error and result.function_code < 0x80:
raise InvalidMessageRecievedException(result)
else:
self.populateResult(result)
self.advanceFrame()
callback(result) # defer or push to a thread?
def resetFrame(self):
''' Reset the entire message frame.
This allows us to skip ovver errors that may be in the stream.
It is hard to know if we are simply out of sync or if there is
an error in the stream as we have no way to check the start or
end of the message (python just doesn't have the resolution to
check for millisecond delays).
'''
self.__buffer = b''
self.__header = {}
def getRawFrame(self):
"""
Returns the complete buffer
"""
return self.__buffer
def buildPacket(self, message):
''' Creates a ready to send modbus packet
:param message: The populated request/response to send
'''
data = message.encode()
packet = struct.pack('>HHHBB',
message.transaction_id,
message.protocol_id,
len(data) + 2,
message.unit_id,
message.function_code) + data
return packet
#---------------------------------------------------------------------------#
# Modbus RTU Message
#---------------------------------------------------------------------------#
class ModbusRtuFramer(IModbusFramer):
'''
Modbus RTU Frame controller::
[ Start Wait ] [Address ][ Function Code] [ Data ][ CRC ][ End Wait ]
3.5 chars 1b 1b Nb 2b 3.5 chars
Wait refers to the amount of time required to transmist at least x many
characters. In this case it is 3.5 characters. Also, if we recieve a
wait of 1.5 characters at any point, we must trigger an error message.
Also, it appears as though this message is little endian. The logic is
simplified as the following::
block-on-read:
read until 3.5 delay
check for errors
decode
The following table is a listing of the baud wait times for the specified
baud rates::
------------------------------------------------------------------
Baud 1.5c (18 bits) 3.5c (38 bits)
------------------------------------------------------------------
1200 13333.3 us 31666.7 us
4800 3333.3 us 7916.7 us
9600 1666.7 us 3958.3 us
19200 833.3 us 1979.2 us
38400 416.7 us 989.6 us
------------------------------------------------------------------
1 Byte = start + 8 bits + parity + stop = 11 bits
(1/Baud)(bits) = delay seconds
'''
def __init__(self, decoder):
''' Initializes a new instance of the framer
:param decoder: The decoder factory implementation to use
'''
self.__buffer = b''
self.__header = {}
self.__hsize = 0x01
self.__end = b'\x0d\x0a'
self.__min_frame_size = 4
self.decoder = decoder
#-----------------------------------------------------------------------#
# Private Helper Functions
#-----------------------------------------------------------------------#
def checkFrame(self):
'''
Check if the next frame is available. Return True if we were
successful.
'''
try:
self.populateHeader()
frame_size = self.__header['len']
data = self.__buffer[:frame_size - 2]
crc = self.__buffer[frame_size - 2:frame_size]
crc_val = (byte2int(crc[0]) << 8) + byte2int(crc[1])
return checkCRC(data, crc_val)
except (IndexError, KeyError):
return False
def advanceFrame(self):
''' Skip over the current framed message
This allows us to skip over the current message after we have processed
it or determined that it contains an error. It also has to reset the
current frame header handle
'''
try:
self.__buffer = self.__buffer[self.__header['len']:]
except KeyError:
# Error response, no header len found
self.resetFrame()
self.__header = {}
def resetFrame(self):
''' Reset the entire message frame.
This allows us to skip ovver errors that may be in the stream.
It is hard to know if we are simply out of sync or if there is
an error in the stream as we have no way to check the start or
end of the message (python just doesn't have the resolution to
check for millisecond delays).
'''
self.__buffer = b''
self.__header = {}
def isFrameReady(self):
''' Check if we should continue decode logic
This is meant to be used in a while loop in the decoding phase to let
the decoder know that there is still data in the buffer.
:returns: True if ready, False otherwise
'''
return len(self.__buffer) > self.__hsize
def populateHeader(self):
''' Try to set the headers `uid`, `len` and `crc`.
This method examines `self.__buffer` and writes meta
information into `self.__header`. It calculates only the
values for headers that are not already in the dictionary.
Beware that this method will raise an IndexError if
`self.__buffer` is not yet long enough.
'''
self.__header['uid'] = byte2int(self.__buffer[0])
func_code = byte2int(self.__buffer[1])
pdu_class = self.decoder.lookupPduClass(func_code)
size = pdu_class.calculateRtuFrameSize(self.__buffer)
self.__header['len'] = size
self.__header['crc'] = self.__buffer[size - 2:size]
def addToFrame(self, message):
'''
This should be used before the decoding while loop to add the received
data to the buffer handle.
:param message: The most recent packet
'''
self.__buffer += message
def getFrame(self):
''' Get the next frame from the buffer
:returns: The frame data or ''
'''
start = self.__hsize
end = self.__header['len'] - 2
buffer = self.__buffer[start:end]
if end > 0: return buffer
return ''
def populateResult(self, result):
''' Populates the modbus result header
The serial packets do not have any header information
that is copied.
:param result: The response packet
'''
result.unit_id = self.__header['uid']
#-----------------------------------------------------------------------#
# Public Member Functions
#-----------------------------------------------------------------------#
def processIncomingPacket(self, data, callback):
''' The new packet processing pattern
This takes in a new request packet, adds it to the current
packet stream, and performs framing on it. That is, checks
for complete messages, and once found, will process all that
exist. This handles the case when we read N + 1 or 1 / N
messages at a time instead of 1.
The processed and decoded messages are pushed to the callback
function to process and send.
:param data: The new packet data
:param callback: The function to send results to
'''
self.addToFrame(data)
while True:
if self.isFrameReady():
if self.checkFrame():
self._process(callback)
else:
# Could be an error response
if len(self.__buffer):
# Possible error ???
self._process(callback, error=True)
else:
if len(self.__buffer):
# Possible error ???
if self.__header.get('len', 0) < 2:
self._process(callback, error=True)
break
def buildPacket(self, message):
''' Creates a ready to send modbus packet
:param message: The populated request/response to send
'''
data = message.encode()
packet = struct.pack('>BB',
message.unit_id,
message.function_code) + data
packet += struct.pack(">H", computeCRC(packet))
return packet
def _process(self, callback, error=False):
"""
Process incoming packets irrespective error condition
"""
data = self.getRawFrame() if error else self.getFrame()
result = self.decoder.decode(data)
if result is None:
raise ModbusIOException("Unable to decode request")
elif error and result.function_code < 0x80:
raise InvalidMessageRecievedException(result)
else:
self.populateResult(result)
self.advanceFrame()
callback(result) # defer or push to a thread?
def getRawFrame(self):
"""
Returns the complete buffer
"""
return self.__buffer
#---------------------------------------------------------------------------#
# Modbus ASCII Message
#---------------------------------------------------------------------------#
class ModbusAsciiFramer(IModbusFramer):
'''
Modbus ASCII Frame Controller::
[ Start ][Address ][ Function ][ Data ][ LRC ][ End ]
1c 2c 2c Nc 2c 2c
* data can be 0 - 2x252 chars
* end is '\\r\\n' (Carriage return line feed), however the line feed
character can be changed via a special command
* start is ':'
This framer is used for serial transmission. Unlike the RTU protocol,
the data in this framer is transferred in plain text ascii.
'''
def __init__(self, decoder):
''' Initializes a new instance of the framer
:param decoder: The decoder implementation to use
'''
self.__buffer = b''
self.__header = {'lrc':'0000', 'len':0, 'uid':0x00}
self.__hsize = 0x02
self.__start = b':'
self.__end = b"\r\n"
self.decoder = decoder
#-----------------------------------------------------------------------#
# Private Helper Functions
#-----------------------------------------------------------------------#
def checkFrame(self):
''' Check and decode the next frame
:returns: True if we successful, False otherwise
'''
start = self.__buffer.find(self.__start)
if start == -1: return False
if start > 0 : # go ahead and skip old bad data
self.__buffer = self.__buffer[start:]
start = 0
end = self.__buffer.find(self.__end)
if (end != -1):
self.__header['len'] = end
self.__header['uid'] = int(self.__buffer[1:3], 16)
self.__header['lrc'] = int(self.__buffer[end - 2:end], 16)
data = a2b_hex(self.__buffer[start + 1:end - 2])
return checkLRC(data, self.__header['lrc'])
return False
def advanceFrame(self):
''' Skip over the current framed message
This allows us to skip over the current message after we have processed
it or determined that it contains an error. It also has to reset the
current frame header handle
'''
self.__buffer = self.__buffer[self.__header['len'] + 2:]
self.__header = {'lrc':'0000', 'len':0, 'uid':0x00}
def isFrameReady(self):
''' Check if we should continue decode logic
This is meant to be used in a while loop in the decoding phase to let
the decoder know that there is still data in the buffer.
:returns: True if ready, False otherwise
'''
return len(self.__buffer) > 1
def addToFrame(self, message):
''' Add the next message to the frame buffer
This should be used before the decoding while loop to add the received
data to the buffer handle.
:param message: The most recent packet
'''
self.__buffer += message
def getFrame(self):
''' Get the next frame from the buffer
:returns: The frame data or ''
'''
start = self.__hsize + 1
end = self.__header['len'] - 2
buffer = self.__buffer[start:end]
if end > 0: return a2b_hex(buffer)
return b''
def resetFrame(self):
''' Reset the entire message frame.
This allows us to skip ovver errors that may be in the stream.
It is hard to know if we are simply out of sync or if there is
an error in the stream as we have no way to check the start or
end of the message (python just doesn't have the resolution to
check for millisecond delays).
'''
self.__buffer = b''
self.__header = {'lrc':'0000', 'len':0, 'uid':0x00}
def populateResult(self, result):
''' Populates the modbus result header
The serial packets do not have any header information
that is copied.
:param result: The response packet
'''
result.unit_id = self.__header['uid']
#-----------------------------------------------------------------------#
# Public Member Functions
#-----------------------------------------------------------------------#
def processIncomingPacket(self, data, callback):
''' The new packet processing pattern
This takes in a new request packet, adds it to the current
packet stream, and performs framing on it. That is, checks
for complete messages, and once found, will process all that
exist. This handles the case when we read N + 1 or 1 / N
messages at a time instead of 1.
The processed and decoded messages are pushed to the callback
function to process and send.
:param data: The new packet data
:param callback: The function to send results to
'''
self.addToFrame(data)
while self.isFrameReady():
if self.checkFrame():
result = self.decoder.decode(self.getFrame())
if result is None:
raise ModbusIOException("Unable to decode response")
self.populateResult(result)
self.advanceFrame()
callback(result) # defer this
else:
break
def buildPacket(self, message):
''' Creates a ready to send modbus packet
Built off of a modbus request/response
:param message: The request/response to send
:return: The encoded packet
'''
encoded = message.encode()
buffer = struct.pack('>BB', message.unit_id, message.function_code)
checksum = computeLRC(encoded + buffer)
packet = bytearray()
params = (message.unit_id, message.function_code)
packet.extend(self.__start)
packet.extend(('%02x%02x' % params).encode())
packet.extend(b2a_hex(encoded))
packet.extend(('%02x' % checksum).encode())
packet.extend(self.__end)
return bytes(packet).upper()
#---------------------------------------------------------------------------#
# Modbus Binary Message
#---------------------------------------------------------------------------#
class ModbusBinaryFramer(IModbusFramer):
'''
Modbus Binary Frame Controller::
[ Start ][Address ][ Function ][ Data ][ CRC ][ End ]
1b 1b 1b Nb 2b 1b
* data can be 0 - 2x252 chars
* end is '}'
* start is '{'
The idea here is that we implement the RTU protocol, however,
instead of using timing for message delimiting, we use start
and end of message characters (in this case { and }). Basically,
this is a binary framer.
The only case we have to watch out for is when a message contains
the { or } characters. If we encounter these characters, we
simply duplicate them. Hopefully we will not encounter those
characters that often and will save a little bit of bandwitch
without a real-time system.
Protocol defined by jamod.sourceforge.net.
'''
def __init__(self, decoder):
''' Initializes a new instance of the framer
:param decoder: The decoder implementation to use
'''
self.__buffer = b''
self.__header = {'crc':0x0000, 'len':0, 'uid':0x00}
self.__hsize = 0x02
self.__start = b'\x7b' # {
self.__end = b'\x7d' # }
self.__repeat = [b'}'[0], b'{'[0]] # python3 hack
self.decoder = decoder
#-----------------------------------------------------------------------#
# Private Helper Functions
#-----------------------------------------------------------------------#
def checkFrame(self):
''' Check and decode the next frame
:returns: True if we are successful, False otherwise
'''
start = self.__buffer.find(self.__start)
if start == -1: return False
if start > 0 : # go ahead and skip old bad data
self.__buffer = self.__buffer[start:]
end = self.__buffer.find(self.__end)
if (end != -1):
self.__header['len'] = end
self.__header['uid'] = struct.unpack('>B', self.__buffer[1:2])
self.__header['crc'] = struct.unpack('>H', self.__buffer[end - 2:end])[0]
data = self.__buffer[start + 1:end - 2]
return checkCRC(data, self.__header['crc'])
return False
def advanceFrame(self):
''' Skip over the current framed message
This allows us to skip over the current message after we have processed
it or determined that it contains an error. It also has to reset the
current frame header handle
'''
self.__buffer = self.__buffer[self.__header['len'] + 2:]
self.__header = {'crc':0x0000, 'len':0, 'uid':0x00}
def isFrameReady(self):
''' Check if we should continue decode logic
This is meant to be used in a while loop in the decoding phase to let
the decoder know that there is still data in the buffer.
:returns: True if ready, False otherwise
'''
return len(self.__buffer) > 1
def addToFrame(self, message):
''' Add the next message to the frame buffer
This should be used before the decoding while loop to add the received
data to the buffer handle.
:param message: The most recent packet
'''
self.__buffer += message
def getFrame(self):
''' Get the next frame from the buffer
:returns: The frame data or ''
'''
start = self.__hsize + 1
end = self.__header['len'] - 2
buffer = self.__buffer[start:end]
if end > 0: return buffer
return b''
def populateResult(self, result):
''' Populates the modbus result header
The serial packets do not have any header information
that is copied.
:param result: The response packet
'''
result.unit_id = self.__header['uid']
#-----------------------------------------------------------------------#
# Public Member Functions
#-----------------------------------------------------------------------#
def processIncomingPacket(self, data, callback):
''' The new packet processing pattern
This takes in a new request packet, adds it to the current
packet stream, and performs framing on it. That is, checks
for complete messages, and once found, will process all that
exist. This handles the case when we read N + 1 or 1 / N
messages at a time instead of 1.
The processed and decoded messages are pushed to the callback
function to process and send.
:param data: The new packet data
:param callback: The function to send results to
'''
self.addToFrame(data)
while self.isFrameReady():
if self.checkFrame():
result = self.decoder.decode(self.getFrame())
if result is None:
raise ModbusIOException("Unable to decode response")
self.populateResult(result)
self.advanceFrame()
callback(result) # defer or push to a thread?
else:
break
def buildPacket(self, message):
''' Creates a ready to send modbus packet
:param message: The request/response to send
:returns: The encoded packet
'''
data = self._preflight(message.encode())
packet = struct.pack('>BB',
message.unit_id,
message.function_code) + data
packet += struct.pack(">H", computeCRC(packet))
packet = self.__start + packet + self.__end
return packet
def _preflight(self, data):
''' Preflight buffer test
This basically scans the buffer for start and end
tags and if found, escapes them.
:param data: The message to escape
:returns: the escaped packet
'''
array = bytearray()
for d in data:
if d in self.__repeat:
array.append(d)
array.append(d)
return bytes(array)
def resetFrame(self):
''' Reset the entire message frame.
This allows us to skip ovver errors that may be in the stream.
It is hard to know if we are simply out of sync or if there is
an error in the stream as we have no way to check the start or
end of the message (python just doesn't have the resolution to
check for millisecond delays).
'''
self.__buffer = b''
self.__header = {'crc': 0x0000, 'len': 0, 'uid': 0x00}
#---------------------------------------------------------------------------#
# Exported symbols
#---------------------------------------------------------------------------#
__all__ = [
"FifoTransactionManager",
"DictTransactionManager",
"ModbusSocketFramer", "ModbusRtuFramer",
"ModbusAsciiFramer", "ModbusBinaryFramer",
]
|