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_7b_creating_and_publishing_your_own_keybrd_extension_library.md 3.2KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. Tutorial 7b - creating and publishing your own keybrd extension library
  2. =======================================================================
  3. Listing your keybrd extension library allows others to find and install your library.
  4. The keybrd extension library name should start with "keybrd_" so that it is easy for people to find.
  5. The directory structure of the library depends on where it will be listed.
  6. ## Publishing anywhere with listing on Arduino Playground LibraryList
  7. Arduino Playground LibraryList can list a library with any directory structure.
  8. The directory structure of your keybrd extension library can be as simple as:
  9. keybrd_MyKeyboard/
  10. class1.cpp
  11. class1.h
  12. class2.cpp
  13. class2.h
  14. ..
  15. instantiations_codes.h
  16. instantiations_ports.h
  17. instantiations_matrix.h
  18. doc/
  19. keybrd_MyKeyboard_guide
  20. examples/
  21. keybrd_MyKeyboard1/
  22. keybrd_MyKeyboard1.ino
  23. keybrd_MyKeyboard2/
  24. keybrd_MyKeyboard2.ino
  25. [Arduino playground](http://playground.arduino.cc/) is a wiki.
  26. Instructions for listing a library on the Arduino playgound LibraryList are at:
  27. http://playground.arduino.cc/Code/Library#Sharing
  28. Add your keybrd library to the Keyboard/Keypads sublist:
  29. http://playground.arduino.cc/Main/InterfacingWithHardware#keyb
  30. ## Publishing on GitHub with listing on Arduino Library-Manager and Arduino Playground LibraryList
  31. The advantage of using GitHub is that users can submit pull requests.
  32. The advantage of using Arduino Library-Manager is that users can install your library through the Arduino IDE.
  33. Arduino Library-Manager is particular about directory structures it accepts.
  34. The directory structure of your keybrd extension library to look like this:
  35. keybrd_MyKeyboard/
  36. library.properties
  37. doc/
  38. keybrd_MyKeyboard_guide
  39. examples/
  40. keybrd_MyKeyboard1/
  41. keybrd_MyKeyboard1.ino
  42. keybrd_MyKeyboard2/
  43. keybrd_MyKeyboard2.ino
  44. src/
  45. class1.cpp
  46. class1.h
  47. class2.cpp
  48. class2.h
  49. ..
  50. instantiations_codes.h
  51. instantiations_ports.h
  52. instantiations_matrix.h
  53. The library.properties file is described in
  54. https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification
  55. Example library.properties file:
  56. name=keybrd_MyKeyboard
  57. version=1.2.3
  58. author=Me
  59. maintainer=Me
  60. sentence=An extension to the keybrd library for the My keyboard.
  61. paragraph=This library demonstrates my feature.
  62. category=Device Control
  63. url=https://github.com/Me/keybrd_MyKeyboard
  64. architectures=Teensy LC
  65. Instructions for listing a library on Arduino Library Manager are at:
  66. https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ
  67. After it has been accepted into the Arduino IDE Library Manager, add your library to the Arduino Playground LibraryList.
  68. [Arduino playground](http://playground.arduino.cc/) is a wiki.
  69. Sign in at http://playground.arduino.cc/Main/LibraryList and add keybrd libraries to Keyboard/Keypads sublist:
  70. http://playground.arduino.cc/Main/InterfacingWithHardware#keyb