laforge has uploaded this change for review.

View Change

extend documentation about transports

By adding a description to each of the transports, we extend the
manual.

Change-Id: I84d926b45c97477e77a7852bc8254ce9a7614a33
---
M pySim/transport/calypso.py
M pySim/transport/modem_atcmd.py
M pySim/transport/pcsc.py
M pySim/transport/serial.py
4 files changed, 20 insertions(+), 4 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/88/35388/1

diff --git a/pySim/transport/calypso.py b/pySim/transport/calypso.py
index 98330a9..b660cc0 100644
--- a/pySim/transport/calypso.py
+++ b/pySim/transport/calypso.py
@@ -169,6 +169,7 @@
 
     @staticmethod
     def argparse_add_reader_args(arg_parser: argparse.ArgumentParser):
-        osmobb_group = arg_parser.add_argument_group('OsmocomBB Reader')
+        osmobb_group = arg_parser.add_argument_group('OsmocomBB Reader', description=
+        """Use a Calypso based cellphone running the OsmocomBB layer1 firmware and the osmocon host program to access your SIM card""")
         osmobb_group.add_argument('--osmocon', dest='osmocon_sock', metavar='PATH', default=None,
                                   help='Socket path for Calypso (e.g. Motorola C1XX) based reader (via OsmocomBB)')
diff --git a/pySim/transport/modem_atcmd.py b/pySim/transport/modem_atcmd.py
index 71f76e2..27a03e9 100644
--- a/pySim/transport/modem_atcmd.py
+++ b/pySim/transport/modem_atcmd.py
@@ -181,7 +181,8 @@
 
     @staticmethod
     def argparse_add_reader_args(arg_parser: argparse.ArgumentParser):
-        modem_group = arg_parser.add_argument_group('AT Command Modem Reader')
+        modem_group = arg_parser.add_argument_group('AT Command Modem Reader', description=
+        """Use a AT commands to access a SIM card inserted to a cellular modem""")
         modem_group.add_argument('--modem-device', dest='modem_dev', metavar='DEV', default=None,
                                  help='Serial port of modem for Generic SIM Access (3GPP TS 27.007)')
         modem_group.add_argument('--modem-baud', type=int, metavar='BAUD', default=115200,
diff --git a/pySim/transport/pcsc.py b/pySim/transport/pcsc.py
index 762908c..878f887 100644
--- a/pySim/transport/pcsc.py
+++ b/pySim/transport/pcsc.py
@@ -104,6 +104,7 @@
 
     @staticmethod
     def argparse_add_reader_args(arg_parser: argparse.ArgumentParser):
-        pcsc_group = arg_parser.add_argument_group('PC/SC Reader')
+        pcsc_group = arg_parser.add_argument_group('PC/SC Reader', description=
+        """Use a smart card interface via the PC/SC driver middleware of your OS""")
         pcsc_group.add_argument('-p', '--pcsc-device', type=int, dest='pcsc_dev', metavar='PCSC', default=None,
                                 help='PC/SC reader number to use for SIM access')
diff --git a/pySim/transport/serial.py b/pySim/transport/serial.py
index ad800ed..fae2f30 100644
--- a/pySim/transport/serial.py
+++ b/pySim/transport/serial.py
@@ -247,7 +247,8 @@
 
     @staticmethod
     def argparse_add_reader_args(arg_parser: argparse.ArgumentParser):
-        serial_group = arg_parser.add_argument_group('Serial Reader')
+        serial_group = arg_parser.add_argument_group('Serial Reader', description=
+        """Use a classic "dumb" low-cost serial (RS232) reader to talk to your SIM card""")
         serial_group.add_argument('-d', '--device', metavar='DEV', default='/dev/ttyUSB0',
                                   help='Serial Device for SIM access')
         serial_group.add_argument('-b', '--baud', dest='baudrate', type=int, metavar='BAUD', default=9600,

To view, visit change 35388. To unsubscribe, or for help writing mail filters, visit settings.