Add Quick Start for PIO Remote to docs
This commit is contained in:
@@ -11,16 +11,16 @@
|
||||
|
||||
.. _cmd_remote_agent:
|
||||
|
||||
platformio remote agent
|
||||
=======================
|
||||
PIO Remote™ Agent
|
||||
=================
|
||||
|
||||
Start :ref:`pio_remote_agent` on a local host machine and work remotely with
|
||||
Start :ref:`cmd_remote_agent` on a local host machine and work remotely with
|
||||
your devices **WITHOUT** extra software, services, SSH, VPN, tunneling or
|
||||
opening incoming network ports.
|
||||
|
||||
:ref:`pio_remote` supports wired and wireless devices. Wired devices should be
|
||||
connected physically to host machine where :ref:`pio_remote_agent` is started,
|
||||
where wireless devices should be visible for :ref:`pio_remote_agent` to provide
|
||||
connected physically to host machine where :ref:`cmd_remote_agent` is started,
|
||||
where wireless devices should be visible for :ref:`cmd_remote_agent` to provide
|
||||
network operations Over-The-Air.
|
||||
|
||||
.. contents::
|
||||
@@ -41,7 +41,7 @@ Usage
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
List active :ref:`pio_remote_agent` s started using own :ref:`cmd_account`
|
||||
List active :ref:`cmd_remote_agent` s started using own :ref:`cmd_account`
|
||||
or shared with you by other PlatformIO developers.
|
||||
|
||||
Example
|
||||
@@ -76,7 +76,7 @@ Usage
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
Start :ref:`pio_remote_agent` and work remotely with your devices from
|
||||
Start :ref:`cmd_remote_agent` and work remotely with your devices from
|
||||
anywhere in the world. This command can be run as daemon or added to
|
||||
autostart list of your OS.
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
List `Serial Ports <http://en.wikipedia.org/wiki/Serial_port>`_ on remote
|
||||
machines where :ref:`pio_remote_agent` is started.
|
||||
machines where :ref:`cmd_remote_agent` is started.
|
||||
|
||||
You can list devices from the specified remote machines using ``--agent NAME``
|
||||
option between "remote" & "device" sub-commands. For example, you have run
|
||||
@@ -124,7 +124,7 @@ Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
Connect to Serial Port of remote device Over-The-Air (OTA) and receive or
|
||||
send data in real time. :ref:`pio_remote_agent` should be started before.
|
||||
send data in real time. :ref:`cmd_remote_agent` should be started before.
|
||||
|
||||
To control *monitor* please use these "hot keys":
|
||||
|
||||
|
||||
@@ -9,14 +9,14 @@
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
.. _userguide_remote:
|
||||
.. _cmd_remote:
|
||||
|
||||
PIO Remote™ CLI
|
||||
===============
|
||||
|
||||
:ref:`pio_remote` allows you to work remotely with devices from
|
||||
*Anywhere In The World*. No matter where are you now! Run small and
|
||||
cross-platform :ref:`pio_remote_agent` on a host machine and you will be able to
|
||||
cross-platform :ref:`cmd_remote_agent` on a host machine and you will be able to
|
||||
list active devices (wireless + wired), to upload firmware **Over-The-Air (OTA)**,
|
||||
to process remote unit tests, or to start remote debugging session via OTA
|
||||
Serial Port Monitor.
|
||||
|
||||
Reference in New Issue
Block a user