e-puck2 PC side development

Hardware

Overview

The following figures show the main components offered by the e-puck2 robot and where they are physically placed:

Specifications

The e-puck2 robot maintains full compatibility with its predecessor e-puck (e-puck HWRev 1.3 is considered in the following table):

Feature	e-puck1.3	e-puck2	Compatibility	Additional
Size, weight	70 mm diameter, 55 mm height, 150 g	Same form factor: 70 mm diameter, 45 mm, 130 g		No e-jumper required
Battery, autonomy	LiIPo rechargeable battery (external charger), 1800 mAh. About 3 hours autonomy. Recharging time about 2-3h.	Same battery; USB charging, recharging time about 2.5h.		USB charging
Processor	16-bit dsPIC30F6014A @ 60MHz (15 MIPS), DSP core for signal processing	32-bit STM32F407 @ 168 MHz (210 DMIPS), DSP and FPU, DMA		~10 times faster
Memory	RAM: 8 KB; Flash: 144 KB	RAM: 192 KB; Flash: 1024 KB		RAM: 24x more capable Flash:~7x more capable
Motors	2 stepper motors with a 50:1 reduction gear; 20 steps per revolution; about 0.13 mm resolution	Same motors
Wheels	Wheels diamater = 41 mm Distance between wheels = 53 mm	Same wheels
Speed	Max: 1000 steps/s (about 12.9 cm/s)	Max: 1200 steps/s (about 15.4 cm/s)		20% faster
Mechanical structure	Transparent plastic body supporting PCBs, battery and motors	Same mechanics
Distance sensor	8 infra-red sensors measuring ambient light and proximity of objects up to 6 cm	Same infra-red sensors Front real distance sensor, Time of fight (ToF), up to 2 meter.		ToF sensor
IMU	3D accelerometer and 3D gyro	3D accelerometer, 3D gyro, 3D magnetometer		3D magnetometer
Camera	VGA color camera; typical use: 52x39 or 480x1	Same camera; typical use: 160x120		Bigger images handling
Audio	3 omni-directional microphones for sound localization speaker capable of playing WAV or tone sounds	4 omni-directional microhpones (digital) for sound localization speaker capable of playing WAV or tone sounds		+1 front microphone
LEDs	8 red LEDs around the robot, green body light, 1 strong red LED in front	4 red LEDs and 4 RGB LEDs around the robot, green light, 1 strong red LED in front		4x RGB LEDs
Communication	RS232 and Bluetooth 2.0 for connection and programming	USB Full-speed, Bluetooth 2.0, BLE, WiFi		WiFi, BLE
Storage	Not available	Micro SD slot		Micro SD
Remote Control	Infra-red receiver for standard remote control commands	Same receiver
Switch / selector	16 position rotating switch	Same selector
Extensions	Ground sensors, range and bearing, RGB panel, Gumstix extension, omnivision, your own	All extension supported
Programming	Free C compiler and IDE, Webots simulator, external debugger	Free C compiler and IDE, Webots simulator, onboard debugger (GDB)		Onboard debugger

This is the overall communication schema:

Documentation

• Main microcontroller: STM32F407, datasheet, reference-manual
• Programmer/debugger: STM32F413, datasheet, reference-manual
• Radio module: Espressif ESP32, datasheet, reference-manual
• Camera: PixelPlus PO8030D CMOS image sensor, datasheet, no IR cut filter
• Microphones: STM-MP45DT02, datasheet
• Optical sensors: Vishay Semiconductors Reflective Optical Sensor, datasheet
• ToF distance sensor: STM-VL53L0X, datasheet, user-manual
• IMU: InvenSense MPU-9250, product-specification, register-map
• Motors: details
• Speaker: Diameter 13mm, power 500mW, 8 Ohm, DS-1389 or PSR12N08AK or similar
• IR receiver: TSOP36230

Migrating from e-puck1.x to e-puck2

The e-puck2 robot maintains full compatibility with its predecessor e-puck, but there are some improvements that you should be aware of.

