circuitpython/ports/rp2/boards/WEACTSTUDIO/README.md
Matt Trentini bdbc44474f rp2/boards/WEACTSTUDIO: Add WEACTSTUDIO with multiple variants.
This supports 2, 4, 8 and 16MB flash variants.
2022-09-26 12:40:14 +10:00

35 lines
1.1 KiB
Markdown

# WeAct Studio RP2040
The WeAct Studio RP2040 Board is based on the Raspberry Pi RP2040 and can be
purchased with 2/4/8/16 MiB of flash.
These boards are available from a number of resellers and often have the name
"Pico Board RP2040". WeAct maintain the [WeActStudio.RP2040CoreBoard](https://github.com/WeActTC/WeActStudio.RP2040CoreBoard/tree/master)
repository containing information on the board.
## Build notes
Builds can be configured with the `BOARD_VARIANT` parameter. Valid variants
can be displayed with the `query-variant` target. An example:
```bash
> cd ports/rp2
> make BOARD=WEACTSTUDIO query-variants
VARIANTS: flash_2mb flash_4mb flash_8mb flash_16mb
> make BOARD=WEACTSTUDIO BOARD_VARIANT=flash_8mb submodules all # Build the 8 MiB variant
```
`flash_16mb` is the default if `BOARD_VARIANT` is not supplied.
## Board-specific modules
The `board` module contains definitions for the onboard LED and user button.
Example:
```python
> import board
> board.led.toggle() # Toggles the state of the on-board LED
> board.key.value() # Returns 0 or 1 corresponding to the state of the user key
```