File tree Expand file tree Collapse file tree 4 files changed +10
-28
lines changed Expand file tree Collapse file tree 4 files changed +10
-28
lines changed Original file line number Diff line number Diff line change @@ -36,16 +36,11 @@ This is easily achieved by downloading
36
36
or individual libraries can be installed using
37
37
`circup <https://github.com/adafruit/circup >`_.
38
38
39
- .. todo :: Describe the Adafruit product this library works with. For PCBs, you can also add the
40
- image from the assets folder in the PCB's GitHub repo.
41
-
42
39
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/ >`_
40
+
41
+
43
42
Installing from PyPI
44
43
=====================
45
- .. note :: This library is not available on PyPI yet. Install documentation is included
46
- as a standard element. Stay tuned for PyPI availability!
47
-
48
- .. todo :: Remove the above note if PyPI version is/will be available at time of release.
49
44
50
45
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
51
46
PyPI <https://pypi.org/project/adafruit-circuitpython-ble-beacon/> `_.
@@ -96,8 +91,7 @@ Or the following command to update an existing version:
96
91
Usage Example
97
92
=============
98
93
99
- .. todo :: Add a quick, simple example. It and other examples should live in the
100
- examples folder and be included in docs/examples.rst.
94
+ See the ``examples/ `` folder for more usage examples.
101
95
102
96
Documentation
103
97
=============
Original file line number Diff line number Diff line change 15
15
Implementation Notes
16
16
--------------------
17
17
18
- **Hardware:**
19
-
20
- .. todo:: Add links to any specific hardware product page(s), or category page(s).
21
- Use unordered list & hyperlink rST inline format: "* `Link Text <url>`_"
22
-
23
18
**Software and Dependencies:**
24
19
25
20
* Adafruit CircuitPython firmware for the supported boards:
26
21
https://circuitpython.org/downloads
27
22
28
- .. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies
29
- based on the library's use of either.
30
-
31
- # * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
32
- # * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
33
23
"""
34
24
35
25
import struct
Original file line number Diff line number Diff line change 1
- Simple test
2
- ------------
1
+ Sending and Receiving
2
+ ---------------------
3
3
4
4
Ensure your device works with this simple test.
5
5
6
6
.. literalinclude :: ../examples/ble_beacon_simpletest.py
7
- :caption: examples/ble_beacon_simpletest.py
7
+ :caption: Receive iBeacon advertisements
8
+ :linenos:
9
+
10
+ .. literalinclude :: ../examples/ble_beacon_sendtest.py
11
+ :caption: Send iBeacon advertisements
8
12
:linenos:
Original file line number Diff line number Diff line change @@ -24,15 +24,9 @@ Table of Contents
24
24
.. toctree ::
25
25
:caption: Tutorials
26
26
27
- .. todo :: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28
- the toctree above for use later.
29
-
30
27
.. toctree ::
31
28
:caption: Related Products
32
29
33
- .. todo :: Add any product links here. If there are none, then simply delete this todo and leave
34
- the toctree above for use later.
35
-
36
30
.. toctree ::
37
31
:caption: Other Links
38
32
You can’t perform that action at this time.
0 commit comments