The PS2 device controller class. More...

#include <ps2controller.h>

Static Public Member Functions
static void	begin (gpio_num_t port0_clkGPIO, gpio_num_t port0_datGPIO, gpio_num_t port1_clkGPIO=GPIO_UNUSED, gpio_num_t port1_datGPIO=GPIO_UNUSED)
	Initializes PS2 device controller. More...

static void	begin (PS2Preset preset=PS2Preset::KeyboardPort0_MousePort1, KbdMode keyboardMode=KbdMode::CreateVirtualKeysQueue)
	Initializes PS2 device controller using default GPIOs. More...

static bool	dataAvailable (int PS2Port)
	Determines if one byte has been received from the specified port. More...

static void	disableRX (int PS2Port)
	Disables inputs from PS/2 port driving the CLK line Low. More...

static void	enableRX (int PS2Port)
	Enables inputs from PS/2 port releasing CLK line. More...

static int	getData (int PS2Port, int timeOutMS)
	Gets a scancode from the queue. More...

static PS2Controller *	instance ()
	Returns the singleton instance of PS2Controller class. More...

static Keyboard *	keyboard ()
	Returns the instance of Keyboard object automatically created by PS2Controller. More...

static bool	lock (int PS2Port, int timeOutMS)
	Gets exclusive access to the specified PS/2 port. More...

static Mouse *	mouse ()
	Returns the instance of Mouse object automatically created by PS2Controller. More...

static void	sendData (uint8_t data, int PS2Port)
	Sends a command to the device. More...

static void	unlock (int PS2Port)
	Releases port from exclusive access. More...

Detailed Description

The PS2 device controller class.

The PS2 controller uses ULP coprocessor and RTC slow memory to communicate with up to two PS2 devices.
The ULP coprocessor continuously monitor CLK and DATA lines for incoming data. Optionally can send commands to the PS2 devices.

Examples: Others/KeyboardScanCodes/KeyboardScanCodes.ino, Others/KeyboardVirtualKeys/KeyboardVirtualKeys.ino, Others/MouseStudio/MouseStudio.ino, SSD1306_OLED/128x64/NetworkTerminal/NetworkTerminal.ino, SSD1306_OLED/128x64/RTClock/RTClock.ino, SSD1306_OLED/128x64/UI/UI.ino, ST7789_TFT/240x240/FileBrowser/FileBrowser.ino, VGA/Altair8800/Altair8800.ino, VGA/AnsiTerminal/AnsiTerminal.ino, VGA/Audio/Audio.ino, VGA/ClassicRacer/ClassicRacer.ino, VGA/DirectVGA_ElMuro/DirectVGA_ElMuro.ino, VGA/FileBrowser/FileBrowser.ino, VGA/GraphicalUserInterface/GraphicalUserInterface.ino, VGA/HardwareTest/HardwareTest.ino, VGA/LoopbackTerminal/LoopbackTerminal.ino, VGA/MouseOnScreen/MouseOnScreen.ino, VGA/MultitaskingCPM/MultitaskingCPM.ino, VGA/NetworkTerminal/NetworkTerminal.ino, VGA/Songs/Songs.ino, VGA/SoundChipSimulator/SoundChipSimulator.ino, VGA/SpaceInvaders/SpaceInvaders.ino, and VGA/VIC20/VIC20.ino.

Definition at line 82 of file ps2controller.h.

The documentation for this class was generated from the following files:

Static Public Member Functions

Detailed Description