@@ -93,46 +93,30 @@ We are using a gerrit-based patch review process explained at
93
93
< https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit >
94
94
95
95
96
- Usage Examples
97
- --------------
98
-
99
- * Program customizable SIMs. Two modes are possible:
100
-
101
- - one where you specify every parameter manually:
102
- ```
103
- ./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i <IMSI> -s <ICCID>
104
- ```
105
-
106
- - one where they are generated from some minimal set:
107
- ```
108
- ./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -z <random_string_of_choice> -j <card_num>
109
- ```
110
-
111
- With `` <random_string_of_choice> `` and `` <card_num> `` , the soft will generate
112
- 'predictable' IMSI and ICCID, so make sure you choose them so as not to
113
- conflict with anyone. (for e.g. your name as `` <random_string_of_choice> `` and
114
- 0 1 2 ... for `` <card num> `` ).
96
+ Documentation
97
+ -------------
115
98
116
- You also need to enter some parameters to select the device:
99
+ The pySim user manual can be built from this very source code by means
100
+ of sphinx (with sphinxcontrib-napoleon and sphinx-argparse). See the
101
+ Makefile in the 'docs' directory.
117
102
118
- -t TYPE : type of card (`` supersim `` , `` magicsim `` , `` fakemagicsim `` or try `` auto `` )
119
- -d DEV : Serial port device (default `` /dev/ttyUSB0 `` )
120
- -b BAUD : Baudrate (default 9600)
103
+ A pre-rendered HTML user manual of the current pySim 'git master' is
104
+ available from < https://downloads.osmocom.org/docs/latest/pysim/ > and
105
+ a downloadable PDF version is published at
106
+ < https://downloads.osmocom.org/docs/latest/osmopysim-usermanual.pdf > .
121
107
122
- * Interact with SIMs from a python interactive shell (e.g. ipython):
108
+ A slightly dated video presentation about pySim-shell can be found at
109
+ < https://media.ccc.de/v/osmodevcall-20210409-laforge-pysim-shell > .
123
110
124
- ```
125
- from pySim.transport.serial import SerialSimLink
126
- from pySim.commands import SimCardCommands
127
-
128
- sl = SerialSimLink(device='/dev/ttyUSB0', baudrate=9600)
129
- sc = SimCardCommands(sl)
130
111
131
- sl.wait_for_card()
112
+ pySim-shell vs. legacy tools
113
+ ----------------------------
132
114
133
- # Print IMSI
134
- print(sc.read_binary(['3f00', '7f20', '6f07']))
115
+ While you will find a lot of online resources still describing the use of
116
+ pySim-prog.py and pySim-read.py, those tools are considered legacy by
117
+ now and have by far been superseded by the much more capable
118
+ pySim-shell. We strongly encourage users to adopt pySim-shell, unless
119
+ they have very specific requirements like batch programming of large
120
+ quantities of cards, which is about the only remaining use case for the
121
+ legacy tools.
135
122
136
- # Run A3/A8
137
- print(sc.run_gsm('00112233445566778899aabbccddeeff'))
138
- ```
0 commit comments