Skip to content

Commit 4ef4f50

Browse files
authored
Merge pull request #9654 from RetiredWizard/envdoc
Environment Variables doc to note possible board specific keys
2 parents ca99b41 + 0d235d7 commit 4ef4f50

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/environment.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ CircuitPython behavior
5656
CircuitPython will also read the environment to configure its behavior. Other
5757
keys are ignored by CircuitPython. Here are the keys it uses:
5858

59+
Core CircuitPython keys
60+
^^^^^^^^^^^^^^^^^^^^^^^
61+
5962
CIRCUITPY_BLE_NAME
6063
~~~~~~~~~~~~~~~~~~
6164
Default BLE name the board advertises as, including for the BLE workflow.
@@ -94,3 +97,25 @@ Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID.
9497
CIRCUITPY_WIFI_SSID
9598
~~~~~~~~~~~~~~~~~~~
9699
Wi-Fi SSID to auto-connect to even if user code is not running.
100+
101+
Additional board specific keys
102+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
103+
104+
`MaTouch ESP32-S3 Parallel TFT with Touch 7“ <https://circuitpython.org/board/makerfabs_tft7/>`_
105+
106+
CIRCUITPY_DISPLAY_WIDTH
107+
~~~~~~~~~~~~~~~~~~~~~~~
108+
Selects the correct screen resolution (1024x600 or 800x640) for the particular board variant.
109+
If the CIRCUITPY_DISPLAY_WIDTH parameter is set to a value of 1024 the display is initialized
110+
during power up at 1024x600 otherwise the display will be initialized at a resolution
111+
of 800x480.
112+
113+
`Sunton ESP32-2432S028 <https://circuitpython.org/board/sunton_esp32_2432S028/>`_
114+
115+
CIRCUITPY_DISPLAY_ROTATION
116+
~~~~~~~~~~~~~~~~~~~~~~~~~~
117+
Selects the correct screen rotation (0, 90, 180 or 270) for the particular board variant.
118+
If the CIRCUITPY_DISPLAY_ROTATION parameter is set the display will be initialized
119+
during power up with the selected rotation, otherwise the display will be initialized with
120+
a rotation of 0. Attempting to initialize the screen with a rotation other than 0,
121+
90, 180 or 270 is not supported and will result in an unexpected screen rotation.

0 commit comments

Comments
 (0)