SquidHID

/**
 * This example exists to demonstrate the basic functions of SQUIDHID
 *
 * Please feel free to use this example as a reference or template!
 */


#include <SQUIDHID.h>

SQUIDHID esp("ESP32-TEST", "gargum", 100);   // Here, we set the name to "ESP32-TEST", the manufacturer to "gargum", and the battery level to 100%

void setup() {
  esp.setAppearance(CYCLING_COMPUTER);          // You can set the device to advertise itself as a wide array of different things!
  esp.begin();                                  // Here, we start up our ESP32 running SQUIDHID
}

void loop() {
  esp.update();            // SQUIDHID requires you to call the 'update()' function in sketches. This is used to control things like the scanning interval.

  esp.press(KC_SLSH);      // SQUIDHID allows you to press down individual keys using the 'press' function!
  delay(2000);
  esp.press(KC_RSFT);      // NKRO is enabled by default, meaning you can just keep pushing down buttons without letting anything go!
  delay(2000);
  esp.press(KC_VOLD);      // Any keyboard button in SQUIDHID should be compatible with the 'press' function.
  delay(2000);
  esp.release(KC_RSFT);    // Using the 'release' function, you can let go of individual keys you've previously 'pressed'.
  delay(2000);
  esp.releaseAll();        // If you're holding down lots of buttons, you can also simply call the 'releaseAll' function.
  delay(2000);
  esp.write(KC_SLSH);      // You can also simply output any keyboard key one time in one command using 'write'.
  delay(2000);             // Please note that 'write' is NOT compatible with gamepad or mouse inputs at this time.

  esp.press(MO_BTN1);  // The press function allows supports mouse buttons. 
  delay(2000);  
  esp.press(GB_R1);   // All gamepad buttons are also supported by the press function.
  delay(2000);
  esp.releaseAll();
  delay(2000);
  
  esp.press(GB_L1);   // The 'release' function on the other hand can parse all the same things 'press' can.
  delay(2000);
  esp.release(GB_L1); // This means you can always use 'release' when you want to let go of just one button.
  delay(2000);

         //X    Y
  esp.move(100, 100);       // The 'move' function allows you to perform relative movements, like a computer mouse.
  delay(2000);
         //X    Y    W  hW
  esp.move(100, 100, 1, 1);    // 'move' also allows you to set the state of the vertical and horizontal mouse wheels respectively.
  delay(2000);
           //X     Y
  esp.moveTo(1000, 1000);    // 'moveTo' parses absolute coordinates, like a finger on a touchscreen or like a Wacom tablet.
  delay(2000);
           //X     Y     W  Stylus button
  esp.moveTo(1000, 1000, 1, DI_BTN3); // Just like 'move', 'moveTo' also allows you to set the state of the vertical and horizontal mouse wheels.
  delay(2000);

  esp.click(MO_BTN1);    // The 'click' function is the mouse's version of the 'write' function. I decided to call it 'click' because 'write' seemed confusing in this context.
  delay(2000);

  esp.click(5000, 5000, DI_BTN1); // Just like the 'moveTo' function, 'click' is able to parse absolute coordinates. (By default, it will just click wherever the cursor is.)
  delay(2000);
  
}

#include <SQUIDHID.h>

SQUIDHID tentacle("SquidHID"); // To start off, simply create and name your board.

// This matrix example includes both onboard MCU pins, and MCP23XXX pins.
// The matrix also includes keys that employ a direct wiring, and pin pairs.
//
// SquidHID does not utilize ROW2COL or COL2ROW, but instead the FROM-TO system.
// Pairs of pins are defined as {FROM, TO}.
// 
// A key wired as ROW2COL translates to {ROW, COL}
// A key wired as COL2ROW translates to {COL, ROW}

MATRIX(matrix) = {
  {1, 2}, {2, 1}, {A0, 3}, {3, A0},     // SquidHID's system means this matrix is valid.
  {B7},   {4},    {1, A0}, {2, 3}       // This makes complex matrices easier to define.
};

