6446010753
This adds support for CIRCUITPY_WIFI_SSID and CIRCUITPY_WIFI_PASSWORD in `/.env`. When both are defined, CircuitPython will attempt to connect to the network even when user code isn't running. If the user code attempts to a network with the same SSID, it will return immediately. Connecting to another SSID will disconnect from the auto-connected network. If the user code initiates the connection, then it will be shutdown after user code exits. (Should match <8 behavior.) This PR also reworks the default displayio terminal. It now supports a title bar TileGrid in addition to the (newly renamed) scroll area. The default title bar is the top row of the display and is positioned to the right of the Blinka logo when it is enabled. The scroll area is now below the Blinka logo. The Wi-Fi auto-connect code now uses the title bar to show its state including the IP address when connected. It does this through the "standard" OSC control sequence `ESC ] 0 ; <s> ESC \` where <s> is the title bar string. This is commonly supported by terminals so it should work over USB and UART as well. Related to #6174
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
Environment Variables
|
|
=====================
|
|
|
|
CircuitPython 8.0.0 introduces support for environment variables. Environment
|
|
variables are commonly used to store "secrets" such as Wi-Fi passwords and API
|
|
keys. This method *does not* make them secure. It only separates them from the
|
|
code.
|
|
|
|
CircuitPython supports these by mimicking the `dotenv <https://github.com/theskumar/python-dotenv>`_
|
|
CPython library. Other languages such as Javascript, PHP and Ruby also have
|
|
dotenv libraries.
|
|
|
|
These libraries store environment variables in a ``.env`` file. Here is a simple
|
|
example:
|
|
|
|
.. code-block:: bash
|
|
|
|
KEY1='value1'
|
|
# Comment
|
|
KEY2='value2
|
|
is multiple lines'
|
|
|
|
CircuitPython uses the ``.env`` at the drive root (no folder) as the environment.
|
|
User code can access the values from the file using `os.getenv()`. It is
|
|
recommended to save any values used repeatedly in a variable because `os.getenv()`
|
|
will parse the ``/.env`` on every access.
|
|
|
|
CircuitPython behavior
|
|
----------------------
|
|
|
|
CircuitPython will also read the environment to configure its behavior. Other
|
|
keys are ignored by CircuitPython. Here are the keys it uses:
|
|
|
|
CIRCUITPY_WIFI_PASSWORD
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID
|
|
|
|
CIRCUITPY_WIFI_SSID
|
|
~~~~~~~~~~~~~~~~~~~
|
|
Wi-Fi SSID to auto-connect to even if user code is not running.
|