ErgoDox

De Disposition de clavier bépo

Présentation

ErgoDox.png

Site internet du projet : http://ergodox.org

Le projet s'est inspiré d'un projet déjà existant http://www.key64.org. Vous pouvez retracer l'historique du projet en lisant le fil d'origine sur :

Achat

Plusieurs sites vous propose des kits complet pour vous permettre de monter votre clavier. Sachez qu'il faut compter un budget minimum de 200€ pour faire l'acquisition d'un modèle neuf. Un fil sur le forum vous détail tout cela.

Massdrop

Le plus connu et le plus ancien revendeur de kit. Selon le principe du site on ne peut commander que quand un nombre suffisant de personne en fait la demande (200) et le prix diminue suivant le nombre d'acheteur après une certaine période. Pour la page des commandes c'est , ils proposent pas mal d'option de personnalisation (switch, repose poignet, …). Ils proposent pas mal d’accessoire autour du produit donc il ne faut pas hésiter a fouiller un peu le site pour trouver son bonheur, par exemple :

Pour la personnalisation de la disposition ils proposent aussi un configurateur en ligne qui permet de faire ses première armes.

A savoir qu'ils propose aussi une version évolué, infinity. Chaque partie est autonome, inclue un écrans LCD, une conception simplifié, bien moins de composant a souder, connexion des 2 partie via USB, …

Falbatech

Site plus classique de commande, basé en Pologne. Des bépoïste ont déjà expérimenté cette boutique et ils en sont content.

A noter que Falbatech propose aussi des service de montage partiel ou complet ce qui peut être rassurant pour les moins bricoleurs. Ils proposent aussi pas mal d'accessoire en tout genre et les prix sont raisonnable.

Personnalisation

Capuchons

Si vous n'avez pas pris les capuchons lors de votre achat ou que vous souhaitez en changer vous pouvez vous tourner vers des sites tel que :

Sinon il y a une page plus complète de revendeur ici : https://www.reddit.com/r/MechanicalKeyboards/wiki/keycapsellers

Disposition

Pour cela vous avez le choix entre utiliser le configurateur web que massdrop met a disposition (vous pouvez l'utiliser même si vous n'avez pas acheté chez eux). Soit passer par la compilation maison pour profiter des avantages des derniers firmware ou des alternatif. Ils apportent des fonctionnalités supplémentaires comme les touches de média, copier/couper/coller, etc. La procédure n'est pas des plus compliqué.

Il existe sur le forum un fil regroupant toutes les propositions d'adaptation du Bépo sur ce clavier. Vous pouvez librement reprendre le travail fait par les contributeur pour vous faire une base rapidement et le personnaliser a votre convenance.

Reprogramation

Nous allons voir les manière possible de configurer la disposition de votre ErgoDox.

1 Configurateur Massdrop

C'est l'interface la plus conviviale pour se faire une première disposition personnalisé sans trop mettre les main dans les lignes de code.Pour cela il vous suffit d'aller sur le site adéquate, de charger la configuration par défaut et de faire vos petits arrangement.

Massdrop load.png

Pour vous mettre le pied à l'étrillé voilà un lien qui vous donneras une disposition de base. ATTENTION, vous remarquerez que la disposition globale des touches est en QWERTY et non Bépo comme l'on pourrais s'y attendre. La raison est que le clavier n'envoie que des code de touches à votre OS et que c'est le driver qui va faire la traduction vers une disposition ou une autre. Donc n'essayez surtout pas de refaire un Bépo dans cette interface, seulement déplacer les touches qui vous sont proposés.

Vous avez aussi la possibilité de sauvegarder vos œuvre et de les modifier plus tard. Pour cela il vous suffit d'utiliser les boutons «save» et «load» de l'outil.

1bis Compilation

C'est la face nord pour la personnalisation mais clairement celle qui offre le plus de possibilités! Cependant il n'y a rien de bien compliqué car le travail est tout pré-mâché et il ne vous reste plus qu'a modifier un fichier et lancer quelques lignes de commande. D'abord on s'install les outils qui nous seront utile :

sudo apt-get install avr-libc g++ gcc

Ensuite on télécharge les sources : Le dépot de référence est celui de TMK mais il est générique a beaucoup de clavier programmable. Donc des fork sont plus spécialisé pour l'Ergodox comme celui de Cub-uanic ou celui de Jack Humbert. Il y a aussi le dépot de Benblazak qui est une autre alternative.

Pour notre exemple nous allons rester avec celui de Jack Humbert qui est légèrement plus populaire que celui de Cub-uanic et a un fichier de d'entête permettant la configuration simplifié pour le bépo.