First of all the e-jumper, that is the small board that is attached on top of the e-puck1.x, isn't anymore needed in the e-puck2. The components available on the e-jumper are integrated directly in the robot board. On top of the e-puck2 you'll see a quite big free connector, this is used to attach the extensions board designed for the e-puck1.x that are fully compatible with the e-puck2; you must not connect the e-jumper in this connector.

Secondly you don't need anymore to unplug and plugin the battery for charging, but instead you can charge the battery (up to 1 ampere) directly by connecting the USB cable. If you want you can still charge the battery with the e-puck1.x external charger, in case you have more than one battery.

Moreover you don't need anymore a special serial cable (with probably an RS232 to USB adapter) to be able to communicate with the robot, but you can use the USB cable. Once connected to the computer a serial port will be available that you can use to easily exchange data with the robot.

Extensions

All the extensions (ground sensors, range and bearing, RGB panel, gumstix and omnvision) are supported by the e-puck2 robot, this means that if you have some extensions for the e-puck1.x you can still use them also with e-puck2.
For more information about using the gumstix extension with e-puck2 robot refer to http://www.gctronic.com/doc/index.php?title=Overo_Extension#e-puck2.

Getting Started

The e-puck2 robot features 3 chips onboard:

• the main microcontroller, that is responsible for handling the sensors and actuators and which runs also the demos/algorithms
• the programmer, that provides programming/debugging capabilties and moreover it configures the USB hub and is responsible for the power management (on/off of the robot and battery measure)
• radio module, that is responsible for handling the wireless communication (WiFi, BLE, BT), the RGB LEDs and the user button (the RGB LEDs and button are connected to the radio module due to the pin number limitation on the main microcontroller)

The robot is shipped with the last firmware version programmed on all 3 chips, so you can immediately start using the robot.
The following sections explain the basic usage of the robot, all the users should read this chapter completely in order to have a minimal working system ready to play with the e-puck2 robot. Some sections will have more detailed information that can be read by following the links provided.

When required, dedicated informations are given for all platforms (Windows, Linux, Mac). The commands given for Linux are related to the Ubuntu distribution, similar commands are available in other distributions.

Turn on/off the robot

To turn on the robot you need to press the power button (blue button) placed on the bottom side of the board, near the speaker, as shown in the following figures:

To turn off the robot you need to press the power button for 1 second.

Meaning of the LEDs

The e-puck2 has three groups of LEDs that are not controllable by the user.

Top view of the e-puck2

• Charger: RED if charging, GREEN if charge complete and RED and GREEN if an error occurs
• USB: Turned ON if the e-puck2 detects a USB connection with a computer
• STATUS: Turned ON if the robot is ON and OFF if the robot is OFF. When ON, gives an indication of the level of the battery. Also blinks GREEN if the program is running during a debug session.

Battery level indications (STATUS RGB LED):

• GREEN if the system's tension is greater than 3.5V
• ORANGE if the system's tension is between 3.5V and 3.4V
• RED if the system's tension is between 3.4V and 3.3V
• RED blinking if the system's tension is below 3.3V

The robot is automatically turned OFF if the system's tension gets below 3.2V during 10 seconds.

Connecting the USB cable

A micro USB cable (included with the robot in the package) is needed to connect the robot to the computer. There are two connectors, one placed on top of the robot facing upwards and the other placed on the side of the robot, as shown in the following figures. Both can be used to charge the robot (up to 1 ampere) or to communicate with it, but do not connect two cables at the same time. Connect the USB cable where is more comfortable to you.

Installing the USB drivers

The USB drivers must be installed only for the users of a Windows version older than Windows 10:

1. Download and open zadig-2.3.exe
2. Connect the e-puck2 with the USB cable and turn it on. Three unknown devices appear in the device list of the program, namely e-puck2 STM32F407, e-puck2 GDB Server (Interface 0) and e-puck2 Serial Monitor (Interface 2).
3. For each of the three devices mentioned above, select the USB Serial (CDC) driver and click on the Install Driver button to install it. Accept the different prompts which may appear during the process. At the end you can simply quit the program and the drivers are installed. These steps are illustrated on Figure 3 below.

