Skip to content

Latest commit

 

History

History
178 lines (136 loc) · 7.09 KB

pio-remote.rst

File metadata and controls

178 lines (136 loc) · 7.09 KB

Remote Development

Your devices are always with you!

PlatformIO Remote Development Solution allows you to work remotely with devices from Anywhere In The World. No matter where are you now! Run a small and cross-platform :ref:`cmd_remote_agent` on a remote machine and you are able to list active devices (wireless + wired), to upload firmware (program), to process remote unit tests, or to start remote debugging session via Remote Serial Port Monitor.

Using PlatformIO Remote Development Solution you can share your devices with colleagues across your organization or friends. In combination with :ref:`ide_cloud`, you can create awesome things at any time when inspiration comes to you.

You must have an :ref:`pioaccount` to use PlatformIO Remote Development Solution. A registration is FREE.

  • :ref:`Remote Device Manager <cmd_remote_device>`
  • :ref:`Remote Serial Port Monitor <cmd_remote_device_monitor>`
  • :ref:`Remote Firmware Updates <cmd_remote_run>`
  • Share devices with your team members
  • Continuous Deployment
  • Continuous Delivery
  • Remote Unit Testing
Cloud IDE:

Program your devices from anywhere in the world using the most popular :ref:`ide_cloud`. You do not need to install any extra software, no need to have static IP or open network ports. Everything works out of the box.

Devices behind card sized PC:

Work with your favorite development environment and program devices connected to card-sized PC (Raspberry Pi, Cubie Board, etc.). You do not need to open SSH ports, install any extra Linux packages, toolchains.

Remote Unit Testing:

Instruct any of :ref:`ci` services to run remote tests on a physical device. See the documentation for :ref:`unit_testing_runner_remote`.

How does it work?

  • You commit new changes to your source code repository
  • :ref:`ci` service deploys unit tests to a remote agent
  • :ref:`unit_testing` engine runs tests on a physical device, process them, and send results
  • :ref:`ci` service prints results in human readable format
  • If one test fails, current CI build will fail too.
Board Farm:

A similar concept as described in "Remote Unit Testing" above. Let's imagine that you need to test some logic on the unlimited number of target devices. Very often it can be the same hardware prototype but with different factory revisions.

You connect these devices via USB hub to PC and instruct PlatformIO Remote Development Solution to process your test on ALL targets connected to a specific agent. See documentation below.

Remote Serial Monitor:

Sometimes you don't have physical access to a target device but you need to read data from some serial port. PlatformIO Remote Development Solution allows you to connect to a remote agent and list connected devices with their serial ports. See :ref:`cmd_remote_device_monitor` command for details.

../_static/images/pio-remote-architecture.png

PlatformIO Remote Development Solution is an own PlatformIO technology for remote solutions without external dependencies to operating system or its software based on client-server architecture. The Server component (PlatformIO Cloud) plays a role of coupling link between :ref:`cmd_remote_agent` and Client (:ref:`cmd_remote`, :ref:`ide_cloud`, :ref:`ci`, SDKs, etc.). When you start :ref:`cmd_remote_agent`, it connects over the Internet with PlatformIO Cloud and listen for the actions/commands which you can send in Client role from anywhere in the world.

PlatformIO Remote Development Solution is multi-agents and multi-clients system. A single agent can be shared with multiple clients, where different clients can use the same agent. This approach allows one to work with distributed hardware located in the different places, networks, etc.

This technology allows one to work with remote devices in generic form as you do that with local devices using PlatformIO ecosystem. The only one difference 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`.

PlatformIO Remote Development Solution is built into :ref:`pioide`. Please open PlatformIO IDE Terminal and run pio remote --help command for usage (see :ref:`cmd_remote`).

If you do not have :ref:`pioide`, or use :ref:`ide_cloud` or a card-sized PC (Raspberry Pi, BeagleBoard, etc.), please install :ref:`piocore`.

  1. Start PlatformIO Remote Development Solution Agent using :ref:`cmd_remote_agent_start` command on a remote machine where devices are connected physically or are accessible via network. PlatformIO Remote Development Solution Agent works on Windows, macOS, Linux and Linux ARMv6+. It means that you can use desktop machine, laptop or credit card sized PC (Raspberry Pi, BeagleBoard, etc).

    You can share own devices/hardware with friends, team or other developers using :option:`pio remote agent start --share` option.

  2. Using host machine (:ref:`cmd_remote`, :ref:`ide_cloud` Terminal in a browser, SDKs, etc.), please authorize via :ref:`cmd_account_login` command with the same credentials that you used on the previous step. Now, you can use :ref:`cmd_remote` commands to work with remote machine and its devices.

    You don't need to have networking or other access to remote machine where PlatformIO Remote Development Solution Agent is started.

    If you use PlatformIO Remote Development Solution in pair with :ref:`ci` or want automatically authorize, please set :envvar:`PLATFORMIO_AUTH_TOKEN` system environment variable instead of using :ref:`cmd_account_login` command.

Note

In case with :ref:`ide_cloud`, your browser with Cloud IDE's VM is a "host machine". The machine where devices are connected physically (your real PC) is called "remote machine" in this case. You should run PlatformIO Remote Development Solution Agent here (not in Cloud IDE's Terminal).

Note

Please use local IP as "upload port" when device is not connected directly to a remote machine where PlatformIO Remote Development Solution 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 pio remote run -t upload --upload-port 192.168.0.255 or pio remote run -t upload --upload-port myesp8266.local.

.. toctree::
    :maxdepth: 3

    ../core/userguide/remote/index