Skip to content

Commit

Permalink
Updated the README file (#3)
Browse files Browse the repository at this point in the history
* Updates to picofuse

* Updated pool code

* Added fuse application

* Updates

* Updates

* Updated

* Updated pool

* Updated to compile for pico

* Added LED

* Updated code and added blink test

* Updated ADC

* WIP: GPIO events

* Updated assert

* Updated documentation

* Added docs

* Updated

* Updated README
  • Loading branch information
djthorpe authored Oct 24, 2023
1 parent 38a5192 commit fbeb60e
Showing 1 changed file with 10 additions and 32 deletions.
42 changes: 10 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# pico-fuse

This is a library to use with the Raspberry Pi Pico boards using the RP2040 microprocessor,
which provides an event-driven architecture for interacting with devices in C.
which provides an event-driven architecture for interacting with devices in C. The API documentation
is available here:

* https://mutablelogic.github.io/pico-fuse/

The following sections provide more information on how to use this library:

* [Dependencies](#dependencies)
* [Configuration](#configuration)
* [References](#references)

## Dependencies

Expand Down Expand Up @@ -57,37 +66,6 @@ board then the Pico W then here are some values for PICO_BOARD you can use inste

Whenever you target a different board, use `make clean` before `make picotool` and `make config`.

## Initialization

## Scheduling Timers

## The On-board LED

## GPIO Input and Output

## ADC Sampling

## WiFi Access

## Blink

The blink example is a simple example that blinks the LED on the Pico W board (so pretty much just tests that the board is working).
To load the example onto your Pico W, plug it in using the USB cable whilst holding down the "BOOTSEL" button on the top of the
Pico. Then run the following command:

```bash
cd ${HOME}/projects/pico-fuse
PICO_BOARD=pico make config && make picotool && make examples/blink
build/lib/picotool/picotool load build/examples/blink/blink.uf2 -x -f
```

Fingers crossed, the LED should start blinking. The code for this example is in the [`src/blink`](src/blink) folder:

* The `CMakeLists.txt` file defines how to build the example
* The `blink.c` file contains the source code for the example

This one is a little complicated as the Pico hardware and the Pico W hardware use different GPIO pins for the LED.

## References

* Pico SDK
Expand Down

0 comments on commit fbeb60e

Please sign in to comment.