Note : The drivers installed are located in C:\Users\"your_user_name"\usb_driver

Example of driver installation for e-puck2 STM32F407

The drivers are automatically installed with Windows 10, Linux and Mac OS.

Anyway in Linux in order to access the serial ports, a little configuration is needed. Type the following command in a terminal session: sudo adduser $USER dialout. Once done, you need to log off to let the change take effect.

Finding the USB serial ports used

Two ports are created by the e-puck2's programmer when the USB cable is connected to the robot (even if the robot is turned off):

• e-puck2 GDB Server. The port used to program and debug the e-puck2.
• e-puck2 Serial Monitor. Serial communication between the PC and the radio module (used also to program the radio module).

A third port could be available depending on the code inside the e-puck2's microcontroller. With the factory firmware a port named e-puck2 STM32F407 is created.

Windows

1. Open the Device Manager
2. Under Ports (COM & LPT) you can see the virtual ports connected to your computer.
3. Do a Right-click -> properties on the COM port you want to identify.
4. Go under the details tab and select Bus reported device description in the properties list.
5. The name of the port should be written in the text box below.
6. Once you found the desired device, you can simply look at its port number (COMX).

Linux

1. Open a terminal window (ctrl+alt+t) and enter the following command: ls /dev/ttyACM*

2. Look for ttyACM0 and ttyACM1 in the generated list, which are respectively e-puck2 GDB Server and e-puck2 Serial Monitor. ttyACM2 will be also available with the factory firmware, that is related to e-puck2 STM32F407 port

Note : Virtual serial port numbering on Linux depends on the connections order, thus it can be different if another device using virtual serial ports is already connected to your computer before connecting the robot, but the sequence remains the same.

Mac

1. Open a terminal window and enter the following command: ls /dev/cu.usbmodem*

2. Look for two cu.usbmodemXXXX, where XXXX is the number attributed by your computer. You should find two names, with a numbering near to each other, which are respectively e-puck2 GDB Server (lower number) and e-puck2 Serial Monitor (higher number). A third device cu.usbmodemXXXX will be available with the factory firmware, that is related to e-puck2 STM32F407 port

Note : Virtual serial port numbering on Mac depends on the physical USB port used and the device. If you want to keep the same names, you must connect to the same USB port each time.

PC interface

A PC application was developed to start playing with the robot: you can have information about all the sensors, receive camera images and control the leds and motors.
Beware that it's not mandatory to download this application in order to work with the robot, but it is a nice demo that gives you an overview of all the sensors and actuators available on the robot, this is a first step to gain confidence with the robot.

With the factory firmwares programmed in the robot, place the selector in position 8, attach the USB cable and turn on the robot. Enter the correct port (the one related to e-puck2 STM32F407) in the interface and click connect.

The source code is available from the repository https://github.com/e-puck2/monitor.

Available executables

• Windows executable: tested on Windows 7 and Windows 10
• Max OS X executable
• Linux 64 bit

On Linux remember to apply the configuration explained in the chapter Installing the USB drivers in order to access the serial port.

Installing the dependencies for firmwares updates

You can update the firmware for all 3 chips: the main microcontroller, the radio module and the programmer. For doing that, you need some tools to be installed on the system.

Windows

To upload a new firmware in the microcontroller or in the radio module, you don't need to install anything, the packages provided include all the dependencies.

To upload a new firmware in the programmer you need to install an application called DfuSe released by STMicroelectronics. You can download it from DfuSe_V3.0.5.zip.

Linux

To upload a new firmware in the microcontroller or in the radio module, you need:

• Python (>= 3.4): sudo apt-get install python3
• Python pip: sudo apt-get install -y python3-pip
• pySerial (>= 2.5): sudo pip3 install pyserial

To upload a new firmware in the programmer you need:

• dfu-util: sudo apt-get install dfu-util

Mac

Install the Homewbrew package manager by opening a terminal and issueing:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
and then:
brew upgrade

To upload a new firmware in the microcontroller or in the radio module, you need:

• Python (>= 3.4): brew install python (it will install also pip)
• pySerial (>= 2.5): pip3 install pyserial

To upload a new firmware in the programmer you need:

• dfu-util: brew install dfu-util

PC side development

This section is dedicated to the users that develop algorithms on the PC side and interact with the robot remotely through a predefined communication protocol. These users don't modify the firmware of the robot, but instead they use the factory firmware released with the robot. They update the robot firmware only when there is an official update.
The remote control of the robot, by receiving sensors values and setting the actuators, is done through the following channels: Bluetooth, Bluetooth Low Energy, WiFi, USB cable.
Examples of tools/environment used by these users:

1. Aseba
2. Simulator (e.g. Webots)
3. ROS
4. iOS, Android apps
5. Custom PC application
6. IoT (e.g. IFTTT)

If you fall into this category, then follow this section for more information: PC side development.

Main microcontroller

The e-puck2 robot main microcontroller is a 32-bit STM32F407 that runs at 168 MHz (210 DMIPS) and include DSP, FPU and DMA capabilities. The version chosen for the e-puck2 has 192 KB of total RAM and 1024 KB of flash, so there is a lot of memory to work with.
This chip is responsible for handling the sensors and actuators and runs also the demos and algorithms.

Factory firmware

The main microcontroller of the robot is initially programmed with a firmware that includes many demos that could be started based on the selector position, here is a list of the demos with related position and a small description:

• Selector position 0: Aseba
• Selector position 1: Shell
• Selector position 2: Read proximity sensors
• Selector position 3: Asercom protocol v2 (BT)
• Selector positoin 4: Range and bearing extension (receiver)
• Selector position 5: Range and bearing extension (transmitter)
• Selector position 6: ESP32 UART communication test
• Selector position 7: ...
• Selector position 8: Asercom protocol v2 (USB)
• Selector position 9: Asercom protocol (BT)
• Selector position 10: This position is used to work with the gumstix extension.
• Selector position 11: Simple obstacle avoidance + some animation
• Selector position 12: Hardware test
• Selector position 13: LEDs reflect orientation of the robot
• Selector position 14: Read magnetometer sensor
• Selector position 15: ...

The pre-built firmware is available here main microcontroller factory firmware.

Firmware update

Now and then there could be an official firmware update for the robot and it's important to keep the robot updated with the last firmware to get possibile new features, improvements and for bug fixes.
The onboard programmer run a GDB server, so we use GDB commands to upload a new firmware, for this reason a toolchain is needed to upload a new firmware to the robot.
The following steps explain how to update the main microcontroller firmware:
1. Download the package containing the required toolchain and script to program the robot: Windows, Linux 32 bits/64 bits, Mac OS
2. Download the last version of the main microcontroller factory firmware, or use your custom firmware
3. Extract the package and put the firmware file (with elf extension) inside the package directory; beware that only one elf file must be present inside this directory
4. Attach the USB cable and turn on the robot
5. Run the script from the package directory:

Windows: double click program.bat

Linux/Mac: issue the following command in a terminal ./program.sh. If you get permission errors, then issue sudo chmod +x program.sh to let the script be executable.

When the upload is complete you'll see an output like in the following figure:

The final lines should contain the entry ".data",, this means that the upload was successfull. You can then close the terminal window if it is still open.

If you encounter some problem, try to unplug and plug again the USB cable and power cycle the robot, then retry.

Robot side development

If you are an embedded developer and are brave enough, then you have complete access to the source code running on the robot, so you can discover what happen inside the main microcontroller and modify it to accomodate your needs. Normally the users that fall into this category develop algorithms optimized to run directly on the microcontroller, such as:

1. onboard image processing
2. swarm algorithms
3. fully autonomous behaviors
4. ...

For more information about programming the robot itself, refer to section Robot side development

Radio module

