Skip to content

Commit 4e4197b

Browse files
committed
Update changelog.
1 parent 76ce18a commit 4e4197b

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

CHANGELOG.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,74 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [Unreleased]
6+
7+
### Added
8+
- `NimBLECharacteristic::getDescriptorByHandle`: Return the BLE Descriptor for the given handle.
9+
10+
- `NimBLEDescriptor::getStringValue`: Get the value of this descriptor as a string.
11+
12+
- `NimBLEServer::getServiceByHandle`: Get a service by its handle.
13+
14+
- `NimBLEService::getCharacteristicByHandle`: Get a pointer to the characteristic object with the specified handle.
15+
16+
- `NimBLEService::getCharacteristics`: Get the vector containing pointers to each characteristic associated with this service.
17+
Overloads to get a vector containing pointers to all the characteristics in a service with the UUID. (supports multiple same UUID's in a service)
18+
- `NimBLEService::getCharacteristics(const char *uuid)`
19+
- `NimBLEService::getCharacteristics(const NimBLEUUID &uuid)`
20+
21+
- `NimBLEAdvertisementData` New methods:
22+
- `NimBLEAdvertisementData::addTxPower`: Adds transmission power to the advertisement.
23+
- `NimBLEAdvertisementData::setPreferredParams`: Adds connection parameters to the advertisement.
24+
- `NimBLEAdvertisementData::setURI`: Adds URI data to the advertisement.
25+
26+
- `NimBLEAdvertising` New methods:
27+
- `NimBLEAdvertising::setName`: Set the name advertised.
28+
- `NimBLEAdvertising::setManufacturerData`: Adds manufacturer data to the advertisement.
29+
- `NimBLEAdvertising::setURI`: Adds URI data to the advertisement.
30+
- `NimBLEAdvertising::setServiceData`: Adds service data to the advertisement.
31+
- `NimBLEAdvertising::addTxPower`: Adds transmission power to the advertisement.
32+
- `NimBLEAdvertising::reset`: Stops the current advertising and resets the advertising data to the default values.
33+
34+
- `NimBLEDevice::setScanFilterMode`: Set the controller duplicate filter mode for filtering scanned devices.
35+
36+
- `NimBLEDevice::setScanDuplicateCacheSize`: Sets the number of advertisements filtered before the cache is reset.
37+
38+
- `NimBLEScan::setMaxResults`: This allows for setting a maximum number of advertised devices stored in the results vector.
39+
40+
- `NimBLEAdvertisedDevice` New data retrieval methods added:
41+
- `haveAdvInterval/getAdvInterval`: checks if the interval is advertised / gets the advertisement interval value.
42+
43+
- `haveConnParams/getMinInterval/getMaxInterval`: checks if the parameters are advertised / get min value / get max value.
44+
45+
- `haveURI/getURI`: checks if a URI is advertised / gets the URI data.
46+
47+
- `haveTargetAddress/getTargetAddressCount/getTargetAddress(index)`: checks if a target address is present / gets a count of the addresses targeted / gets the address of the target at index.
48+
49+
### Changed
50+
- `NimBLEServer::getServiceByUUID` Now takes an extra parameter of instanceID to support multiple services with the same UUID.
51+
52+
- `NimBLEService::getCharacteristic` Now takes an extra parameter of instanceID to support multiple characteristics with the same UUID.
53+
54+
- `NimBLEAdvertising` Transmission power is no longer advertised by default and can be added to the advertisement by calling `NimBLEAdvertising::addTxPower`
55+
56+
- `NimBLEScan` Now uses the controller duplicate filter.
57+
58+
- `NimBLEAdvertisedDevice` Has been refactored to store the complete advertisement payload and no longer parses the data from each advertisement.
59+
Instead the data will be parsed on-demand when the user application asks for specific data.
60+
61+
### Fixed
62+
- `NimBLEHIDDevice` Characteristics now use encryption, this resolves an issue with communicating with devices requiring encryption for HID devices.
63+
64+
565
## [1.1.0] - 2021-01-20
666

767
### Added
868
- `NimBLEDevice::setOwnAddrType` added to enable the use of random and random-resolvable addresses, by asukiaaa
969

1070
- New examples for securing and authenticating client/server connections, by mblasee.
1171

12-
- `NimBLEAdvertiseing::SetMinPreferred` and `NimBLEAdvertiseing::SetMinPreferred` re-added.
72+
- `NimBLEAdvertising::SetMinPreferred` and `NimBLEAdvertising::SetMinPreferred` re-added.
1373

1474
- Conditional checks added for command line config options in `nimconfig.h` to support custom configuration in platformio.
1575

@@ -71,6 +131,7 @@ advertised them as 16/32bit but resolved them to 128bits. Both are now checked.
71131

72132
- (Arduino) Ensure controller mode is set to BLE Only.
73133

134+
74135
## [1.0.2] - 2020-09-13
75136

76137
### Changed
@@ -84,6 +145,7 @@ Any changes to the controller max connection settings in `sdkconfig.h` will now
84145
- (Arduino) Revert the previous change to fix the advertising start delay. Instead a replacement fix that routes all BLE controller commands from
85146
a task running on core 0 (same as the controller) has been implemented. This improves response times and reliability for all BLE functions.
86147

148+
87149
## [1.0.1] - 2020-09-02
88150

89151
### Added

0 commit comments

Comments
 (0)