Codeanywhere¶

Demo¶

Integration¶

1. Sign in to Codeanywhere. A registration is FREE and gives you unlimited private projects within the one Container.

2. Open Dashboard Projects

3. Create a new Project and open it. In Connection Wizard create new Container:

   • Name set to “PlatformIO”

   • Stack search for Python stack (not Python3) that is based on Ubuntu OS.

   • Click on “Create” button.

4. Open SSH-Terminal tab (right click on Container (PlatformIO) > SSH Terminal) and install PlatformIO Core (CLI) using a next command

sudo python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/develop/scripts/get-platformio.py)"

5. Log in to PlatformIO Account using pio account login command.

Quick Start¶

Let’s create our first PlatformIO-based Codeanywhere Project

1. Initialize new PlatformIO-based Project. Run a next command in a Cloud IDE SSH Terminal:

   pio project init --board <ID>
   
   # initialize project for Arduino Uno
   pio project init --board uno
   

   To get board ID please use pio boards command or Embedded Boards Explorer.

   If you do not see created project, please refresh Project Tree using right-click on Container Name (PlatformIO) > Refresh.

2. Create new source file named main.cpp in src folder using Project Tree (left side). Please make right click on src folder, then “Create File” and insert a next content:

   #include <Arduino.h>
   
   int i = 0;
   
   void setup() {
       Serial.begin(9600);
       Serial.println("Hello Codeanywhere!");
   }
   
   void loop() {
       /*  serial echo */
       while (Serial.available()) {
           Serial.write(Serial.read());
       }
   
       i++;
       Serial.println(i);
       delay(100);
   }
   

3. If you prefer to work with PlatformIO Core (CLI) CLI, then you can process project using Cloud IDE SSH Terminal and the next commands:

   • pio run - build project locally (using Cloud IDE’s virtual machine)

   • pio run -t clean - clean project

   • pio remote run -t upload - upload firmware (program) to a remote device

   • pio remote device list - list available remote devices

   • pio remote device monitor - Remote Serial Port Monitor

4. We recommend to hide “Hidden Files”. You can do that via Cloud IDE Menu: View > Show Hidden Files.

Run Button¶

Codeanywhere provides a quick “Run Project” button where you can specify own command. Let’s add “PlatformIO Build Project” command:

1. Open “Project Config” via right click on Container Name (PlatformIO) > Config

2. Set commands field to

   "commands": [
       "pio run"
   ]
   

3. Save configuration file.

Now, try to click on “Run Project” button. You can assign any PlatformIO command to this button.

Remote Device Manager¶

Remote Device Manager works in pair with Remote Development. You can list remote devices that are connected to host machine where PlatformIO Remote Agent is started or are visible for it.

1. Open Cloud IDE SSH Terminal

2. Paste this command

   pio remote device list
   

Remote Firmware Uploading¶

Remote Firmware Uploading works in pair with Remote Development. You can deploy firmware to any devices which are visible for PlatformIO Remote Agent.

1. Open Cloud IDE SSH Terminal

2. Paste this command

   pio remote run -t upload
   

Remote Serial Port Monitor¶

Remote Serial Port Monitor works in pair with Remote Development. You can read or send data to any device that is connected to host machine where PlatformIO Remote Agent is started. To list active agents please use this command pio remote agent list.

1. Open Cloud IDE SSH Terminal

2. Paste this command

   pio remote device monitor
   

Multi-Project workspace¶

You can have multiple PlatformIO-based Projects in the same workspace. We recommend a next folders structure:

├── project-A
│   ├── lib
│   │   └── README
│   ├── platformio.ini
│   └── src
│       └── main.ino
└── project-B
    ├── lib
    │   └── README
    ├── platformio.ini
    └── src
        ├── main.cpp
        └── main.h

In this case, you need to use -d, --project-dir option for pio run or pio remote run commands:

• pio remote run --project-dir project-A -t upload build Project-A

• pio remote run --project-dir project-A -t upload remote firmware uploading

  using Project-A

• pio remote run -d project-B -t upload remote firmware (program) uploading

  using Project-B

See documentation for pio remote run --project-dir option.