This is an automated email from the ASF dual-hosted git repository.
utzig pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 8a04d76 nRF tutorials: fix table formatting, and syntax errors in
interim examples (#99)
8a04d76 is described below
commit 8a04d7649bdf534c3451ad2fdd2c914a11316839
Author: Michael Farrell <[email protected]>
AuthorDate: Mon Jul 6 03:38:57 2020 +1000
nRF tutorials: fix table formatting, and syntax errors in interim examples
(#99)
* Fix table formatting and typos in interim examples for nRF
* Simplify emphasis per @caspermeijn comment
---
docs/tutorials/ble/eddystone.rst | 83 +++++++++++++++-------------------------
docs/tutorials/ble/ibeacon.rst | 78 ++++++++++++++-----------------------
2 files changed, 59 insertions(+), 102 deletions(-)
diff --git a/docs/tutorials/ble/eddystone.rst b/docs/tutorials/ble/eddystone.rst
index b362cc9..d6cc862 100644
--- a/docs/tutorials/ble/eddystone.rst
+++ b/docs/tutorials/ble/eddystone.rst
@@ -70,14 +70,15 @@ We achieve this by configuring the NimBLE host with a
callback function
that gets called when sync takes place:
.. code-block:: console
- :emphasize-lines: 1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,23
+ :emphasize-lines: 1-17,24
static void
ble_app_set_addr()
{ }
static void
- ble_app_advertise(); { }
+ ble_app_advertise()
+ { }
static void
ble_app_on_sync(void)
@@ -138,7 +139,7 @@ identifying information, and they are expected to change
frequently.
assert(rc == 0);
}
- static void ble_app_advertise();
+ static void ble_app_advertise()
{ }
static void ble_app_on_sync(void)
@@ -250,55 +251,33 @@ advertising is to be done. The default values are mostly
fine for our
simple beaconing application. We will pass the following values to this
function:
-+--------------+----------+----------+
-| Parameter | Value | Notes |
-+==============+==========+==========+
-| own\_addr\_t | BLE\_OWN | Use the |
-| ype | \_ADDR\_ | nRPA we |
-| | RANDOM | generate |
-| | | d |
-| | | earlier. |
-+--------------+----------+----------+
-| direct\_addr | NULL | We are |
-| | | broadcas |
-| | | ting, |
-| | | not |
-| | | targetin |
-| | | g |
-| | | a peer. |
-+--------------+----------+----------+
-| duration\_ms | BLE\_HS\ | Advertis |
-| | _FOREVER | e |
-| | | indefini |
-| | | tely. |
-+--------------+----------+----------+
-| adv\_params | defaults | Can be |
-| | | used to |
-| | | specify |
-| | | low |
-| | | level |
-| | | advertis |
-| | | ing |
-| | | paramete |
-| | | rs. |
-+--------------+----------+----------+
-| cb | NULL | We are |
-| | | non-conn |
-| | | ectable, |
-| | | so no |
-| | | need for |
-| | | an event |
-| | | callback |
-| | | . |
-+--------------+----------+----------+
-| cb\_arg | NULL | No |
-| | | callback |
-| | | implies |
-| | | no |
-| | | callback |
-| | | argument |
-| | | . |
-+--------------+----------+----------+
++-----------------+------------------------+--------------------+
+| Parameter | Value | Notes |
++=================+========================+====================+
+| own\_addr\_type | BLE\_OWN\_ADDR\_RANDOM | Use the nRPA we |
+| | | generated earlier. |
++-----------------+------------------------+--------------------+
+| direct\_addr | NULL | We are |
+| | | broadcasting, not |
+| | | targeting a peer. |
++-----------------+------------------------+--------------------+
+| duration\_ms | BLE\_HS\_FOREVER | Advertise |
+| | | indefinitely. |
++-----------------+------------------------+--------------------+
+| adv\_params | defaults | Can be used to |
+| | | specify low level |
+| | | advertising |
+| | | parameters. |
++-----------------+------------------------+--------------------+
+| cb | NULL | We are |
+| | | non-connectable, |
+| | | so no need for an |
+| | | event callback. |
++-----------------+------------------------+--------------------+
+| cb\_arg | NULL | No callback |
+| | | implies no |
+| | | callback argument. |
++-----------------+------------------------+--------------------+
These arguments are mostly self-explanatory. The exception is
``adv_params``, which can be used to specify a number of low-level
diff --git a/docs/tutorials/ble/ibeacon.rst b/docs/tutorials/ble/ibeacon.rst
index 9da7eb5..90f0656 100644
--- a/docs/tutorials/ble/ibeacon.rst
+++ b/docs/tutorials/ble/ibeacon.rst
@@ -63,7 +63,7 @@ that gets called when sync takes place:
void ble_app_set_addr()
{ }
- static void ble_app_advertise();
+ static void ble_app_advertise()
{ }
static void ble_app_on_sync(void)
@@ -209,55 +209,33 @@ advertising is to be done. The default values are mostly
fine for our
simple beaconing application. We will pass the following values to this
function:
-+--------------+----------+----------+
-| Parameter | Value | Notes |
-+==============+==========+==========+
-| own\_addr\_t | BLE\_OWN | Use the |
-| ype | \_ADDR\_ | nRPA we |
-| | RANDOM | generate |
-| | | d |
-| | | earlier. |
-+--------------+----------+----------+
-| direct\_addr | NULL | We are |
-| | | broadcas |
-| | | ting, |
-| | | not |
-| | | targetin |
-| | | g |
-| | | a peer. |
-+--------------+----------+----------+
-| duration\_ms | BLE\_HS\ | Advertis |
-| | _FOREVER | e |
-| | | indefini |
-| | | tely. |
-+--------------+----------+----------+
-| adv\_params | defaults | Can be |
-| | | used to |
-| | | specify |
-| | | low |
-| | | level |
-| | | advertis |
-| | | ing |
-| | | paramete |
-| | | rs. |
-+--------------+----------+----------+
-| cb | NULL | We are |
-| | | non-conn |
-| | | ectable, |
-| | | so no |
-| | | need for |
-| | | an event |
-| | | callback |
-| | | . |
-+--------------+----------+----------+
-| cb\_arg | NULL | No |
-| | | callback |
-| | | implies |
-| | | no |
-| | | callback |
-| | | argument |
-| | | . |
-+--------------+----------+----------+
++-----------------+------------------------+--------------------+
+| Parameter | Value | Notes |
++=================+========================+====================+
+| own\_addr\_type | BLE\_OWN\_ADDR\_RANDOM | Use the nRPA we |
+| | | generated earlier. |
++-----------------+------------------------+--------------------+
+| direct\_addr | NULL | We are |
+| | | broadcasting, not |
+| | | targeting a peer. |
++-----------------+------------------------+--------------------+
+| duration\_ms | BLE\_HS\_FOREVER | Advertise |
+| | | indefinitely. |
++-----------------+------------------------+--------------------+
+| adv\_params | defaults | Can be used to |
+| | | specify low level |
+| | | advertising |
+| | | parameters. |
++-----------------+------------------------+--------------------+
+| cb | NULL | We are |
+| | | non-connectable, |
+| | | so no need for an |
+| | | event callback. |
++-----------------+------------------------+--------------------+
+| cb\_arg | NULL | No callback |
+| | | implies no |
+| | | callback argument. |
++-----------------+------------------------+--------------------+
These arguments are mostly self-explanatory. The exception is
``adv_params``, which can be used to specify a number of low-level