On récupère les sources via :

wget https://github.com/jackhumbert/tmk_keyboard/archive/master.zip
unzip tmk_keyboard-master.zip

ou en clonant le dépot git :

git clone https://github.com/jackhumbert/tmk_keyboard.git

Ensuite il est préférable de se faire son propre répertoire pour sa futur disposition :

cd tmk_keyboard/keyboard/ergodox_ez/keymaps/
cp default bepo
vi bepo/keymap.c

Puis on personnalise le fichier «keymap.c» qui se trouve dans le répertoire nouvellement créé. Vous pouvez vous inspirer des diverses disposition présente. Sinon sur le forum vous en trouverez pour le Bépo, attention la plus part sont pour Cub-uain, des adaptations sont peut être nécessaire. Sinon un exemple est disponible ici

Alors pourquoi ergodox_ez alors que l'on parle de l'Ergodox «tout court». Il s'agit juste d'une version commerciale de l'Ergodox original, électroniquement il n'y a aucun changement, rien que du cosmétique et packaging. Vous pouvez aller voir le site ici

Ensuite on vérifie que l'on a bien les dépendances suivante pour la cross compilation :

  • gcc-avr
  • binutils-avr
  • avr-libc

Et enfin place la variable «export KEYMAP=bepo» pour que la compilation prenne bien le répertoire que l'on a créé, puis avec un simple «make» en se plaçant dans le répertoire «keyboard/ergodox_ez» on récupère le fichier «ergodox_ez.hex» dans le même répertoire qui sera chargé dans le clavier (voir § suivant).

Vous allez me dire pourquoi s'embêter a le faire à la main si un utilitaire graphique nous le fait ? Et bien l'outil de Massdrop n'est pas basé sur le dernier firmware disponible et certaines touches spéciales ne sont pas fonctionnelles, comme copier/couper/coller, volume+/-, … donc oui le jeu en vaut largement la chandelle.

Astuces

Dans le fichier «config.h» vous pouvez configurer les données de description USB du clavier. Personnellement j'ai remis les identifiants d'origine de mon ergodox, ce qui donne :

/* USB Device descriptor parameter */
#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0x1307
#define DEVICE_VER      0x0001
#define MANUFACTURER    ErgoDox
#define PRODUCT         ErgoDox ergonomic keyboard
#define DESCRIPTION     t.m.k. keyboard firmware for Ergodox

Si vous voulez plus d'info sur les possibilités voilà quelques fichiers qui vous aiderons.

README.MD = vous explique ce que vous pouvez faire avec le programme
tmk_core/doc/keymap.md = vous explique comment fonctionne le programme
            /keycode.txt = liste toutes les touches disponibles avec leur significations
        /common/keycode.h = liste toutes les notations abrégées des touches
quantum/keymap_extras/keymap_bepo.h = liste toutes les correspondances pour le bépo

Installation en mémoire

Pour cela rien de plus simple. Il suffit d'aller sur la page du composant et de télécharger son «loader» https://www.pjrc.com/teensy/loader.html De cliquer sur l'image correspondant a votre système d'exploitation et de suivre les indications très bien faite du site. Seulement en anglais malheureusement mais si vous rencontrer des difficultés venez sur le forum nous en parler.

Si vous faites de nombreux essais de configuration, je vous recommande de laisser le programme en arrière plan et de cliquer sur le bouton «auto». Comme ça il vous suffit d'appuyer avec un cure-dent ou similaire, sur le petit bouton pour recharger votre nouvelle configuration après chaque compilation. Pratique et rapide.

Parfois il peut s'avérer nécessaire de débrancher et rebrancher le clavier pour qu'il fonctionne correctement, mais rien de grave en soi.

Représentation schématique

Vous pouvez utiliser ces schémas pour présenter votre propre adaptation du Bépo a ce clavier.

