Skip to content

Commit eb23b58

Browse files
Document how to increase pystack size for CircuitPython installations
1 parent f1b6dc1 commit eb23b58

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,15 @@ Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bund
9292
circup bundle-add sparkfun/Qwiic_Py
9393
```
9494

95-
Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
95+
Then, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
9696
```sh
9797
circup install --py qwiic_oled
9898
```
9999

100+
> [!NOTE]
101+
> This library requires a decent stack size in order to run. In a file named "settings.toml" in the base directory on your CircuitPython board,
102+
> add the following line: ```CIRCUITPY_PYSTACK_SIZE=12288```. If you don't perform this step you will likely get "pystack exhausted" errors when trying to use these modules.
103+
100104
If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators. See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
101105

102106
```sh

0 commit comments

Comments
 (0)