From 71b9184bd6745138531da40dae8a3b09e8409bc6 Mon Sep 17 00:00:00 2001
From: swym <0xfd000000@gmail.com>
Date: Wed, 28 Aug 2019 00:26:21 +0200
Subject: [PATCH] pycardium: document os.usbconfig
---
Documentation/pycardium/os.rst | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/Documentation/pycardium/os.rst b/Documentation/pycardium/os.rst
index ce71c1b4..51b9590e 100644
--- a/Documentation/pycardium/os.rst
+++ b/Documentation/pycardium/os.rst
@@ -72,3 +72,16 @@ Card10-Specific
Please only call this function if absolutely necessary. In most cases
you'll want to just :py:func:`os.exit` instead.
+
+.. py:function:: usbconfig(config_type)
+
+ Change active USB configuration. By default, card10 boots with
+ :py:data:`os.SERIAL` active.
+
+ This will deactivate the currently active USB configuration. This
+ means that, if you activate :py:data:`os.FLASH` while :py:data:`os.SERIAL`
+ was active, the USB serial will be disconnected.
+
+ :param int config_type: Selects which config to activate. Possible
+ values are :py:data:`os.SERIAL`, :py:data:`os.FLASH`
+ or :py:data:`os.NONE`
--
GitLab