kopia lustrzana https://github.com/pimoroni/pimoroni-pico
Updated GU readme
ZodiusInfuser
GitHub
rodzic
c2b695f7e9
commit
d11c73d45e
|
|
@ -1,7 +1,9 @@
|
|||
# Galactic Unicorn <!-- omit in toc -->
|
||||
# Galactic Unicorn (C/C++)<!-- omit in toc -->
|
||||
|
||||
Galactic Unicorn offers 53x11 bright RGB LEDs driven by Pico W's PIO in addition to a 1W amplifier + speaker, a collection of system and user buttons, and two Qw/ST connectors for adding external sensors and devices. Woha!
|
||||
|
||||
You can buy one here: https://shop.pimoroni.com/products/galactic-unicorn
|
||||
|
||||
## These are not your everyday RGB LEDs!
|
||||
|
||||
Internally Galactic Unicorn applies gamma correction to the supplied image data and updates the display with 14-bit precision resulting in extremely linear visual output - including at the low end.
|
||||
|
|
@ -17,9 +19,9 @@ The Galactic Unicorn library provides a collection of methods that allow you to
|
|||
Drawing is primarily handled via our [PicoGraphics](https://github.com/pimoroni/pimoroni-pico/tree/main/libraries/pico_graphics) library which provides a comprehensive selection of drawing methods - once your drawing work is complete you pass the PicoGraphics object to Galactic Unicorn to have it displayed on the screen.
|
||||
|
||||
- [Example Program](#example-program)
|
||||
- [Interleaved framebuffer](#interleaved-framebuffer)
|
||||
- [Interleaved Framebuffer](#interleaved-framebuffer)
|
||||
- [Function Reference](#function-reference)
|
||||
- [System state](#system-state)
|
||||
- [System State](#system-state)
|
||||
- [`void init()`](#void-init)
|
||||
- [`void set_brightness(float value)`](#void-set_brightnessfloat-value)
|
||||
- [`float get_brightness()`](#float-get_brightness)
|
||||
|
|
@ -55,7 +57,7 @@ The following example shows how to scroll a simple message across the display.
|
|||
using namespace pimoroni;
|
||||
|
||||
// create a PicoGraphics framebuffer to draw into
|
||||
PicoGraphics_PenRGB888 graphics(53, 11, nullptr);
|
||||
PicoGraphics_PenRGB888 graphics(GalacticUnicorn::WIDTH, GalacticUnicorn::HEIGHT, nullptr);
|
||||
|
||||
// create our GalacticUnicorn object
|
||||
GalacticUnicorn galactic_unicorn;
|
||||
|
|
@ -71,14 +73,14 @@ int main() {
|
|||
galactic_unicorn.init();
|
||||
|
||||
// start position for scrolling (off the side of the display)
|
||||
float scroll = -53.0f;
|
||||
float scroll = -(float)GalacticUnicorn::WIDTH;
|
||||
|
||||
while(true) {
|
||||
// determine the scroll position of the text
|
||||
int width = graphics.measure_text(message, 1);
|
||||
scroll += 0.25f;
|
||||
if(scroll > width) {
|
||||
scroll = -53.0f;
|
||||
scroll = -(float)GalacticUnicorn::WIDTH;
|
||||
}
|
||||
|
||||
// clear the graphics object
|
||||
|
|
@ -99,7 +101,7 @@ int main() {
|
|||
}
|
||||
```
|
||||
|
||||
# Interleaved framebuffer
|
||||
# Interleaved Framebuffer
|
||||
|
||||
Galactic Unicorn takes advantage of the RP2040's PIOs to drive screen updates - this is what gives it the performance it needs to render with 14-bit precision at over 300 frames per second.
|
||||
|
||||
|
|
@ -123,7 +125,7 @@ If you're working with our library then you don't need to worry about any of the
|
|||
|
||||
# Function Reference
|
||||
|
||||
## System state
|
||||
## System State
|
||||
|
||||
### `void init()`
|
||||
|
||||
|
|
@ -131,15 +133,15 @@ Initialise the Galactic Unicorn hardware, interleaved framebuffer, and PIO progr
|
|||
|
||||
### `void set_brightness(float value)`
|
||||
|
||||
Set the brightness - `value` is supplied as a floating point value between `0..1`.
|
||||
Set the brightness - `value` is supplied as a floating point value between `0.0` and `1.0`.
|
||||
|
||||
### `float get_brightness()`
|
||||
|
||||
Returns the current brightness as a value between `0..1`.
|
||||
Returns the current brightness as a value between `0.0` to `1.0`.
|
||||
|
||||
### `void adjust_brightness(float delta)`
|
||||
|
||||
Adjust the brightness of the display - `delta` is supplied as a floating point value and will be added to the current brightness (and then clamped to the range `0..1`).
|
||||
Adjust the brightness of the display - `delta` is supplied as a floating point value and will be added to the current brightness (and then clamped to the range `0.0` to `1.0`).
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -152,15 +154,15 @@ galactic.adjust_brightness(-0.2f); // brightness is now 0.8
|
|||
|
||||
### `void set_volume(float value)`
|
||||
|
||||
Set the volume - `value` is supplied as a floating point value between `0..1`.
|
||||
Set the volume - `value` is supplied as a floating point value between `0.0` and `1.0`.
|
||||
|
||||
### `float get_volume()`
|
||||
|
||||
Returns the current volume as a value between `0..1`.
|
||||
Returns the current volume as a value between `0.0` and `1.0`.
|
||||
|
||||
### `void adjust_volume(float delta)`
|
||||
|
||||
Adjust the volume - `delta` is supplied as a floating point value and will be added to the current volume (and then clamped to the range `0..1`).
|
||||
Adjust the volume - `delta` is supplied as a floating point value and will be added to the current volume (and then clamped to the range `0.0` to `1.0`).
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -173,7 +175,7 @@ galactic.adjust_volume(-0.2f); // volume is now 0.8
|
|||
|
||||
### `uint16_t light()`
|
||||
|
||||
Get the current value seen by the onboard light sensor as a value between `0...4096`.
|
||||
Get the current value seen by the onboard light sensor as a value between `0` and `4095`.
|
||||
|
||||
### `bool is_pressed(uint8_t button)`
|
||||
|
||||
|
|
@ -196,7 +198,7 @@ static const uint8_t SWITCH_BRIGHTNESS_DOWN = 26;
|
|||
For example:
|
||||
|
||||
```c++
|
||||
while(!galactic.is_pressed(GalacticUnicorn.SWITCH_A)) {
|
||||
while(!galactic.is_pressed(GalacticUnicorn::SWITCH_A)) {
|
||||
// wait for switch A to be pressed
|
||||
}
|
||||
printf("We did it! We pressed switch A! Heck yeah!");
|
||||
|
|
@ -208,21 +210,25 @@ printf("We did it! We pressed switch A! Heck yeah!");
|
|||
|
||||
**This is our recommended way to update the image on Galactic Unicorn.** The PicoGraphics library provides a collection of powerful drawing methods to make things simple.
|
||||
|
||||
The image on the PicoGraphics object provided is copied to the interleaved framebuffer with gamma correction applied.
|
||||
The image on the PicoGraphics object provided is copied to the interleaved framebuffer with gamma correction applied. This lets you have multiple PicoGraphics objects on the go at once and switch between them by changing which gets passed into this function.
|
||||
|
||||
If however you'd rather twiddle individual pixels (for example you're producing some sort of algorithmic output) then you can simply use the `clear()` and `update()` methods mentioned below.
|
||||
If however you'd rather twiddle individual pixels (for example you're producing some sort of algorithmic output) then you can simply use the `clear()` and `set_pixel()` methods mentioned below.
|
||||
|
||||
### `void clear()`
|
||||
|
||||
Clear the contents of the interleaved framebuffer. If you're using PicoGraphics to build your image (recommended!) then you won't need to call this method as you'll overwrite the entire dispaly when you call `update()` anyway.
|
||||
Clear the contents of the interleaved framebuffer. This will make your Galactic Unicorn display turn off when the next frame is displayed.
|
||||
|
||||
If you're using PicoGraphics to build your image (recommended!) then you won't need to call this method as you'll overwrite the entire display when you call `update()` anyway.
|
||||
|
||||
### `void set_pixel(int x, int y, uint8_t r, uint8_t g, uint8_t b)`
|
||||
|
||||
Set a single pixel to the specified colour. Pixel coordinates go from `0..52` along the `x` axis and from `0..10` on the `y` axis. Colour values are specified as a `0..255` RGB triplet - the supplied colour will be gamma corrected automatically.
|
||||
Set a single pixel to the specified colour. The newly set colour will be shown at the next frame. Pixel coordinates go from `0` to `52` along the `x` axis and from `0` to `10` on the `y` axis. Colour values are specified as a `0` to `255` RGB triplet - the supplied colour will be gamma corrected automatically.
|
||||
|
||||
When drawing a full image it's recommended that you keep the time between each `set_pixel` call short to ensure your image gets displayed on the next frame. Otherwise you can get scanning-like visual artefacts (unless that is your intention of course!)
|
||||
|
||||
## Audio
|
||||
|
||||
Audio functionality is supported by our [PicoSynth library](https://github.com/pimoroni/pimoroni-pico/tree/main/libraries/pico_synth) which allows you to create multiple voice channels with ADSR envelopes. It provides a similar set of functionality to the classic SID chip in the Commodore 64.
|
||||
Audio functionality is supported by our [PicoSynth library](https://github.com/pimoroni/pimoroni-pico/tree/main/libraries/pico_synth) which allows you to create multiple voice channels with ADSR (attack decay sustain release) envelopes. It provides a similar set of functionality to the classic SID chip in the Commodore 64.
|
||||
|
||||
### `void play_sample(uint8_t *data, uint32_t length)`
|
||||
|
||||
|
|
@ -240,7 +246,6 @@ Start the synth playing.
|
|||
|
||||
Stops any currently playing audio.
|
||||
|
||||
|
||||
## Constants
|
||||
|
||||
### `WIDTH` & `HEIGHT`
|
||||
|
|
@ -250,5 +255,5 @@ The width and height of Galactic Unicorn are available in constants `WIDTH` and
|
|||
For example:
|
||||
|
||||
```c++
|
||||
int num_pixels = GalacticUnicorn.WIDTH * GalacticUnicorn.HEIGHT;
|
||||
int num_pixels = GalacticUnicorn::WIDTH * GalacticUnicorn::HEIGHT;
|
||||
```
|
||||
|
|
@ -104,9 +104,7 @@ namespace pimoroni {
|
|||
float get_volume();
|
||||
void adjust_volume(float delta);
|
||||
|
||||
private:
|
||||
void set_pixel(int x, int y, uint8_t r, uint8_t g, uint8_t b);
|
||||
public:
|
||||
|
||||
uint16_t light();
|
||||
|
||||
|
|
|
|||
|
|
@ -16,13 +16,13 @@ No strobing or brightness stepping here folks - it's the perfect backdrop for yo
|
|||
|
||||
The Galactic Unicorn library provides a collection of methods that allow you to easily access all of the features on the board.
|
||||
|
||||
Drawing is primarily handled via our [PicoGraphics](https://github.com/pimoroni/pimoroni-pico/tree/main/micropython/modules/picographics) library which provides a comprehensive selection of drawing methods - once your drawing work is complete you pass the PicoGraphics object to Galactic Unicorn to have it displayed on the screen.
|
||||
Drawing is primarily handled via our [PicoGraphics]https://github.com/pimoroni/pimoroni-pico/tree/main/micropython/modules/picographics) library which provides a comprehensive selection of drawing methods - once your drawing work is complete you pass the PicoGraphics object to Galactic Unicorn to have it displayed on the screen.
|
||||
|
||||
- [Example Program](#example-program)
|
||||
- [Interleaved framebuffer](#interleaved-framebuffer)
|
||||
- [Interleaved Framebuffer](#interleaved-framebuffer)
|
||||
- [Function Reference](#function-reference)
|
||||
- [Imports and objects](#imports-and-objects)
|
||||
- [System state](#system-state)
|
||||
- [Imports and Objects](#imports-and-objects)
|
||||
- [System State](#system-state)
|
||||
- [`set_brightness(value)`](#set_brightnessvalue)
|
||||
- [`get_brightness()`](#get_brightness)
|
||||
- [`adjust_brightness(delta)`](#adjust_brightnessdelta)
|
||||
|
|
@ -33,11 +33,13 @@ Drawing is primarily handled via our [PicoGraphics](https://github.com/pimoroni/
|
|||
- [`is_pressed(button)`](#is_pressedbutton)
|
||||
- [Drawing](#drawing)
|
||||
- [`update(PicoGraphics)`](#updatepicographics)
|
||||
- [`clear()`](#clear)
|
||||
- [Audio](#audio)
|
||||
- [`play_sample(data, length)`](#play_sampledata-length)
|
||||
- [`synth_channel(channel)`](#synth_channelchannel)
|
||||
- [`play_synth()`](#play_synth)
|
||||
- [`stop_playing()`](#stop_playing)
|
||||
- [Channel Function Reference](#channel_function_reference)
|
||||
- [Constants](#constants)
|
||||
- [`WIDTH` & `HEIGHT`](#width--height)
|
||||
- [Using Breakouts](#using-breakouts)
|
||||
|
|
@ -58,7 +60,7 @@ graphics = PicoGraphics(display=DISPLAY_GALACTIC_UNICORN)
|
|||
gu = GalacticUnicorn()
|
||||
|
||||
# start position for scrolling (off the side of the display)
|
||||
scroll = -53.0
|
||||
scroll = float(-GalacticUnicorn.WIDTH)
|
||||
|
||||
# message to scroll
|
||||
MESSAGE = "Pirate. Monkey. Robot. Ninja."
|
||||
|
|
@ -72,7 +74,7 @@ while True:
|
|||
width = graphics.measure_text(MESSAGE, 1)
|
||||
scroll += 0.25
|
||||
if scroll > width:
|
||||
scroll = -53.0
|
||||
scroll = float(-GalacticUnicorn.WIDTH)
|
||||
|
||||
# clear the graphics object
|
||||
graphics.set_pen(BLACK)
|
||||
|
|
@ -88,7 +90,7 @@ while True:
|
|||
time.sleep(0.02)
|
||||
```
|
||||
|
||||
# Interleaved framebuffer
|
||||
# Interleaved Framebuffer
|
||||
|
||||
Galactic Unicorn takes advantage of the RP2040's PIOs to drive screen updates - this is what gives it the performance it needs to render with 14-bit precision at over 300 frames per second.
|
||||
|
||||
|
|
@ -112,7 +114,7 @@ If you're working with our library then you don't need to worry about any of the
|
|||
|
||||
# Function Reference
|
||||
|
||||
## Imports and objects
|
||||
## Imports and Objects
|
||||
|
||||
To access these functions, you'll need to first `import` the relevant libraries and then set up a Galactic Unicorn object:
|
||||
|
||||
|
|
@ -132,19 +134,19 @@ gu = GalacticUnicorn()
|
|||
graphics = PicoGraphics(display=DISPLAY_GALACTIC_UNICORN)
|
||||
```
|
||||
|
||||
## System state
|
||||
## System State
|
||||
|
||||
### `set_brightness(value)`
|
||||
|
||||
Set the brightness - `value` is supplied as a floating point value between `0..1`.
|
||||
Set the brightness - `value` is supplied as a floating point value between `0.0` and `1.0`.
|
||||
|
||||
### `get_brightness()`
|
||||
|
||||
Returns the current brightness as a value between `0..1`.
|
||||
Returns the current brightness as a value between `0.0` and `1.0`.
|
||||
|
||||
### `adjust_brightness(delta)`
|
||||
|
||||
Adjust the brightness of the display - `delta` is supplied as a floating point value and will be added to the current brightness (and then clamped to the range `0..1`).
|
||||
Adjust the brightness of the display - `delta` is supplied as a floating point value and will be added to the current brightness (and then clamped to the range `0.0` to `1.0`).
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -157,15 +159,15 @@ gu.adjust_brightness(-0.2) # brightness is now 0.8
|
|||
|
||||
### `set_volume(value)`
|
||||
|
||||
Set the volume - `value` is supplied as a floating point value between `0..1`.
|
||||
Set the volume - `value` is supplied as a floating point value between `0.0` and `1.0`.
|
||||
|
||||
### `get_volume()`
|
||||
|
||||
Returns the current volume as a value between `0..1`.
|
||||
Returns the current volume as a value between `0.0` and `1.0`.
|
||||
|
||||
### `adjust_volume(delta)`
|
||||
|
||||
Adjust the volume - `delta` is supplied as a floating point value and will be added to the current volume (and then clamped to the range `0..1`).
|
||||
Adjust the volume - `delta` is supplied as a floating point value and will be added to the current volume (and then clamped to the range `0.0` to `1.0`).
|
||||
|
||||
For example:
|
||||
|
||||
|
|
@ -178,7 +180,7 @@ gu.adjust_volume(-0.2) # volume is now 0.8
|
|||
|
||||
### `light()`
|
||||
|
||||
Get the current value seen by the onboard light sensor as a value between `0...4096`.
|
||||
Get the current value seen by the onboard light sensor as a value between `0` and `4095`.
|
||||
|
||||
### `is_pressed(button)`
|
||||
|
||||
|
|
@ -201,38 +203,44 @@ SWITCH_BRIGHTNESS_DOWN = 26
|
|||
For example:
|
||||
|
||||
```python
|
||||
while gu.is_pressed(gu.SWITCH_A):
|
||||
while not gu.is_pressed(GalacticUnicorn.SWITCH_A):
|
||||
# wait for switch A to be pressed
|
||||
print("We did it! We pressed switch A! Heck yeah!")
|
||||
pass
|
||||
|
||||
print("We did it! We pressed switch A! Heck yeah!")
|
||||
```
|
||||
|
||||
## Drawing
|
||||
|
||||
### `update(PicoGraphics)`
|
||||
|
||||
**This is our recommended way to update the image on Galactic Unicorn.** The PicoGraphics library provides a collection of powerful drawing methods to make things simple.
|
||||
The PicoGraphics library provides a collection of powerful drawing methods to make things simple.
|
||||
|
||||
The image on the PicoGraphics object provided is copied to the interleaved framebuffer with gamma correction applied.
|
||||
|
||||
For example (assuming you've set up your Galactic Unicorn and PicoGraphics objects up as [we did above](#imports-and-objects)):
|
||||
For example (assuming you've set up your Galactic Unicorn and PicoGraphics objects up [as we did above](#imports-and-objects)):
|
||||
|
||||
```python
|
||||
gu.update(graphics)
|
||||
gu.update(graphics)
|
||||
```
|
||||
|
||||
⚠️ If you've used PicoGraphics on our other boards note that this `update` function works a little differently (here it's a Galactic Unicorn function to which you need to pass a PicoGraphics object).
|
||||
⚠️ If you've used PicoGraphics on our other boards note that this `update` function works a little differently. Here it's a Galactic Unicorn function to which you need to pass a PicoGraphics object to.
|
||||
|
||||
### `void clear()`
|
||||
|
||||
Clear the contents of the interleaved framebuffer. This will make your Galactic Unicorn display turn off. To show an image again, call the `update()` function as described above.
|
||||
|
||||
## Audio
|
||||
|
||||
Audio functionality is supported by our [PicoSynth library](https://github.com/pimoroni/pimoroni-pico/tree/main/libraries/pico_synth) which allows you to create multiple voice channels with ADSR envelopes. It provides a similar set of functionality to the classic SID chip in the Commodore 64.
|
||||
Audio functionality is supported by our [PicoSynth library](https://github.com/pimoroni/pimoroni-pico/tree/main/libraries/pico_synth) which allows you to create multiple voice channels with ADSR (attack decay sustain release) envelopes. It provides a similar set of functionality to the classic SID chip in the Commodore 64.
|
||||
|
||||
### `play_sample(data, length)`
|
||||
### `play_sample(data)`
|
||||
|
||||
Play the provided 16-bit audio sample. `data` must point to a buffer that contains 16-bit PCM data and `length` must be the number of samples.
|
||||
Play the provided 16-bit audio sample. `data` must point to a `bytearray` that contains 16-bit PCM data. The number of samples is retrieved from the array's length.
|
||||
|
||||
### `synth_channel(channel)`
|
||||
|
||||
Gets an `AudioChannel` object which can then be configured with voice, ADSR envelope, etc.
|
||||
Gets a `Channel` object which can then be configured with voice, ADSR envelope, etc.
|
||||
|
||||
### `play_synth()`
|
||||
|
||||
|
|
@ -242,6 +250,34 @@ Start the synth playing.
|
|||
|
||||
Stops any currently playing audio.
|
||||
|
||||
### Channel Function Reference
|
||||
|
||||
```python
|
||||
configure(waveforms=None, frequency=None, volume=None,
|
||||
attack=None, decay=None, sustain=None,
|
||||
release=None, pulse_width=None)
|
||||
restore()
|
||||
waveforms()
|
||||
waveforms(waveforms)
|
||||
frequency()
|
||||
frequency(frequency)
|
||||
volume()
|
||||
volume(volume)
|
||||
attack_duration()
|
||||
attack_duration(duration)
|
||||
decay_duration()
|
||||
decay_duration(duration)
|
||||
sustain_level()
|
||||
sustain_level(level)
|
||||
release_duration()
|
||||
release_duration(duration)
|
||||
pulse_width()
|
||||
pulse_width(width)
|
||||
trigger_attack() # start the channel playing
|
||||
trigger_release() # stop the channel playing
|
||||
play_tone(frequency, volume=None, attack=None, release=None)
|
||||
```
|
||||
|
||||
## Constants
|
||||
|
||||
### `WIDTH` & `HEIGHT`
|
||||
|
|
@ -251,7 +287,7 @@ The width and height of Galactic Unicorn are available in constants `WIDTH` and
|
|||
For example:
|
||||
|
||||
```python
|
||||
num_pixels = gu.WIDTH * gu.HEIGHT
|
||||
num_pixels = GalacticUnicorn.WIDTH * GalacticUnicorn.HEIGHT
|
||||
print(num_pixels)
|
||||
```
|
||||
|
||||
|
|
@ -275,5 +311,5 @@ Alternatively, you can specify the pin numbers directly:
|
|||
```python
|
||||
from pimoroni_i2c import PimoroniI2C
|
||||
|
||||
i2c = PimoroniI2C(sda=(4), scl=(5))
|
||||
i2c = PimoroniI2C(sda=4, scl=5)
|
||||
```
|
||||
Ładowanie…
Reference in New Issue