Skip to content

Commit

Permalink
Fix variable scope and remove unneeded ones
Browse files Browse the repository at this point in the history
  • Loading branch information
@lemmingDev
lemmingDev authored Feb 17, 2025
1 parent 7a35a86 commit f3c97cc
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 90 deletions.
118 changes: 37 additions & 81 deletions BleGamepad.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,42 +29,17 @@ static const char *LOG_TAG = "BLEGamepad";
#define CHARACTERISTIC_UUID_HARDWARE_REVISION "2A27" // Characteristic - Hardware Revision String - 0x2A27
#define CHARACTERISTIC_UUID_BATTERY_POWER_STATE "2A1A" // Characteristic - Battery Power State - 0x2A1A

#define POWER_STATE_UNKNOWN 0 // B00
#define POWER_STATE_NOT_SUPPORTED 1 // B01
#define POWER_STATE_NOT_PRESENT 2 // B10
#define POWER_STATE_NOT_DISCHARGING 2 // B10
#define POWER_STATE_NOT_CHARGING 2 // B10
#define POWER_STATE_GOOD 2 // B10
#define POWER_STATE_PRESENT 3 // B11
#define POWER_STATE_DISCHARGING 3 // B11
#define POWER_STATE_CHARGING 3 // B11
#define POWER_STATE_CRITICAL 3 // B11



uint8_t tempHidReportDescriptor[150];
int hidReportDescriptorSize = 0;
uint8_t reportSize = 0;
uint8_t numOfButtonBytes = 0;
uint16_t vid;
uint16_t pid;
uint16_t guidVersion;
int16_t axesMin;
int16_t axesMax;
int16_t simulationMin;
int16_t simulationMax;
int16_t motionMin;
int16_t motionMax;

std::string modelNumber;
std::string softwareRevision;
std::string serialNumber;
std::string firmwareRevision;
std::string hardwareRevision;
int8_t powerLevel;

bool enableOutputReport = false;
uint16_t outputReportLength = 64;
#define POWER_STATE_UNKNOWN 0 // 0b00
#define POWER_STATE_NOT_SUPPORTED 1 // 0b01
#define POWER_STATE_NOT_PRESENT 2 // 0b10
#define POWER_STATE_NOT_DISCHARGING 2 // 0b10
#define POWER_STATE_NOT_CHARGING 2 // 0b10
#define POWER_STATE_GOOD 2 // 0b10
#define POWER_STATE_PRESENT 3 // 0b11
#define POWER_STATE_DISCHARGING 3 // 0b11
#define POWER_STATE_CHARGING 3 // 0b11
#define POWER_STATE_CRITICAL 3 // 0b11

