mirror of
https://github.com/platformio/platformio-core.git
synced 2025-07-29 17:47:14 +02:00
Add Quick Start for PIO Remote to docs
This commit is contained in:
Ivan Kravets
@ -142,7 +142,7 @@ OTA Device Manager
|
||||
|
||||
Over-The-Air (OTA) Device Manager works in pair with :ref:`pio_remote`.
|
||||
You can list remote devices that are connected to host machine where
|
||||
:ref:`pio_remote_agent` is started or are visible for it.
|
||||
:ref:`cmd_remote_agent` is started or are visible for it.
|
||||
|
||||
Let's create New Run Configuration (shortcut) that will be used for OTA Manager.
|
||||
Please click on ``Menu: Run > Run Configurations > Manage...``, then
|
||||
@ -160,7 +160,7 @@ OTA Firmware Uploading
|
||||
----------------------
|
||||
|
||||
Over-The-Air (OTA) Firmware Uploading works in pair with :ref:`pio_remote`.
|
||||
You can deploy firmware to any devices which are visible for :ref:`pio_remote_agent`.
|
||||
You can deploy firmware to any devices which are visible for :ref:`cmd_remote_agent`.
|
||||
|
||||
Let's create New Run Configuration (shortcut) that will be used for OTA Uploads.
|
||||
Please click on ``Menu: Run > Run Configurations > Manage...``, then
|
||||
@ -177,7 +177,7 @@ OTA Serial Port Monitor
|
||||
|
||||
Over-The-Air (OTA) Serial Port Monitor works in pair with :ref:`pio_remote`.
|
||||
You can read or send data to any device that is connected to host machine
|
||||
where :ref:`pio_remote_agent` is started.
|
||||
where :ref:`cmd_remote_agent` is started.
|
||||
To list active agents please use this command :ref:`cmd_remote_agent_list`.
|
||||
|
||||
Let's create New Run Configuration (shortcut) that will be used for OTA Serial Port Monitor.
|
||||
|
||||
@ -155,7 +155,7 @@ OTA Device Manager
|
||||
|
||||
Over-The-Air (OTA) Device Manager works in pair with :ref:`pio_remote`.
|
||||
You can list remote devices that are connected to host machine where
|
||||
:ref:`pio_remote_agent` is started or are visible for it.
|
||||
:ref:`cmd_remote_agent` is started or are visible for it.
|
||||
|
||||
1. Open Cloud IDE SSH Terminal
|
||||
2. Paste this command
|
||||
@ -170,7 +170,7 @@ OTA Firmware Uploading
|
||||
----------------------
|
||||
|
||||
Over-The-Air (OTA) Firmware Uploading works in pair with :ref:`pio_remote`.
|
||||
You can deploy firmware to any devices which are visible for :ref:`pio_remote_agent`.
|
||||
You can deploy firmware to any devices which are visible for :ref:`cmd_remote_agent`.
|
||||
|
||||
1. Open Cloud IDE SSH Terminal
|
||||
2. Paste this command
|
||||
@ -186,7 +186,7 @@ OTA Serial Port Monitor
|
||||
|
||||
Over-The-Air (OTA) Serial Port Monitor works in pair with :ref:`pio_remote`.
|
||||
You can read or send data to any device that is connected to host machine
|
||||
where :ref:`pio_remote_agent` is started.
|
||||
where :ref:`cmd_remote_agent` is started.
|
||||
To list active agents please use this command :ref:`cmd_remote_agent_list`.
|
||||
|
||||
1. Open Cloud IDE SSH Terminal
|
||||
|
||||
@ -23,7 +23,7 @@ PIO Remote™
|
||||
|
||||
|PIORemote| 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.
|
||||
@ -53,9 +53,9 @@ Technology
|
||||
**Over-The-Air (OTA)** remote operations without external dependencies to
|
||||
operation system or its software based on `client-server architecture <https://en.wikipedia.org/wiki/Client–server_model>`_.
|
||||
The Server component (|PIOCloud|) plays a role of coupling link between
|
||||
:ref:`pio_remote_agent` and client (end-developer, continuous integration
|
||||
:ref:`cmd_remote_agent` and client (end-developer, continuous integration
|
||||
system, etc.).
|
||||
When you start :ref:`pio_remote_agent`, it connects over the Internet with
|
||||
When you start :ref:`cmd_remote_agent`, it connects over the Internet with
|
||||
|PIOCloud| and listen for the actions/commands which you can send in Client
|
||||
role from anywhere in the world.
|
||||
|
||||
@ -70,23 +70,32 @@ is a prefix "remote" before each generic PlatformIO command. For example,
|
||||
listing of local and remote devices will look like :ref:`cmd_device_list` and
|
||||
:ref:`cmd_remote_device_list`.
|
||||
|
||||
.. _pio_remote_agent:
|
||||
Quick Start
|
||||
-----------
|
||||
|
||||
|PIORemote| Agent
|
||||
-----------------
|
||||
1. Start |PIORemote| Agent using :ref:`cmd_remote_agent_start` command on a
|
||||
on a host machine where devices are connected physically or are visible
|
||||
via network. |PIORemote| **Agent works on Windows, macOS, Linux and Linux ARMv6+**.
|
||||
It means that you can use desktop machine, laptop or credit card sized PC
|
||||
(RaspberryPi, BeagleBoard, etc).
|
||||
|
||||
Start |PIORemote| Agent (using :ref:`cmd_remote_agent_start` command) on a
|
||||
local host machine and work remotely with your devices **WITHOUT** extra
|
||||
software, 3-rd party services, SSH, VPN, tunneling or
|
||||
opening incoming network ports.
|
||||
You can share own devices/hardware with friends, team or other developers
|
||||
using :option:`platformio remote agent start --share` option.
|
||||
|
||||
|PIORemote| supports wired and wireless devices. Wired devices should be
|
||||
connected physically to host machine where |PIORemote| Agent is started,
|
||||
where wireless devices should be visible for |PIORemote| Agent to provide
|
||||
network operations Over-The-Air.
|
||||
2. Using the same :ref:`cmd_account` please login in to other machine or Cloud
|
||||
IDE. You don't need to have network or other access to host machine where
|
||||
|PIORemote| Agent is started. Just use :ref:`cmd_remote` commands and
|
||||
PlatformIO will automatically process all local commands Over-The-Air (OTA)
|
||||
on a remote machine.
|
||||
|
||||
To list active |PIORemote| Agents, please use :ref:`cmd_remote_agent_list`
|
||||
command.
|
||||
|
||||
.. note::
|
||||
Please use local IP as "upload port" when device is not connected directly
|
||||
to host machine where |PIORemote| Agent is started but supports natively
|
||||
Over-the-Air (OTA) updates. For example, :ref:`platform_espressif8266` and
|
||||
:ref:`platform_espressif_ota`. In this case, the final command for remote
|
||||
OTA update will look as ``platformio remote run -t upload --upload-port 192.168.0.255``
|
||||
or ``platformio remote run -t upload --upload-port myesp8266.local``.
|
||||
|
||||
User Guide (CLI)
|
||||
----------------
|
||||
|
||||
@ -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