LAYER(base) = {
  KC_A,     KC_B,    KC_C,    KC_D,     // Many QMK keycodes are also valid in SquidHID.
  MO(1),    KC_BSPC, KC_SPC,  TG(2)     // Layering is also available in SquidHID.
};

LAYER(func) = {
  KC_VOLD,  KC_MPRV, KC_MNXT, KC_VOLU,  // Media keys are also included in SquidHID.
  TRANS,    TRANS,   TRANS,   TRANS     // Transparent keys also exist in SquidHID.
};

LAYER(game) = {
  GB_UP,    GB_LE,   GB_RI,   GB_DO,    // Some keys like gamepad buttons and steno keys
  TRANS,    TRANS,   TRANS,   TRANS     // use new, shortened aliases for ease of use.
};

KEYMAP(keymap) = {                      // Keymaps in SquidHID are simply sets of layers.
    base,
    func, 
    game
};

void setup() {
  
  tentacle.begin(matrix, keymap);       // After defining your matrix and keymap,
                                        // simply pass it to the begin function.
}

void loop() {
  
  tentacle.update();                    // Now you can call the update function to
                                        // check for/process any updates.
}

/**
 * @file config.h
 * @brief User function toggles for conditional compilation and feature-setting
 */

#define TRANSPORT        BLE        // Currently, the available transport methods for connecting to hosts are BLE, USB, and PS/2

#define KEYBOARD_ENABLE   true       // Enabling the Keyboard feature allows you to include keyboard buttons in your sketches
#define MEDIA_ENABLE      true       // Enabling the Media feature allows you to include media keys in your sketches
#define STENO_ENABLE      true       // Enabling the Steno feature enables the PloverHID feature, allowing you to create a stenotype machine
#define MOUSE_ENABLE      true       // Enabling the Mouse feature enables the relative pointer feature, allowing you to create a computer mouse or other pointing devicee
#define DIGITIZER_ENABLE  true       // Enabling the Digitizer feature enables the absolute pointer feature, which allows you to create things like Android-compatible drawing tablets with tip and barrel switches
#define GAMEPAD_ENABLE    true       // Enabling the Gamepad feature enables the gamepad buttons, dual analogue joystick reports, the hat-switch d-pad reporting, and the dual analogue trigger reports
#define SPACEMOUSE_ENABLE true       // Enabling the Spacemouse feature enables the 6-DOF Spacemouse reporting alongside 64 3DConnexion buttons for use in keymaps.

#define LED_ENABLE       true       // SquidHID comes bundled with a NeoPixel driver, allowing you to easily enable, define, and manipulate RGB LEDs
#define LED_PIN          20         // Simply define which pin is being used as the data pin
#define LED_COUNT        48         // Then, define how many LEDs are present

#define OLED_ENABLE      true       // SquidHID also includes an I2C OLED driver, enabling you to add simple screens to projects
#define OLED_HEIGHT      64         // The OLED driver supports I2C OLED screens of any screen resolution! Simply set your height and width in pixels
#define OLED_WIDTH       128        // Please note that when rotating your OLED be 90 degrees, these height and width values do not change. Your images are the thing that rotates in this case

#define MCP_ENABLE       true       // Enabling the MCP feature alongside the I2C and/or the SPI feature will allow MCP23XXX units to be automatically detected and configured for use in sketches

#define UART_ENABLE      true       // SquidHID is intended to support a wide range of protocols, so users may optionally define an RTS and CTS pin for use by the UART driver
#define TX_PIN           21
#define RX_PIN           20
#define RTS_PIN          0
#define CTS_PIN          1

#define I2C_ENABLE       true       
#define SDA_PIN          8
#define SCL_PIN          9

#define SPI_ENABLE       true       
#define MISO_PIN         5
#define MOSI_PIN         6
#define SCK_PIN          4
#define CS_PIN           7