jolly has submitted this change. ( https://gerrit.osmocom.org/c/onomondo-ipa/+/43403?usp=email ) Change subject: Update README.md related to the current command line parameters ...................................................................... Update README.md related to the current command line parameters Change-Id: I66b89db33676139c8746eb1f94133e14af6e1485 --- M README.md 1 file changed, 13 insertions(+), 13 deletions(-) Approvals: dexter: Looks good to me, approved Jenkins Builder: Verified diff --git a/README.md b/README.md index 2c7ba03..44d76ea 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Onomondo IPA onomondo-ipa is a C-based IoT Profile Assistant in the IoT Device (IPAd, see also SGP.31) implementation. The IPAd is an -element in the 3GPP IoT eSIM system as described in SGP.31 and SGP.32. It interfaces between the eUICC on one side, -and the eIM (via HTTPS) on the other side. The implementation presented here can run on a regular Linux host. It can also be used -as a library to add IPAd functionality to an IoT device that runs an RTOS. +element in the 3GPP IoT eSIM system as described in SGP.31 and SGP.32. It interfaces between the eUICC on one side, +and the eIM (via HTTPS) on the other side. The implementation presented here can run on a regular Linux host. It can +also be used as a library to add IPAd functionality to an IoT device that runs an RTOS. This code currently implements SGP.32 v1.0, an early version of the GSMA specifications which did never get used in production. The only SAS-SM accredited eUICCs @@ -89,19 +89,19 @@ ### Command-Line Options -There are a number of command-line options supported. The most relevant options are: +There are a number of command-line options and operations supported. The most relevant options are: * `-r` specifies the PCSC reader number. -* `-f` specifies the path to an initial eIM configuration file. * `-I` omit verification of the SSL certificate of the eIM. This option makes the operation of onomondo-ipa insecure, but may be helpful for testing and debugging in lab setups. * `-E` enable the IoT eUICC emulation in case a regular consumer eUICC should be used. +* `add-initial-eim <PATH>` specifies the path to an initial eIM configuration file. -(use option -h to query the full list of parameters) +(use option -h to query the full list of options and operation parameters) ### Initial Setup -During the first run, onomondo-ipa will create an `nvstate.bin` file in its working directory. +During the first run, onomondo-ipa will create an `nvstate.bin` file in its working directory. This file is used as non-volatile storage of data. In case the IoT eUICC is not yet provisioned with an eIM configuration, onomondo-ipa can be used to perform the @@ -112,15 +112,15 @@ Example: load the initial eIM configuration onto the eUICC in PCSC reader 2 ``` -./src/ipa/ipa -r 2 -f ../contrib/sample_eim_cfg.ber +./src/ipa/ipa -r 2 add-initial-eim ../contrib/sample_eim_cfg.ber ``` ### Querying eIM Packages -When onomondo-ipa is called without the `-f` parameter, it will read the eUICC configuration and the eidValue from the -eUICC and use it to query the eIM for eIM packages. In case no eIM package is available (error code -noEimPackageAvailable), onomondo-ipa will exit. This condition is technically not an error, it just means that currently -no eIM package is available for the given eUICC / eidValue. +When onomondo-ipa is called without the `add-initial-eim` operation parameter, it will read the eIM configuration data +and the eidValue from the eUICC and use it to query the eIM for eIM packages. In case no eIM package is available (error +code noEimPackageAvailable), onomondo-ipa will exit. This condition is technically not an error, it just means that +currently no eIM package is available for the given eUICC / eidValue. When there is an eIM package available for the given eUICC / eidValue, then onomondo-ipa will download it and execute the requested procedure. Immediately after that, the next eIM package is requested and processed until the eIM returns @@ -134,6 +134,6 @@ License ---------- -Copyright (c) 2025 Onomondo ApS & sysmocom - s.f.m.c. GmbH. +Copyright (c) 2025-2026 Onomondo ApS & sysmocom - s.f.m.c. GmbH. Licensed under the GNU Affero General Public License v3.0 only. -- To view, visit https://gerrit.osmocom.org/c/onomondo-ipa/+/43403?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: merged Gerrit-Project: onomondo-ipa Gerrit-Branch: master Gerrit-Change-Id: I66b89db33676139c8746eb1f94133e14af6e1485 Gerrit-Change-Number: 43403 Gerrit-PatchSet: 4 Gerrit-Owner: jolly <andreas@eversberg.eu> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: dexter <pmaier@sysmocom.de> Gerrit-Reviewer: jolly <andreas@eversberg.eu>