Skip to content

Commit 4e4a2ad

Browse files
authored
Merge pull request #623 from mavlink/pr-docs-update
docs: update pip instructions, clarify debugging
2 parents 6955725 + 7a49601 commit 4e4a2ad

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

mavsdk/source/index.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To install simply run:
3434

3535
.. code:: bash
3636
37-
pip3 install mavsdk
37+
python -m pip install --upgrade mavsdk
3838
3939
4040
The package contains ``mavsdk_server`` already (previously called "backend"), which is started automatically when connecting (e.g. ``await drone.connect()``). Have a look at the examples to see it used in practice. It will be something like:
@@ -74,26 +74,26 @@ For this case, let's assume the example was like this:
7474
await drone.connect(system_address="udp://:14540")
7575
7676
77-
The mavsdk_server binary is installed using ``pip3``. If installed with ``pip3 --user`` it is usually (at least for Linux) to be found in ``~/.local/lib/python3.9/site-packages/mavsdk/bin/`` (of course depending on the Python version used).
77+
The mavsdk_server binary is installed using ``pip``. If installed with ``python -m pip install --upgrade mavsdk`` it is usually (at least for Linux) to be found in ``~/.local/lib/python3.10/site-packages/mavsdk/bin/`` (of course depending on the Python version used).
7878

7979
It can then be run in a separate console with the ``system_address`` as an argument:
8080

8181
.. code:: bash
8282
83-
~/.local/lib/python3.9/site-packages/mavsdk/bin/mavsdk_server udp://:14540
83+
~/.local/lib/python3.10/site-packages/mavsdk/bin/mavsdk_server udp://:14540
8484
8585
Without an autopilot connecting, the output will look something like:
8686

8787
.. code:: bash
8888
89-
[02:36:31|Info ] MAVSDK version: v0.50.0 (mavsdk_impl.cpp:28)
89+
[02:36:31|Info ] MAVSDK version: v1.4.16 (mavsdk_impl.cpp:28)
9090
[02:36:31|Info ] Waiting to discover system on udp://:14540... (connection_initiator.h:20)
9191
9292
Once an autopilot is discovered, something like this should be printed:
9393

9494
.. code:: bash
9595
96-
[02:38:12|Info ] MAVSDK version: v0.50.0 (mavsdk_impl.cpp:28)
96+
[02:38:12|Info ] MAVSDK version: v1.4.16 (mavsdk_impl.cpp:28)
9797
[02:38:12|Info ] Waiting to discover system on udp://:14540... (connection_initiator.h:20)
9898
[02:39:01|Info ] New system on: 127.0.0.1:14580 (with sysid: 1) (udp_connection.cpp:194)
9999
[02:39:01|Debug] New: System ID: 1 Comp ID: 1 (mavsdk_impl.cpp:484)
@@ -105,7 +105,9 @@ Once an autopilot is discovered, something like this should be printed:
105105
106106
This would look promising, and the example can now be run against this server, however, without ``system_address``:
107107

108+
108109
.. code:: python
110+
109111
drone = System()
110112
await drone.connect()
111113

0 commit comments

Comments
 (0)