Carte complète

 ╔══════╗────┬────┬────┬────┬────┬────┐ ┌────┬────┬────┬────┬────┬────╔══════╗
 ║      ║    │    │    │    │    │    │ │    │    │    │    │    │    ║      ║
 ║      ║    │    │    │    │    │    │ │    │    │    │    │    │    ║      ║
 ╠══════╣────┼────┼────┼────┼────╔════╗ ╔════╗────┼────┼────┼────┼────╠══════╣
 ║      ║    │    │    │    │    ║    ║ ║    ║    │    │    │    │    ║      ║
 ║      ║    │    │    │    │    ║    ║ ║    ║    │    │    │    │    ║      ║
 ╠══════╣────┼────┼────┼────┼────╢    ║ ║    ╟────┼────┼────┼────┼────╠══════╣
 ║      ║    │    │    │    │    ╠════╣ ╠════╣    │    │    │    │    ║      ║
 ║      ║    │    │    │    │    ║    ║ ║    ║    │    │    │    │    ║      ║
 ╠══════╣────┼────┼────┼────┼────╢    ║ ║    ╟────┼────┼────┼────┼────╠══════╣
 ║      ║    │    │    │    │    ║    ║ ║    ║    │    │    │    │    ║      ║
 ║      ║    │    │    │    │    ║    ║ ║    ║    │    │    │    │    ║      ║
 ╚══════╝────┴────┼────┼────┼────╚════╝ ╚════╝────┼────┼────┼────┼────╚══════╝
   │    │    │    │    │    │                     │    │    │    │    │    │  
   │    │    │    │    │    │                     │    │    │    │    │    │  
   └────┴────┴────┴────┴────┘                     └────┴────┴────┴────┴────┘  
                            ┌────┬────┐ ┌────┬────┐                           
                            │    │    │ │    │    │                           
                            │    │    │ │    │    │                           
                       ┌────┼────┼────┤ ├────┼────┼────┐                      
                       │    │    │    │ │    │    │    │                      
                       │    │    │    │ │    │    │    │                      
                       │    │    ├────┤ ├────┤    │    │                      
                       │    │    │    │ │    │    │    │                      
                       │    │    │    │ │    │    │    │                      
                       └────┴────┴────┘ └────┴────┴────┘                      

Carte simplifiée

 ┌─────┬───┬───┬───┬───┬───┬───┐ ┌───┬───┬───┬───┬───┬───┬─────┐
 │     │   │   │   │   │   │   │ │   │   │   │   │   │   │     │
 ├─────┼───┼───┼───┼───┼───┼───┤ ├───┼───┼───┼───┼───┼───┼─────┤
 │     │   │   │   │   │   │   │ │   │   │   │   │   │   │     │
 ├─────┼───┼───┼───┼───┼───┤   │ │   ├───┼───┼───┼───┼───┼─────┤
 │     │   │   │   │   │   ├───┤ ├───┤   │   │   │   │   │     │
 ├─────┼───┼───┼───┼───┼───┤   │ │   ├───┼───┼───┼───┼───┼─────┤
 │     │   │   │   │   │   │   │ │   │   │   │   │   │   │     │
 └─┬───┼───┼───┼───┼───┼───┴───┘ └───┴───┼───┼───┼───┼───┼───┬─┘
   │   │   │   │   │   │                 │   │   │   │   │   │  
   └───┴───┴───┴───┴───┘                 └───┴───┴───┴───┴───┘  
                       ┌───┬───┐ ┌───┬───┐                      
                       │   │   │ │   │   │                      
                   ┌───┼───┼───┤ ├───┼───┼───┐                  
                   │   │   │   │ │   │   │   │                  
                   │   │   ├───┤ ├───┤   │   │                  
                   │   │   │   │ │   │   │   │                  
                   └───┴───┴───┘ └───┴───┴───┘                  

Autre

Un retour d'expérience d'un utilisateur (non converti au Bépo) http://www.olivierpons.fr/ergodox/

Exemple de fichier déjà prêt

Pour ne pas partir de zéro je vous met ma configuration actuelle : <source>

  1. include "ergodox_ez.h"
  2. include "debug.h"
  3. include "action_layer.h"
  4. include "keymap_bepo.h"
  1. define BASE 0 // default layer
  2. define SYMB 1 // symbols
  3. define MOUSE 2 // media keys

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { /* Keymap 0: Basic layer

*
* ,--------------------------------------------------.           ,--------------------------------------------------.
* | Esc    |   "  |   «  |   »  |   (  |   )  |  $   |           |  %   |   @  |   +  |   -  |   /  |   *  |   =    |
* |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
* | Ç      |   B  |   É  |   P  |   O  |   È  | Tab  |           | Tab  |   ^  |   V  |   D  |   L  |   J  |   Z    |
* |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
* | W      |   A  |   U  |   I  |   E  |   ,  |------|           |------|   C  |   T  |   S  |   R  |   N  |   M    |
* |--------+------+------+------+------+------|  Del |           | BkSp |------+------+------+------+------+--------|
* | Ctrl   |   À  |   Y  |   X  |   .  |   K  |      |           |      |   '  |   Q  |   G  |   H  |   F  |  Ctrl  |
* `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
*   | LGui | Home | Pgup |Pgdown| End  |                                       | Left | Down |  Up  |Right | RGui |
*   `----------------------------------'                                       `----------------------------------'
*                                        ,-------------.       ,-------------.
*                                        |Ctrl+C|Ctrl+V|       |  L1  |  L2  |
*                                 ,------|------|------|       |------+--------+------.
*                                 |      |      | ~L1  |       | App  |        |      |
*                                 | Space|Shift |------|       |------|  Shift |Enter |
*                                 |      |      |Alt/Enter|    | AltGr|        |      |
*                                 `--------------------'       `----------------------'
*/

// If it accepts an argument (i.e, is a function), it doesn't need KC_. // Otherwise, it needs KC_* [BASE] = KEYMAP( // layer 0 : default

       // left hand
       KC_ESC,       BP_DOUBLE_QUOTE, BP_LEFT_GUILLEMET, BP_RIGHT_GUILLEMET, BP_LEFT_PAREN, BP_RIGHT_PAREN, BP_DOLLAR,
       BP_C_CEDILLA, BP_B,            BP_E_ACUTE,        BP_P,               BP_O,          BP_E_GRAVE,     KC_TAB,
       BP_W,         BP_A,            BP_U,              BP_I,               BP_E,          BP_COMMA,
       KC_LCTL,      BP_A_GRAVE,      BP_Y,              BP_X,               BP_DOT,        BP_K,           KC_DELT,
         KC_LGUI,    KC_HOME,         KC_PGUP,           KC_PGDN,            KC_END,
                                         

LCTL(BP_C), LCTL(BP_V),

                                                              MO(SYMB),
                                             KC_SPC, KC_LSFT, ALT_T(KC_ENT),
       // right hand
            BP_PERCENT, BP_AT,              BP_PLUS, BP_MINUS, BP_SLASH, BP_ASTERISK, BP_EQUAL,
            KC_TAB,     BP_DEAD_CIRCUMFLEX, BP_V,    BP_D,     BP_L,     BP_J,        BP_Z,
                        BP_C,               BP_T,    BP_S,     BP_R,     BP_N,        BP_M,
            KC_BSPC,    BP_APOSTROPHE,      BP_Q,    BP_G,     BP_H,     BP_F,        KC_RCTL,
                                            KC_LEFT, KC_DOWN,  KC_UP,    KC_RGHT,     KC_LGUI,
            TG(SYMB), TG(MOUSE),
            KC_APP,
            KC_RALT,KC_RSFT, KC_ENT
   ),

/* Keymap 1: Symbol Layer

*
* ,--------------------------------------------------.           ,--------------------------------------------------.
* |        |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |           |P.Scr|NumLock|   +  |  -   |  /   |  *   |    =   |
* |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
* | VolUp  |   F7 |  F8  |  F9  |  F10 | F11  |  F12 |           |      |   ^  |   7  |   8  |   9  |   +  |ScrLock |
* |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
* |  Mute  | Prev | Play | Stop | Next | Calc |------|           |------|   ˇ  |   4  |   5  |   6  |   +  | Pause  |
* |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
* | VolDn  | Undo | Cut  | Copy | Paste| Redo |      |           |      |  Ins |   1  |   2  |   3  |Enter |        |
* `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
*   |      |      |      |      |      |                                       |   0  |   ,  |   .  |Enter |      |
*   `----------------------------------'                                       `----------------------------------'
*                                        ,-------------.       ,-------------.
*                                        |      |      |       |      |      |
*                                 ,------|------|------|       |------+------+------.
*                                 |      |      |      |       |      |      |      |
*                                 |      |      |------|       |------|      |      |
*                                 |      |      |      |       |      |      |      |
*                                 `--------------------'       `--------------------'
*/

