Mercurial > libervia-backend
annotate doc/libervia-cli/remote-control.rst @ 4306:94e0968987cd
plugin XEP-0033: code modernisation, improve delivery, data validation:
- Code has been rewritten using Pydantic models and `async` coroutines for data validation
and cleaner element parsing/generation.
- Delivery has been completely rewritten. It now works even if server doesn't support
multicast, and send to local multicast service first. Delivering to local multicast
service first is due to bad support of XEP-0033 in server (notably Prosody which has an
incomplete implementation), and the current impossibility to detect if a sub-domain
service handles fully multicast or only for local domains. This is a workaround to have
a good balance between backward compatilibity and use of bandwith, and to make it work
with the incoming email gateway implementation (the gateway will only deliver to
entities of its own domain).
- disco feature checking now uses `async` corountines. `host` implementation still use
Deferred return values for compatibility with legacy code.
rel 450
author | Goffi <goffi@goffi.org> |
---|---|
date | Thu, 26 Sep 2024 16:12:01 +0200 |
parents | 05f01ac1d5b2 |
children |
rev | line source |
---|---|
4244
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
1 .. _libervia-cli_remote-control: |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 ============================== |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 remote-control: Remote Control |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 ============================== |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 The ``remote-control`` feature allows you to control another device or be controlled by another device. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 send |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 ==== |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 Send control events to another device. For now, it only sends keyboard events. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 example |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 ------- |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 Louise wants to control Pierre's device:: |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 $ li remote-control send pierre@example.net |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
21 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 receive |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 ======= |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 Use ``receive`` to establish a connection with another device and accept incoming control |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 events. This feature uses the freedesktop.org's Remote Desktop portal, which must be |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 installed on your system and compatible with your platform. On most Wayland-based desktop |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 environments, this portal is usually available. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 Immediately upon connecting, Libervia CLI requests permission to initiate the remote |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 control session, event if not request has been received yet. This ensures that the |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 connection can be established without requiring manual intervention to authorize access. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
33 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 After a connection has been accepted and terminated, the command quits. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
35 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 ``--verbose, -v`` can be used to show received input events. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
37 If you don't expect to share screen, use ``S {yes,no,auto}, --share-screen {yes,no,auto}`` |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
38 with a value of ``no``. |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 example |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
41 ------- |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
42 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 Louise is expecting Piotr to control her device and wants to automatically accept control from him:: |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 |
05f01ac1d5b2
doc (cli): remote-control documentation
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 $ li remote-control receive louise@example.org |