[taler-docs] branch master updated: document taler-mdb

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new 08d99c70 document taler-mdb
08d99c70 is described below

commit 08d99c708023ce35160c5705b85ff79d04eb91b0
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Sat Jan 13 14:23:41 2024 +0100

    document taler-mdb
---
 conf.py                   |  7 +++++
 manpages/taler-mdb.1.rst  | 73 +++++++++++++++++++++++++++++++++++++++++++++++
 manpages/taler.conf.5.rst | 41 ++++++++++++++++++++++++++
 3 files changed, 121 insertions(+)

diff --git a/conf.py b/conf.py
index e1663ff4..e20b2961 100644
--- a/conf.py
+++ b/conf.py
@@ -574,6 +574,13 @@ man_pages = [
         "GNU Taler contributors",
         1,
     ),
+    (
+        "manpages/taler-mdb.1",
+        "taler-mdb",
+        "operate multi drop bus (MDB) based vending machines with Taler 
payments",
+        "GNU Taler contributors",
+        1,
+    ),
     (
         "manpages/taler-merchant-dbinit.1",
         "taler-merchant-dbinit",
diff --git a/manpages/taler-mdb.1.rst b/manpages/taler-mdb.1.rst
new file mode 100644
index 00000000..5e6f86d2
--- /dev/null
+++ b/manpages/taler-mdb.1.rst
@@ -0,0 +1,73 @@
+taler-mdb(1)
+############
+
+.. only:: html
+
+   Name
+   ====
+
+   **taler-mdb** - Taler multi-drop bus vending machine integration
+
+
+Synopsis
+========
+
+**taler-mdb**
+[**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
+[**-d** | **--disable-mdb**]
+[**-h** | **--help**]
+[**-i** | **--backlight-invert**]
+[**-L** _*LOGLEVEL* | **--log=**\ \ *LOGLEVEL*]
+[**-l** _*FILENAME* | **--logfile=**\ \ *FILENAME*]
+[**-s** | **--enable-soldout**]
+[**-t** | **--disable-tty**]
+[**-v** | **--version**]
+
+
+Description
+===========
+
+**taler-mdb** is a command-line tool to operate a vending machine using GNU 
Taler for payments.
+
+Its options are as follows:
+
+**-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
+   Use the configuration and other resources for the Sync commands
+   to operate from *FILENAME*.
+
+**-d** \| **--disable-mdb**
+   Disable interaction with the MDB bus (for testing).
+
+**-h** \| **--help**
+   Print short help on options.
+
+**-i** \| **--backlight-invert**
+   Invert the bit for turning on/off the backlight.
+
+**-L** *LOGLEVEL* \| **--log=**\ \ *LOGLEVEL*
+   Configure logging to use *LOGLEVEL*.
+
+**-l** *FILENAME* \| **--logfile=**\ \ *FILENAME*
+   Configure logging to write logs to *FILENAME*.
+
+**-s** \| **--enable-soldout**
+   When the machine fails to dispense a product, internally set the product to 
"sold out" and refuse future orders until restarted.
+
+**-t** \| **--disable-tty**
+   Disable interactive command-line use.
+
+**-v** \| **–version**
+   Print version information.
+
+
+See Also
+========
+
+taler-merchant-httpd(1), taler.conf(5).
+
+
+Bugs
+====
+
+Report bugs by using https://bugs.taler.net or by sending electronic
+mail to <taler@gnu.org>.
diff --git a/manpages/taler.conf.5.rst b/manpages/taler.conf.5.rst
index 164efb2d..fc6f5952 100644
--- a/manpages/taler.conf.5.rst
+++ b/manpages/taler.conf.5.rst
@@ -784,6 +784,47 @@ RAM_LIMIT
   This gives the number of transactions to keep in memory. Older transactions 
will be overwritten and history requests for overwritten transactions will fail.
 
 
+Taler-mdb Options
+-----------------
+
+Taler-mdb is a component to run GNU Taler as a payment system on
+vending machines using the multi-drop bus protocol. These options
+are thus not useful for most users.  Note that right now, the
+cancel button is hard-coded to be using GPIO pin 23.
+
+ADVERTISEMENT_BINARY
+  Program to run while not vending, possibly useful to show advertisements on 
the screen (optional).
+ESSID
+  ESSID to advertise to wallets for use as an open WiFi to make payments 
(optional).
+FULFILLMENT_MSG
+  Message shown to users by their wallets upon successful payment.
+BACKEND_BASE_URL
+  Base URL (possibly including instance) for the Taler merchant backend used 
to process payments.
+FRAMEBUFFER_BACKLIGHT
+  Name of the file used to control brightness of the display. Optional. 
Defaults to "/sys/class/backlight/soc:backlight/brightness" if not given.
+FRAMEBUFFER_DEVICE
+  Name of the framebuffer device to use. Defaults to "/dev/fb1" if not given.
+UART_DEVICE
+  Name of the UART device to use. Defaults to "/dev/ttyAMA0" if not given.
+
+Each products being sold must be configured in a section where the name starts 
with "product-".
+In these sections, the options that must be provided are:
+
+NUMBER
+  Number identifying the slot in the vending machine that corresponds to this 
product.
+INSTANCE
+  Instance to use for the payment. Optional. If not given, the 
BACKEND_BASE_URL from "[taler-mdb]" will be used.
+BACKEND_AUTHORIZATION
+  Full HTTP "Authorization" header (usually with a Bearer token) to be send to 
the merchant backend for authorization of requests. Mandatory.
+DESCRIPTION
+  Human-readable description of the product. Use "empty" if the product is 
known to be sold out (only effective if selling out is enabled via 
command-line).
+PRICE
+  Actual price of the product, as a Taler amount 
("$CURRENCY:$VALUE.$FRACTION").
+KEY
+  Key used to select the product from the console during testing. Optional.
+THUMBNAIL
+  Name of a filename with a preview image of the product to be given to the 
wallet. Optional. Only ".png", ".jpg", ".jpeg" and ".svg" are supported at this 
time.
+
 
 SEE ALSO
 ========

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.