keybrd library is an open source library for creating custom-keyboard firmware.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

tutorial_9_breaking_up_a_sketch_into_smaller_files.md 2.0KB

8 yıl önce
8 yıl önce
7 yıl önce
12345678910111213141516171819202122232425262728293031
  1. Tutorial 9 - breaking up a sketch into smaller files
  2. ====================================================
  3. A keybrd sketch can become quite lengthy, which can make it harder to navigate and understand.
  4. The keybrd_DH sketch has about 800 lines of code; 700 of which are for instantiating objects.
  5. The object instantiations are grouped into six files located in the keybrd_DH library, and included in keybrd_DH.ino:
  6. // ========= INSTANTIATE THE KEYBOARD ==========
  7. #include "config.h"
  8. #include <instantiations_pins.h>
  9. #include <instantiations_scancodes.h>
  10. #include <instantiations_layercodes.h>
  11. #include <instantiations_rows_L.h>
  12. #include <instantiations_rows_R.h>
  13. Splitting your code into groups of instantiations also provides organizational and reusability benefits.
  14. Example 1.
  15. You have three versions of LED indicators you are experimenting with:
  16. * instantiations_LEDs_1.h
  17. * instantiations_LEDs_2.h
  18. * instantiations_LEDs_3.h
  19. Example 2.
  20. You use Colemak and want QWERTY users to to try your new keyboard design.
  21. So you publish your keybrd extension library with two versions of instantiations_matrix.h:
  22. * instantiations_rows_colemak.h
  23. * instantiations_rows_QWERTY.h
  24. <br>
  25. <a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">keybrd tutorial</span> by <a xmlns:cc="https://creativecommons.org/ns" href="https://github.com/wolfv6/keybrd" property="cc:attributionName" rel="cc:attributionURL">Wolfram Volpi</a> is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />Permissions beyond the scope of this license may be available at <a xmlns:cc="https://creativecommons.org/ns" href="https://github.com/wolfv6/keybrd/issues/new" rel="cc:morePermissions">https://github.com/wolfv6/keybrd/issues/new</a>.