Commit Graph

33 Commits

Author SHA1 Message Date
Kevin Dewald
198f90e766 Updated READMEs throughout. 2025-05-30 15:07:32 -07:00
Kevin Dewald
038e9ad8ea Preview of power on/off capabilities 2025-04-25 22:20:40 -07:00
Claudiu Jipa
ed2095a541 Fix link paths in tutorial.rst (#399)
* Fix link paths in tutorial.rst

* Update tutorial.rst

---------

Co-authored-by: Kevin Dewald <5274600+kdewald@users.noreply.github.com>
2025-04-14 22:24:10 -07:00
Kevin Dewald
7c91280c04 Minor fixes, linting and documentation updates. 2025-02-20 12:41:58 -08:00
Kevin Dewald
53ccd2731f Further documentation updates 2025-01-27 21:18:06 -08:00
Kevin Dewald
19dc2a403d Better READMEs and updated URLs (#385)
* New README

* Tweaks

* Tweaks

* Tweaks

* Tweaks

* Tweaks

* Updated old references
2025-01-26 19:03:52 -08:00
Kevin Dewald
f9bc134b1c Updated readmes 2024-11-03 22:02:18 -08:00
Tobías Lifschitz
39cc358693 Refactor ByteArray from std::string alias to class implementation (#319)
* Refactor ByteArray from string alias to class implementation

- Converted ByteArray from an alias of std::string to a class implementation.
- Added multiple constructors to support initialization from various sources:
  - std::vector<uint8_t>
  - uint8_t pointer with size
  - std::string
  - C-string with and without null termination
- Implemented static methods fromHex() to construct from hex strings.
- Implemented c_str() method to return a C-string representation.
- Overloaded the stream operator to support pretty printing ByteArrays.

* Use an internal std::vector instead of inheriting from it

* Access directly to internal bytes of ByteArray

* Remove c_str methods

* Add slicing methods to ByteArray

* Fix data slicing in Windows backend

* Simplify ByteArray::fromHex

* Rename ByteArray::toHexString to toHex

so as to be consistent with fromHex

* Share ByteArray with simplebluez using common directory

* Remove unnecessary cast from ByteArray to string

* Extend use of ByteArray in simplebluez

* Revert changes in build script

* Remove subdirectory and rename namespace

* Allow hex prefix in 'fromHex' and clarify documentation

* Explicitly build ByteArray from py::bytes in python wrapper

* Add ByteArray to documentation

* Rename common dir to external

And rename kvn::ByteArray to kvn::bytearray

* Fix include path and format

* Use preprocessor guards instead of pragma
2024-07-27 16:25:56 -07:00
Kevin Dewald
79ac0c9702 Another pass at documentation and READMEs. (#327) 2024-07-07 20:38:16 -07:00
Tobías Lifschitz
22de7ed503 Misc doc changes (#323)
* [docs] Change CMake source flag in build documentation

From deprecated -H /path/to/source to -S /path/to/source

* [docs] Add class diagram to Simpleble 'API reference' page

Showing relationship between main frontend classes

* [docs] Add missing Cmake link

* Update api.rst

Removed class diagram. Doesn't seem necessary.

---------

Co-authored-by: Kevin Dewald <5274600+kdewald@users.noreply.github.com>
2024-07-06 11:18:36 -07:00
Kevin Dewald
1947dcc15c Updated documentation 2023-02-21 21:55:57 -08:00
Minos Park
8a7fcb8267 Add option for using session dbus (#197)
* add option for using session dbus

* Implemented required changes

* Removed extra character

* Updated documentation

---------

Co-authored-by: Minos Park <minos@neuralink.com>
Co-authored-by: Kevin Dewald <kdewald@itba.edu.ar>
2023-02-13 12:16:21 -08:00
Kevin Dewald
d80f593344 Proper safe version of Adapter::bluetooth_enabled (#198)
* Proper safe version of Adapter::bluetooth_enabled

* Linting

* Cleanup examples a bit as well
2023-02-10 09:24:29 -08:00
Kevin Dewald
8e2b76bfbd Correct handling of DBus initialization error 2023-02-09 09:50:52 -08:00
Kevin Dewald
dfe8ba9325 Fix incorrect logging logic 2023-02-05 20:09:35 -08:00
Stephen-Hamilton-C
e0e95eb34d Add section for RPM-based distros (#178) 2023-01-24 20:35:02 -08:00
Kevin Dewald
e20c39bce9 Improved usage docs 2023-01-22 15:38:22 -08:00
Kevin Dewald
eb6392d49b Next batch of features for v0.6 (#130)
* Prep work for advertised services.

* Added support for advertised services on Windows

* Test with an older version of Windows SDK

* Reorganized internals a bit

* Added support for characteristic properties on Windows

* Scan report no longer deletes the identifier if it's empty

* Added stubs for MTU and wrote implementation on Windows

* Added support for characteristic properties on MacOS too

* Added support for advertised services on MacOS

* Minor docs changes

* MTU support for MacOS

* More explicit exception messages on MacOS

* GATT characteristic properties on Linux

* Retrieve MTU for Linux

* Added scanned services for Linux

* Linting

* Cppcheck

* Fixed plain backend

* Fixed plain backend, now for real
2022-11-13 18:20:39 -08:00
Kevin Dewald
c57eb935ec Next batch of features for v0.6 (#128)
* Add better instructions for Windows

* [Windows] Update device identifier if a new one is available.

* Added all the missing code. Damn autosave.

* Added logging for WinRT init
2022-11-06 22:34:53 -08:00
Kevin Dewald
5da893162f Added plain-flavored mode 2022-09-29 21:59:25 -07:00
Kevin Dewald
3e5daa09a5 More questions for FAQ 2022-09-27 08:02:46 -07:00
Kevin Dewald
c46624a184 More docs for SimpleBLE v0.5 (#113)
* More docs!

* Made version handling a bit simpler. Unified versions across subpackages.

* Fixed previous documentation bugs. First pass at Python docs

* Separated python binding code by class.

* Some progress with new docs

* See of we can get RTD to work

* See if the YAML file is correctly executed

* Move config file to root.

* Forgot the file

* Tweaking yaml

* Tweaking yaml

* Use apt packages

* Add breathe

* Try an older Python version.

* Try an older Python version.

* Pin Python packages

* Try another theme

* See if we can get RTD working

* Pin version post installation

* Raw pass at documentation of all functions.

* Add docs dependencies

* Pin requirement versions

* Fix linting exclude
2022-09-25 12:41:58 -04:00
Kevin Dewald
60e087b0da Cleanup in preparation for v0.5.0 release. (#108)
* Add support to run Doxygen on SimpleBLE source code.

* Merged changelogs and dropped old messages.

* Added tutorial page

* Add tutorial to index

* Minor tweaks in changelog

* Initial tutorial

* Minor fixes

* Clean lint job, add docs build job

* Fix indentation error

* Fix indentation error, again...

* Doxygen now works fine

* Added a lot of documentation
2022-09-20 13:17:43 -07:00
Kevin Dewald
94fc295b92 Made characteristic cleanup on Linux exception safe 2022-09-10 20:38:30 -07:00
Kevin Dewald
f474b76e0e Add support for discovery filters (#97)
* Added support for proper discovery filters in SimpleBluez.

* Changed Linux settings, updated changelog so far
2022-09-09 01:08:24 -04:00
Kevin Dewald
f107a59c37 Fix issue in CMakeLists forcing incorrect OSX deployment target (#96)
* Fixed issue in CMakeLists which forced incorrect OSX deployment target

* Add logs

* See if deployment target really needs to be defined

* Only set the target if none is set

* Remove unnecessary deployment target configuration. It should be passed in by the user.

* Fixed minor docs issues.
2022-09-06 10:58:54 -07:00
Kevin Dewald
0baaf7f715 Added Linux support for querying if adapters are enabled or not. 2022-09-05 21:13:50 -07:00
Kevin Dewald
1b6d2ede1d Logger now prints by default, updated changelog. 2022-09-05 11:00:36 -07:00
Kevin Dewald
f712d5079c Fixed incorrect setting when building SimplePyBLE 2022-08-29 23:00:28 -07:00
Kevin Dewald
13e5cffddc Updated changelog and fixed linting. 2022-08-28 21:44:26 -07:00
Kevin Dewald
232e81d193 Finalized documentation for a first pass. 2022-08-26 22:17:07 -07:00
Kevin Dewald
4133ae9b01 First complete pass at docs 2022-08-20 17:43:48 -07:00
Kevin Dewald
323edeb595 Basic documentation structure. 2022-08-20 12:39:56 -07:00