From b02de1795f5b77d846bc7a6a1cce4e8fd1246e04 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sun, 14 Jun 2020 19:00:49 +0200 Subject: console-server: T2490: rename CLI to "serial-proxy" --- data/templates/ser2net/ser2net.conf.tmpl | 4 +- interface-definitions/ser2net.xml.in | 82 --------------- interface-definitions/service_serial-proxy.xml.in | 82 +++++++++++++++ src/conf_mode/ser2net.py | 116 ---------------------- src/conf_mode/system_serial-proxy.py | 116 ++++++++++++++++++++++ 5 files changed, 199 insertions(+), 201 deletions(-) delete mode 100644 interface-definitions/ser2net.xml.in create mode 100644 interface-definitions/service_serial-proxy.xml.in delete mode 100755 src/conf_mode/ser2net.py create mode 100755 src/conf_mode/system_serial-proxy.py diff --git a/data/templates/ser2net/ser2net.conf.tmpl b/data/templates/ser2net/ser2net.conf.tmpl index 202fe8104..0e946e84e 100644 --- a/data/templates/ser2net/ser2net.conf.tmpl +++ b/data/templates/ser2net/ser2net.conf.tmpl @@ -69,9 +69,7 @@ # The original config file shipped with the upstream sources can be # found in /usr/share/doc/ser2net/examples -BANNER:banner:\r\nser2net port \p device \d [\s] (VyOS)\r\n\r\n - -#3001:telnet:600:/dev/ttyS1:19200 8DATABITS NONE 1STOPBIT banner +BANNER:banner:\r\nConnected to serial proxy device \d [\s]\r\n\r\n {% for d in devices %} localhost,{{ d.port }}:telnet:{{ d.timeout }}:{{ d.serial_port }}:{{ d.speed }} {{ d.data_bits}}DATABITS {{ d.parity | upper }} {{ d.stop_bits}}STOPBIT banner diff --git a/interface-definitions/ser2net.xml.in b/interface-definitions/ser2net.xml.in deleted file mode 100644 index 8b025070f..000000000 --- a/interface-definitions/ser2net.xml.in +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - Serial to Network - - - - - System serial interface name (ttyS or ttyUSB) - - - - - - ttySxxx - Regular serial interface - - - usbxbxpx - USB based serial interface - - - ^(ttyS\d+|usb\d+b.*p.*)$ - - - - #include - #include - - - Serial port baud rate - - 300 1200 2400 4800 9600 19200 38400 57600 115200 - - - (300|1200|2400|4800|9600|19200|38400|57600|115200) - - - - - - Serial port data bits - - 7 8 - - - (7|8) - - - - - - Serial port stop bits - - 1 2 - - - (1|2) - - - - - - Parity setting - - even odd none - - - (even|odd|none) - - - - - - - - - - diff --git a/interface-definitions/service_serial-proxy.xml.in b/interface-definitions/service_serial-proxy.xml.in new file mode 100644 index 000000000..cedaae5ea --- /dev/null +++ b/interface-definitions/service_serial-proxy.xml.in @@ -0,0 +1,82 @@ + + + + + + + Serial to Network + + + + + System serial interface name (ttyS or ttyUSB) + + + + + + ttySxxx + Regular serial interface + + + usbxbxpx + USB based serial interface + + + ^(ttyS\d+|usb\d+b.*p.*)$ + + + + #include + #include + + + Serial port baud rate + + 300 1200 2400 4800 9600 19200 38400 57600 115200 + + + (300|1200|2400|4800|9600|19200|38400|57600|115200) + + + + + + Serial port data bits + + 7 8 + + + (7|8) + + + + + + Serial port stop bits + + 1 2 + + + (1|2) + + + + + + Parity setting + + even odd none + + + (even|odd|none) + + + + + + + + + + diff --git a/src/conf_mode/ser2net.py b/src/conf_mode/ser2net.py deleted file mode 100755 index ec8afcb48..000000000 --- a/src/conf_mode/ser2net.py +++ /dev/null @@ -1,116 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (C) 2018-2020 VyOS maintainers and contributors -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License version 2 or later as -# published by the Free Software Foundation. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . - -import os - -from copy import deepcopy -from sys import exit - -from vyos.config import Config -from vyos.template import render -from vyos.util import call -from vyos import ConfigError - -config_file = r'/run/ser2net/ser2net.conf' - -default_config_data = { - 'devices': [], -} - -def get_config(): - ser2net = deepcopy(default_config_data) - conf = Config() - base = ['service', 'ser2net'] - - if not conf.exists(base): - return None - else: - conf.set_level(base) - - for serial_port in conf.list_nodes(['device']): - conf.set_level(base + ['device', serial_port]) - serial = { - 'data_bits': '', - 'parity': '', - 'port': '', - 'serial_port': '/dev/serial/by-bus/' + serial_port, - 'speed': '', - 'stop_bits': '', - 'timeout': '600' - } - - if conf.exists(['data-bits']): - serial['data_bits'] = conf.return_value(['data-bits']) - - if conf.exists(['stop-bits']): - serial['stop_bits'] = conf.return_value(['stop-bits']) - - if conf.exists(['parity']): - serial['parity'] = conf.return_value(['parity']) - - if conf.exists(['port']): - serial['port'] = conf.return_value(['port']) - - if conf.exists(['speed']): - serial['speed'] = conf.return_value(['speed']) - - ser2net['devices'].append(serial) - - return ser2net - -def verify(ser2net): - if not ser2net: - return None - - for device in ser2net['devices']: - if not os.path.exists('{serial_port}'.format(**device)): - raise ConfigError('Serial interface "{serial_port} does not exist"' - .format(**device)) - - for key in ['data_bits', 'parity', 'port', 'speed', 'stop_bits']: - if not device[key]: - value = key.replace('_','-') - raise ConfigError(f'{value} option must be defined!') - - return None - -def generate(ser2net): - if not ser2net: - return None - - render(config_file, 'ser2net/ser2net.conf.tmpl', ser2net) - return None - -def apply(ser2net): - if not ser2net: - call('systemctl stop ser2net.service') - if os.path.isfile(config_file): - os.unlink(config_file) - - return None - - call('systemctl restart ser2net.service') - return None - -if __name__ == '__main__': - try: - c = get_config() - verify(c) - generate(c) - apply(c) - except ConfigError as e: - print(e) - exit(1) diff --git a/src/conf_mode/system_serial-proxy.py b/src/conf_mode/system_serial-proxy.py new file mode 100755 index 000000000..83369d39d --- /dev/null +++ b/src/conf_mode/system_serial-proxy.py @@ -0,0 +1,116 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2018-2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import os + +from copy import deepcopy +from sys import exit + +from vyos.config import Config +from vyos.template import render +from vyos.util import call +from vyos import ConfigError + +config_file = r'/run/ser2net/ser2net.conf' + +default_config_data = { + 'devices': [], +} + +def get_config(): + proxy = deepcopy(default_config_data) + conf = Config() + base = ['service', 'serial-proxy'] + + if not conf.exists(base): + return None + else: + conf.set_level(base) + + for serial_port in conf.list_nodes(['device']): + conf.set_level(base + ['device', serial_port]) + serial = { + 'data_bits': '', + 'parity': '', + 'port': '', + 'serial_port': '/dev/serial/by-bus/' + serial_port, + 'speed': '', + 'stop_bits': '', + 'timeout': '600' + } + + if conf.exists(['data-bits']): + serial['data_bits'] = conf.return_value(['data-bits']) + + if conf.exists(['stop-bits']): + serial['stop_bits'] = conf.return_value(['stop-bits']) + + if conf.exists(['parity']): + serial['parity'] = conf.return_value(['parity']) + + if conf.exists(['port']): + serial['port'] = conf.return_value(['port']) + + if conf.exists(['speed']): + serial['speed'] = conf.return_value(['speed']) + + proxy['devices'].append(serial) + + return proxy + +def verify(proxy): + if not proxy: + return None + + for device in proxy['devices']: + if not os.path.exists('{serial_port}'.format(**device)): + raise ConfigError('Serial interface "{serial_port} does not exist"' + .format(**device)) + + for key in ['data_bits', 'parity', 'port', 'speed', 'stop_bits']: + if not device[key]: + value = key.replace('_','-') + raise ConfigError(f'{value} option must be defined!') + + return None + +def generate(proxy): + if not proxy: + return None + + render(config_file, 'ser2net/ser2net.conf.tmpl', proxy) + return None + +def apply(proxy): + if not proxy: + call('systemctl stop ser2net.service') + if os.path.isfile(config_file): + os.unlink(config_file) + + return None + + call('systemctl start ser2net.service') + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) -- cgit v1.2.3