diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..01b1bee --- /dev/null +++ b/examples/README.md @@ -0,0 +1,49 @@ +# QwSTPad Micropython Examples + +These are micropython examples for the Pimoroni [QwSTPad](https://shop.pimoroni.com/products/qwstpad), an I2C gamepad controller breakout. + +- [Function Examples](#function-examples) + - [Read All](#read-all) + - [LED Wave](#led-wave) + - [Pad Detect](#pad-detect) +- [Game Examples](#game-examples) + - [Random Maze](#random-maze) + - [Multi-Player](#multi-player) + + +## Function Examples + +### Read All +[function/read_all.py](function/read_all.py) + +How to read all of the buttons on QwSTPad. + + +### LED Wave +[function/led_wave.py](function/led_wave.py) + +Apply a wave effect across QwSTPad's onboard LEDs. + + +### Pad Detect +[function/pad_detect.py](function/pad_detect.py) + +How to detect multiple QwSTPads and handle their unexpected connection and disconnection. + + +## Game Examples + +### Random Maze +[games/random_maze.py](games/random_maze.py) + +A single player QwSTPad game demo. Navigate a set of mazes from the start (red) to the goal (green). +Mazes get bigger / harder with each increase in level. +Makes use of 1 QwSTPad and a Pico Display Pack 2.0 / 2.8. + + +### Multi-Player +[games/multi_player.py](games/multi_player.py) + +A multi-player QwSTPad game demo. Each player drives a tank-like vehicle around an arena +with the goal of hitting other players with projects to get the most points. +Makes use of 1 to 4 QwSTPads and a Pico Display Pack 2.0 / 2.8. \ No newline at end of file diff --git a/examples/function/led_wave.py b/examples/function/led_wave.py index ef7c197..099a2d8 100644 --- a/examples/function/led_wave.py +++ b/examples/function/led_wave.py @@ -5,7 +5,7 @@ from qwstpad import ADDRESSES, NUM_LEDS, QwSTPad """ -Apply a wave effect across QwSTPad's onboard LEDs +Apply a wave effect across QwSTPad's onboard LEDs. """ # Constants diff --git a/examples/function/pad_detect.py b/examples/function/pad_detect.py index b76023d..634bfd5 100644 --- a/examples/function/pad_detect.py +++ b/examples/function/pad_detect.py @@ -5,7 +5,7 @@ from qwstpad import ADDRESSES, QwSTPad """ -How to detect multiple QwSTPads and handle their unexpected connection and disconnection +How to detect multiple QwSTPads and handle their unexpected connection and disconnection. """ # Constants diff --git a/examples/function/read_all.py b/examples/function/read_all.py index a4dae30..ccffbfb 100644 --- a/examples/function/read_all.py +++ b/examples/function/read_all.py @@ -5,7 +5,7 @@ from qwstpad import ADDRESSES, QwSTPad """ -How to read all of the buttons on QwSTPad +How to read all of the buttons on QwSTPad. """ # Constants diff --git a/examples/games/multi_player.py b/examples/games/multi_player.py index f906d50..b47e7ee 100644 --- a/examples/games/multi_player.py +++ b/examples/games/multi_player.py @@ -10,7 +10,7 @@ """ A multi-player QwSTPad game demo. Each player drives a tank-like vehicle around an arena with the goal of hitting other players with projects to get the most points. -Makes us of 1 to 4 QwSTPads and a Pico Display pack 2.0 / 2.8 +Makes use of 1 to 4 QwSTPads and a Pico Display Pack 2.0 / 2.8. Controls: * U = Move Forward diff --git a/examples/games/random_maze.py b/examples/games/random_maze.py index 54b0357..e8a7b0e 100644 --- a/examples/games/random_maze.py +++ b/examples/games/random_maze.py @@ -12,7 +12,7 @@ """ A single player QwSTPad game demo. Navigate a set of mazes from the start (red) to the goal (green). Mazes get bigger / harder with each increase in level. -Makes us of 1 QwSTPad and a Pico Display pack 2.0 / 2.8 +Makes use of 1 QwSTPad and a Pico Display Pack 2.0 / 2.8. Controls: * U = Move Forward