keyboard.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#include "freertos/FreeRTOS.h"
 
#include "fabglconf.h"
#include "comdrivers/ps2device.h"
#include "fabui.h"
#include "kbdlayouts.h"
#include "codepages.h"
 
 
namespace fabgl {
 
 
 
class Keyboard : public PS2Device {
 
public:
 
  Keyboard();
  ~Keyboard();
 
  void begin(gpio_num_t clkGPIO, gpio_num_t dataGPIO, bool generateVirtualKeys = true, bool createVKQueue = true);
 
  void begin(bool generateVirtualKeys, bool createVKQueue, int PS2Port);
 
  void enableVirtualKeys(bool generateVirtualKeys, bool createVKQueue);
 
  void setUIApp(uiApp * app) { m_uiApp = app; }
 
  bool reset();
 
  bool isKeyboardAvailable() { return m_keyboardAvailable; }
 
  void setLayout(KeyboardLayout const * layout);
 
  KeyboardLayout const * getLayout() { return m_layout; }
 
  bool isVKDown(VirtualKey virtualKey);
 
  int virtualKeyAvailable();
 
  VirtualKey getNextVirtualKey(bool * keyDown = nullptr, int timeOutMS = -1);
 
  bool getNextVirtualKey(VirtualKeyItem * item, int timeOutMS = -1);
 
  void injectVirtualKey(VirtualKey virtualKey, bool keyDown, bool insert = false);
 
  void injectVirtualKey(VirtualKeyItem const & item, bool insert = false);
 
  void emptyVirtualKeyQueue();
 
  int virtualKeyToASCII(VirtualKey virtualKey);
 
  void setCodePage(CodePage const * codepage)                      { m_codepage = codepage; }
 
  int scancodeAvailable();
 
  int getNextScancode(int timeOutMS = -1, bool requestResendOnTimeOut = false);
 
  bool setLEDs(bool numLock, bool capsLock, bool scrollLock);
 
  void getLEDs(bool * numLock, bool * capsLock, bool * scrollLock);
 
  bool setTypematicRateAndDelay(int repeatRateMS, int repeatDelayMS) { return send_cmdTypematicRateAndDelay(repeatRateMS, repeatDelayMS); }
 
  bool setScancodeSet(int value);
 
  int scancodeSet()                { return m_scancodeSet; }
 
  static uint8_t convScancodeSet2To1(uint8_t code);
 
#if FABGLIB_HAS_VirtualKeyO_STRING
  static char const * virtualKeyToString(VirtualKey virtualKey);
#endif
 
 
 
  Delegate<VirtualKey *, bool> onVirtualKey;
 
 
 
 
  static int scancodeToVirtualKeyTaskStackSize;
 
 
 
private:
 
  VirtualKey scancodeToVK(uint8_t scancode, bool isExtended, KeyboardLayout const * layout = nullptr);
  VirtualKey VKtoAlternateVK(VirtualKey in_vk, bool down, KeyboardLayout const * layout = nullptr);
  VirtualKey manageCAPSLOCK(VirtualKey vk);
  void updateLEDs();
  bool blockingGetVirtualKey(VirtualKeyItem * item);
  void convertScancode2to1(VirtualKeyItem * item);
  void postVirtualKeyItem(VirtualKeyItem const & item);
  static int convKeypadVKToNum(VirtualKey vk);
 
  static void SCodeToVKConverterTask(void * pvParameters);
 
 
  bool                      m_keyboardAvailable;  // self test passed and support for scancode set 2
 
  TaskHandle_t              m_SCodeToVKConverterTask; // Task that converts scancodes to virtual key and populates m_virtualKeyQueue
  QueueHandle_t             m_virtualKeyQueue;
 
  uint8_t                   m_VKMap[(int)(VK_LAST + 7) / 8];
 
  // allowed values: 1, 2 or 3
  // If virtual keys are enabled only 1 and 2 are possible. In case of scancode set 1 it is converted from scan code set 2, which is necessary
  // in order to decode virtual keys.
  uint8_t                   m_scancodeSet;
 
  KeyboardLayout const *    m_layout;
 
  uiApp *                   m_uiApp;
 
  bool                      m_CTRL;
  bool                      m_LALT;
  bool                      m_RALT;
  bool                      m_SHIFT;
  bool                      m_CAPSLOCK;
  bool                      m_GUI;
  bool                      m_NUMLOCK;
  bool                      m_SCROLLLOCK;
 
  VirtualKey                m_lastDeadKey;
 
  // store status of the three LEDs
  bool                      m_numLockLED;
  bool                      m_capsLockLED;
  bool                      m_scrollLockLED;
 
  CodePage const *          m_codepage;
 
};
 
 
 
 
 
} // end of namespace