Skip to content

Commit af4043b

Browse files
committed
doc: complete some missing parts of the documentation
- Updated copyright and GIT repository URL. Signed-off-by: Diego Escalona <diego.escalona@digi.com>
1 parent 615b5c0 commit af4043b

File tree

7 files changed

+46
-4
lines changed

7 files changed

+46
-4
lines changed

doc/api/digi.xbee.packets.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Submodules
1818
digi.xbee.packets.devicecloud
1919
digi.xbee.packets.network
2020
digi.xbee.packets.raw
21+
digi.xbee.packets.relay
2122
digi.xbee.packets.wifi
2223
digi.xbee.packets.factory
2324

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949

5050
# General information about the project.
5151
project = u'XBee Python Library'
52-
copyright = u'2017, 2018, Digi International Inc.'
52+
copyright = u'2017-2019, Digi International Inc.'
5353

5454
# The version info for the project you're documenting, acts as replacement for
5555
# |version| and |release|, also used in various other places throughout the

doc/examples.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,20 @@ You can find the example at the following path:
425425
:ref:`communicateReceiveBluetoothData`.
426426

427427

428+
Receive Bluetooth file
429+
``````````````````````
430+
431+
This sample application shows how to receive a file from the XBee Bluetooth Low
432+
Energy interface.
433+
434+
You can find the example at the following path:
435+
**examples/communication/bluetooth/ReceiveBluetoothFileSample**
436+
437+
.. note::
438+
For more information about receiving Bluetooth data, see
439+
:ref:`communicateReceiveBluetoothData`.
440+
441+
428442
Receive MicroPython data
429443
````````````````````````
430444

doc/faq.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,16 @@ You can install PySerial running this command in your terminal application:
5555
For further information about the installation of PySerial, refer to the
5656
`PySerial installation guide
5757
<http://pythonhosted.org/pyserial/pyserial.html#installation>`_.
58+
59+
60+
I get the Python error ``ImportError: No module named 'srp'``
61+
-------------------------------------------------------------
62+
63+
This error means that Python cannot find the ``srp`` module, which is used by
64+
the library to authenticate with XBee devices over Bluetooth Low Energy.
65+
66+
You can install SRP running this command in your terminal application:
67+
68+
.. code::
69+
70+
$ pip install srp

doc/getting_started_with_xbee_python_library.rst

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ XBee Python application:
2222

2323
* :ref:`gsgInstallPython3`
2424
* :ref:`gsgInstallPySerial3`
25+
* :ref:`gsgInstallSRP`
2526
* :ref:`gsgInstallXBeePythonLibrarySoftware`
2627
* :ref:`gsgInstallXCTU`
2728

@@ -51,6 +52,18 @@ This module is automatically downloaded when you install the XBee Python
5152
library.
5253

5354

55+
.. _gsgInstallSRP:
56+
57+
SRP
58+
```
59+
60+
The XBee Python library uses the **SRP** module to authenticate with
61+
XBee devices over Bluetooth Low Energy.
62+
63+
This module is automatically downloaded when you install the XBee Python
64+
library.
65+
66+
5467
.. _gsgInstallXBeePythonLibrarySoftware:
5568

5669
XBee Python library software
@@ -74,12 +87,12 @@ Get the source code
7487
*******************
7588

7689
The XBee Python library is actively developed on GitHub, where the code is
77-
`always available <https://github.com/digidotcom/python-xbee>`_. You can
90+
`always available <https://github.com/digidotcom/xbee-python>`_. You can
7891
clone the repository with:
7992

8093
.. code::
8194
82-
$ git clone git@github.com:digidotcom/python-xbee.git
95+
$ git clone git@github.com:digidotcom/xbee-python.git
8396
8497
8598
.. _gsgInstallXCTU:

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ properly:
4444
the `PySerial installation guide
4545
<http://pythonhosted.org/pyserial/pyserial.html#installation>`_ for further
4646
information about getting PySerial.
47+
* **SRP** Install it with pip (``pip install srp``).
4748

4849

4950
Contents

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
version='1.1.1',
2424
description='Digi XBee Python library',
2525
long_description=long_description,
26-
url='https://github.com/digidotcom/python-xbee',
26+
url='https://github.com/digidotcom/xbee-python',
2727
author='Digi International Inc.',
2828
author_email='tech.support@digi.com',
2929
packages=find_packages(exclude=('unit_test*', 'functional_tests*', 'demos*')),

0 commit comments

Comments
 (0)