Skip to content

Commit

Permalink
Docs: Fixup README, document examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Oct 11, 2024
1 parent 71e98fc commit b73a6bb
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
# Explorer
# Explorer <!-- omit in toc -->

This repository is home to the Explorer MicroPython fimrware and examples.
This repository is home to the Explorer MicroPython fimrware and examples.

Explorer is a electronic adventure playground for physical computing, built around the RP2350B. Includes a 2.8" LCD screen, a speaker, a mini breadboard, and much more!
Explorer is a MicroPython-powered electronic adventure playground for physical computing, built around the RP2350B.

Grab yours at https://shop.pimoroni.com/products/explorer

- [Explorer](#explorer)
- [Download MicroPython for Explorer](#download-micropython-for-explorer)
- [Introduction](#introduction)
- [Download MicroPython for Explorer](#download-micropython-for-explorer)
- [Flashing The Firmware](#flashing-the-firmware)
- [Examples](#examples)
- [Documentation](#documentation)

## Download MicroPython for Explorer
# Introduction

Explorer comes pre-flashed with MicroPython, our own custom drivers/libraries and a range of examples to get you started. MicroPython support for the RP2350B is currently a work-in-progress, so you should be prepared to update as we make fixes and improvements!

# Download MicroPython for Explorer

To upgrade, grab the latest release from https://github.com/pimoroni/explorer/releases/latest

There are two choices of firmware:

* explorer-vX.X.X-micropython-with-filesystem.uf2 :warning: (recommended) - A full update package including examples and the explorer library
* explorer-vX.X.X-micropython.uf2 - a firmware-only update, that will leave your filesystem alone!

:warning: If you flash the `with-filesystem` version, the contents of your Explorer board will be erased- so make sure to back up your own code first. Alternatively you can flash the firmware-only build and manually copy the files in [examples/lib](examples/libs)
:warning: If you flash the `with-filesystem` version, the contents of your Explorer board will be erased- so make sure to back up your own code first. Alternatively you can flash the firmware-only build and manually copy the files in [examples/lib](examples/lib)

# Flashing The Firmware

Expand Down
85 changes: 85 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Examples

# balls_demo.py

Our timeless silly bouncing balls demo, shows off drawing in PicoGraphics.

# button_test.py

Want to test your buttons? Look no further!

# clock.py

We'd be remiss without an example to flex our new PicoVector and PicoGraphics improvements. If you're not using your Explorer for anything else, then here's a handy Analog or Digital desk clock for you. Connect to your computer and use Thonny to automagically set the time.

# cubes.py

Seen those spinny wire mesh cube demos and wondered "how do they do that?" well you can continue to wonder, because this code makes me cry.

# display_jpg.py

As the name suggests, this example will display a JPEG. Remember, it's "f" as in "Photographic" so technically you should pronounce it "jfeg.""

# display_png.py

Bored of jfegs? Display a PNG instead... no, not the sound, but an image. PNG's are great because they can be *paletted* and give you super crisp details for low colour applications. Think icons, icons and, uh, icons!

# double_tap.py / double_tap_async.py

A delightful example for the LSM6DS3 accelerometer on our [multi sensor stick](https://shop.pimoroni.com/products/multi-sensor-stick). Knock on your desk, go on!

The async version uses `asyncio.create_task` to poll for a tap event. Keeps your main loop all nice and clean.

# explorer_sensor_stick_demo.py

Another example for our [multi sensor stick](https://shop.pimoroni.com/products/multi-sensor-stick). Uh, sorry. I guess this is a bit of an upsell. But it's three pretty cool sensors in one... and not a bag of virtual gems!

Displays light, acceleromater and temperature data!

# external_buttons.py

Gotta put something on that little breadboard, right! How about more buttons. You can never have enough buttons. The ones they keep taking out of cars must go somewhere!?

# image_gallery.py

At a loss for what to do with your Explorer. Clock just not your cup of tea? How about a digital photo frame! Those are still cool, right?

# marker.py

If you haven't Google'd "permenant marker font" yet, you really should. It's about the only worthwhile thing Google.com still does.

# maze.py

It's a-maze-ing! Use the C, Z, A and B buttons to navigate.

# multiple_servos.py

You can't do much with one servo, so how about multiple? You could be well on your way to being the next terrifyingly lifelike robot engineer!

# potentiometer.py

While it sounds like something for detecting ghosts or 1920s Soviet silent movies, a potentiometer is actually just a resistor, in a circle, with a knob to change its resistance. This one weird trick gives you a rotary control for your projects... use it to wiggle a servo!

# rainbow.py

Cue [appropriate musical accompaniment](https://remix.kwed.org/files/RKOfiles/Lagerfeldt%20-%20Flip%20the%20Flop%20(Rock%20My%20Commodore).mp3) before launching.

# shake.py

Another example for our [multi sensor stick](https://shop.pimoroni.com/products/multi-sensor-stick). A truly classic falling sand demo. [Shake it off. Shake it off.](https://www.youtube.com/watch?v=jRMHp7_kPec)

# simple_menu.py

How to menu? How to menu!

# single_servo.py

Nobody wants one servo... though I guess this does demonstrate all the cool features Chris packed into our servo library. Give it a go!

# step_counter.py

Another example for our [multi sensor stick](https://shop.pimoroni.com/products/multi-sensor-stick). Turns out the LSM6DS3 has turnkey step counting built right in... I guess we know how all those sports trackers work now!

# tone_song.py

By the grace of alphabetical ordering this wonderful musical example has come last. I think parents will thank us for this.

0 comments on commit b73a6bb

Please sign in to comment.