├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── requirements.txt ├── scripts ├── conv-data-gui ├── modbus-gui ├── modbus-request-serial └── modbus-scan-serial └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *,cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # dotenv 80 | .env 81 | 82 | # virtualenv 83 | .venv 84 | venv/ 85 | ENV/ 86 | 87 | # Spyder project settings 88 | .spyderproject 89 | 90 | # Rope project settings 91 | .ropeproject 92 | 93 | # PyCharm 94 | .idea/ 95 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.8-buster 2 | 3 | RUN apt-get update && \ 4 | apt-get install -y git python3-setuptools 5 | 6 | RUN git clone https://github.com/sourceperl/modbus-serial-monitor.git 7 | 8 | WORKDIR /modbus-serial-monitor 9 | 10 | RUN python3 setup.py install 11 | 12 | ENV DEVICE=/dev/ttyAP0 13 | ENV BAUDRATE=115200 14 | 15 | CMD ["sh", "-c", "python3 scripts/modbus-scan-serial --device=$DEVICE --baudrate=$BAUDRATE --parity=N"] 16 | 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 l.lefebvre 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | modbus-serial-monitor 2 | ===================== 3 | 4 | Modbus/RTU python monitor: check serial frame between devices. 5 | 6 | Format modbus RTU serial frames receive from a serial port to console stdout. 7 | 8 | Test with python3. 9 | 10 | ## Synoptic 11 | 12 | RS-485 13 | RS-422 bus -> FTDI cable -> /dev/ttyUSBx -> this_script -> CSV out 14 | RS-232 15 | 16 | ## CSV out sample 17 | 18 | DATE=2015-11-05T17:31:27.977;ERR=NO;FRAME=01-03-50-00-00-04-55-09;SLAVE=1; 19 | 20 | ## Prerequisite 21 | 22 | E.g. in Debian based dists, install package: 23 | 24 | $ sudo apt-get install python3-setuptools 25 | 26 | ## Setup 27 | 28 | $ sudo python3 setup.py install 29 | 30 | ## Use it 31 | 32 | Help 33 | 34 | $ modbus-scan-serial -h 35 | 36 | See frame only for slave 1 37 | 38 | $ modbus-scan-serial -d /dev/ttyUSB2 | grep SLAVE=1 39 | 40 | Store all traffic on modbus.log file 41 | 42 | $ modbus-scan-serial > modbus.log 43 | 44 | ## Use it with docker 45 | 46 | $ docker build -t modbus-serial-monitor . 47 | $ docker run -it --device=/dev/ttyUSB2:/dev/ttyUSB2:rwm -e "DEVICE=/dev/ttyUSB2" -e "BAUDRATE=460800" modbus-serial-monitor 48 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyserial==2.7 2 | MinimalModbus==0.7 -------------------------------------------------------------------------------- /scripts/conv-data-gui: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import tkinter as tk 4 | from tkinter import ttk 5 | import struct 6 | import binascii 7 | 8 | # some const 9 | FORMATS = ['LONG (entier sur 4 octets)', 10 | 'SINGLE (flottant sur 4 octets)', 11 | 'DOUBLE (flottant sur 8 octets)'] 12 | 13 | 14 | def hex_to_long(s): 15 | b_hex = binascii.unhexlify(s.rjust(8, '0')) 16 | if len(b_hex) > 4: 17 | raise ValueError 18 | return struct.unpack('!l', b_hex.rjust(4, b'\0'))[0] 19 | 20 | 21 | def hex_to_single(s): 22 | b_hex = binascii.unhexlify(s.rjust(8, '0')) 23 | if len(b_hex) > 4: 24 | raise ValueError 25 | return struct.unpack('!f', b_hex.rjust(4, b'\0'))[0] 26 | 27 | 28 | def hex_to_double(s): 29 | b_hex = binascii.unhexlify(s.rjust(8, '0')) 30 | if len(b_hex) > 8: 31 | raise ValueError 32 | return struct.unpack('!d', b_hex.rjust(8, b'\0'))[0] 33 | 34 | 35 | def long_to_hex(l): 36 | return '%08x'.upper() % (struct.unpack('', lambda evt: self.tab_update()) 57 | self._tab_update() 58 | 59 | def _tab_update(self): 60 | if self.winfo_ismapped(): 61 | self.tab_update() 62 | self.master.after(self.update_ms, self._tab_update) 63 | 64 | def tab_update(self): 65 | pass 66 | 67 | 68 | class TkApp(tk.Tk): 69 | def __init__(self, *args, **kwargs): 70 | tk.Tk.__init__(self, *args, **kwargs) 71 | # configure main window 72 | self.wm_title('Convertion format de donnée') 73 | self.resizable(False, False) 74 | # build a notebook with tabs 75 | self.fMain = FrmMain(self) 76 | self.fMain.pack(fill=tk.BOTH, expand=tk.YES) 77 | 78 | def do_every(self, do_cmd, every_ms=1000): 79 | do_cmd() 80 | self.after(every_ms, lambda: self.do_every(do_cmd, every_ms=every_ms)) 81 | 82 | 83 | class FrmMain(FrmTab): 84 | def __init__(self, notebook, update_ms=500, *args, **kwargs): 85 | FrmTab.__init__(self, notebook, update_ms, *args, **kwargs) 86 | # some vars 87 | self.hex_str = tk.StringVar(value='00000000') 88 | self.value_str = tk.StringVar(value='0.0') 89 | self.fmt_str = tk.StringVar() 90 | self.data_fmt = '' 91 | # install callback 92 | self.fmt_str.trace('w', self.on_data_fmt_change) 93 | # capture frame 94 | self.frm1 = tk.Frame(self) 95 | self.frm1.grid(row=0, column=0, sticky=tk.NSEW, padx=5, pady=5) 96 | self.lbl_dat = tk.Label(self.frm1, text='Données brutes (format hexa)') 97 | self.lbl_dat.grid(row=0, column=0, sticky=tk.W, padx=5, pady=5) 98 | self.ent_hex = tk.Entry(self.frm1, width=16, validate='all', textvariable=self.hex_str) 99 | self.ent_hex.grid(row=0, column=1, sticky=tk.W, padx=5, pady=5) 100 | self.lbl_val = tk.Label(self.frm1, text='Valeur (format décimal)') 101 | self.lbl_val.grid(row=1, column=0, sticky=tk.W, padx=5, pady=5) 102 | self.ent_val = tk.Entry(self.frm1, width=16, textvariable=self.value_str) 103 | self.ent_val.grid(row=1, column=1, sticky=tk.W, padx=5, pady=5) 104 | self.lbl_fmt = tk.Label(self.frm1, text='formats') 105 | self.lbl_fmt.grid(row=2, column=0, sticky=tk.W, padx=5, pady=5) 106 | self.cbb_fmt = ttk.Combobox(self.frm1, textvariable=self.fmt_str, values=FORMATS, width=25) 107 | self.cbb_fmt.current(newindex=0) 108 | self.cbb_fmt.grid(row=2, column=1, sticky=tk.W, padx=5, pady=5) 109 | self.but_to_value = tk.Button(self.frm1, text='Convertion données > valeur', command=self.data_to_value) 110 | self.but_to_value.grid(row=3, column=0, sticky=tk.EW, padx=5, pady=5) 111 | self.but_to_hex = tk.Button(self.frm1, text='Convertion valeur > données', command=self.value_to_data) 112 | self.but_to_hex.grid(row=3, column=1, sticky=tk.EW, padx=5, pady=5) 113 | 114 | def on_data_fmt_change(self, *args): 115 | self.data_fmt = (self.cbb_fmt.get().split(' ')[0]) 116 | # 32 bits: limit to 8 digits 117 | if self.data_fmt in ['LONG', 'SINGLE']: 118 | self.hex_str.set(self.hex_str.get().rjust(8, '0')[-8:]) 119 | # 64 bits: limit to 16 digits 120 | elif self.data_fmt in ['DOUBLE']: 121 | self.hex_str.set(self.hex_str.get().rjust(16, '0')[-16:]) 122 | 123 | def data_to_value(self): 124 | if self.data_fmt == 'LONG': 125 | try: 126 | self.value_str.set(hex_to_long(self.hex_str.get())) 127 | self.ent_hex.config(bg='white') 128 | except ValueError: 129 | self.ent_hex.config(bg='red') 130 | elif self.data_fmt == 'SINGLE': 131 | try: 132 | self.value_str.set(hex_to_single(self.hex_str.get())) 133 | self.ent_hex.config(bg='white') 134 | except ValueError: 135 | self.ent_hex.config(bg='red') 136 | elif self.data_fmt == 'DOUBLE': 137 | try: 138 | self.value_str.set(hex_to_double(self.hex_str.get())) 139 | self.ent_hex.config(bg='white') 140 | except ValueError: 141 | self.ent_hex.config(bg='red') 142 | 143 | def value_to_data(self): 144 | if self.data_fmt == 'LONG': 145 | try: 146 | self.hex_str.set(long_to_hex(int(float(self.value_str.get())))) 147 | self.ent_val.config(bg='white') 148 | except ValueError: 149 | self.ent_val.config(bg='red') 150 | elif self.data_fmt == 'SINGLE': 151 | try: 152 | self.hex_str.set(single_to_hex(float(self.value_str.get()))) 153 | self.ent_val.config(bg='white') 154 | except ValueError: 155 | self.ent_val.config(bg='red') 156 | elif self.data_fmt == 'DOUBLE': 157 | try: 158 | self.hex_str.set(double_to_hex(float(self.value_str.get()))) 159 | self.ent_val.config(bg='white') 160 | except ValueError: 161 | self.ent_val.config(bg='red') 162 | 163 | 164 | if __name__ == '__main__': 165 | # main Tk App 166 | app = TkApp() 167 | app.mainloop() 168 | -------------------------------------------------------------------------------- /scripts/modbus-gui: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import tkinter as tk 4 | from tkinter import ttk 5 | import os 6 | 7 | # some const 8 | DEV_ID2NAME = {'RS232': 'RS232', 'RS485': 'RS485', 'RS422': 'RS422', 9 | 'usb-Arduino': 'Arduino', 'FTDI_UT232R': 'RS232 DB9'} 10 | F_CODES = ['1 (lecture bit)', '2 (lecture bit)', '3 (lecture mot)', '4 (lecture mot)', 11 | '5 (écriture d\'un bit)', '6 (écriture d\'un mot)'] 12 | 13 | 14 | class Serial(object): 15 | def __init__(self): 16 | # device string ID (default is '/dev/ttyUSB0') 17 | self.device = tk.StringVar() 18 | self.device.set('/dev/ttyUSB0') 19 | self.device.trace('w', self.on_change) 20 | # baudrate as string (default is '9600') 21 | self.baudrate = tk.StringVar() 22 | self.baudrate.set('9600') 23 | self.baudrate.trace('w', self.on_change) 24 | # parity string (default is 'N' for none) 25 | self.parity = tk.StringVar() 26 | self.parity.set('N') 27 | self.parity.trace('w', self.on_change) 28 | # stop bit string (defaut is '1') 29 | self.stop = tk.StringVar() 30 | self.stop.set('1') 31 | self.stop.trace('w', self.on_change) 32 | # callbacks list 33 | self.l_on_change = [] 34 | 35 | def add_on_change(self, cmd): 36 | self.l_on_change.append(cmd) 37 | 38 | def on_change(self, *args): 39 | # call all callbacks 40 | for cmd in self.l_on_change: 41 | cmd() 42 | 43 | 44 | class FrmTab(tk.Frame): 45 | def __init__(self, notebook, update_ms=500, *args, **kwargs): 46 | tk.Frame.__init__(self, notebook, *args, **kwargs) 47 | # global tk app shortcut 48 | self.notebook = notebook 49 | self.app = notebook.master 50 | # frame auto-refresh delay (in ms) 51 | self.update_ms = update_ms 52 | # setup auto-refresh of notebook tab (on-visibility and every update_ms) 53 | self.bind('', lambda evt: self.tab_update()) 54 | self._tab_update() 55 | 56 | def copy_to_clipboard(self, content): 57 | self.clipboard_clear() 58 | self.clipboard_append(content) 59 | 60 | def _tab_update(self): 61 | if self.winfo_ismapped(): 62 | self.tab_update() 63 | self.master.after(self.update_ms, self._tab_update) 64 | 65 | def tab_update(self): 66 | pass 67 | 68 | 69 | class TkApp(tk.Tk): 70 | def __init__(self, *args, **kwargs): 71 | tk.Tk.__init__(self, *args, **kwargs) 72 | # global vars 73 | self.serial = Serial() 74 | # configure main window 75 | self.wm_title('Analyse modbus RTU') 76 | self.resizable(False, False) 77 | # build a notebook with tabs 78 | self.note = ttk.Notebook(self) 79 | self.tab1 = FrmCap(self.note) 80 | self.tab2 = FrmReq(self.note) 81 | self.note.add(self.tab1, text='Capture') 82 | self.note.add(self.tab2, text='Requêtes') 83 | self.note.pack(fill=tk.BOTH, expand=tk.YES) 84 | 85 | def do_every(self, do_cmd, every_ms=1000): 86 | do_cmd() 87 | self.after(every_ms, lambda: self.do_every(do_cmd, every_ms=every_ms)) 88 | 89 | 90 | class SerialFrm(FrmTab): 91 | def __init__(self, notebook, serial, update_ms=1000, *args, **kwargs): 92 | FrmTab.__init__(self, notebook, update_ms, *args, **kwargs) 93 | # some vars 94 | self.d_serial_dev = {} 95 | self.l_lst1_serial = [] 96 | self.serial = serial 97 | self.cmd_cap = tk.StringVar() 98 | # widget 99 | # device 100 | self.lbfrm1 = tk.LabelFrame(self, text='Port') 101 | self.lbfrm1.grid(row=0, rowspan=2, column=0, sticky=tk.NSEW, padx=5, pady=5) 102 | self.lst1 = tk.Listbox(self.lbfrm1, width=25) 103 | self.lst1.pack(fill=tk.BOTH, expand=tk.YES) 104 | self.lst1.bind('<>', self.on_dev_select) 105 | # baudrate 106 | self.lbfrm2 = tk.LabelFrame(self, text='Baudrate') 107 | self.lbfrm2.grid(row=0, rowspan=2, column=1, sticky=tk.NSEW, padx=5, pady=5, ipadx=10) 108 | tk.Radiobutton(self.lbfrm2, text='1200', variable=self.serial.baudrate, value='1200').pack(anchor=tk.W) 109 | tk.Radiobutton(self.lbfrm2, text='2400', variable=self.serial.baudrate, value='2400').pack(anchor=tk.W) 110 | tk.Radiobutton(self.lbfrm2, text='4800', variable=self.serial.baudrate, value='4800').pack(anchor=tk.W) 111 | tk.Radiobutton(self.lbfrm2, text='9600', variable=self.serial.baudrate, value='9600').pack(anchor=tk.W) 112 | tk.Radiobutton(self.lbfrm2, text='19200', variable=self.serial.baudrate, value='19200').pack(anchor=tk.W) 113 | tk.Radiobutton(self.lbfrm2, text='38400', variable=self.serial.baudrate, value='38400').pack(anchor=tk.W) 114 | tk.Radiobutton(self.lbfrm2, text='57600', variable=self.serial.baudrate, value='57600').pack(anchor=tk.W) 115 | tk.Radiobutton(self.lbfrm2, text='115200', variable=self.serial.baudrate, value='115200').pack(anchor=tk.W) 116 | # parity 117 | self.lbfrm3 = tk.LabelFrame(self, text='Parité') 118 | self.lbfrm3.grid(row=0, column=2, sticky=tk.NSEW, padx=5, pady=5, ipadx=10) 119 | tk.Radiobutton(self.lbfrm3, text='Aucune', variable=self.serial.parity, value='N').pack(anchor=tk.W) 120 | tk.Radiobutton(self.lbfrm3, text='Paire', variable=self.serial.parity, value='E').pack(anchor=tk.W) 121 | tk.Radiobutton(self.lbfrm3, text='Impaire', variable=self.serial.parity, value='O').pack(anchor=tk.W) 122 | tk.Radiobutton(self.lbfrm3, text='Espace', variable=self.serial.parity, value='S').pack(anchor=tk.W) 123 | tk.Radiobutton(self.lbfrm3, text='Marque', variable=self.serial.parity, value='M').pack(anchor=tk.W) 124 | # stop bit 125 | self.lbfrm4 = tk.LabelFrame(self, text='Bit de Stop') 126 | self.lbfrm4.grid(row=1, column=2, sticky=tk.NSEW, padx=5, pady=5, ipadx=10) 127 | tk.Radiobutton(self.lbfrm4, text='1', variable=self.serial.stop, value='1').pack(anchor=tk.W) 128 | tk.Radiobutton(self.lbfrm4, text='1.5', variable=self.serial.stop, value='1.5').pack(anchor=tk.W) 129 | tk.Radiobutton(self.lbfrm4, text='2', variable=self.serial.stop, value='2').pack(anchor=tk.W) 130 | 131 | def tab_update(self): 132 | # update serials port 133 | d_dev = {} 134 | if os.path.exists('/dev/serial/by-id'): 135 | for link in os.listdir('/dev/serial/by-id'): 136 | dev_rpath = os.readlink(os.path.join('/dev/serial/by-id', link)) 137 | device = os.path.normpath(os.path.join('/dev/serial/by-id', dev_rpath)) 138 | d_dev[device] = link 139 | # add or remove serial ? 140 | if self.d_serial_dev != d_dev: 141 | self.d_serial_dev = d_dev 142 | # refresh widget 143 | self.lst1.delete(0, tk.END) 144 | self.l_lst1_serial = [] 145 | for d in self.d_serial_dev: 146 | # lst1 widget info cache 147 | self.l_lst1_serial.append({'dev': d, 'type': 'n/a'}) 148 | i = len(self.l_lst1_serial) - 1 149 | # device type (RS232/485...) from link name 150 | for d_id in DEV_ID2NAME: 151 | if d_id in self.d_serial_dev[d]: 152 | self.l_lst1_serial[i]['type'] = DEV_ID2NAME[d_id] 153 | # add "device (device type)" to widget 154 | self.lst1.insert(i, '%s (%s)' % (d, self.l_lst1_serial[i]['type'])) 155 | 156 | def on_dev_select(self, event): 157 | try: 158 | index = self.lst1.curselection()[0] 159 | self.serial.device.set(self.l_lst1_serial[index]['dev']) 160 | except IndexError: 161 | pass 162 | 163 | 164 | class FrmCap(FrmTab): 165 | def __init__(self, notebook, update_ms=500, *args, **kwargs): 166 | FrmTab.__init__(self, notebook, update_ms, *args, **kwargs) 167 | # some vars 168 | self.cmd_cap = tk.StringVar() 169 | # serial frame 170 | self.ser_f = SerialFrm(self, serial=self.app.serial) 171 | self.ser_f.pack(anchor=tk.W, fill=tk.X) 172 | # command area 173 | self.ent1 = tk.Entry(self, width=50, state='readonly', textvariable=self.cmd_cap, 174 | readonlybackground='pale green') 175 | self.ent1.pack(anchor=tk.W, fill=tk.X) 176 | # start command 177 | self.but1 = tk.Button(self, text='Lancer la capture', state='disabled', 178 | command=lambda: os.system('xterm -title \'Capture modbus\' -e \'%s\' &' 179 | % self.cmd_cap.get())) 180 | self.but1.pack(anchor=tk.W, fill=tk.X) 181 | self.but2 = tk.Button(self, text='Copier la commande dans le presse papier', state='disabled', 182 | command=lambda: self.copy_to_clipboard(self.cmd_cap.get())) 183 | self.but2.pack(anchor=tk.W, fill=tk.X) 184 | # install callback 185 | self.app.serial.add_on_change(self.on_serial_update) 186 | 187 | def on_serial_update(self): 188 | # update cmd cap 189 | self.cmd_cap.set('modbus-scan-serial -d %s -t 0.02' % self.app.serial.device.get()) 190 | # add params if not as default 191 | if self.app.serial.baudrate.get() != '9600': 192 | self.cmd_cap.set(self.cmd_cap.get() + ' -b %s' % self.app.serial.baudrate.get()) 193 | if self.app.serial.parity.get() != 'N': 194 | self.cmd_cap.set(self.cmd_cap.get() + ' -p %s' % self.app.serial.parity.get()) 195 | if self.app.serial.stop.get() != '1': 196 | self.cmd_cap.set(self.cmd_cap.get() + ' --bit-stop %s' % self.app.serial.stop.get()) 197 | # valid button if cmd cap ok 198 | if self.cmd_cap: 199 | self.but1.configure(state='normal') 200 | self.but2.configure(state='normal') 201 | else: 202 | self.but1.configure(state='disabled') 203 | self.but2.configure(state='disabled') 204 | 205 | 206 | class FrmReq(FrmTab): 207 | def __init__(self, notebook, update_ms=500, *args, **kwargs): 208 | FrmTab.__init__(self, notebook, update_ms, *args, **kwargs) 209 | # some vars 210 | self.cmd_cap = tk.StringVar() 211 | self.slave_ad = tk.IntVar(value=1) 212 | self.mbus_ad = tk.IntVar(value=0) 213 | self.w_value = tk.IntVar(value=0) 214 | self.w_bit = 0 215 | self.w_word = 0 216 | self.f_code = tk.StringVar() 217 | self.f_code_int = 0 218 | # serial frame 219 | self.ser_f = SerialFrm(self, serial=self.app.serial) 220 | self.ser_f.grid(row=0, column=0, sticky=tk.NS + tk.W) 221 | # capture frame 222 | self.lbfrm1 = tk.LabelFrame(self, text='Modbus') 223 | self.lbfrm1.grid(row=0, column=1, sticky=tk.NSEW, padx=5, pady=5, ipadx=30) 224 | self.lbl_slv = tk.Label(self.lbfrm1, text='@ esclave') 225 | self.lbl_slv.grid(row=0, column=0, sticky=tk.W, padx=5, pady=5) 226 | self.sp_slv = tk.Spinbox(self.lbfrm1, from_=1, to=254, width=3, validate='all', textvariable=self.slave_ad) 227 | self.sp_slv.grid(row=0, column=1, sticky=tk.W, padx=5, pady=5) 228 | self.lbl_ad = tk.Label(self.lbfrm1, text='@ modbus') 229 | self.lbl_ad.grid(row=1, column=0, sticky=tk.W, padx=5, pady=5) 230 | self.sp_mad = tk.Spinbox(self.lbfrm1, from_=0, to=65535, width=5, textvariable=self.mbus_ad) 231 | self.sp_mad.grid(row=1, column=1, sticky=tk.W, padx=5, pady=5) 232 | self.lbl_ad = tk.Label(self.lbfrm1, text='fonction') 233 | self.lbl_ad.grid(row=2, column=0, sticky=tk.W, padx=5, pady=5) 234 | self.cbb_f = ttk.Combobox(self.lbfrm1, textvariable=self.f_code, values=F_CODES) 235 | self.cbb_f.current(newindex=0) 236 | self.cbb_f.grid(row=2, column=1, sticky=tk.W, padx=5, pady=5) 237 | self.lbl_wvl = tk.Label(self.lbfrm1, text='valeur (écriture)') 238 | self.lbl_wvl.grid(row=3, column=0, sticky=tk.W, padx=5, pady=5) 239 | self.sp_wvl = tk.Spinbox(self.lbfrm1, from_=0, to=65535, width=5, textvariable=self.w_value) 240 | self.sp_wvl.grid(row=3, column=1, sticky=tk.W, padx=5, pady=5) 241 | self.but_req = tk.Button(self.lbfrm1, text='Création de la requête', command=self.build_request) 242 | self.but_req.grid(row=4, column=0, columnspan=2, sticky=tk.EW, padx=5, pady=3) 243 | self.but_conv = tk.Button(self.lbfrm1, text='Outil de conversion', command=lambda: os.system('conv-data-gui&')) 244 | self.but_conv.grid(row=5, column=0, columnspan=2, sticky=tk.EW, padx=5, pady=3) 245 | # command frame 246 | self.req_f = tk.Frame(self) 247 | self.req_f.grid(row=1, column=0, columnspan=2, sticky=tk.NSEW) 248 | # command area 249 | self.ent_cmd = tk.Entry(self, width=80, state='readonly', textvariable=self.cmd_cap, 250 | readonlybackground='pale green') 251 | self.ent_cmd.grid(row=1, column=0, columnspan=2, sticky=tk.NSEW) 252 | # start command 253 | self.but1 = tk.Button(self, text='Lancer la requête', state='disabled', 254 | command=lambda: os.system('xterm -title \'Requete modbus\' -e \'%s |less\' &' 255 | % self.cmd_cap.get())) 256 | self.but1.grid(row=2, column=0, columnspan=2, sticky=tk.NSEW) 257 | self.but2 = tk.Button(self, text='Copier la commande dans le presse papier', state='disabled', 258 | command=lambda: self.copy_to_clipboard(self.cmd_cap.get())) 259 | self.but2.grid(row=3, column=0, columnspan=2, sticky=tk.NSEW) 260 | # install callback 261 | self.app.serial.add_on_change(self.on_widget_change) 262 | self.slave_ad.trace('w', self.on_widget_change) 263 | self.mbus_ad.trace('w', self.on_widget_change) 264 | self.f_code.trace('w', self.on_widget_change) 265 | self.w_value.trace('w', self.on_widget_change) 266 | 267 | def on_widget_change(self, *args): 268 | self.cmd_cap.set('') 269 | self.but1.configure(state='disabled') 270 | self.but2.configure(state='disabled') 271 | 272 | def build_request(self): 273 | is_ok = True 274 | # check slave address 275 | try: 276 | if 1 <= int(self.slave_ad.get()) <= 254: 277 | self.sp_slv.config(bg='white') 278 | else: 279 | raise ValueError() 280 | except (ValueError, tk.TclError): 281 | self.sp_slv.config(bg='red') 282 | is_ok = False 283 | # check modbus address 284 | try: 285 | if 0 <= int(self.mbus_ad.get()) <= 65535: 286 | self.sp_mad.config(bg='white') 287 | else: 288 | raise ValueError() 289 | except (ValueError, tk.TclError): 290 | self.sp_mad.config(bg='red') 291 | is_ok = False 292 | # check function code 293 | try: 294 | self.f_code_int = int(self.cbb_f.get().split(' ')[0]) 295 | except: 296 | is_ok = False 297 | # check modbus value to write 298 | try: 299 | if self.f_code_int == 5: 300 | if int(self.w_value.get()) in [0, 1]: 301 | self.w_bit = int(self.w_value.get()) 302 | self.sp_wvl.config(bg='white') 303 | else: 304 | raise ValueError() 305 | elif self.f_code_int == 6: 306 | if 0 <= int(self.w_value.get()) <= 65535: 307 | self.w_word = int(self.w_value.get()) 308 | self.sp_wvl.config(bg='white') 309 | else: 310 | raise ValueError() 311 | except (ValueError, tk.TclError): 312 | self.sp_wvl.config(bg='red') 313 | is_ok = False 314 | # format command 315 | if is_ok: 316 | # update cmd cap 317 | self.cmd_cap.set('modbus-request-serial -d %s -t 1.0' % self.app.serial.device.get()) 318 | # add params if not as default 319 | if self.app.serial.baudrate.get() != '9600': 320 | self.cmd_cap.set(self.cmd_cap.get() + ' -b %s' % self.app.serial.baudrate.get()) 321 | if self.app.serial.parity.get() != 'N': 322 | self.cmd_cap.set(self.cmd_cap.get() + ' -p %s' % self.app.serial.parity.get()) 323 | if self.app.serial.stop.get() != '1': 324 | self.cmd_cap.set(self.cmd_cap.get() + ' --bit-stop %s' % self.app.serial.stop.get()) 325 | if self.slave_ad.get() != 1: 326 | self.cmd_cap.set(self.cmd_cap.get() + ' -s %s' % self.slave_ad.get()) 327 | if self.mbus_ad.get() != 0: 328 | self.cmd_cap.set(self.cmd_cap.get() + ' -a %s' % self.mbus_ad.get()) 329 | if self.f_code_int != 1: 330 | self.cmd_cap.set(self.cmd_cap.get() + ' -f %s' % self.f_code_int) 331 | if self.f_code_int == 5: 332 | self.cmd_cap.set(self.cmd_cap.get() + ' --bit-value %s' % self.w_bit) 333 | if self.f_code_int == 6: 334 | self.cmd_cap.set(self.cmd_cap.get() + ' --word-value %s' % self.w_word) 335 | # valid button if cmd cap ok 336 | if self.cmd_cap: 337 | self.but1.configure(state='normal') 338 | self.but2.configure(state='normal') 339 | 340 | 341 | if __name__ == '__main__': 342 | # main Tk App 343 | app = TkApp() 344 | app.mainloop() 345 | -------------------------------------------------------------------------------- /scripts/modbus-request-serial: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # home : https://github.com/sourceperl/modbus-serial-monitor 4 | 5 | # modbus/RTU python request 6 | 7 | # format modbus RTU serial frame receive from a serial port to console stdout 8 | # check with python2.7 and python3, and module serial 2.7 (don't work with 3.x timeout issue ?) 9 | 10 | import argparse 11 | import minimalmodbus 12 | from minimalmodbus import serial 13 | import time 14 | import sys 15 | 16 | # some const 17 | SEP = ";" 18 | PARITY = {'N': serial.PARITY_NONE, 'E': serial.PARITY_EVEN, 'O': serial.PARITY_ODD, 19 | 'M': serial.PARITY_MARK, 'S': serial.PARITY_SPACE} 20 | STOP = {'1': serial.STOPBITS_ONE, '1.5': serial.STOPBITS_ONE_POINT_FIVE, '2': serial.STOPBITS_TWO} 21 | 22 | 23 | def check_slave_ad(value): 24 | ivalue = int(value) 25 | if 1 > ivalue: 26 | raise argparse.ArgumentTypeError("%s address must be great or equal 1" % value) 27 | if 255 <= ivalue: 28 | raise argparse.ArgumentTypeError("%s address must be lower or equal 255" % value) 29 | return ivalue 30 | 31 | 32 | def check_address(value): 33 | ivalue = int(value) 34 | if 0 > ivalue: 35 | raise argparse.ArgumentTypeError("%s address must be great or equal 0" % value) 36 | if 65535 <= ivalue: 37 | raise argparse.ArgumentTypeError("%s address must be lower or equal 65535" % value) 38 | return ivalue 39 | 40 | 41 | def check_f_code(value): 42 | ivalue = int(value) 43 | if ivalue not in [1, 2, 3, 4, 5, 6]: 44 | raise argparse.ArgumentTypeError("%s not supported function code" % value) 45 | return ivalue 46 | 47 | 48 | def check_number(value): 49 | ivalue = int(value) 50 | if 0 > ivalue: 51 | raise argparse.ArgumentTypeError("%s number must be great or equal 0" % value) 52 | if 65535 <= ivalue: 53 | raise argparse.ArgumentTypeError("%s number must be lower or equal 65535" % value) 54 | return ivalue 55 | 56 | 57 | def check_bit(value): 58 | ivalue = int(value) 59 | if ivalue not in [0, 1]: 60 | raise argparse.ArgumentTypeError("%s bit value must be 0 or 1" % value) 61 | return bool(ivalue) 62 | 63 | 64 | def check_word(value): 65 | ivalue = int(value) 66 | if not (0 <= ivalue <= 65535): 67 | raise argparse.ArgumentTypeError("%s word value must be between 0 and 65535" % value) 68 | return ivalue 69 | 70 | 71 | if __name__ == '__main__': 72 | # parse args 73 | parser = argparse.ArgumentParser() 74 | parser.add_argument('-d', '--device', type=str, default='/dev/ttyUSB0', 75 | help='device (default is /dev/ttyUSB0)') 76 | parser.add_argument('-b', '--baudrate', type=int, default=9600, 77 | help='baudrate (default is 9600)') 78 | parser.add_argument('-p', '--parity', type=str, default='N', choices=['N', 'E', 'O', 'M', 'S'], 79 | help='parity (default is N)') 80 | parser.add_argument('--bit-stop', type=str, default='1', choices=['1', '1.5', '2'], 81 | help='stop (default is 1)') 82 | parser.add_argument('-f', '--function', type=check_f_code, default=1, 83 | help='function code (default is 1)') 84 | parser.add_argument('-s', '--slave', type=check_slave_ad, default=1, 85 | help='slave address (default is 1)') 86 | parser.add_argument('-a', '--address', type=check_address, default=0, 87 | help='modbus address (default is 0)') 88 | parser.add_argument('-n', '--number', type=check_number, default=1, 89 | help='modbus number to read (default is 1)') 90 | parser.add_argument('--bit-value', type=check_bit, default=None, 91 | help='bit value to write') 92 | parser.add_argument('--word-value', type=check_word, default=None, 93 | help='word value to write') 94 | parser.add_argument('-t', '--timeout', type=float, default=None, 95 | help='timeout for response (value in s)') 96 | parser.add_argument('-w', '--wait', type=float, default=0.0, 97 | help='wait time between open serial port and request (default is 0)') 98 | parser.add_argument('--debug', action='store_true', default=False, 99 | help='print debug messages') 100 | args = parser.parse_args() 101 | 102 | # init slave object 103 | slave = minimalmodbus.Instrument(args.device, args.slave) 104 | slave.serial.baudrate = args.baudrate 105 | slave.serial.parity = PARITY[args.parity] 106 | slave.stopbits = STOP[args.bit_stop] 107 | 108 | # debug mode 109 | if args.debug: 110 | slave.debug = True 111 | 112 | # read serial timeout 113 | if args.timeout is not None: 114 | slave.serial.timeout = args.timeout 115 | 116 | # wait time after serial open 117 | time.sleep(args.wait) 118 | 119 | # do modbus stuff 120 | if args.function in [1, 2]: 121 | if args.number != 1: 122 | raise argparse.ArgumentTypeError('function 1 or 2 are for 1 bit only') 123 | try: 124 | result = slave.read_bit(args.address, functioncode=args.function) 125 | print(result) 126 | except ValueError: 127 | sys.exit('bit read error') 128 | elif args.function in [3, 4]: 129 | try: 130 | result = slave.read_registers(args.address, args.number, functioncode=args.function) 131 | print(result) 132 | except ValueError: 133 | sys.exit('word read error') 134 | elif args.function == 5: 135 | if args.bit_value is None: 136 | raise argparse.ArgumentTypeError('bit-value must be set for function 5 (write a bit)') 137 | try: 138 | slave.write_bit(args.address, args.bit_value) 139 | print('write ok') 140 | except ValueError: 141 | sys.exit('bit write error') 142 | elif args.function == 6: 143 | if args.word_value is None: 144 | raise argparse.ArgumentTypeError('word-value must be set for function 6 (write a word)') 145 | try: 146 | slave.write_register(args.address, args.word_value) 147 | print('write ok') 148 | except ValueError: 149 | sys.exit('word write error') 150 | -------------------------------------------------------------------------------- /scripts/modbus-scan-serial: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # home : https://github.com/sourceperl/modbus-serial-monitor 4 | 5 | # modbus/RTU python monitor (check serial frame between devices) 6 | 7 | # format modbus RTU serial frame receive from a serial port to console stdout 8 | # check with python2.7 and python3, and module serial 2.7 (don't work with 3.x timeout issue ?) 9 | 10 | # synoptic : 11 | # 12 | # RS-485 bus -> FTDI USB cable -> /dev/ttyUSBx -> this_script -> CSV modbus 13 | # RS-422 decode 14 | # RS-232 15 | 16 | # CSV out sample : 17 | # DATE=2015-11-05T17:31:27.977;ERR=NO;FRAME=01-03-50-00-00-04-55-09;SLAVE=1; 18 | 19 | # use it like this : 20 | # - help : 21 | # $ ./mb_rtu_mon.py -h 22 | # - see frame only for slave 17 : 23 | # $ ./mb_rtu_mon.py | grep SLAVE=0x11 24 | # - store all traffic on a file 25 | # $ ./mb_rtu_mon.py > modbus.log 26 | 27 | 28 | import argparse 29 | import sys 30 | import serial 31 | import struct 32 | import time 33 | from datetime import datetime 34 | 35 | # some const 36 | SEP = ";" 37 | PARITY = {'N': serial.PARITY_NONE, 'E': serial.PARITY_EVEN, 'O': serial.PARITY_ODD, 38 | 'M': serial.PARITY_MARK, 'S': serial.PARITY_SPACE} 39 | STOP = {'1': serial.STOPBITS_ONE, '1.5': serial.STOPBITS_ONE_POINT_FIVE, '2': serial.STOPBITS_TWO} 40 | 41 | 42 | def frame2crc(frame): 43 | """Compute modbus CRC16 (for RTU mode) 44 | 45 | :param label: modbus frame 46 | :type label: str (Python2) or class bytes (Python3) 47 | :returns: CRC16 48 | :rtype: int 49 | """ 50 | crc = 0xFFFF 51 | for index, item in enumerate(bytearray(frame)): 52 | next_byte = item 53 | crc ^= next_byte 54 | for i in range(8): 55 | lsb = crc & 1 56 | crc >>= 1 57 | if lsb: 58 | crc ^= 0xA001 59 | return crc 60 | 61 | 62 | if __name__ == '__main__': 63 | # parse args 64 | parser = argparse.ArgumentParser() 65 | parser.add_argument('-d', '--device', type=str, default='/dev/ttyUSB0', 66 | help='device (default is /dev/ttyUSB0)') 67 | parser.add_argument('-b', '--baudrate', type=int, default=9600, 68 | help='baudrate (default is 9600)') 69 | parser.add_argument('-p', '--parity', type=str, default='N', choices=['N', 'E', 'O', 'M', 'S'], 70 | help='parity (default is N)') 71 | parser.add_argument('--bit-stop', type=str, default='1', choices=['1', '1.5', '2'], 72 | help='stop (default is 1)') 73 | parser.add_argument('-t', '--timeout', type=float, default=None, 74 | help='timeout for response (default is 3.5x the byte tx time)') 75 | args = parser.parse_args() 76 | 77 | # parity 78 | 79 | # modbus end of frame is a tx silent of [3.5 * byte tx time * 30% margin] seconds 80 | if args.timeout is None: 81 | inter_char_wait = (1.0 / args.baudrate) * 11.0 * 3.5 * 1.3 82 | else: 83 | inter_char_wait = args.timeout 84 | 85 | # init serial object 86 | ser = serial.Serial(args.device, args.baudrate, parity=PARITY[args.parity], stopbits=STOP[args.bit_stop], 87 | timeout=inter_char_wait) 88 | 89 | # wait serial start and flush all 90 | time.sleep(.5) 91 | ser.read(ser.inWaiting()) 92 | 93 | # main loop 94 | while True: 95 | frame = bytes(ser.read(256)) 96 | # skip null frame 97 | if not frame: 98 | continue 99 | # init vars 100 | err_str = "NO" 101 | slave_id = 0 102 | f_code = 0 103 | e_code = 0 104 | # add date and time 105 | now = datetime.now() 106 | date = now.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] 107 | # format modbus frame as txt string 108 | txt_frame = '' 109 | for item in bytearray(frame): 110 | if txt_frame: 111 | txt_frame += "-" 112 | txt_frame += "%02x" % item 113 | # check short frame 114 | if len(frame) >= 5: 115 | # check CRC 116 | r_crc = struct.unpack(" 0x80: 128 | err_str = "EXCEPT_FRAME" 129 | e_code = struct.unpack("B", frame[2:3])[0] 130 | else: 131 | err_str = "SHORT_FRAME" 132 | # send result to stdout 133 | items = ['DATE=%s' % date, 'ERR=%s' % err_str, 'FRAME=%s' % txt_frame, 'SLAVE=%s' % slave_id] 134 | csv_line = SEP.join(items) 135 | print(csv_line) 136 | sys.stdout.flush() 137 | 138 | ser.close() 139 | 140 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | from setuptools import setup 4 | 5 | with open('requirements.txt') as f: 6 | required = f.read().splitlines() 7 | 8 | setup( 9 | name='modbus_serial_monitor', 10 | version='0.0.1', 11 | description='A set of tools for modbus diagnostic', 12 | long_description='', 13 | author='Loic Lefebvre', 14 | author_email='loic.celine@free.fr', 15 | license='MIT', 16 | url='https://github.com/sourceperl/modbus-serial-monitor', 17 | platforms='any', 18 | install_requires=required, 19 | scripts=[ 20 | 'scripts/modbus-scan-serial', 21 | 'scripts/modbus-request-serial', 22 | 'scripts/modbus-gui', 23 | 'scripts/conv-data-gui', 24 | ], 25 | ) 26 | --------------------------------------------------------------------------------