Skip to content

Commit

Permalink
docs: fix mistakes in concepts and tutorial.
Browse files Browse the repository at this point in the history
Signed-off-by: Romain Bezut <[email protected]>
  • Loading branch information
morian committed Oct 4, 2024
1 parent dae4e37 commit 4943168
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions docs/start/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The following table tells the range covered by each gate depending on the distan
resolution setting:

+-----------------------++-----------------------+
| 75cm resolution || 25cm resolution |
| 75cm resolution || 20cm resolution |
+======+========+=======++======+========+=======+
| Gate | Start | End || Gate | Start | End |
+------+--------+-------++------+--------+-------+
Expand Down Expand Up @@ -88,8 +88,8 @@ resolution setting:
Energy and sensitivity
^^^^^^^^^^^^^^^^^^^^^^

Each gate is configured individually with two energy thresholds, one for moving targets,
and on for static targets. When the reading energy value is above the configured threshold,
Each gate is configured individually with two energy thresholds, one for moving targets
and one for static targets. When the reading energy value is above the configured threshold,
a target is detected (either as moving or standing still).

Both reported energies and threshold have values ranging from 0 to 100.
Expand Down Expand Up @@ -124,6 +124,6 @@ It depends on whether the engineering mode is currently enabled or not.
To send commands to the device, we first have to put it in the configuration mode.
During this phase, status reports are no longer being generated.

All command requests sent to the device must be performed in configuration mode or the device
will simply send back an error status. Also note that some commands require a device restart
to be effective.
All command requests sent to the device have to be performed in configuration mode, otherwise
the device will simply send back an error status. Also note that some commands require a device
restart to be effective.
10 changes: 5 additions & 5 deletions docs/start/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Before going further on this tutorial, make sure to have a suitable python envir
Connecting to the device
------------------------

First you need to identify your device and its name depends on your platform!
First you need to identify your device, its name depends on your platform!
You can ask pyserial_ to list all available console devices on your system:

.. _pyserial: https://github.com/pyserial/pyserial/tree/master
Expand Down Expand Up @@ -49,12 +49,12 @@ Entering the configuration mode

Entering configuration mode is also implemented as an asynchronous context.
You cannot call configuration commands outside of this context!
This context is a requirement before any other command is issued.
This context is a requirement before any other command can be issued.

.. seealso::
:meth:`LD2410.configure` for more details.

In the following example the configuration context spread over the emphasized lines:
In the following example the configuration context spreads over the emphasized lines:

.. literalinclude:: ../../examples/read_firmware_version.py
:caption: examples/read_firmware_version.py
Expand Down Expand Up @@ -109,7 +109,7 @@ Distance resolution
:class: warning

This command seems to only be available for ``LD2410B`` and ``LD2410C`` devices
with a (quite recent) firmware.
with a (quite) recent firmware.

Using :meth:`LD2410.get_distance_resolution` we can read the range covered by gates:

Expand Down Expand Up @@ -190,7 +190,7 @@ commands to the device (as it is restarting).
Reading reports
---------------

Reports are push by the device to the serial link regularly and contain detection results.
Reports are pushed by the device to the serial link regularly and contain detection results.
Advanced reports cat be requested using the engineering mode, which will not be covered in
this tutorial

Expand Down

0 comments on commit 4943168

Please sign in to comment.