// SYMBOLS [SYMB] = KEYMAP(

      // left hand
      KC_TRNS,   KC_F1,   KC_F2,   KC_F3,   KC_F4,    KC_F5,   KC_F6,
      KC_VOLU,   KC_F7,   KC_F8,   KC_F9,   KC_F10,   KC_F11,  KC_F12,
      KC_MUTE,   KC_MPRV, KC_MPLY, KC_MSTP, KC_MNXT,  KC_CALC,
      KC_VOLD,   KC_UNDO, KC_CUT,  KC_COPY, KC_PASTE, KC_CALC, KC_TRNS,
        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
      
                                      KC_TRNS, KC_TRNS,
                                               KC_TRNS,
                              KC_TRNS,KC_TRNS, KC_TRNS,
      // right hand
      KC_PSCR, KC_LNUM,            KC_KP_PLUS,KC_KP_MINUS,KC_KP_SLASH,KC_KP_ASTERISK,KC_KP_EQUAL,
      KC_TRNS, BP_DEAD_CIRCUMFLEX, KC_KP_7,   KC_KP_8,    KC_KP_9,    KC_KP_PLUS,    KC_SLCK,
               RALT(BP_V),         KC_KP_4,   KC_KP_5,    KC_KP_6,    KC_KP_PLUS,    KC_PAUS,
      KC_TRNS, KC_INS,             KC_KP_1,   KC_KP_2,    KC_KP_3,    KC_KP_ENTER,   KC_TRNS,
                                   KC_KP_0,   KC_KP_COMMA,KC_KP_DOT,  KC_KP_ENTER,   KC_TRNS,
      KC_TRNS, KC_TRNS,
      KC_TRNS,
      KC_TRNS, KC_TRNS, KC_TRNS

), /* Keymap 2: Mouse keys

*
* ,--------------------------------------------------.           ,--------------------------------------------------.
* |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
* |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
* |        | WhUp | Lclk | MsUp | Rclk | Acc0 |      |           |      | Acc0 | WhLft| WhUp | WhRgh|      |        |
* |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
* |        | WhDwn|MsLeft|MsDown|MsRght| Acc1 |------|           |------| Acc1 | Lclk | Cclk | Rclk |      |        |
* |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
* |        |      | Btn4 | Cclk | Btn5 | Acc2 |      |           |      | Acc2 | Btn4 | WhDwn| Btn5 |      |        |
* `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
*   |      |      |      |      |      |                                       |      |      |      |      |      |
*   `----------------------------------'                                       `----------------------------------'
*                                        ,-------------.       ,-------------.
*                                        |      |      |       |      |      |
*                                 ,------|------|------|       |------+------+------.
*                                 |      |      |      |       |      |      |      |
*                                 |      |      |------|       |------|      |      |
*                                 |      |      |      |       |      |      |      |
*                                 `--------------------'       `--------------------'
*/

// MOUSE [MOUSE] = KEYMAP(

      KC_TRNS, KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
      KC_TRNS, KC_MS_WH_UP,   KC_BTN1, KC_MS_U, KC_BTN2, KC_ACL0, KC_TRNS,
      KC_TRNS, KC_MS_WH_DOWN, KC_MS_L, KC_MS_D, KC_MS_R, KC_ACL1,
      KC_TRNS, KC_TRNS,       KC_BTN4, KC_BTN3, KC_BTN5, KC_ACL2, KC_TRNS,
      KC_TRNS, KC_TRNS,       KC_TRNS, KC_TRNS, KC_TRNS,
                                          KC_TRNS, KC_TRNS,
                                                   KC_TRNS,
                                 KC_TRNS, KC_TRNS, KC_TRNS,
   // right hand
      KC_TRNS,  KC_TRNS, KC_TRNS,     KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS,
      KC_TRNS,  KC_ACL0, KC_MS_WH_UP, KC_MS_WH_UP,   KC_MS_WH_DOWN, KC_TRNS, KC_TRNS,
                KC_ACL1, KC_BTN1,     KC_BTN3,       KC_BTN2,       KC_TRNS, KC_TRNS,
      KC_TRNS,  KC_ACL2, KC_BTN4,     KC_MS_WH_DOWN, KC_BTN5,       KC_TRNS, KC_TRNS,
                         KC_TRNS,     KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS,
      KC_TRNS, KC_TRNS,
      KC_TRNS,
      KC_TRNS, KC_TRNS, KC_TRNS

), };

const uint16_t PROGMEM fn_actions[] = {

   [1] = ACTION_LAYER_TAP_TOGGLE(SYMB)                // FN1 - Momentary Layer 1 (Symbols)

};

const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {

 // MACRODOWN only works in this function
     switch(id) {
       case 0:
       if (record->event.pressed) {
         register_code(KC_RSFT);
       } else {
         unregister_code(KC_RSFT);
       }
       break;
     }
   return MACRO_NONE;

};

// Runs just one time when the keyboard initializes. void matrix_init_user(void) {

};

// Runs constantly in the background, in a loop. void matrix_scan_user(void) {

   uint8_t layer = biton32(layer_state);
   ergodox_board_led_off();
   ergodox_right_led_1_off();
   ergodox_right_led_2_off();
   ergodox_right_led_3_off();
   switch (layer) {
     // TODO: Make this relevant to the ErgoDox EZ.
       case 1:
           ergodox_right_led_1_on();
           break;
       case 2:
           ergodox_right_led_2_on();
           break;

case 3:

           ergodox_right_led_1_on();

ergodox_right_led_2_on();

           break;
       default:
           // none
           break;
   }

};

<source>