Skip to content

Commit 44a91c1

Browse files
committed
add docs for dotenv BLE
1 parent 5ca6d89 commit 44a91c1

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

docs/environment.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,17 @@ CircuitPython behavior
3131
CircuitPython will also read the environment to configure its behavior. Other
3232
keys are ignored by CircuitPython. Here are the keys it uses:
3333

34+
CIRCUITPY_BLE_NAME
35+
~~~~~~~~~~~~~~~~~~
36+
Default BLE name the board advertises as, including for the BLE workflow.
37+
38+
CIRCUITPY_WEB_API_PASSWORD
39+
~~~~~~~~~~~~~~~~~~~~~~~~~~
40+
Password required to make modifications to the board from the Web Workflow.
41+
3442
CIRCUITPY_WIFI_PASSWORD
3543
~~~~~~~~~~~~~~~~~~~~~~~
36-
Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID
44+
Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID.
3745

3846
CIRCUITPY_WIFI_SSID
3947
~~~~~~~~~~~~~~~~~~~

docs/workflows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ using a rotating key rather than a static one. Non-bonded devices won't be able
4545
connection, the central device can discover two default services. One for file transfer and one for
4646
CircuitPython specifically that includes serial characteristics.
4747

48+
To change the default BLE advertising name without (or before) running user code, the desired name
49+
can be put in the `/.env` file. The key is `CIRCUITPY_BLE_NAME`. It's limited to approximately
50+
30 characters depending on the port's settings and will be truncated if longer.
51+
4852
### File Transfer API
4953

5054
CircuitPython uses [an open File Transfer API](https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer)

0 commit comments

Comments
 (0)