Skip to content

Latest commit

 

History

History
180 lines (120 loc) · 8.36 KB

README.md

File metadata and controls

180 lines (120 loc) · 8.36 KB
Raw

Description

Control your ESP32 projects with a PS3 controller!

This library is meant to be used with Espressif's ESP-IDF IoT Development Framework.

However, Arduino is supported too!

Pairing the PS3 Controller:

When a PS3 controller is 'paired' to a PS3 console, it just means that it has stored the console's Bluetooth MAC address, which is the only device the controller will connect to. Usually, this pairing happens when you connect the controller to the PS3 console using a USB cable, and press the PS button. This initiates writing the console's MAC address to the controller.

Therefore, if you want to connect your PS3 controller to the ESP32, you either need to figure out what the Bluetooth MAC address of your PS3 console is and set the ESP32's address to it, or change the MAC address stored in the PS3 controller.

Whichever path you choose, you're going to need a tool to read and/or write the currently paired MAC address from the PS3 controller. I used SixaxisPairTool for this, but you can try using sixaxispairer as well, if open source is important to you.

Note for ESP-IDF: If you opted to change the ESP32's MAC address, you'll need to include this snippet in your code before calling ps3Init(), where the MAC address should match with the one stored on the PS3 controller:

uint8_t new_mac[8] = {0x01,0x02,0x03,0x04,0x05,0x06};
ps3SetBluetoothMacAddress(new_mac);

Getting Started with Arduino

Installing the ESP32 board

In case you haven't yet, you can add the ESP32 boards to your Arduino IDE by adding them to the Boards Manager: Open File -> Preferences, and paste the following URL in the Additional Boards Manager URLs field:

  • https://dl.espressif.com/dl/package_esp32_index.json

Open the Boards Manager with Tools -> Board: "xxx" -> Boards Manager, look for esp32 (probably the last one in the list), and click Install.

Finally, select the ESP32 board you have with Tools -> Board: "xxx" under the section ESP32 Arduino (I always have ESP32 Dev Module selected).

Installing the library

You can install the Arduino library from within the Arduino IDE. Open the Library Manager with Sketch -> Include Library -> Manage Libraries....

Search for PS3 Controller Host, and click Install.

Using the library

To use this library in your sketch, include it with Sketch -> Include Library -> PS3 Controller Host.

You can initialize the library using Ps3.begin(mac), passing a string with the MAC address stored in the PS3 Controller. Your sketch would then look like this:

#include <Ps3Controller.h>

void setup()
{
    Ps3.begin("01:02:03:04:05:06");
}

Examples

In order to learn more about how to use this library, please refer to the example sketches in the Arduino IDE with File -> Examples -> PS3 Controller Host:

  • Try to connect to the PS3 controller first with the Ps3Connect sketch.

  • Take a look at the Ps3Data sketch to see how you can access the controller data values.

  • Take a look at the Ps3DataNotify to see how you can attach a notification function which gets triggered every time new data is received from the PS3 controller. This allows your code to quickly react on controller input even when you have multiple delay() calls in your loop().

  • The Ps3Demo sketch showcases how to access (almost) all of the controller data made available by this library.

  • Finally, Ps3Accelerometer allows you to draw live graphs of the accelerometer data inside the PS3 controller by using Tools -> Serial Plotter.

Getting Started with ESP-IDF

Installing the library

There are two options to install this library: either install it globally in the ESP-IDF folder so all of your projects can make use of it, or install it locally in your project folder.

Go to the root of either, and clone this repository by running:

git clone https://github.com/jvpernis/esp32-ps3.git components/ps3

In case you are using git to manage your project, you can also add this library to your repository by running:

git submodule add https://github.com/jvpernis/esp32-ps3.git components/ps3

Configuring your project

Make sure you have configured your project correctly in order to use your PS3 controller. In your project folder, run make menuconfig and configure your project with the following steps:

  • Navigate to Component config ---> and press Enter to open the component config menu.
  • Navigate to Bluetooth ---> and press Enter to open the Bluetooth config menu.
  • Select [] Bluetooth and press Y to enable Bluetooth
  • Navigate to Bluetooth controller ---> and press Enter to open its menu.
  • Navigate to Bluetooth controller mode and press Enter to show the controller mode options.
  • Select BR/EDR Only and press Enter to confirm the choice.
  • Press E to go back to the Bluetooth menu.
  • If it exists, navigate to Bluetooth Host and press Enter to show the host options.
  • Select Bluedroid - Dual-mode and press Enter to confirm the choice.
  • Navigate to [] Bluedroid Enable ---> and press Y to enable Bluedroid if it isn't already, then press Enter to open its menu.
  • Navigate to Classic Bluetooth and press Y to enable it
  • Navigate to SPP and press Y to enable it
  • Navigate to Secure Simple Pairing and press Y to enable it if it isn't already
  • Press S to save the configuration.

Using the library

In order to use this library, you just need to set an event callback, call the initialisation function, and, optionally, wait for the PS3 controller to be connected:

#include "ps3.h"
#include "freertos/task.h"

ps3SetEventCallback(controller_event_cb);
ps3Init();

while (!ps3IsConnected()){
    // Prevent the Task Watchdog from triggering
    vTaskDelay(10 / portTICK_PERIOD_MS);
}

Your event callback will have to look like this:

void controller_event_cb( ps3_t ps3, ps3_event_t event )
{
    // Event handling here...
}

Examples

if ( ps3.status.battery >= ps3_status_battery_high )
    print("The controller still has sufficient battery charge");

if ( ps3.status.charging )
    print("Controller is charging");

if ( ps3.button.triangle )
    print("Currently pressing the trangle button");

if ( ps3.analog.stick.lx < 0 )
    print("Currently pulling analog stick to the left");

if ( event.button_down.cross )
    print("The user started pressing the X button");

if ( event.button_up.cross )
    print("The user released the X button");

if ( event.analog_changed.stick.lx )
    print("The user has moved the left stick sideways");

Troubleshooting

The component gives compilation errors

This project uses ESP-IDF internal API's in order to implement the PS3 controller functionality. This has a drawback of being susceptible to being suddenly broken. To remedy this, a compatibility config menu has been added so you can select older ESP-IDF versions to work with.

In your project folder, run make menuconfig and configure your project with the following steps:

  • Navigate to Component config ---> and press Enter to open the component config menu.
  • Navigate to PS3 ---> and press Enter to open the Bluetooth config menu.
  • Navigate to Framework compatibility and press Enter to show the compatibility options.
  • Select the compatibility suitable to your ESP-IDF version

If you selected the Latest stable release or Latest master revision option and you are still getting compiler errors, please create an issue.

If you are unsure which master branch revision you should take, figure out what the commit date is of your ESP-IDF version (by running git show), and look at the help text of each revision listed in the Framework compatibility configuration option to know their revision date.

Sources

I've had tremendous help developing this library by reading these sources: