Skip to content

Commit ff3d859

Browse files
committed
Small corrections on comms doc page
1 parent 10a4973 commit ff3d859

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

docs/connections.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ bluetooth as well.
1010
Serial Line
1111
-----------
1212

13-
The RS232 serial line is the main method of connection. The main primitive
14-
is the :class:`~geocompy.communication.SerialConnection` class, that acts as a
15-
wrapper around a :class:`~serial.Serial` object that implements the actual
16-
low level serial communication.
13+
The RS232 serial line is the main method of connection. The relevant main
14+
primitive is the :class:`~geocompy.communication.SerialConnection` class,
15+
that acts as a wrapper around a :class:`~serial.Serial` object that
16+
implements the actual low level serial communication.
1717

1818
.. code-block:: python
1919
:caption: Simple serial connection
@@ -67,8 +67,8 @@ library.
6767
with open_serial("COM1", timeout=15) as com:
6868
com.send("some message")
6969
70-
If a time consuming request has to be executed, that might exceed the normal
71-
connection timeout, it is possible to run it with a temporary override.
70+
If a time consuming request has to be executed (that might exceed the normal
71+
connection timeout), it is possible to run it with a temporary override.
7272

7373
.. code-block:: python
7474
:caption: Timeout override for slow requests
@@ -95,6 +95,13 @@ built-in or attachable bluetooth connection capabilities (e.g. Leica TS15
9595
with radio handle). These instruments communicate over Serial Port Profile
9696
Bluetooth Classic, that emulates a direct line serial connection.
9797

98+
.. note::
99+
100+
In case of Leica instruments and GeoCom, the GeoCom interface on the
101+
instrument might have to be manually switched to the bluetooth device,
102+
before initiating a connection. Make sure to sync the port parameters
103+
(e.g. speed, parity) between the instrument and the computer!
104+
98105
To initiate a connection like this, the instrument first has to be paired
99106
to the controlling computer, and the bluetooth address of the instrument
100107
must be bound to an RFCOMM port as well.
@@ -121,13 +128,6 @@ be opened just like a normal serial line.
121128
with open_serial("COM9") as com:
122129
com.send("some message")
123130
124-
.. note::
125-
126-
In case of Leica instruments and GeoCom, the GeoCom interface on the
127-
instrument has to be manually switched to the bluetooth device,
128-
before initiating a connection. Make sure to sync the port parameters
129-
(e.g. speed, parity) between the instrument and the computer!
130-
131131
.. seealso::
132132

133133
https://youtu.be/6Z4PXct8Rg0?si=db53q6F6NRi2M4BF

docs/introduction.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Introduction
22
============
33

4-
This page aims to introduce the basic usage, and general concepts of the
4+
This section aims to introduce the basic usage, and general concepts of the
55
package.
66

77
Communication
@@ -30,7 +30,8 @@ similarly to the :func:`open` function of the standard library.
3030
3131
.. seealso::
3232

33-
Connection methods are discussed in more detail in :ref:`page_connections`.
33+
Communication methods are discussed in more detail in
34+
:ref:`page_connections`.
3435

3536
Protocols
3637
---------

0 commit comments

Comments
 (0)