docs/feature_dip_switch.md

   1 # DIP Switches
   2
   3 DIP switches are supported by adding this to your `rules.mk`:
   4
   5     DIP_SWITCH_ENABLE = yes
   6
   7 and this to your `config.h`:
   8
   9 ```c
  10 #define DIP_SWITCH_PINS { B14, A15, A10, B9 }
  11 ```
  12
  13 ## Callbacks
  14
  15 The callback functions can be inserted into your `<keyboard>.c`:
  16
  17 ```c
  18 void dip_switch_update_kb(uint8_t index, bool active) {
  19     dip_switch_update_user(index, active);
  20 }
  21 ```
  22
  23
  24 or `keymap.c`:
  25
  26 ```c
  27 void dip_switch_update_user(uint8_t index, bool active) {
  28     switch (index) {
  29         case 0:
  30             if(active) { audio_on(); } else { audio_off(); }
  31             break;
  32         case 1:
  33             if(active) { clicky_on(); } else { clicky_off(); }
  34             break;
  35         case 2:
  36             if(active) { music_on(); } else { music_off(); }
  37             break;
  38         case 3:
  39             if (active) {
  40                 #ifdef AUDIO_ENABLE
  41                     PLAY_SONG(plover_song);
  42                 #endif
  43                 layer_on(_PLOVER);
  44             } else {
  45                 #ifdef AUDIO_ENABLE
  46                     PLAY_SONG(plover_gb_song);
  47                 #endif
  48                 layer_off(_PLOVER);
  49             }
  50             break;
  51     }
  52 }
  53 ```
  54
  55 Additionally, we support bit mask functions which allow for more complex handling.
  56
  57
  58 ```c
  59 void dip_switch_update_mask_kb(uint32_t state) {
  60     dip_switch_update_mask_user(state);
  61 }
  62 ```
  63
  64
  65 or `keymap.c`:
  66
  67 ```c
  68 void dip_switch_update_mask_user(uint32_t state) {
  69     if (state & (1UL<<0) && state & (1UL<<1)) {
  70         layer_on(_ADJUST); // C on esc
  71     } else {
  72         layer_off(_ADJUST);
  73     }
  74     if (state & (1UL<<0)) {
  75         layer_on(_TEST_A); // A on ESC
  76     } else {
  77         layer_off(_TEST_A);
  78     }
  79     if (state & (1UL<<1)) {
  80         layer_on(_TEST_B); // B on esc
  81     } else {
  82         layer_off(_TEST_B);
  83     }
  84 }
  85 ```
  86
  87
  88 ## Hardware
  89
  90 One side of the DIP switch should be wired directly to the pin on the MCU, and the other side to ground.  It should not matter which side is connected to which, as it should be functionally the same.