Skip to content

Commit df6aea2

Browse files
committed
Some documentation impromvements
1 parent a98cb59 commit df6aea2

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,11 @@ SMS or the USSD code.
220220

221221
The ``provider`` is an
222222
information about the operator, the SIM card is associated with. It is not
223-
necessarily the same network operator the modem connects to. The information is not used
224-
but it may be helpful to find SIM cards in the config file. The ``pin`` setting is
225-
the SIM card PIN that unlocks secret keys on the SIM card to allow an
226-
authentication towards the GSM network. If there is no SIM, leave it blank.
223+
necessarily the same network operator the modem connects to. The information
224+
is just for information and not technically used but it may be helpful to
225+
find SIM cards in the config file. The ``pin`` setting is the SIM card PIN
226+
that unlocks secret keys on the SIM card to allow an authentication towards
227+
the GSM network. If there is no PIN, leave it blank.
227228

228229
The ``ussd_account_balance`` is an USSD code to retrieve the account balance
229230
associated with the SIM card. This is required for pre-paid accounts, which
@@ -245,12 +246,14 @@ disables the function.
245246
The ``prefixes`` configuration value specifies which phone networks a modem
246247
respectively a SIM card is responsible for. The setting's value is a list of
247248
phone number prefixes in E.123 international format, which is used to feed
248-
the SMS router. The standard router is a simple implementation with a
249+
the SMS router. The SMS router is an internal component which selects an outgoing
250+
modem for sending an SMS. The standard router is a simple implementation with a
249251
preference for low costs. Additionally, the list is also an allowed list.
250252
If a prefix is not on the list, there is no route to the network. The
251253
``costs_per_sms`` is the costs to send an SMS to a destination network. There
252254
is not conversion between currencies. There is also only a fixed price per
253-
SIM card. If the standard router does not fit, the model must be re-implemented.
255+
SIM card independent of the SMS destination. If the standard router does not
256+
fit, the model must be re-implemented.
254257

255258
The ``health_check_interval`` specified in seconds is used for the internal
256259
monitoring. After this interval has expired, the server performs a modem, network

0 commit comments

Comments
 (0)