Skip to content

Make writeValue return the number of bytes written #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 11, 2025
Merged

Make writeValue return the number of bytes written #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab7509f
Make handleNotify and handleInd return written bytes per peer
pennam Apr 8, 2025
1619dd0
BLE.setAdvertisedServiceData: adopt _valueLength limit
pennam Apr 8, 2025
5d22155
writeValue: return the number of bytes written/stored in buffer
pennam Apr 8, 2025
2a4e4b5
Add writeValue tests
pennam Apr 10, 2025
240c74f
test: check broadcast handleInt and handleNotify with no peers
pennam Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions extras/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ set(TEST_TARGET_CHARACTERISTIC_SRCS
# Test files
${COMMON_TEST_SRCS}
src/test_characteristic/test_permissions.cpp
src/test_characteristic/test_writeValue.cpp
# DUT files
${DUT_SRCS}
# Fake classes files
Expand Down
389 changes: 389 additions & 0 deletions extras/test/src/test_characteristic/test_writeValue.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,389 @@
/*
This file is part of the ArduinoBLE library.
Copyright (c) 2018 Arduino SA. All rights reserved.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/

#include <catch2/catch_test_macros.hpp>

#define private public
#define protected public

#include "FakeBLELocalDevice.h"
#include "BLEAdvertisingData.h"
#include "BLETypedCharacteristics.h"
#include "BLELocalCharacteristic.h"
#include "BLEStringCharacteristic.h"
#include "BLEProperty.h"


TEST_CASE("Test characteristic writeValue", "[ArduinoBLE::BLECharacteristic]")
{
WHEN("Create a bool characteristic")
{
BLEBoolCharacteristic boolCharacteristic("Bool", BLEBroadcast| BLEIndicate | BLENotify );
bool v = false;;
int written = boolCharacteristic.writeValue(v);
REQUIRE( written == sizeof(bool) );

boolCharacteristic.broadcast();
written = boolCharacteristic.writeValue(v);
REQUIRE( written == sizeof(bool) );

BLEDevice device;
boolCharacteristic.local()->writeCccdValue(device, 0x002);
written = boolCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
boolCharacteristic.local()->writeCccdValue(device, 0x001);
written = boolCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a boolean characteristic")
{
BLEBooleanCharacteristic booleanCharacteristic("Boolean", BLEBroadcast| BLEIndicate | BLENotify);
bool v = false;
int written = booleanCharacteristic.writeValue(v);
REQUIRE( written == sizeof(bool) );

booleanCharacteristic.broadcast();
written = booleanCharacteristic.writeValue(v);
REQUIRE( written == sizeof(bool) );

BLEDevice device;
booleanCharacteristic.local()->writeCccdValue(device, 0x002);
written = booleanCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
booleanCharacteristic.local()->writeCccdValue(device, 0x001);
written = booleanCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a char characteristic")
{
BLECharCharacteristic charCharacteristic("Char", BLEBroadcast| BLEIndicate | BLENotify);
char v = 'a';
int written = charCharacteristic.writeValue(v);
REQUIRE( written == sizeof(char) );

charCharacteristic.broadcast();
written = charCharacteristic.writeValue(v);
REQUIRE( written == sizeof(char) );

BLEDevice device;
charCharacteristic.local()->writeCccdValue(device, 0x002);
written = charCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
charCharacteristic.local()->writeCccdValue(device, 0x001);
written = charCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a unsigned char characteristic")
{
BLEUnsignedCharCharacteristic unsignedCharCharacteristic("UnsignedChar", BLEBroadcast| BLEIndicate | BLENotify);
unsigned char v = 0x01;
int written = unsignedCharCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned char) );

unsignedCharCharacteristic.broadcast();
written = unsignedCharCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned char) );

BLEDevice device;
unsignedCharCharacteristic.local()->writeCccdValue(device, 0x002);
written = unsignedCharCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
unsignedCharCharacteristic.local()->writeCccdValue(device, 0x001);
written = unsignedCharCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a byte characteristic")
{
BLEByteCharacteristic byteCharacteristic("Byte", BLEBroadcast| BLEIndicate | BLENotify);
byte v = 0x01;
int written = byteCharacteristic.writeValue(v);
REQUIRE( written == sizeof(byte) );

byteCharacteristic.broadcast();
written = byteCharacteristic.writeValue(v);
REQUIRE( written == sizeof(byte) );

BLEDevice device;
byteCharacteristic.local()->writeCccdValue(device, 0x002);
written = byteCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
byteCharacteristic.local()->writeCccdValue(device, 0x001);
written = byteCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a short characteristic")
{
BLEShortCharacteristic shortCharacteristic("Short", BLEBroadcast| BLEIndicate | BLENotify);
short v = -1;
int written = shortCharacteristic.writeValue(v);
REQUIRE( written == sizeof(short) );

shortCharacteristic.broadcast();
written = shortCharacteristic.writeValue(v);
REQUIRE( written == sizeof(short) );

BLEDevice device;
shortCharacteristic.local()->writeCccdValue(device, 0x002);
written = shortCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
shortCharacteristic.local()->writeCccdValue(device, 0x001);
written = shortCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a unsigned short characteristic")
{
BLEUnsignedShortCharacteristic unsignedShortCharacteristic("UnsignedShort", BLEBroadcast| BLEIndicate | BLENotify);
unsigned short v = 1;
int written = unsignedShortCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned short) );

unsignedShortCharacteristic.broadcast();
written = unsignedShortCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned short) );

BLEDevice device;
unsignedShortCharacteristic.local()->writeCccdValue(device, 0x002);
written = unsignedShortCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
unsignedShortCharacteristic.local()->writeCccdValue(device, 0x001);
written = unsignedShortCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a word characteristic")
{
BLEWordCharacteristic wordCharacteristic("Word", BLEBroadcast| BLEIndicate | BLENotify);
word v = -1;
int written = wordCharacteristic.writeValue(v);
REQUIRE( written == sizeof(word) );

wordCharacteristic.broadcast();
written = wordCharacteristic.writeValue(v);
REQUIRE( written == sizeof(word) );

BLEDevice device;
wordCharacteristic.local()->writeCccdValue(device, 0x002);
written = wordCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
wordCharacteristic.local()->writeCccdValue(device, 0x001);
written = wordCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a int characteristic")
{
BLEIntCharacteristic intCharacteristic("Int", BLEBroadcast| BLEIndicate | BLENotify);
int v = -1;
int written = intCharacteristic.writeValue(v);
REQUIRE( written == sizeof(int) );

intCharacteristic.broadcast();
written = intCharacteristic.writeValue(v);
REQUIRE( written == sizeof(int) );

BLEDevice device;
intCharacteristic.local()->writeCccdValue(device, 0x002);
written = intCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
intCharacteristic.local()->writeCccdValue(device, 0x001);
written = intCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a unsigned int characteristic")
{
BLEUnsignedIntCharacteristic unsignedIntCharacteristic("UnsignedInt", BLEBroadcast| BLEIndicate | BLENotify);
unsigned int v = 1;
int written = unsignedIntCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned int) );

unsignedIntCharacteristic.broadcast();
written = unsignedIntCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned int) );

BLEDevice device;
unsignedIntCharacteristic.local()->writeCccdValue(device, 0x002);
written = unsignedIntCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
unsignedIntCharacteristic.local()->writeCccdValue(device, 0x001);
written = unsignedIntCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a long characteristic")
{
BLELongCharacteristic longCharacteristic("Long", BLEBroadcast| BLEIndicate | BLENotify);
long v = -1;
int written = longCharacteristic.writeValue(v);
REQUIRE( written == sizeof(long) );

longCharacteristic.broadcast();
written = longCharacteristic.writeValue(v);
REQUIRE( written == sizeof(long) );

BLEDevice device;
longCharacteristic.local()->writeCccdValue(device, 0x002);
written = longCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
longCharacteristic.local()->writeCccdValue(device, 0x001);
written = longCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a unsigned long characteristic")
{
BLEUnsignedLongCharacteristic unsignedLongCharacteristic("UnsignedLong", BLEBroadcast| BLEIndicate | BLENotify);
unsigned long v = 1;
int written = unsignedLongCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned long) );

unsignedLongCharacteristic.broadcast();
written = unsignedLongCharacteristic.writeValue(v);
REQUIRE( written == sizeof(unsigned long) );

BLEDevice device;
unsignedLongCharacteristic.local()->writeCccdValue(device, 0x002);
written = unsignedLongCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
unsignedLongCharacteristic.local()->writeCccdValue(device, 0x001);
written = unsignedLongCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a float characteristic")
{
BLEFloatCharacteristic floatCharacteristic("Float", BLEBroadcast| BLEIndicate | BLENotify);
float v = -1.0f;
int written = floatCharacteristic.writeValue(v);
REQUIRE( written == sizeof(float) );

floatCharacteristic.broadcast();
written = floatCharacteristic.writeValue(v);
REQUIRE( written == sizeof(float) );

BLEDevice device;
floatCharacteristic.local()->writeCccdValue(device, 0x002);
written = floatCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
floatCharacteristic.local()->writeCccdValue(device, 0x001);
written = floatCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a double characteristic")
{
BLEDoubleCharacteristic doubleCharacteristic("Double", BLEBroadcast| BLEIndicate | BLENotify);
double v = -1.0;
int written = doubleCharacteristic.writeValue(v);
REQUIRE( written == sizeof(double) );

doubleCharacteristic.broadcast();
written = doubleCharacteristic.writeValue(v);
REQUIRE( written == sizeof(double) );

BLEDevice device;
doubleCharacteristic.local()->writeCccdValue(device, 0x002);
written = doubleCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
doubleCharacteristic.local()->writeCccdValue(device, 0x001);
written = doubleCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a string characteristic")
{
const int maxStringLength = 64;
BLEStringCharacteristic stringCharacteristic("String", BLEBroadcast| BLEIndicate | BLENotify, maxStringLength);
const char* v = "Hello";
int written = stringCharacteristic.writeValue(v);
REQUIRE( written == min(strlen(v), maxStringLength) );

stringCharacteristic.broadcast();
written = stringCharacteristic.writeValue(v);
REQUIRE( written == min(strlen(v), maxStringLength) );

BLEDevice device;
stringCharacteristic.local()->writeCccdValue(device, 0x002);
written = stringCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
stringCharacteristic.local()->writeCccdValue(device, 0x001);
written = stringCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

WHEN("Create a too long string characteristic")
{
const int maxStringLength = 4;
BLEStringCharacteristic stringCharacteristic("String", BLEBroadcast| BLEIndicate | BLENotify, maxStringLength);
const char* v = "Hello";
int written = stringCharacteristic.writeValue(v);
REQUIRE( written == min(strlen(v), maxStringLength) );

stringCharacteristic.broadcast();
written = stringCharacteristic.writeValue(v);
REQUIRE( written == min(strlen(v), maxStringLength) );

BLEDevice device;
stringCharacteristic.local()->writeCccdValue(device, 0x002);
written = stringCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
stringCharacteristic.local()->writeCccdValue(device, 0x001);
written = stringCharacteristic.writeValue(v);
/* No peers connected */
REQUIRE( written == 0 );
}

}
Loading
Loading