djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add docs for dotenv BLE

Browse Source
This commit is contained in:
Neradoc 2022-07-14 20:31:53 +02:00
parent 5ca6d8953d
commit 44a91c12be
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/environment.rst
View File

@ -31,9 +31,17 @@ CircuitPython behavior
CircuitPython will also read the environment to configure its behavior. Other CircuitPython will also read the environment to configure its behavior. Other
keys are ignored by CircuitPython. Here are the keys it uses: keys are ignored by CircuitPython. Here are the keys it uses:
CIRCUITPY_BLE_NAME
~~~~~~~~~~~~~~~~~~
Default BLE name the board advertises as, including for the BLE workflow.
CIRCUITPY_WEB_API_PASSWORD
~~~~~~~~~~~~~~~~~~~~~~~~~~
Password required to make modifications to the board from the Web Workflow.
CIRCUITPY_WIFI_PASSWORD CIRCUITPY_WIFI_PASSWORD
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID Wi-Fi password used to auto connect to CIRCUITPY_WIFI_SSID.
CIRCUITPY_WIFI_SSID CIRCUITPY_WIFI_SSID
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~

4
docs/workflows.md
View File

@ -45,6 +45,10 @@ using a rotating key rather than a static one. Non-bonded devices won't be able
connection, the central device can discover two default services. One for file transfer and one for connection, the central device can discover two default services. One for file transfer and one for
CircuitPython specifically that includes serial characteristics. CircuitPython specifically that includes serial characteristics.
To change the default BLE advertising name without (or before) running user code, the desired name
can be put in the `/.env` file. The key is `CIRCUITPY_BLE_NAME`. It's limited to approximately
30 characters depending on the port's settings and will be truncated if longer.
### File Transfer API ### File Transfer API
CircuitPython uses [an open File Transfer API](https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer) CircuitPython uses [an open File Transfer API](https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer)