UltiBlox on GitHub | UltiBlox Home

SerialCommands is an open-source Arduino library for parsing and handling serial commands. It simplifies serial communication by supporting commands with or without values, enabling user-defined callbacks for easy integration into your project.

Core features:

• Detects and parses serial commands ending with ;.
• Handles commands with or without values (e.g., T; or S:40;).
• Supports user-defined callbacks for flexible command handling.

1. Open the Arduino IDE.
2. Go to Tools > Manage Libraries.
3. Search for UltiBlox-SerialCommands and click Install.
4. Access example sketches under File > Examples > UltiBlox-SerialCommands.

1. Clone the Repository:

   git clone git@github.com:UltiBlox/SerialCommands.git ~/workspace/SerialCommands
   cd ~/workspace/SerialCommands

2. Prepare the Environment: Run the prepare.sh script to set up dependencies:

   bash prepare.sh

3. Install the Library:

   • Copy Installation:

     bash install.sh

   • Symlink Installation (for active development):

     bash install-symlink.sh

4. Build Examples: Compile example sketches with:

   bash build.sh

The library includes several examples to get you started:

This example demonstrates controlling an LED via serial commands. It includes:

• A CLI script (set_led.py) for sending commands to the Arduino.
• A Web App for a user-friendly interface.

1. Open the BasicUsage.ino sketch in the Arduino IDE.
2. Upload it to your Arduino.

Choose one of the following methods to interact with the Arduino:

1. Serial Monitor:

   • Open the Serial Monitor in the Arduino IDE.
   • Send the following commands:
     • L:1; - Turn the LED ON.
     • L:0; - Turn the LED OFF.

2. CLI Script (set_led.py):

   • Navigate to the BasicUsage folder:

     cd examples/BasicUsage

   • Run the Python script to control the LED:

     python set_led.py 1  # Turn ON
     python set_led.py 0  # Turn OFF

   • If the port is not auto-detected, specify it manually:

     python set_led.py --port /dev/ttyUSB0 1

3. Web App:

   • Navigate to the web folder:

     cd examples/BasicUsage/web

   • Launch the Flask app:

     bash run.sh

   • Open your browser and go to:

     http://127.0.0.1:5000
     

   • Use the toggle icon in the web interface to control the LED.

To use the library in your own Arduino projects:

1. Include the library header in your sketch:

   #include "SerialCommands.h"

2. Initialize the library in your setup function:

   SerialCommands commands;
   void setup() {
       Serial.begin(115200);
       commands.begin(Serial);
   }

3. Register a callback to handle commands:

   commands.onCommand([](char command, int value) {
       if (command == 'L') {
           digitalWrite(13, value ? HIGH : LOW);
       }
   });

4. Call the listen() method in your loop:

   void loop() {
       commands.listen();
   }

For detailed examples, refer to the included sketches in the examples folder.

1. Arduino Serial Monitor is Blocking the Port

   • If the CLI script or web app cannot connect to the Arduino, ensure the Serial Monitor in the Arduino IDE is closed. Only one tool can access the serial port at a time.

2. Missing Python

   • To use the CLI script or web app, Python must be installed on your system.
   • Check if Python is installed:

     python --version

     or

     python3 --version

   • If Python is not installed:
     • Download and install Python from the official website.
     • Ensure you add Python to your system's PATH during installation.

3. Missing Python Libraries

   • If you encounter an error like ModuleNotFoundError: No module named 'flask', install the required libraries:

     pip install flask pyserial

4. Serial Port Not Detected

   • If the CLI script cannot detect the Arduino:
     • Verify that your Arduino is connected and visible in your system's device manager (e.g., /dev/ttyUSB0 or COM3).
     • Specify the port manually using the --port argument:

       python set_led.py --port /dev/ttyUSB0 1

5. Web App Doesn't Start

   • Ensure Flask is installed (pip install flask).
   • Launch the app using:

     bash run.sh

   • Open your browser at http://127.0.0.1:5000.