summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2021-06-17 17:22:01 +1000
committerfauxpark <fauxpark@gmail.com>2021-06-17 17:22:01 +1000
commitd04f7bc1608d3acbf1008ae5fd7bf51ddb860ba2 (patch)
tree2f80fbe3f516acdf50050579b87a23beb9091680 /docs
parent9956ff4e031b33c5e1fe1ff6ee44885f1080d966 (diff)
parent2f08a343948c6db3c67505f8fca5fdbfed41831b (diff)
Merge remote-tracking branch 'upstream/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_audio.md4
-rw-r--r--docs/feature_oled_driver.md30
2 files changed, 18 insertions, 16 deletions
diff --git a/docs/feature_audio.md b/docs/feature_audio.md
index b7b572974f..9ffbc2cba8 100644
--- a/docs/feature_audio.md
+++ b/docs/feature_audio.md
@@ -131,12 +131,14 @@ You can override the default songs by doing something like this in your `config.
```c
#ifdef AUDIO_ENABLE
- #define STARTUP_SONG SONG(STARTUP_SOUND)
+# define STARTUP_SONG SONG(STARTUP_SOUND)
#endif
```
A full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).
+Additionally, if you with to maintain your own list of songs (such as ones that may be copyrighted) and not have them added to the repo, you can create a `user_song_list.h` file and place it in your keymap (or userspace) folder. This file will be automatically included, it just needs to exist.
+
To play a custom sound at a particular time, you can define a song like this (near the top of the file):
```c
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
index d2dc6103a6..f3b659b1bc 100644
--- a/docs/feature_oled_driver.md
+++ b/docs/feature_oled_driver.md
@@ -263,22 +263,11 @@ void oled_write(const char *data, bool invert);
void oled_write_ln(const char *data, bool invert);
// Pans the buffer to the right (or left by passing true) by moving contents of the buffer
-// Useful for moving the screen in preparation for new drawing
+// Useful for moving the screen in preparation for new drawing
// oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static
// image such as a logo or to avoid burn-in as it's much, much less cpu intensive
void oled_pan(bool left);
-// Writes a PROGMEM string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Remapped to call 'void oled_write(const char *data, bool invert);' on ARM
-void oled_write_P(const char *data, bool invert);
-
-// Writes a PROGMEM string to the buffer at current cursor position
-// Advances the cursor while writing, inverts the pixels if true
-// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
-// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
-void oled_write_ln_P(const char *data, bool invert);
-
// Returns a pointer to the requested start index in the buffer plus remaining
// buffer length as struct
oled_buffer_reader_t oled_read_raw(uint16_t start_index);
@@ -289,13 +278,24 @@ void oled_write_raw(const char *data, uint16_t size);
// Writes a single byte into the buffer at the specified index
void oled_write_raw_byte(const char data, uint16_t index);
-// Writes a PROGMEM string to the buffer at current cursor position
-void oled_write_raw_P(const char *data, uint16_t size);
-
// Sets a specific pixel on or off
// Coordinates start at top-left and go right and down for positive x and y
void oled_write_pixel(uint8_t x, uint8_t y, bool on);
+// Writes a PROGMEM string to the buffer at current cursor position
+// Advances the cursor while writing, inverts the pixels if true
+// Remapped to call 'void oled_write(const char *data, bool invert);' on ARM
+void oled_write_P(const char *data, bool invert);
+
+// Writes a PROGMEM string to the buffer at current cursor position
+// Advances the cursor while writing, inverts the pixels if true
+// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
+// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
+void oled_write_ln_P(const char *data, bool invert);
+
+// Writes a PROGMEM string to the buffer at current cursor position
+void oled_write_raw_P(const char *data, uint16_t size);
+
// Can be used to manually turn on the screen if it is off
// Returns true if the screen was on or turns on
bool oled_on(void);