Skip to content

Commit 6d10f2f

Browse files
committed
[BREAKING] - Refactor NimBLEHIDDevice
* General code cleanup. * All functions that return a characteristic or service have been renamed to have a `get` prefix to better represent their function. * All functions that set a value have been renamed with the prefix `set` to better represent their functionality. * Added an `bool notify` parameter to `setBatteryLevel`, which if `true`, will send a notification of the value to the peer.
1 parent a874e50 commit 6d10f2f

File tree

3 files changed

+295
-230
lines changed

3 files changed

+295
-230
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,18 @@ All notable changes to this project will be documented in this file.
7070
- `NimBLEEddystoneTLM::getData` now returns a reference to * `NimBLEEddystoneTLM::BeaconData` instead of `std::string`.
7171
- `NimBLEBeacon::setData` now takes `const NimBLEBeacon::BeaconData&` instead of `std::string`.
7272
- `NimBLEBeacon::getData` now returns `const NimBLEBeacon::BeaconData&` instead of `std::string`.
73+
- `NimBLEHIDDevice::reportMap` renamed to `NimBLEHIDDevice::getReportMap`.
74+
- `NimBLEHIDDevice::hidControl` renamed to `NimBLEHIDDevice::getHidControl`.
75+
- `NimBLEHIDDevice::inputReport`renamed to `NimBLEHIDDevice::getInputReport`.
76+
- `NimBLEHIDDevice::outputReport`renamed to `NimBLEHIDDevice::getOutputReport`.
77+
- `NimBLEHIDDevice::featureReport`renamed to `NimBLEHIDDevice::getFeatureReport`.
78+
- `NimBLEHIDDevice::protocolMode`renamed to `NimBLEHIDDevice::getProtocolMode`.
79+
- `NimBLEHIDDevice::bootOutput`renamed to `NimBLEHIDDevice::getBootOutput`.
80+
- `NimBLEHIDDevice::pnp`renamed to `NimBLEHIDDevice::setPnp`.
81+
- `NimBLEHIDDevice::hidInfo`renamed to `NimBLEHIDDevice::setHidInfo`.
82+
- `NimBLEHIDDevice::deviceInfo`renamed to `NimBLEHIDDevice::getDeviceInfoService`.
83+
- `NimBLEHIDDevice::hidService`renamed to `NimBLEHIDDevice::getHidService`.
84+
- `NimBLEHIDDevice::batteryService`renamed to `NimBLEHIDDevice::getBatteryService`.
7385

7486
## Fixed
7587
- `NimBLEDevice::getPower` and `NimBLEDevice::getPowerLevel` bug worked around for the esp32s3 and esp32c3.
@@ -206,6 +218,8 @@ the functions and tracking in the host stack.
206218
- `NimBLEAddress::reverseByteOrder` method which will reverse the byte order of the address value.
207219
- `NimBLEHIDDevice::batteryLevel` returns the HID device battery level characteristic.
208220
- `NimBLEBeacon::setData` overload that takes `uint8_t* data` and `uint8_t length`.
221+
- `NimBLEHIDDevice::getPnp` function added to access the pnp characteristic.
222+
- `NimBLEHIDDevice::getHidInfo` function added to access the hid info characteristic.
209223

210224
## [1.4.1] - 2022-10-30
211225

0 commit comments

Comments
 (0)