From 1cf994c48b912254802f48e31eaf95e49ac55a82 Mon Sep 17 00:00:00 2001
From: Lars Kellogg-Stedman
Date: Wed, 25 Mar 2020 13:23:01 -0400
Subject: tools/pyboard.py: Support setting device/baudrate from shell env
 vars.

Allow defaults for --device and --baudrate to be set in the environment
using PYBOARD_DEVICE and PYBOARD_BAUDRATE.
---
 docs/reference/pyboard.py.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'docs/reference')

diff --git a/docs/reference/pyboard.py.rst b/docs/reference/pyboard.py.rst
index 60d7509af..d7d6fae3f 100644
--- a/docs/reference/pyboard.py.rst
+++ b/docs/reference/pyboard.py.rst
@@ -59,6 +59,17 @@ with the device.::
     $ pyboard.py --device /dev/ttyACM0 -c 'print(1+1)'
     2
 
+If you are often interacting with the same device, you can set the environment
+variable ``PYBOARD_DEVICE`` as an alternative to using the ``--device``
+command line option.  For example, the following is equivalent to the previous
+example::
+
+    $ export PYBOARD_DEVICE=/dev/ttyACM0
+    $ pyboard.py -c 'print(1+1)'
+
+Similarly, the ``PYBOARD_BAUDRATE`` environment variable can be used
+to set the default for the `--baudrate` option.
+
 Running a script on the device
 ------------------------------
 
-- 
cgit v1.2.3