mirror of
https://github.com/OpenBluetoothToolbox/SimpleBLE
synced 2025-05-08 21:47:10 +08:00
Better READMEs and updated URLs (#385)
* New README * Tweaks * Tweaks * Tweaks * Tweaks * Tweaks * Updated old references
This commit is contained in:
Kevin Dewald
GitHub
parent
76ec0d2dbb
commit
19dc2a403d
@ -6,7 +6,7 @@ version = "0.9.1"
|
||||
license = "BUSL-1.1"
|
||||
description = "The all-in-one Bluetooth library that makes it easy to add wireless connectivity to your projects."
|
||||
readme = "simplersble/README.md"
|
||||
repository = "https://github.com/OpenBluetoothToolbox/SimpleBLE"
|
||||
repository = "https://github.com/simpleble/simpleble"
|
||||
|
||||
include = [
|
||||
"/VERSION",
|
||||
|
||||
72
README.rst
72
README.rst
@ -1,52 +1,53 @@
|
||||
|Latest Documentation Status|
|
||||
|
||||
SimpleBLE
|
||||
==========
|
||||
|
||||
The ultimate cross-platform library and bindings for Bluetooth Low Energy (BLE).
|
||||
The ultimate cross-platform library and bindings for Bluetooth Low Energy (BLE), designed for simplicity and ease of use.
|
||||
|
||||
|Latest Documentation Status|
|
||||
Key Features
|
||||
------------
|
||||
|
||||
Overview
|
||||
--------
|
||||
* **Cross-Platform**: Enterprise-grade support for Windows, macOS, Linux, iOS, and Android
|
||||
* **Easy Integration**: Clean, consistent API across all platforms
|
||||
* **Multiple Language Support**: Production-ready bindings for C, C++, and Python, more coming soon
|
||||
* **Commercial Ready**: Source-available commercial license for proprietary applications
|
||||
|
||||
The SimpleBLE project aims to provide fully cross-platform BLE libraries and bindings
|
||||
for C++, Python, Rust and other languages, designed for simplicity and ease of use,
|
||||
with a consistent behavior and API across all platforms.
|
||||
Language Bindings
|
||||
-----------------
|
||||
|
||||
SimpleBLE runs on Windows 10+, macOS 10.15+, Linux (Ubuntu 20.04+), iOS 15.0+, and Android (API 31+ - Still in Alpha).
|
||||
* **C/C++**: Core implementation with full platform support
|
||||
* **Python (SimplePyBLE)**: Python bindings. See the `SimplePyBLE`_ PyPI page for more details.
|
||||
* **Rust (SimpleRsBLE) - Alpha**: Rust bindings (under major refactor). See the `SimpleRsBLE`_ Crates.io page for more details.
|
||||
* **Android (SimpleDroidBLE) - Alpha**: Android-only bindings (alpha).
|
||||
* More languages coming soon!
|
||||
|
||||
**Commercial licensing is available for projects requiring proprietary distribution.**
|
||||
Extension Libraries
|
||||
-------------------
|
||||
|
||||
Below you'll find a list of frontends that are part of SimpleBLE:
|
||||
* **SimpleBluez**: BlueZ abstraction layer over DBus
|
||||
* **SimpleDBus**: DBus object hierarchy handler
|
||||
|
||||
* **SimpleBLE:** C++ cross-platform BLE library.
|
||||
* **SimplePyBLE:** Python bindings for SimpleBLE. See the `SimplePyBLE`_ PyPI page for more details.
|
||||
* **SimpleDroidBLE:** Android-specific package following the SimpleBLE API. (Still in Alpha, more to come)
|
||||
* **SimpleRsBLE:** Rust bindings for SimpleBLE (LEGACY - Big refactor coming soon). See the `SimpleRsBLE`_ Crates.io page for more details.
|
||||
Support & Resources
|
||||
--------------------
|
||||
|
||||
Additionally, we also provide a set of low-level libraries that can be used to interface with the underlying Bluetooth stack on Linux:
|
||||
We're here to help you succeed with SimpleBLE:
|
||||
|
||||
* **SimpleBluez:** C++ abstraction layer for BlueZ over DBus.
|
||||
* **SimpleDBus:** C++ wrapper for libdbus-1 with convenience classes to handle DBus object hierarchies effectively.
|
||||
* **Documentation**: Visit our `ReadTheDocs`_ page for comprehensive guides
|
||||
* **Commercial Support**: Check our `website`_ or `email us <mailto:contact@simpleble.org>`_ for licensing and professional services
|
||||
* **Community**: Join our `Discord`_ server for discussions and help
|
||||
|
||||
If you want to use SimpleBLE and need help. **Please do not hesitate to reach out!**
|
||||
|
||||
* Visit our `ReadTheDocs`_ page for comprehensive documentation.
|
||||
* Visit our `website`_ or email us at `email us <mailto:contact@simpleble.org>`_ for commercial licensing and professional support services.
|
||||
* Join our `Discord`_ server for community discussions and help.
|
||||
Don't hesitate to reach out - we're happy to help!
|
||||
|
||||
Projects using SimpleBLE
|
||||
------------------------
|
||||
|
||||
Don't forget to check out the following projects using SimpleBLE:
|
||||
|
||||
* `BrainFlow`_
|
||||
* `InsideBlue`_
|
||||
* `NodeWebBluetooth`_
|
||||
|
||||
Contributing
|
||||
------------
|
||||
Pull requests are welcome. For major changes, please open an issue first to discuss
|
||||
what you would like to change.
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
@ -64,7 +65,7 @@ version 3 after four years of its initial release.
|
||||
- Priority technical support included
|
||||
- Clear terms for integrating into MIT-licensed projects
|
||||
|
||||
**You can find more information on pricing and commercial terms of service on our `website`_ .**
|
||||
**You can find more information on pricing and commercial terms of service at www.simpleble.org**
|
||||
|
||||
For further enquiries, please contact us at ``contact at simpleble dot org``.
|
||||
|
||||
@ -73,8 +74,7 @@ For further enquiries, please contact us at ``contact at simpleble dot org``.
|
||||
Licensing FAQ
|
||||
-------------
|
||||
|
||||
What does the Business Source License 1.1 allow and restrict?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**What does the Business Source License 1.1 allow and restrict?**
|
||||
|
||||
The Business Source License allows non-production use, such as development and testing in isolated
|
||||
environments. However, any use that could be considered production (including internal tools,
|
||||
@ -83,8 +83,7 @@ revenue-generating projects, or customer-facing deployments) requires purchasing
|
||||
After four years of the initial release of a given version of SimpleBLE, the license automatically
|
||||
converts to the GNU General Public License version 3.
|
||||
|
||||
What do you consider "commercial use"?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**What do you consider "commercial use"?**
|
||||
|
||||
Commercial use in the context of SimpleBLE refers to any usage of the library or its derivatives in
|
||||
a commercial setting where it contributes, either directly or indirectly, to financial gain. This
|
||||
@ -92,8 +91,7 @@ includes, but is not limited to, incorporating SimpleBLE into commercial softwar
|
||||
in the development of services offered for a fee, or deploying it within internal tools or software
|
||||
in a for-profit organization where it adds business value.
|
||||
|
||||
Why do I need to pay for commercial use?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**Why do I need to pay for commercial use?**
|
||||
|
||||
Commercial licensing enables us to sustainably maintain and enhance SimpleBLE, particularly given
|
||||
its growing adoption in critical sectors like medical and industrial applications. The revenue
|
||||
@ -103,13 +101,11 @@ language support, better testing infrastructure, and more comprehensive document
|
||||
SimpleBLE remains freely available for non-commercial use, the Business Source License ensures we
|
||||
can continue providing the level of reliability and support that commercial applications require.
|
||||
|
||||
I already have a commercial license. What happens with this latest license change?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**I already have a commercial license. What happens with this latest license change?**
|
||||
|
||||
Nothing changes. You can continue using SimpleBLE under the terms of your commercial license.
|
||||
|
||||
I'm using SimpleBLE commercially, but don't have a commercial license. What should I do?
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
**I'm using SimpleBLE commercially, but don't have a commercial license. What should I do?**
|
||||
|
||||
Please reach out at ``contact at simpleble dot org`` and we can discuss the specifics of your
|
||||
situation. We have a free commercial license option for small projects and early-stage companies
|
||||
|
||||
@ -227,22 +227,22 @@ Layers and their responsibilities
|
||||
|
||||
.. Links
|
||||
|
||||
.. _examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simpleble
|
||||
.. _examples: https://github.com/simpleble/simpleble/tree/main/examples/simpleble
|
||||
|
||||
.. _list_adapters: https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/list_adapters/list_adapters.cpp
|
||||
.. _list_adapters: https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/list_adapters/list_adapters.cpp
|
||||
|
||||
.. _scan (cpp): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/scan/scan.cpp
|
||||
.. _scan (cpp): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/scan/scan.cpp
|
||||
|
||||
.. _connect (cpp): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/connect/connect.cpp
|
||||
.. _connect (cpp): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/connect/connect.cpp
|
||||
|
||||
.. _connect_safe (cpp): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/connect_safe/connect_safe.cpp
|
||||
.. _connect_safe (cpp): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/connect_safe/connect_safe.cpp
|
||||
|
||||
.. _read: https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/read/read.cpp
|
||||
.. _read: https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/read/read.cpp
|
||||
|
||||
.. _write: https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/write/write.cpp
|
||||
.. _write: https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/write/write.cpp
|
||||
|
||||
.. _notify (cpp): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/cpp/notify/notify.cpp
|
||||
.. _notify (cpp): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/cpp/notify/notify.cpp
|
||||
|
||||
.. _connect (c): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/c/connect.c
|
||||
.. _scan (c): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/c/scan.c
|
||||
.. _notify (c): https://github.com/OpenBluetoothToolbox/SimpleBLE/blob/main/examples/simpleble/c/notify.c
|
||||
.. _connect (c): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/c/connect.c
|
||||
.. _scan (c): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/c/scan.c
|
||||
.. _notify (c): https://github.com/simpleble/simpleble/blob/main/examples/simpleble/c/notify.c
|
||||
|
||||
@ -11,4 +11,4 @@ in the repository.
|
||||
|
||||
.. Links
|
||||
|
||||
.. _examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplebluez
|
||||
.. _examples: https://github.com/simpleble/simpleble/tree/main/examples/simplebluez
|
||||
@ -36,4 +36,4 @@ Proxy
|
||||
|
||||
.. Links
|
||||
|
||||
.. _examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simpledbus
|
||||
.. _examples: https://github.com/simpleble/simpleble/tree/main/examples/simpledbus
|
||||
@ -41,16 +41,16 @@ The following list briefly describes each example provided:
|
||||
|
||||
.. Links
|
||||
|
||||
.. _examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble
|
||||
.. _examples: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble
|
||||
|
||||
.. _list_adapters: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/list_adapters.py
|
||||
.. _list_adapters: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/list_adapters.py
|
||||
|
||||
.. _scan: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/scan.py
|
||||
.. _scan: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/scan.py
|
||||
|
||||
.. _connect: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/connect.py
|
||||
.. _connect: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/connect.py
|
||||
|
||||
.. _read: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/read.py
|
||||
.. _read: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/read.py
|
||||
|
||||
.. _write: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/write.py
|
||||
.. _write: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/write.py
|
||||
|
||||
.. _notify: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble/notify.py
|
||||
.. _notify: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble/notify.py
|
||||
|
||||
2
setup.py
2
setup.py
@ -141,7 +141,7 @@ skbuild.setup(
|
||||
version=version_str,
|
||||
author="Kevin Dewald",
|
||||
author_email="kevin@dewald.me",
|
||||
url="https://github.com/OpenBluetoothToolbox/SimpleBLE",
|
||||
url="https://github.com/simpleble/simpleble",
|
||||
description="The ultimate fully-fledged cross-platform BLE library, designed for simplicity and ease of use.",
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/x-rst",
|
||||
|
||||
@ -6,7 +6,7 @@ project(
|
||||
simpleble
|
||||
VERSION ${SIMPLEBLE_VERSION}
|
||||
DESCRIPTION "The ultimate fully-fledged cross-platform library for Bluetooth Low Energy (BLE)."
|
||||
HOMEPAGE_URL "https://github.com/OpenBluetoothToolbox/SimpleBLE"
|
||||
HOMEPAGE_URL "https://github.com/simpleble/simpleble"
|
||||
LANGUAGES CXX
|
||||
)
|
||||
|
||||
|
||||
@ -1,25 +1,27 @@
|
||||
|Latest Documentation Status| |PyPI Licence|
|
||||
|
||||
SimplePyBLE
|
||||
===========
|
||||
|
||||
The ultimate cross-platform bindings for Bluetooth Low Energy (BLE).
|
||||
The ultimate cross-platform library and bindings for Bluetooth Low Energy (BLE), designed for simplicity and ease of use.
|
||||
|
||||
|Latest Documentation Status| |PyPI Licence|
|
||||
Key Features
|
||||
------------
|
||||
|
||||
Overview
|
||||
--------
|
||||
* **Cross-Platform**: Enterprise-grade support for Windows, macOS, Linux
|
||||
* **Easy Integration**: Clean, consistent API across all platforms
|
||||
* **Commercial Ready**: Source-available commercial license for proprietary applications
|
||||
|
||||
SimplePyBLE provides Python bindings for `SimpleBLE`_, a fully cross-platform BLE library,
|
||||
designed for simplicity and ease of use, with a consistent behavior and API across all platforms.
|
||||
Support & Resources
|
||||
--------------------
|
||||
|
||||
SimplePyBLE runs on Windows 10+, Linux (Ubuntu 20.04+) and MacOS 10.15+ (Catalina and newer).
|
||||
We're here to help you succeed with SimpleBLE:
|
||||
|
||||
**Commercial licensing is available for projects requiring proprietary distribution.**
|
||||
* **Documentation**: Visit our `ReadTheDocs`_ page for comprehensive guides
|
||||
* **Commercial Support**: Check our `website`_ or `email us <mailto:contact@simpleble.org>`_ for licensing and professional services
|
||||
* **Community**: Join our `Discord`_ server for discussions and help
|
||||
|
||||
If you want to use SimplePyBLE and need help. **Please do not hesitate to reach out!**
|
||||
|
||||
* Visit our `ReadTheDocs`_ page for comprehensive documentation.
|
||||
* Visit our `website`_ or email us at `email us <mailto:contact@simpleble.org>`_ for commercial licensing and professional support services.
|
||||
* Join our `Discord`_ server for community discussions and help.
|
||||
Don't hesitate to reach out - we're happy to help!
|
||||
|
||||
Installation
|
||||
------------
|
||||
@ -48,7 +50,7 @@ version 3 after four years of its initial release.
|
||||
- Priority technical support included
|
||||
- Clear terms for integrating into MIT-licensed projects
|
||||
|
||||
**You can find more information on pricing and commercial terms of service on our `website`_.**
|
||||
**You can find more information on pricing and commercial terms of service at www.simpleble.org**
|
||||
|
||||
For further enquiries, please contact us at ``contact at simpleble dot org``.
|
||||
|
||||
@ -60,9 +62,9 @@ For further enquiries, please contact us at ``contact at simpleble dot org``.
|
||||
|
||||
.. _SimplePyBLE: https://pypi.org/project/simplepyble/
|
||||
|
||||
.. _SimpleBLE: https://github.com/OpenBluetoothToolbox/SimpleBLE/
|
||||
.. _SimpleBLE: https://github.com/simpleble/simpleble/
|
||||
|
||||
.. _code examples: https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplepyble
|
||||
.. _code examples: https://github.com/simpleble/simpleble/tree/main/examples/simplepyble
|
||||
|
||||
.. _Discord: https://discord.gg/N9HqNEcvP3
|
||||
|
||||
|
||||
@ -1,19 +1,24 @@
|
||||
# SimpleRsBLE
|
||||
|
||||
The ultimate cross-platform bindings for Bluetooth Low Energy (BLE).
|
||||
|
||||
## Overview
|
||||
|
||||
SimpleRsBLE provides Rust bindings for [SimpleBLE](https://github.com/OpenBluetoothToolbox/SimpleBLE/),
|
||||
a fully cross-platform BLE library, designed for simplicity and ease of use, with a consistent behavior and API across all platforms.
|
||||
The ultimate cross-platform library and bindings for Bluetooth Low Energy (BLE), designed for simplicity and ease of use.
|
||||
|
||||
**IMPORTANT:** SimpleRsBLE is currently in the process of being rewritten from scratch to follow proper idiomatic Rust patterns.
|
||||
|
||||
If you want to use SimpleRsBLE and need help, **please do not hesitate to reach out!**
|
||||
## Key Features
|
||||
|
||||
- Visit our [ReadTheDocs](https://simpleble.readthedocs.io/en/latest/) page for comprehensive documentation
|
||||
- Visit our [website](https://simpleble.org) or email us at `contact@simpleble.org` for commercial licensing and professional support services
|
||||
- Join our [Discord](https://discord.gg/N9HqNEcvP3) server for community discussions and help
|
||||
* **Cross-Platform**: Enterprise-grade support for Windows, macOS, Linux, iOS, and Android
|
||||
* **Easy Integration**: Clean, consistent API across all platforms
|
||||
* **Commercial Ready**: Source-available commercial license for proprietary applications
|
||||
|
||||
## Support & Resources
|
||||
|
||||
We're here to help you succeed with SimpleBLE:
|
||||
|
||||
* **Documentation**: Visit our [ReadTheDocs](https://simpleble.readthedocs.io/en/latest/) page for comprehensive guides
|
||||
* **Commercial Support**: Check our [website](https://simpleble.org) or `email us <mailto:contact@simpleble.org>`_ for licensing and professional services
|
||||
* **Community**: Join our [Discord](https://discord.gg/N9HqNEcvP3) server for discussions and help
|
||||
|
||||
Don't hesitate to reach out - we're happy to help!
|
||||
|
||||
## Installation
|
||||
|
||||
@ -24,7 +29,7 @@ You can add SimpleRsBLE to your project by adding the following lines to your `C
|
||||
simplersble = "0.6.0"
|
||||
```
|
||||
|
||||
Please review our [code examples](https://github.com/OpenBluetoothToolbox/SimpleBLE/tree/main/examples/simplersble/src/bin) on GitHub for more information on how to use SimpleRsBLE.
|
||||
Please review our [code examples](https://github.com/simpleble/simpleble/tree/main/examples/simplersble/src/bin) on GitHub for more information on how to use SimpleRsBLE.
|
||||
|
||||
# License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user