Platform IO

UNIHIKER K10 with Platform IO¶

PlatformIO is a cross-platform, cross-architecture, multiple framework, professional tool for embedded systems engineers and for software developers who write applications for embedded products. In this tutorial, we will guide you through the entire process of downloading, installing, and configuring PlatformIO on your computer.

Download Code Editor¶

Platform IO is typically installed via code editor/IDE like CLion or VSCode. This tutorial will introduce how to configure Platform IO in these two IDEs. If you are using another IDE, please refer to this document to learn how to configure Platform IO in your IDE.

Install Platform IO extension/plug-in¶

Platform IO in CLion¶

CLion is a cross-platform C/C++ IDE for GNU Linux, macOS, and Windows. CLion includes such features as a smart editor, code generation, code quality assurance, automated refactorings, on-the-fly code analysis, project manager, integrated version control systems and debugger.

Refer to the CLion Documentation page for more detailed information.

1. Install PlatformIO Core (CLI). See Installation guide.

2. Download, install and open CLion IDE

3. Install official PlatformIO for CLion plugin.
   Open File > Settings.. > Plugins and go to the "Marketplace" tab. Search for PlatformIO and click the "Install" button.

4. Restart CLion IDE after the plug-in is successfully installed.

5. Setting Up the Project

   • Please open “New Project” wizard, select board and framework, and create a new PlatformIO project. Please USE ONLY Latin characters (a-z) in a project name to avoid further issues with project compilation. Numbers and some symbols are allowed depending on different OS:

   • Open platformio.ini file, then copy and paste the following configure text in it. And use ctrl+s hot key to save the configure file.
     Wait for the SDK download.

     platformio.ini

     [env:unihiker]
     platform = https://github.com/DFRobot/platform-unihiker.git
     board = unihiker_k10
     framework = arduino
     build_flags = 
         -DARDUINO_USB_CDC_ON_BOOT=1
         -DARDUINO_USB_MODE=1
         -DModel=None
     

6. Run test code on Unihiker K10

   • Once the SDK download complete, then the Platform IO in CLion is ready to go.
   • Open main.cpp file from src folder and replace its contents with the next:
   Hello Unihiker

   #include "unihiker_k10.h"
   
   UNIHIKER_K10 k10;
   uint8_t screen_dir = 2;
   
   void setup() {
       k10.begin();
       k10.initScreen(screen_dir);
       k10.creatCanvas();
       k10.setScreenBackground(0xFFFFFF);
       k10.canvas->canvasText("UNIHIKER", 1, 0x0000FF);
       k10.canvas->updateCanvas();
       delay(1000);
       k10.canvas->canvasText("UNIHIKER", 2, 0xFF0000);
       k10.canvas->updateCanvas();
       delay(1000);
       k10.canvas->canvasText("UNIHIKER", 3, 0x00FF00);
       k10.canvas->updateCanvas();
       delay(1000);
       k10.canvas->canvasText("UNIHIKER", 4, 0x000000);
       k10.canvas->updateCanvas();
       delay(1000);
   }
   
   void loop() {
   }
   

   • Build your project and upload code with ctrl+F5 hotkey. The text "Unihiker" will appear on the Unihiker K10 screen.
     

Platform IO in VSCode¶

Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages (such as C++, C#, Python, PHP, Go) and runtimes (such as .NET and Unity)

1. Open VSCode Package Manager
2. Search for the official platformio ide extension

3. Install PlatformIO IDE.
   

4. Install Unihiker K10 SDK

   • Click on “PlatformIO Home” button on the bottom PlatformIO Toolbar

   • Click on “New Project”, select a random DFRobot board and create new PlatformIO Project.

   • Open platformio.ini file, then copy and paste the following configure text in it. And use ctrl+s to save the configure file.
     Wait for the SDK download.

     platformio.ini

     [env:unihiker]
     platform = https://github.com/DFRobot/platform-unihiker.git
     board = unihiker_k10
     framework = arduino
     build_flags = 
         -DARDUINO_USB_CDC_ON_BOOT=1
         -DARDUINO_USB_MODE=1
         -DModel=None
     

5. Run test code on Unihiker K10 Open main.cpp file from src folder and replace its contents with the next:

   test code

   #include "unihiker_k10.h"
   
   UNIHIKER_K10 k10;
   uint8_t screen_dir = 2;
   
   void setup() {
       k10.begin();
       k10.initScreen(screen_dir);
       k10.creatCanvas();
       k10.setScreenBackground(0xFFFFFF);
   }
   
   void loop() {
       // Draw a green circle on the screen
       k10.canvas->canvasCircle(120, 160, 10, 0x00FF00, 0x00FF00, true);
       k10.canvas->updateCanvas();
       delay(1000);
   
       // Clear the circle
       k10.canvas->canvasCircle(120, 160, 10, 0xFFFFFF, 0xFFFFFF, true);
       k10.canvas->updateCanvas();
       delay(1000);
   }
   

   • Build your project with ctrl+alt+b hotkey
   • Connect your K10 to PC/Mac and upload code with ctrl+alt+u hotkey. The text "Unihiker" will appear on the Unihiker K10 screen.
     

Serial Setup¶

Like any other ESP32-S3 based dev board. The serial of Unihiker K10 is not automatically mapped to the USB-C port by default.
Although we have already included the configuration of serial port mapping in the above-mentioned platformio.ini configuration file, but from the second project, the settings related to the serial port in platformio.ini need to be set up manully.
Before uploading the code, please copy and paste the following Settings about the serial port at the end of platformio.ini. Then you can see the data output by the serial port in your code in the serial monitor.

build_flags = 
            -DARDUINO_USB_CDC_ON_BOOT=1
            -DARDUINO_USB_MODE=1
            -DModel=None

The platformio.ini should look like this:

Platform IO Example¶

Cklik to the Platform IO Example.