micropython/ports/rp2/boards/WEACTSTUDIO/README.md
Jim Mussared 45845acf6d rp2: Use uppercase variant names.
This is to support a future change to add the variant name to the build
directory and therefore should be the same style as the board name.

This only affects the WEACTSTUDIO board. Also standardises on a convention
for naming flash-size variants. Normally we would write e.g. 2MiB, but in
uppercase, it's awkward to write 2MIB, so instead use 2M, 512K, etc for
variant names, but use 2MiB when not constrained by case (e.g. a regular
filename).

This work was funded through GitHub Sponsors.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2023-08-23 13:54:37 +10:00

32 lines
1006 B
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
By default the firmware supports boards with 16MiB flash. This can be
configured using the `BOARD_VARIANT` parameter. The valid options are
`FLASH_2M`, 'FLASH_4M', and 'FLASH_8M'.
```bash
> cd ports/rp2
> make BOARD=WEACTSTUDIO BOARD_VARIANT=FLASH_8M submodules all # Build the 8 MiB variant
```
## 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
```