aboutsummaryrefslogtreecommitdiff
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)
downloadqmk_firmware-d04f7bc1608d3acbf1008ae5fd7bf51ddb860ba2.tar.gz
qmk_firmware-d04f7bc1608d3acbf1008ae5fd7bf51ddb860ba2.zip
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 b7b572974..9ffbc2cba 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.
131 131
132```c 132```c
133#ifdef AUDIO_ENABLE 133#ifdef AUDIO_ENABLE
134 #define STARTUP_SONG SONG(STARTUP_SOUND) 134# define STARTUP_SONG SONG(STARTUP_SOUND)
135#endif 135#endif
136``` 136```
137 137
138A 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). 138A 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).
139 139
140Additionally, 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.
141
140To play a custom sound at a particular time, you can define a song like this (near the top of the file): 142To play a custom sound at a particular time, you can define a song like this (near the top of the file):
141 143
142```c 144```c
diff --git a/docs/feature_oled_driver.md b/docs/feature_oled_driver.md
index d2dc6103a..f3b659b1b 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);
263void oled_write_ln(const char *data, bool invert); 263void oled_write_ln(const char *data, bool invert);
264 264
265// Pans the buffer to the right (or left by passing true) by moving contents of the buffer 265// Pans the buffer to the right (or left by passing true) by moving contents of the buffer
266// Useful for moving the screen in preparation for new drawing 266// Useful for moving the screen in preparation for new drawing
267// oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static 267// oled_scroll_left or oled_scroll_right should be preferred for all cases of moving a static
268// image such as a logo or to avoid burn-in as it's much, much less cpu intensive 268// image such as a logo or to avoid burn-in as it's much, much less cpu intensive
269void oled_pan(bool left); 269void oled_pan(bool left);
270 270
271// Writes a PROGMEM string to the buffer at current cursor position
272// Advances the cursor while writing, inverts the pixels if true
273// Remapped to call 'void oled_write(const char *data, bool invert);' on ARM
274void oled_write_P(const char *data, bool invert);
275
276// Writes a PROGMEM string to the buffer at current cursor position
277// Advances the cursor while writing, inverts the pixels if true
278// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
279// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
280void oled_write_ln_P(const char *data, bool invert);
281
282// Returns a pointer to the requested start index in the buffer plus remaining 271// Returns a pointer to the requested start index in the buffer plus remaining
283// buffer length as struct 272// buffer length as struct
284oled_buffer_reader_t oled_read_raw(uint16_t start_index); 273oled_buffer_reader_t oled_read_raw(uint16_t start_index);
@@ -289,13 +278,24 @@ void oled_write_raw(const char *data, uint16_t size);
289// Writes a single byte into the buffer at the specified index 278// Writes a single byte into the buffer at the specified index
290void oled_write_raw_byte(const char data, uint16_t index); 279void oled_write_raw_byte(const char data, uint16_t index);
291 280
292// Writes a PROGMEM string to the buffer at current cursor position
293void oled_write_raw_P(const char *data, uint16_t size);
294
295// Sets a specific pixel on or off 281// Sets a specific pixel on or off
296// Coordinates start at top-left and go right and down for positive x and y 282// Coordinates start at top-left and go right and down for positive x and y
297void oled_write_pixel(uint8_t x, uint8_t y, bool on); 283void oled_write_pixel(uint8_t x, uint8_t y, bool on);
298 284
285// Writes a PROGMEM string to the buffer at current cursor position
286// Advances the cursor while writing, inverts the pixels if true
287// Remapped to call 'void oled_write(const char *data, bool invert);' on ARM
288void oled_write_P(const char *data, bool invert);
289
290// Writes a PROGMEM string to the buffer at current cursor position
291// Advances the cursor while writing, inverts the pixels if true
292// Advances the cursor to the next page, wiring ' ' to the remainder of the current page
293// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM
294void oled_write_ln_P(const char *data, bool invert);
295
296// Writes a PROGMEM string to the buffer at current cursor position
297void oled_write_raw_P(const char *data, uint16_t size);
298
299// Can be used to manually turn on the screen if it is off 299// Can be used to manually turn on the screen if it is off
300// Returns true if the screen was on or turns on 300// Returns true if the screen was on or turns on
301bool oled_on(void); 301bool oled_on(void);