Skip to content

Commit

Permalink
samples: ubx_gnss: Improve documentation
Browse files Browse the repository at this point in the history 
- add the reset GPIO line to requirements
- show a full Devicetree sample for specific board
- give a hint for standard configuration on top of
  an Arduino UNO R3 edge connector (D0, D1, D2)
- add example console session
- test on more boards:

  ST Nucleo L496ZG
  ST Nucleo F413ZH
  ST Nucleo F767ZI
  NXP MIMXRT1060-EVK

Signed-off-by: Stephan Linz <[email protected]>
  • Loading branch information
@rexut
rexut committed Nov 20, 2023
1 parent dc73ebc commit 4ef1cad
Showing 1 changed file with 136 additions and 12 deletions.
148 changes: 136 additions & 12 deletions samples/ubx_gnss/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,44 @@ Ubxlib GNSS Sample
Overview
********

A sample application demonstrating how to integrate a u-blox GNSS device into a
zephyr application.
A sample application demonstrating how to integrate a u-blox GNSS device into
a Zephyr application.

Requirements
************

A u-blox GNSS device must be connected via UART, and a devicetree alias
`ubxlib-uart0` must exist and point towards this UART port. To fulfil this
requirement, you can add a simple devicetree overlay for your board such as
A u-blox GNSS device must be connected via UART, and a Devicetree alias
:code:`ubxlib-uart0` must exist and point towards this UART port. Also
a single GPIO line for the module reset signal have to define. To fulfil
this requirement, you can add a simple Devicetree overlay for your board
as shown below.

.. code-block:: devicetree
/ {
aliases {
ubxlib-uart0 = &usart3;
};
};
/ {
reset_switch: reset_switch {
compatible = "reset-switch";
gpios = <&gpiof 15 GPIO_ACTIVE_LOW>;
};
aliases {
ubxlib-uart0 = &usart3;
};
};
In default this sample application comes with a generic :code:`app.overlay`
that should be usable with all boards that provies an Arduino UNO R3 edge
connector. For :code:`ubxlib-uart0` the standard Arduino UART on D0 (RX)
and D1 (TX) will be used (`&arduino_serial`). The reset signal will be
controlled by D2 (GPIO) and is mapped to :code:`<&arduino_header 8 …>`.

Building and Running
********************

ST Nucleo L496ZG
================
Build and flash for different boards
====================================

.. rubric:: ST Nucleo L496ZG

.. zephyr-app-commands::
:zephyr-app: bridle/samples/ubx_gnss
Expand All @@ -37,3 +52,112 @@ ST Nucleo L496ZG
:west-args: -p
:goals: flash
:compact:

.. rubric:: ST Nucleo F413ZH

.. zephyr-app-commands::
:zephyr-app: bridle/samples/ubx_gnss
:board: nucleo_f413zh
:build-dir: nucleo_f413zh-ubx_gnss
:west-args: -p
:goals: flash
:compact:

.. rubric:: ST Nucleo F767ZI

.. zephyr-app-commands::
:zephyr-app: bridle/samples/ubx_gnss
:board: nucleo_f767zi
:build-dir: nucleo_f767zi-ubx_gnss
:west-args: -p
:goals: flash
:compact:

.. rubric:: NXP MIMXRT1060-EVK

.. zephyr-app-commands::
:zephyr-app: bridle/samples/ubx_gnss
:board: mimxrt1060_evk
:build-dir: mimxrt1060_evk-ubx_gnss
:west-args: -p
:flash-args: -r pyocd
:goals: flash
:compact:

Example console session
=======================

After power-on or hard reset, the GNSS module will be initialized automatically:

.. code-block:: console
*** Booting Zephyr OS build … ***
[00:00:02.021,000] <inf> main: GNSS Device is ready!
uart:~$ _
There is a simple Shell command for some standard evaluation steps:

.. code-block:: console
uart:~$ gnss -h
gnss - GNSS related commands
Subcommands:
single :Get a one-shot position estimate
stream :Start or stop streaming of position estimates
reset :Reset GNSS module
ttff :Measure TTFF
uart:~$ _
Reset GNSS module:

.. code-block:: console
uart:~$ gnss reset
uart:~$ _
The on-module LED for PPS signaling goes off and comes back to blink
after TTFF.

Measure TTFF:

.. code-block:: console
uart:~$ gnss ttff
Run 1 of 1: Acquired fix after 32.26s
---------------
Avg. TTFF: 32.26
uart:~$ _
The on-module LED for PPS signaling goes off and comes back to blink
after TTFF.

Get a one-shot position estimate:

.. code-block:: console
uart:~$ gnss single
Found position estimate after 0.8s: (lat, lon): (50.922432, 11.600015), alt: 192.05m, radius: 1.48m (15 SV used)
uart:~$ _
Start or stop streaming of position estimates:

.. code-block:: console
uart:~$ gnss stream start
Found position estimate: (lat, lon): (50.922447, 11.600006), alt: 192.64m, radius: 1.45m (17 SV used)
Found position estimate: (lat, lon): (50.922451, 11.600005), alt: 192.53m, radius: 1.45m (18 SV used)
Found position estimate: (lat, lon): (50.922451, 11.600004), alt: 192.63m, radius: 1.45m (18 SV used)
Found position estimate: (lat, lon): (50.922455, 11.600004), alt: 192.71m, radius: 1.46m (17 SV used)
Found position estimate: (lat, lon): (50.922455, 11.600004), alt: 192.80m, radius: 1.46m (18 SV used)
Found position estimate: (lat, lon): (50.922455, 11.600004), alt: 192.96m, radius: 1.46m (18 SV used)
Found position estimate: (lat, lon): (50.922455, 11.600003), alt: 192.89m, radius: 1.46m (18 SV used)
Found position estimate: (lat, lon): (50.922459, 11.600002), alt: 192.79m, radius: 1.47m (17 SV used)
Found position estimate: (lat, lon): (50.922459, 11.600001), alt: 192.92m, radius: 1.47m (18 SV used)
Found position estimate: (lat, lon): (50.922462, 11.600000), alt: 192.89m, radius: 1.48m (17 SV used)
Found position estimate: (lat, lon): (50.922462, 11.599999), alt: 192.77m, radius: 1.48m (18 SV used)
Found position estimate: (lat, lon): (50.922466, 11.599998), alt: 192.69m, radius: 1.48m (18 SV used)
Found position estimate: (lat, lon): (50.922466, 11.599996), alt: 192.49m, radius: 1.50m (18 SV used)
Found position estimate: (lat, lon): (50.922470, 11.599995), alt: 192.22m, radius: 1.50m (18 SV used)
uart:~$ gnss stream stop
Found position estimate: (lat, lon): (50.922470, 11.599994), alt: 192.12m, radius: 1.50m (18 SV used)
uart:~$ _

0 comments on commit 4ef1cad

Please sign in to comment.