From 6d271f98b66ea3cccfc6a85ce4de278ccb298d51 Mon Sep 17 00:00:00 2001 From: Olivier Martin Date: Wed, 7 Feb 2024 17:26:12 +0100 Subject: [PATCH] gattlib-py: Document how to develop 'gattlib-py' --- gattlib-py/README.md | 17 ++++++++++++++++- .../advertisement_data/advertisement_data.py | 2 +- gattlib-py/examples/ble_scan/ble_scan.py | 2 +- .../examples/find_eddystone/find_eddystone.py | 2 +- .../nordic_thingy/environment_service.py | 2 +- .../examples/nordic_thingy/nordic_thingy.py | 2 +- .../examples/nordic_thingy/sound_service.py | 2 +- gattlib-py/examples/read_write/read_write.py | 2 +- gattlib-py/gattlib/__init__.py | 2 +- gattlib-py/gattlib/adapter.py | 2 +- gattlib-py/gattlib/device.py | 2 +- gattlib-py/gattlib/exception.py | 2 +- gattlib-py/gattlib/gatt.py | 2 +- gattlib-py/gattlib/uuid.py | 2 +- 14 files changed, 29 insertions(+), 14 deletions(-) diff --git a/gattlib-py/README.md b/gattlib-py/README.md index 455dfc2..1b51b7a 100644 --- a/gattlib-py/README.md +++ b/gattlib-py/README.md @@ -1 +1,16 @@ -`gattlib-py` is a wrapper for `gattlib` library. \ No newline at end of file +`gattlib-py` is a wrapper for `gattlib` library. + +Development +----------- + +1. Set `PYTHONPATH`: `export PYTHONPATH=$PWD/gattlib-py:$PYTHONPATH` + +2. Build native library + +``` +mkdir -p build && cd build +cmake .. +make +``` + +3. Set `export LD_LIBRARY_PATH=$PWD/dbus` for Python module to find native library. \ No newline at end of file diff --git a/gattlib-py/examples/advertisement_data/advertisement_data.py b/gattlib-py/examples/advertisement_data/advertisement_data.py index 6aee9e1..ffb2b23 100755 --- a/gattlib-py/examples/advertisement_data/advertisement_data.py +++ b/gattlib-py/examples/advertisement_data/advertisement_data.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import argparse diff --git a/gattlib-py/examples/ble_scan/ble_scan.py b/gattlib-py/examples/ble_scan/ble_scan.py index f6768c2..1746a29 100755 --- a/gattlib-py/examples/ble_scan/ble_scan.py +++ b/gattlib-py/examples/ble_scan/ble_scan.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2022, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import argparse diff --git a/gattlib-py/examples/find_eddystone/find_eddystone.py b/gattlib-py/examples/find_eddystone/find_eddystone.py index dae3b6f..fb4e64a 100755 --- a/gattlib-py/examples/find_eddystone/find_eddystone.py +++ b/gattlib-py/examples/find_eddystone/find_eddystone.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2022, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import argparse diff --git a/gattlib-py/examples/nordic_thingy/environment_service.py b/gattlib-py/examples/nordic_thingy/environment_service.py index 6fb0dd9..8c209aa 100644 --- a/gattlib-py/examples/nordic_thingy/environment_service.py +++ b/gattlib-py/examples/nordic_thingy/environment_service.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import struct diff --git a/gattlib-py/examples/nordic_thingy/nordic_thingy.py b/gattlib-py/examples/nordic_thingy/nordic_thingy.py index 14a6a07..5ce04c3 100755 --- a/gattlib-py/examples/nordic_thingy/nordic_thingy.py +++ b/gattlib-py/examples/nordic_thingy/nordic_thingy.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import argparse diff --git a/gattlib-py/examples/nordic_thingy/sound_service.py b/gattlib-py/examples/nordic_thingy/sound_service.py index 1bbc44b..3ce4600 100644 --- a/gattlib-py/examples/nordic_thingy/sound_service.py +++ b/gattlib-py/examples/nordic_thingy/sound_service.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import time diff --git a/gattlib-py/examples/read_write/read_write.py b/gattlib-py/examples/read_write/read_write.py index 8fd6c9a..92f3656 100755 --- a/gattlib-py/examples/read_write/read_write.py +++ b/gattlib-py/examples/read_write/read_write.py @@ -3,7 +3,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import argparse diff --git a/gattlib-py/gattlib/__init__.py b/gattlib-py/gattlib/__init__.py index 9e0d0f9..c6d9e5a 100644 --- a/gattlib-py/gattlib/__init__.py +++ b/gattlib-py/gattlib/__init__.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # from ctypes import * diff --git a/gattlib-py/gattlib/adapter.py b/gattlib-py/gattlib/adapter.py index fbd84bf..0de72c5 100644 --- a/gattlib-py/gattlib/adapter.py +++ b/gattlib-py/gattlib/adapter.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2022, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # from uuid import UUID diff --git a/gattlib-py/gattlib/device.py b/gattlib-py/gattlib/device.py index 139a370..266dc68 100644 --- a/gattlib-py/gattlib/device.py +++ b/gattlib-py/gattlib/device.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2022, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import logging diff --git a/gattlib-py/gattlib/exception.py b/gattlib-py/gattlib/exception.py index b1ecf0e..cbbd8b9 100644 --- a/gattlib-py/gattlib/exception.py +++ b/gattlib-py/gattlib/exception.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2022, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # GATTLIB_SUCCESS = 0 diff --git a/gattlib-py/gattlib/gatt.py b/gattlib-py/gattlib/gatt.py index da74bd8..d65cb58 100644 --- a/gattlib-py/gattlib/gatt.py +++ b/gattlib-py/gattlib/gatt.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # from gattlib import * diff --git a/gattlib-py/gattlib/uuid.py b/gattlib-py/gattlib/uuid.py index 1d905a5..a8f5676 100644 --- a/gattlib-py/gattlib/uuid.py +++ b/gattlib-py/gattlib/uuid.py @@ -1,7 +1,7 @@ # # SPDX-License-Identifier: BSD-3-Clause # -# Copyright (c) 2016-2021, Olivier Martin +# Copyright (c) 2016-2024, Olivier Martin # import re