Skip to content

Document BLEStringCharacteristic in API reference - #436

Open
rupayon123 wants to merge 1 commit into
arduino-libraries:masterfrom
rupayon123:docs/string-characteristic-reference-20260924
Open

rupayon123 wants to merge 1 commit into
arduino-libraries:masterfrom
rupayon123:docs/string-characteristic-reference-20260924

Conversation

@rupayon123

Copy link
Copy Markdown

Problem

The API reference lists the typed characteristic constructors but omits BLEStringCharacteristic, leaving its constructor and String methods undocumented (#349).

Change

Add it to the constructor list and document its maximum byte size, writeValue / setValue behavior, value() return type, and a small local-characteristic example. I checked the descriptions against src/BLEStringCharacteristic.h, src/BLEStringCharacteristic.cpp, and the underlying local write path.

Validation

  • git diff --check passed.
  • Compared each documented signature and value-size behavior with the current source.
  • Documentation-only change; no device or example compilation was run locally (arduino-cli is unavailable).

Prepared with AI assistance. Fixes #349.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Sep 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BLEStringCharacteristic is undocumented

4 participants