<p>Falkenber9 has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/24248">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Update README<br><br>* Add instructions for convenient install on Archlinux<br>* Update hyperlinks, replace http with https<br>* Fix incorrect implicit code markup by explicit markup<br>* Fix Typos, etc.<br>* Adjust headlines<br><br>Change-Id: I96ac0f7caea8a28d2bbeba9e54911b4bd44aaad5<br>---<br>M README.md<br>1 file changed, 70 insertions(+), 50 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/48/24248/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/README.md b/README.md</span><br><span>index 274ab11..3751078 100644</span><br><span>--- a/README.md</span><br><span>+++ b/README.md</span><br><span>@@ -1,8 +1,8 @@</span><br><span style="color: hsl(0, 100%, 40%);">-pySim-prog - Utility for programmable SIM/USIM-Cards</span><br><span style="color: hsl(120, 100%, 40%);">+pySim - Read, Write and Browse Programmable SIM/USIM Cards</span><br><span> ====================================================</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-This repository contains a Python-language program that can be used</span><br><span style="color: hsl(0, 100%, 40%);">-to program (write) certain fields/parameters on so-called programmable</span><br><span style="color: hsl(120, 100%, 40%);">+This repository contains Python programs that can be used</span><br><span style="color: hsl(120, 100%, 40%);">+to read, program (write) and browse certain fields/parameters on so-called programmable</span><br><span> SIM/USIM cards.</span><br><span> </span><br><span> Such SIM/USIM cards are special cards, which - unlike those issued by</span><br><span>@@ -13,50 +13,73 @@</span><br><span> network, and want to issue your own SIM/USIM cards for that network.</span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Homepage</span><br><span>---------</span><br><span style="color: hsl(120, 100%, 40%);">+Homepage and Manual</span><br><span style="color: hsl(120, 100%, 40%);">+-------------------</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-The official homepage of the project is</span><br><span style="color: hsl(0, 100%, 40%);">-<http://osmocom.org/projects/pysim/wiki></span><br><span style="color: hsl(120, 100%, 40%);">+Please visit the [official homepage](https://osmocom.org/projects/pysim/wiki) for usage instructions, manual and examples.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-GIT Repository</span><br><span style="color: hsl(120, 100%, 40%);">+Git Repository</span><br><span> --------------</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-You can clone from the official libosmocore.git repository using</span><br><span style="color: hsl(120, 100%, 40%);">+You can clone from the official Osmocom  git repository using</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+git clone git://git.osmocom.org/pysim.git</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- git clone git://git.osmocom.org/pysim.git</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-There is a cgit interface at <http://git.osmocom.org/pysim/></span><br><span style="color: hsl(120, 100%, 40%);">+There is a cgit interface at <https://git.osmocom.org/pysim></span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Dependencies</span><br><span style="color: hsl(120, 100%, 40%);">+Installation</span><br><span> ------------</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-pysim requires:</span><br><span style="color: hsl(120, 100%, 40%);">+Please install the following dependencies:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-- pyscard</span><br><span style="color: hsl(0, 100%, 40%);">-- serial</span><br><span style="color: hsl(0, 100%, 40%);">-- pytlv</span><br><span style="color: hsl(0, 100%, 40%);">-- cmd2</span><br><span style="color: hsl(0, 100%, 40%);">-- jsonpath-ng</span><br><span style="color: hsl(0, 100%, 40%);">-- bidict</span><br><span style="color: hsl(120, 100%, 40%);">+ - pyscard</span><br><span style="color: hsl(120, 100%, 40%);">+ - serial</span><br><span style="color: hsl(120, 100%, 40%);">+ - pytlv</span><br><span style="color: hsl(120, 100%, 40%);">+ - cmd2</span><br><span style="color: hsl(120, 100%, 40%);">+ - jsonpath-ng</span><br><span style="color: hsl(120, 100%, 40%);">+ - construct</span><br><span style="color: hsl(120, 100%, 40%);">+ - bidict</span><br><span style="color: hsl(120, 100%, 40%);">+ - gsm0338</span><br><span> </span><br><span> Example for Debian:</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-       apt-get install python3-pyscard python3-serial python3-cmd2 python3-pip python3-yaml</span><br><span style="color: hsl(0, 100%, 40%);">-    pip3 install pytlv bidict</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+apt-get install python3-pyscard python3-serial python3-cmd2 python3-pip python3-yaml</span><br><span style="color: hsl(120, 100%, 40%);">+pip3 install pytlv jsonpath-ng construct bidict gsm0338</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span> Alternatively, everything can be installed using pip:</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span style="color: hsl(120, 100%, 40%);">+pip3 install -r requirements.txt</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- pip3 install -r requirements.txt</span><br><span style="color: hsl(120, 100%, 40%);">+After installing all dependencies, the pySim applications ``pySim-read.py``, ``pySim-prog.py`` and ``pySim-shell.py`` may be started directly from the cloned repository.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+### Archlinux Package</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Archlinux users may install the package ``python-pysim-git``</span><br><span style="color: hsl(120, 100%, 40%);">+[](https://aur.archlinux.org/packages/python-pysim-git)</span><br><span style="color: hsl(120, 100%, 40%);">+from the [Arch User Repository (AUR)](https://aur.archlinux.org).</span><br><span style="color: hsl(120, 100%, 40%);">+The most convenient way is the use of an [AUR Helper](https://wiki.archlinux.org/index.php/AUR_helpers),</span><br><span style="color: hsl(120, 100%, 40%);">+e.g. [yay](https://aur.archlinux.org/packages/yay) or [pacaur](https://aur.archlinux.org/packages/pacaur).</span><br><span style="color: hsl(120, 100%, 40%);">+The following example shows the installation with ``yay``.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```sh</span><br><span style="color: hsl(120, 100%, 40%);">+# Install</span><br><span style="color: hsl(120, 100%, 40%);">+yay -Sy python-pysim-git</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# Uninstall</span><br><span style="color: hsl(120, 100%, 40%);">+sudo pacman -Rs python-pysim-git</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span> </span><br><span> Mailing List</span><br><span> ------------</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-There is no separate mailing list for this project.  However,</span><br><span style="color: hsl(120, 100%, 40%);">+There is no separate mailing list for this project. However,</span><br><span> discussions related to pysim-prog are happening on the</span><br><span style="color: hsl(0, 100%, 40%);">-openbsc@lists.osmocom.org mailing list, please see</span><br><span style="color: hsl(120, 100%, 40%);">+<openbsc@lists.osmocom.org> mailing list, please see</span><br><span> <https://lists.osmocom.org/mailman/listinfo/openbsc> for subscription</span><br><span> options and the list archive.</span><br><span> </span><br><span>@@ -64,6 +87,7 @@</span><br><span> Rules](https://osmocom.org/projects/cellular-infrastructure/wiki/Mailing_List_Rules)</span><br><span> when posting.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> Contributing</span><br><span> ------------</span><br><span> </span><br><span>@@ -74,40 +98,35 @@</span><br><span> <https://osmocom.org/projects/cellular-infrastructure/wiki/Gerrit></span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Manual</span><br><span>-------</span><br><span style="color: hsl(0, 100%, 40%);">-p</span><br><span style="color: hsl(0, 100%, 40%);">-Please see the sphinx based documentation in the 'docs' sub-directory</span><br><span style="color: hsl(0, 100%, 40%);">-of the source.  A PDF rendering of the user manual is available from</span><br><span style="color: hsl(0, 100%, 40%);">-<https://ftp.osmocom.org/docs/latest/osmosmlc-usermanual.pdf></span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Usage</span><br><span>------</span><br><span style="color: hsl(120, 100%, 40%);">+Usage Examples</span><br><span style="color: hsl(120, 100%, 40%);">+--------------</span><br><span> </span><br><span>  * Program customizable SIMs. Two modes are possible:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-  - one where you specify every parameter manually :</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+  - one where you specify every parameter manually:</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> ./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -i <IMSI> -s <ICCID></span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-  - one where they are generated from some minimal set :</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+  - one where they are generated from some minimal set:</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> ./pySim-prog.py -n 26C3 -c 49 -x 262 -y 42 -z <random_string_of_choice> -j <card_num></span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-    With <random_string_of_choice> and <card_num>, the soft will generate</span><br><span style="color: hsl(0, 100%, 40%);">-    'predictable' IMSI and ICCID, so make sure you choose them so as not to</span><br><span style="color: hsl(0, 100%, 40%);">-    conflict with anyone. (for eg. your name as <random_string_of_choice> and</span><br><span style="color: hsl(0, 100%, 40%);">-    0 1 2 ... for <card num>).</span><br><span style="color: hsl(120, 100%, 40%);">+With ``<random_string_of_choice>`` and ``<card_num>``, the soft will generate</span><br><span style="color: hsl(120, 100%, 40%);">+'predictable' IMSI and ICCID, so make sure you choose them so as not to</span><br><span style="color: hsl(120, 100%, 40%);">+conflict with anyone. (for e.g. your name as ``<random_string_of_choice>`` and</span><br><span style="color: hsl(120, 100%, 40%);">+0 1 2 ... for ``<card num>``).</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-  You also need to enter some parameters to select the device :</span><br><span style="color: hsl(0, 100%, 40%);">-   -t TYPE : type of card (supersim, magicsim, fakemagicsim or try 'auto')</span><br><span style="color: hsl(0, 100%, 40%);">-   -d DEV  : Serial port device (default /dev/ttyUSB0)</span><br><span style="color: hsl(0, 100%, 40%);">-   -b BAUD : Baudrate (default 9600)</span><br><span style="color: hsl(120, 100%, 40%);">+You also need to enter some parameters to select the device:</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- * Interact with SIMs from a python interactive shell (ipython for eg :)</span><br><span style="color: hsl(120, 100%, 40%);">+ -t TYPE : type of card (``supersim``, ``magicsim``, ``fakemagicsim`` or try ``auto``)  </span><br><span style="color: hsl(120, 100%, 40%);">+ -d DEV  : Serial port device (default ``/dev/ttyUSB0``)  </span><br><span style="color: hsl(120, 100%, 40%);">+ -b BAUD : Baudrate (default 9600)  </span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ * Interact with SIMs from a python interactive shell (e.g. ipython):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span> from pySim.transport.serial import SerialSimLink</span><br><span> from pySim.commands import SimCardCommands</span><br><span> </span><br><span>@@ -121,3 +140,4 @@</span><br><span> </span><br><span>       # Run A3/A8</span><br><span> print(sc.run_gsm('00112233445566778899aabbccddeeff'))</span><br><span style="color: hsl(120, 100%, 40%);">+```</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/24248">change 24248</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/pysim/+/24248"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: pysim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I96ac0f7caea8a28d2bbeba9e54911b4bd44aaad5 </div>
<div style="display:none"> Gerrit-Change-Number: 24248 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Falkenber9 <robert.falkenberg@tu-dortmund.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>