Any AVR microcontroller based board which follows the standard Arduino schematic and is flashed with the Arduino bootloader can be called an arduino board. There is no other tool available which helps in easy prototyping like the Arduino does. The Arduino board has all the required circuitary to get the built-in AVR microcontroller running. When it comes to programming the Arduino board anyone who have basic knowledge of c programming can quickly get started with the Arduino IDE. It is very simple to understand and has built-in functions for almost every simple or complex task. All the Arduino boards are flashed with the arduino boot-loader which enables them to be connected and programmed with the Arduino IDE.The Arduino can act as a stand-alone system which can take inputs, process the inputs and generate the output. The arduino can communicate with the other devices using its digital I/O, serial port, I2C port, SPI port etc. The Arduino based system can act as a mini-computer with which it can take input from standard input devices like mouse, keyboard and generate output on LCD display screens.
This particular project demonstrates how to interface a PS2 mouse with the Arduino board and use the buttons of the mouse to control other devices. The project uses the Left-button, right-button and the center button of a mouse to control an LED which can be replaced with any other device with little effort in future projects.
In this project the Arduino pro-mini board is used which is pre-programmed with the Arduino boot-loader. The programming IDE used for this project isArduino IDE version 1.0.3 on windows operating system. The image of the Arduino pro-mini board and the Arduino IDE is shown in the following;
Fig. 2: Typical Arduino Pro-Mini Board
Fig. 3: Arduino IDE Software Window
Another hardware which can perform the USB to TTL conversion is used to upload the program into the arduino board.
Fig. 4: External USB to TTL converter board for programming Arduino and serial communication
It is assumed that the reader has gone through the project how to get started with the arduino and done all the things discussed in it.
The PS2 mouse uses a synchronous communication with the PC which is very much similar to the Two Wire Interface protocol. The PS2 connector has a pin for Data and another pin for Clock and using only these two pins the mouse communicate with the host device. The mouse always has 6 pin mini-DIN male connector for PS2 interface and the host device always has the corresponding female pin. The images and the pin-outs of the PS2 male and female connectors are shown in the following image;
The image of the PS2 male pin
Fig. 5: 6 pin mini-DIN Male connector for PS2 interface
The image of the PS2 female pin
Fig. 6: 6 Pin Mini DIN Female Connector Plug for PS2 interface
The pin-out of the PS2 male and female connectors
Fig. 7: Pin-Out Of PS2 Male and Female Connectors
When it comes to connecting the female connector with the circuit board one should be able to identify the pins at the bottom of the PS2 connector and the following image will be helpful.
Fig. 8: Bottom of Mini DIN Female Connector Plug for PS2 interface
The code written for this project uses the custom PS2 library file called “PS2Mouse.h” which has all the necessary routines for accessing a PS2 mouse. There are two functions which the user can directly make use in their code and are namely “mouse.initialize()” and “mouse.report(data)”. The details of the functions are discussed in the following.
mouse.initialize()
The function mouse.initialize() is used to perform all the necessary things to initialize data reporting from a mouse. Once the initialization is done properly the mouse starts sending the data regarding its X-Y movement and the status of the buttons on the mouse. The function takes no parameter and returns nothing but will exist only when the initialization is properly done.
mouse.report(data)
The function mouse.report(data) can be used to read the current data from the mouse. The function should be provided with an integer array of three elements and the function will fill the elements with the required values. The first element is written with the status value, the second element with the X movement value and the third element will be written with the Y movement value.
If there is no movement in the X-Y plane the value for both the second and the third variables will be zero and if there is no button press the first element will be having a value 8. The first element of the array will be having the values 8, 10 and 12 for left-button press, right-button press and center-button press respectively.
Hence in this project the status values are read and compared in the code to identify whether if there is a button has been pressed or not and also identify the button. The details of reading the X-Y value and the status value from a mouse and displaying them in a Serial Monitor window can be found in a previous project on how to interface a PS2 mouse with the Arduino.
Once a button press occurs the code identifies the button from the status value read from the mouse and then turns a LED on or off according to which button has been identified. The LED is controlled with the help of functions pinMode(), delay() and digitalWrite() which are already discussed in a previous project on how to get started with the Arduino andhow to use digital input and output of the Arduino.
Make sure that the files “PS2Mouse.h” and “PS2Mouse.cpp” are kept in the same folder where the .pde file has been saved. When the coding is finished one can verify and upload the code to the Arduino board as explained in the project how to get started with the Arduino and can control the LED using the left button and the right button of the mouse.
Project Source Code
### /*============================ EG LABS ===================================// Demonstration on how to use PS2 MOUSE with an arduino board The circuit: LCD: * LCD RS pin to digital pin 12 * LCD Enable pin to digital pin 11 * LCD D4 pin to digital pin 7 * LCD D5 pin to digital pin 6 * LCD D6 pin to digital pin 5 * LCD D7 pin to digital pin 4 * LCD R/W pin to ground * 10K resistor: * ends to +5V and ground * wiper to LCD pin 3 * LED anode attached to digital output 9 * LED cathode attached to ground through a 1K resistor MOUSE: DATA PIN TO PIN NUMBER 8 CLOCK PIN TO PIN NUMBER 3 ============================== EG LABS ===================================*/ #include "PS2Mouse.h" #define MOUSE_DATA 8 #define MOUSE_CLOCK 3 // include the library code: #include <LiquidCrystal.h> // initialize the library with the numbers of the interface pins LiquidCrystal lcd(12, 11, 7, 6, 5, 4); PS2Mouse mouse(MOUSE_CLOCK, MOUSE_DATA, STREAM); // initializing the PS2 library int data[2]; int led = 9; void setup() { pinMode(led, OUTPUT); lcd.begin(16, 2); lcd.print("ENGINEERS GARAGE"); lcd.setCursor(0, 1); lcd.print(" PS2 MOUSE "); delay(2000); mouse.initialize(); // initializing the PS2 mouse connected with the Arduino digitalWrite(led, LOW); } void loop() { mouse.report(data); // get data from the mouse if(data[0] == 9) // Status Byte for left button digitalWrite(led, HIGH); else if(data[0] == 10) // Status Byte for right button digitalWrite(led, LOW); else; } //***********PS2.h************//#include "HardwareSerial.h" #include "PS2Mouse.h" #include "Arduino.h" PS2Mouse::PS2Mouse(int clock_pin, int data_pin, int mode) { _clock_pin = clock_pin; _data_pin = data_pin; _mode = mode; _initialized = false; _disabled = true; _enabled = false; } int PS2Mouse::clock_pin() { return _clock_pin; } int PS2Mouse::data_pin() { return _data_pin; } void PS2Mouse::initialize() { pull_high(_clock_pin); pull_high(_data_pin); delay(20); write(0xff); // Send Reset to the mouse read_byte(); // Read ack byte delay(20); // Not sure why this needs the delay read_byte(); // blank read_byte(); // blank delay(20); // Not sure why this needs the delay if (_mode == REMOTE) { set_remote_mode(); } else { enable_data_reporting(); // Tell the mouse to start sending data again } delayMicroseconds(100); _initialized = 1; } void PS2Mouse::set_mode(int data) { if (_mode == STREAM) { disable_data_reporting(); // Tell the mouse to stop sending data. } write(data); // Send Set Mode read_byte(); // Read Ack byte if (_mode == STREAM) { enable_data_reporting(); // Tell the mouse to start sending data again } if (_initialized) { delayMicroseconds(100); } } void PS2Mouse::set_remote_mode() { set_mode(0xf0); _mode = REMOTE; } void PS2Mouse::set_stream_mode() { set_mode(0xea); _mode = STREAM; } void PS2Mouse::set_sample_rate(int rate) { if (_mode == STREAM) { disable_data_reporting(); // Tell the mouse to stop sending data. } write(0xf3); // Tell the mouse we are going to set the sample rate. read_byte(); // Read Ack Byte write(rate); // Send Set Sample Rate read_byte(); // Read ack byte if (_mode == STREAM) { enable_data_reporting(); // Tell the mouse to start sending data again } delayMicroseconds(100); } void PS2Mouse::set_scaling_2_1() { set_mode(0xe7); // Set the scaling to 2:1 } void PS2Mouse::set_scaling_1_1() { set_mode(0xe6); // set the scaling to 1:1 } // This only effects data reporting in Stream mode. void PS2Mouse::enable_data_reporting() { if (!_enabled) { write(0xf4); // Send enable data reporting read_byte(); // Read Ack Byte _enabled = true; } } // Disabling data reporting in Stream Mode will make it behave like Remote Mode void PS2Mouse::disable_data_reporting() { if (!_disabled) { write(0xf5); // Send disable data reporting read_byte(); // Read Ack Byte _disabled = true; } } void PS2Mouse::set_resolution(int resolution) { if (_mode == STREAM) { enable_data_reporting(); } write(0xe8); // Send Set Resolution read_byte(); // Read ack Byte write(resolution); // Send resolution setting read_byte(); // Read ack Byte if (_mode == STREAM) { disable_data_reporting(); } delayMicroseconds(100); } void PS2Mouse::write(int data) { char i; char parity = 1; pull_high(_data_pin); pull_high(_clock_pin); delayMicroseconds(300); pull_low(_clock_pin); delayMicroseconds(300); pull_low(_data_pin); delayMicroseconds(10); pull_high(_clock_pin); // Start Bit while (digitalRead(_clock_pin)) {;} // wait for mouse to take control of clock) // clock is low, and we are clear to send data for (i=0; i < 8; i++) { if (data & 0x01) { pull_high(_data_pin); } else { pull_low(_data_pin); } // wait for clock cycle while (!digitalRead(_clock_pin)) {;} while (digitalRead(_clock_pin)) {;} parity = parity ^ (data & 0x01); data = data >> 1; } // parity if (parity) { pull_high(_data_pin); } else { pull_low(_data_pin); } while (!digitalRead(_clock_pin)) {;} while (digitalRead(_clock_pin)) {;} pull_high(_data_pin); delayMicroseconds(50); while (digitalRead(_clock_pin)) {;} while ((!digitalRead(_clock_pin)) || (!digitalRead(_data_pin))) {;} // wait for mouse to switch modes pull_low(_clock_pin); // put a hold on the incoming data. } int * PS2Mouse::report(int data[]) { write(0xeb); // Send Read Data read_byte(); // Read Ack Byte data[0] = read(); // Status bit data[1] = read_movement_x(data[0]); // X Movement Packet data[2] = read_movement_y(data[0]); // Y Movement Packet return data; } int PS2Mouse::read() { return read_byte(); } int PS2Mouse::read_byte() { int data = 0; pull_high(_clock_pin); pull_high(_data_pin); delayMicroseconds(50); while (digitalRead(_clock_pin)) {;} delayMicroseconds(5); // not sure why. while (!digitalRead(_clock_pin)) {;} // eat start bit for (int i = 0; i < 8; i++) { bitWrite(data, i, read_bit()); } read_bit(); // Partiy Bit read_bit(); // Stop bit should be 1 pull_low(_clock_pin); return data; } int PS2Mouse::read_bit() { while (digitalRead(_clock_pin)) {;} int bit = digitalRead(_data_pin); while (!digitalRead(_clock_pin)) {;} return bit; } int PS2Mouse::read_movement_x(int status) { int x = read(); if (bitRead(status, 4)) { for(int i = 8; i < 16; ++i) { x |= (1<<i); } } return x; } int PS2Mouse::read_movement_y(int status) { int y = read(); if (bitRead(status, 5)) { for(int i = 8; i < 16; ++i) { y |= (1<<i); } } return y; } void PS2Mouse::pull_low(int pin) { pinMode(pin, OUTPUT); digitalWrite(pin, LOW); } void PS2Mouse::pull_high(int pin) { pinMode(pin, INPUT); digitalWrite(pin, HIGH); }###
Project Source Code
### #ifndef PS2Mouse_h #define PS2Mouse_h #define REMOTE 1 #define STREAM 2 class PS2Mouse { private: int _clock_pin; int _data_pin; int _mode; int _initialized; int _enabled; int _disabled; int read_byte(); int read_bit(); int read_movement_x(int); int read_movement_y(int); void pull_high(int); void pull_low(int); void set_mode(int); public: PS2Mouse(int, int, int mode = REMOTE); void initialize(); int clock_pin(); int data_pin(); int read(); int* report(int data[]); void write(int); void enable_data_reporting(); void disable_data_reporting(); void set_remote_mode(); void set_stream_mode(); void set_resolution(int); void set_scaling_2_1(); void set_scaling_1_1(); void set_sample_rate(int); }; #endif ###
Circuit Diagrams
Project Components
Project Video
Filed Under: Arduino
Filed Under: Arduino