The radio module chosen for the e-puck is the new ESP32 chip from Espressif, integrating a dual core that run up to 240 MHz, 4 MB of flash and 520 KB of RAM. It supports WiFi standards 802.11 b/g/n (access point mode supported), Bluetooth and Bluetooth LE 4.2. It is the successor of the ESP8266 chip. The following figure shows the various peripherals available on the ESP32:

This chip first of all is responsible for handling the wireless communication, moreover it handles also the RGB LEDs (with PWM) and the user button. The RGB LEDs and button are connected to the radio module due to the pin number limitation on the main microcontroller.

Factory firmware

The radio module of the robot is initially programmed with a firmware that supports Bluetooth communication.
The pre-built firmware is available here radio module factory firmware.

WiFi firmware

At the moment the factory firmware supports only Bluetooth, if you want to work with WiFi you need to program the radio with a dedicated firmware, refer to section PC side development: WiFi.

Firmware update

In order to update the firmware of the ESP32 WiFi module you need to use a python script called esptool provided by Espressif (manufacturer of the chip). This script was modified to work with the e-puck2 robot and is included in the provided package. The following steps explain how to update the radio module firmware:
1. Download the package containing the required tools and script to program the robot: Windows, Linux / Mac
2. Download the last version of the radio module factory firmware, or use your custom firmware. The firmware is composed by 3 files named bootloader.bin, ESP32_E-Puck_2.bin and partitions_singleapp.bin
3. Extract the package and put the firmware files inside the package directory; beware that the name of the .bin files must be the same as indicated in step 2
4. Attach the USB cable and turn on the robot
5. Run the script from the package directory:

Windows: double click program.bat

Linux/Mac: issue the following command in a terminal ./program.sh. If you get permission errors, then issue sudo chmod +x program.sh to let the script be executable.

The upload should last about 10-15 seconds and you'll see the progress as shown in the following figure:

When the upload is complete you'll see that all 3 bin files are uploaded correctly as shown in the following figure:

Sometime you could encounter a timeout error as shown in the following figures; in these cases you need to unplug and plug again the USB cable and power cycle the robot, then you can retry.

Development

Probably, you'll never need to touch the firmware running in the radio module, but in case you need to modify the code or you're simply curious about what is happening at the low level, then refer to the section Radio module development.

Programmer

Factory firmware

The programmer is initially programmed with a firmware based on Black Magic Probe programmer/debugger.
The pre-built firmware is available here programmer-firmware.bin; it is also available in dfu format here programmer-firmware.dfu.

Firmware update

The programmer's microcontroller features a factory bootloader that can be entered by acting on some special pins, the bootloader mode is called DFU (device firmware upgrade). You can enter DFU mode by contacting two pinholes together while inserting the USB cable (no need to turn on the robot). The two pin holes are located near the USB connector of the e-puck2, see the photo below.

Location of the pin holes to put the programmer into DFU

The programmer will be recognized as STM Device in DFU Mode device.

Note for Windows users: the device should be recognized automatically (in all Windows versions), but in case it won't be detected then you need to install a libusbK driver for the DFU device.
Follow the same procedure as explained in section Installing the USB drivers using libusbK driver instead of USB Serial (CDC).

Linux/Mac

In order to update the programmer firmware you need an utility called dfu-util, it should be already installed from section Installing the dependencies for firmwares updates.
To uplaod the firmware, issue the following command: sudo dfu-util -d 0483:df11 -a 0 -s 0x08000000 -D programmer-firmware.bin

Windows

Start the DfuSe application (previously installed from section Installing the dependencies for firmwares updates). The programmer in DFU mode will be automatically detected as shown in figure 1. Then you need to open the compiled firmware by clicking on choose and then locating the file with dfu extension, as shown in figure 2. Now click on the upgrade button, a warning message will be shown, confirm the action by clicking on yes as shown in figure 3. If all is ok you'll be prompted with a message saying that the upgrade was successfull as shown in figure 4.

[1]	[2]	[3]	[4]

Development

The programmer code shouldn't be modified, but if you know what you're doing then refer to section Programmer development.