BleGamepad::BleGamepad(std::string deviceName, std::string deviceManufacturer, uint8_t batteryLevel) : _buttons(),
_specialButtons(0),
_x(0),
Expand Down Expand Up @@ -95,13 +70,20 @@ BleGamepad::BleGamepad(std::string deviceName, std::string deviceManufacturer, u
_chargingState(0),
_powerLevel(0),
hid(0),
pCharacteristic_Power_State(0)
pCharacteristic_Power_State(0),
configuration()
{
this->resetButtons();
this->deviceName = deviceName;
this->deviceManufacturer = deviceManufacturer;
this->batteryLevel = batteryLevel;
this->connectionStatus = new BleConnectionStatus();

hidReportDescriptorSize = 0;
hidReportSize = 0;
numOfButtonBytes = 0;
enableOutputReport = false;
outputReportLength = 64;
}

void BleGamepad::resetButtons()
Expand All @@ -113,34 +95,8 @@ void BleGamepad::begin(BleGamepadConfiguration *config)
{
configuration = *config; // we make a copy, so the user can't change actual values midway through operation, without calling the begin function again

modelNumber = configuration.getModelNumber();
softwareRevision = configuration.getSoftwareRevision();
serialNumber = configuration.getSerialNumber();
firmwareRevision = configuration.getFirmwareRevision();
hardwareRevision = configuration.getHardwareRevision();

vid = configuration.getVid();
pid = configuration.getPid();
guidVersion = configuration.getGuidVersion();

enableOutputReport = configuration.getEnableOutputReport();
outputReportLength = configuration.getOutputReportLength();

powerLevel = configuration.getTXPowerLevel();

#ifndef PNPVersionField
uint8_t high = highByte(vid);
uint8_t low = lowByte(vid)
vid = low << 8 | high;

high = highByte(pid);
low = lowByte(pid)
pid = low << 8 | high;

high = highByte(guidVersion);
low = lowByte(guidVersion);
guidVersion = low << 8 | high;
#endif

uint8_t buttonPaddingBits = 8 - (configuration.getButtonCount() % 8);
if (buttonPaddingBits == 8)
Expand Down Expand Up @@ -178,7 +134,7 @@ void BleGamepad::begin(BleGamepadConfiguration *config)
numOfMotionBytes += 6;
}

reportSize = numOfButtonBytes + numOfSpecialButtonBytes + numOfAxisBytes + numOfSimulationBytes + numOfMotionBytes + configuration.getHatSwitchCount();
hidReportSize = numOfButtonBytes + numOfSpecialButtonBytes + numOfAxisBytes + numOfSimulationBytes + numOfMotionBytes + configuration.getHatSwitchCount();

// USAGE_PAGE (Generic Desktop)
tempHidReportDescriptor[hidReportDescriptorSize++] = 0x05;
Expand Down Expand Up @@ -963,7 +919,7 @@ void BleGamepad::sendReport(void)
{
uint8_t currentReportIndex = 0;

uint8_t m[reportSize];
uint8_t m[hidReportSize];

memset(&m, 0, sizeof(m));
memcpy(&m, &_buttons, sizeof(_buttons));
Expand Down Expand Up @@ -1837,8 +1793,8 @@ int8_t BleGamepad::getTXPowerLevel()

void BleGamepad::setTXPowerLevel(int8_t level)
{
powerLevel = level;
NimBLEDevice::setPower(powerLevel); // The only valid values are: -12, -9, -6, -3, 0, 3, 6 and 9
NimBLEDevice::setPower(level); // The only valid values are: -12, -9, -6, -3, 0, 3, 6 and 9
configuration.setTXPowerLevel(level);
}

void BleGamepad::setGyroscope(int16_t gX, int16_t gY, int16_t gZ)
Expand Down Expand Up @@ -1982,7 +1938,7 @@ void BleGamepad::taskServer(void *pvParameter)
BleGamepad *BleGamepadInstance = (BleGamepad *)pvParameter; // static_cast<BleGamepad *>(pvParameter);

NimBLEDevice::init(BleGamepadInstance->deviceName);
NimBLEDevice::setPower(powerLevel); // Set transmit power for advertising (Range: -12 to +9 dBm)
NimBLEDevice::setPower(BleGamepadInstance->configuration.getTXPowerLevel()); // Set transmit power for advertising (Range: -12 to +9 dBm)
NimBLEServer *pServer = NimBLEDevice::createServer();
pServer->setCallbacks(BleGamepadInstance->connectionStatus);
pServer->advertiseOnDisconnect(true);
Expand All @@ -1992,11 +1948,11 @@ void BleGamepad::taskServer(void *pvParameter)
BleGamepadInstance->inputGamepad = BleGamepadInstance->hid->getInputReport(BleGamepadInstance->configuration.getHidReportId()); // <-- input REPORTID from report map
BleGamepadInstance->connectionStatus->inputGamepad = BleGamepadInstance->inputGamepad;

if (enableOutputReport)
if (BleGamepadInstance->enableOutputReport)
{
BleGamepadInstance->outputGamepad = BleGamepadInstance->hid->getOutputReport(BleGamepadInstance->configuration.getHidReportId());
BleGamepadInstance->outputReceiver = new BleOutputReceiver(outputReportLength);
BleGamepadInstance->outputBackupBuffer = new uint8_t[outputReportLength];
BleGamepadInstance->outputReceiver = new BleOutputReceiver(BleGamepadInstance->outputReportLength);
BleGamepadInstance->outputBackupBuffer = new uint8_t[BleGamepadInstance->outputReportLength];
BleGamepadInstance->outputGamepad->setCallbacks(BleGamepadInstance->outputReceiver);
}

Expand All @@ -2008,31 +1964,31 @@ void BleGamepad::taskServer(void *pvParameter)
CHARACTERISTIC_UUID_MODEL_NUMBER,
NIMBLE_PROPERTY::READ
);
pCharacteristic_Model_Number->setValue(modelNumber);
pCharacteristic_Model_Number->setValue(std::string(BleGamepadInstance->configuration.getModelNumber()));

BLECharacteristic* pCharacteristic_Software_Revision = pService->createCharacteristic(
CHARACTERISTIC_UUID_SOFTWARE_REVISION,
NIMBLE_PROPERTY::READ
);
pCharacteristic_Software_Revision->setValue(softwareRevision);
pCharacteristic_Software_Revision->setValue(std::string(BleGamepadInstance->configuration.getSoftwareRevision()));

BLECharacteristic* pCharacteristic_Serial_Number = pService->createCharacteristic(
CHARACTERISTIC_UUID_SERIAL_NUMBER,
NIMBLE_PROPERTY::READ
);
pCharacteristic_Serial_Number->setValue(serialNumber);
pCharacteristic_Serial_Number->setValue(std::string(BleGamepadInstance->configuration.getSerialNumber()));

BLECharacteristic* pCharacteristic_Firmware_Revision = pService->createCharacteristic(
CHARACTERISTIC_UUID_FIRMWARE_REVISION,
NIMBLE_PROPERTY::READ
);
pCharacteristic_Firmware_Revision->setValue(firmwareRevision);
pCharacteristic_Firmware_Revision->setValue(std::string(BleGamepadInstance->configuration.getFirmwareRevision()));

BLECharacteristic* pCharacteristic_Hardware_Revision = pService->createCharacteristic(
CHARACTERISTIC_UUID_HARDWARE_REVISION,
NIMBLE_PROPERTY::READ
);
pCharacteristic_Hardware_Revision->setValue(hardwareRevision);
pCharacteristic_Hardware_Revision->setValue(std::string(BleGamepadInstance->configuration.getHardwareRevision()));

NimBLECharacteristic* pCharacteristic_Power_State = BleGamepadInstance->hid->getBatteryService()->createCharacteristic(
CHARACTERISTIC_UUID_BATTERY_POWER_STATE,
Expand All @@ -2041,26 +1997,26 @@ void BleGamepad::taskServer(void *pvParameter)
BleGamepadInstance->pCharacteristic_Power_State = pCharacteristic_Power_State; // Assign the created characteristic
BleGamepadInstance->pCharacteristic_Power_State->setValue(0b00000000); // Now it's safe to call setValue <- Set all to unknown by default

BleGamepadInstance->hid->setPnp(0x01, vid, pid, guidVersion);
BleGamepadInstance->hid->setPnp(0x01, BleGamepadInstance->configuration.getVid(), BleGamepadInstance->configuration.getPid(), BleGamepadInstance->configuration.getGuidVersion());
BleGamepadInstance->hid->setHidInfo(0x00, 0x01);

// NimBLEDevice::setSecurityAuth(BLE_SM_PAIR_AUTHREQ_BOND);
NimBLEDevice::setSecurityAuth(true, false, false); // enable bonding, no MITM, no SC


uint8_t *customHidReportDescriptor = new uint8_t[hidReportDescriptorSize];
memcpy(customHidReportDescriptor, tempHidReportDescriptor, hidReportDescriptorSize);
uint8_t *customHidReportDescriptor = new uint8_t[BleGamepadInstance->hidReportDescriptorSize];
memcpy(customHidReportDescriptor, BleGamepadInstance->tempHidReportDescriptor, BleGamepadInstance->hidReportDescriptorSize);

// Testing - Ask ChatGPT to convert it into a commented HID descriptor
//Serial.println("------- HID DESCRIPTOR START -------");
//for (int i = 0; i < hidReportDescriptorSize; i++)
//for (int i = 0; i < BleGamepadInstance->hidReportDescriptorSize; i++)
//{
// Serial.printf("%02x", customHidReportDescriptor[i]);
// Serial.println();
//}
//Serial.println("------- HID DESCRIPTOR END -------");

BleGamepadInstance->hid->setReportMap((uint8_t *)customHidReportDescriptor, hidReportDescriptorSize);
BleGamepadInstance->hid->setReportMap((uint8_t *)customHidReportDescriptor, BleGamepadInstance->hidReportDescriptorSize);
BleGamepadInstance->hid->startServices();

BleGamepadInstance->onStarted(pServer);
Expand Down
13 changes: 10 additions & 3 deletions BleGamepad.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,15 @@
class BleGamepad
{
private:
uint8_t _buttons[16]; // 8 bits x 16 --> 128 bits
std::string deviceManufacturer;
std::string deviceName;
uint8_t tempHidReportDescriptor[150];
int hidReportDescriptorSize;
uint8_t hidReportSize;
uint8_t numOfButtonBytes;
bool enableOutputReport;
uint16_t outputReportLength;
uint8_t _buttons[16]; // 8 bits x 16 bytes = 128 bits --> 128 button max
uint8_t _specialButtons;
int16_t _x;
int16_t _y;
Expand Down Expand Up @@ -64,6 +72,7 @@ class BleGamepad

public:
BleGamepadConfiguration configuration;

BleGamepad(std::string deviceName = "ESP32 BLE Gamepad", std::string deviceManufacturer = "Espressif", uint8_t batteryLevel = 100);
void begin(BleGamepadConfiguration *config = new BleGamepadConfiguration());
void end(void);
Expand Down Expand Up @@ -130,8 +139,6 @@ class BleGamepad
void setTXPowerLevel(int8_t level = 9);
int8_t getTXPowerLevel();
uint8_t batteryLevel;
std::string deviceManufacturer;
std::string deviceName;
bool isOutputReceived();
uint8_t* getOutputBuffer();
bool deleteBond(bool resetBoard = false);
Expand Down
6 changes: 3 additions & 3 deletions BleGamepadConfiguration.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ BleGamepadConfiguration::BleGamepadConfiguration() : _controllerType(CONTROLLER_
_hardwareRevision("1.0.0"),
_enableOutputReport(false),
_outputReportLength(64),
_powerLevel(9)
_transmitPowerLevel(9)
{
}

Expand Down Expand Up @@ -132,7 +132,7 @@ char *BleGamepadConfiguration::getFirmwareRevision(){ return _firmwareRevision;
char *BleGamepadConfiguration::getHardwareRevision(){ return _hardwareRevision; }
bool BleGamepadConfiguration::getEnableOutputReport(){ return _enableOutputReport; }
uint16_t BleGamepadConfiguration::getOutputReportLength(){ return _outputReportLength; }
int8_t BleGamepadConfiguration::getTXPowerLevel(){ return _powerLevel; } // Returns the power level that was set as the server started
int8_t BleGamepadConfiguration::getTXPowerLevel(){ return _transmitPowerLevel; } // Returns the power level that was set as the server started

void BleGamepadConfiguration::setWhichSpecialButtons(bool start, bool select, bool menu, bool home, bool back, bool volumeInc, bool volumeDec, bool volumeMute)
{
Expand Down Expand Up @@ -211,4 +211,4 @@ void BleGamepadConfiguration::setFirmwareRevision(char *value) { _firmwareRevisi
void BleGamepadConfiguration::setHardwareRevision(char *value) { _hardwareRevision = value; }
void BleGamepadConfiguration::setEnableOutputReport(bool value) { _enableOutputReport = value; }
void BleGamepadConfiguration::setOutputReportLength(uint16_t value) { _outputReportLength = value; }
void BleGamepadConfiguration::setTXPowerLevel(int8_t value) { _powerLevel = value; }
void BleGamepadConfiguration::setTXPowerLevel(int8_t value) { _transmitPowerLevel = value; }
2 changes: 1 addition & 1 deletion BleGamepadConfiguration.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ class BleGamepadConfiguration
char *_hardwareRevision;
bool _enableOutputReport;
uint16_t _outputReportLength;
int8_t _powerLevel;
int8_t _transmitPowerLevel;


public:
Expand Down
4 changes: 2 additions & 2 deletions examples/GetPeerInfo/GetPeerInfo.ino
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
If you just need the MAC address, you can instead call bleGamepad.getAddress() which returns type NimBLEAddress
or bleGamepad.getStringAddress() to get it directly as a string
This sketch also chows how to access the information used to configure the BLE device such as vid, pid, model number and software revision etc
This sketch also shows how to access the information used to configure the BLE device such as vid, pid, model number and software revision etc
See CharacteristicsConfiguration.ino example to see how to set them
*/

Expand Down Expand Up @@ -69,7 +69,7 @@ void loop()
Serial.println(bleGamepad.configuration.getVid(), HEX);
Serial.println(bleGamepad.configuration.getPid(), HEX);
Serial.println(bleGamepad.configuration.getGuidVersion());
Serial.println(bleGamepad.configuration.getTXPowerLevel());
Serial.println(bleGamepad.configuration.getTXPowerLevel());
Serial.println();
delay(1000);
}
Expand Down

0 comments on commit f3c97cc

Please sign in to comment.