Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
This page gets you started with building/playing/coding with your Petoi robots
Hi, thanks for getting a Petoi robot.
If you have a construction kit, you can follow the following instructions to build it.
If you have a Bittle X V2 kit(as indicated on the package barcode label)
pay attention to the BiBoard V1 servo wiring
select BiBoard V1 during the firmware upload process with Petoi Firmware Uploader
Note that the robot is suitable for working on smooth surfaces. When walking on a carpet, the movement may not be smooth.
Play with the default actions
Play with simple joint control
Add more commands to the controller panel
Play with group commands to make your robot perform multiple actions in sequence
Play with voice commands(for Bittle X or any robot with the voice command module)
If the robot doesn’t respond to your voice commands, please see the troubleshooting guide.
You can turn off the voice command functionality(for example: in a public space, or in a classroom setting requiring quiet periods) to avoid accidentally triggering voice responses and robot reactions.
Do some coding
Visually design some new robotics skills with Petoi Skill Composer
Follow C++ curriculum to code some Petoi robotics moves in C++
For Bittle/Bittle X, you may 3D-print this stand to make your robot not run around while you program it.
Work on some quadruped robotics competition projects
Note that all the tutorials work on Bittle/Bittle X robot dogs and Nybble robot cat even though we use one particular robot pet as an example.
Question: I am confused by the product packaging and unsure if you sent me the right robot.
Answer: We reuse the packaging for Bittle and BIttle X. If you order a Bittle but receive a package with “Bittle X” marking, or vice versa, you can check the text label with the barcode. That text identifies what’s inside the packaging.
Check other FAQs on our official website or those in the Petoi Doc Center.
Since the ESP8266 can be used as a regular Arduino board, we can write a simple Arduino code to open the serial port and send the serial commands to control the robot. It's like a stand-alone serial commander written in C and can go with the robot. You may write hundreds of pre-defined tasks without worrying about the memory limits on the main controller.
You can find a short test8266Master in OpenCat/ModuleTest:
ROS Interface
There's also a ROS wrapper for developpers to easily connect to the ROS environment. It is recommended to use ROS with Raspberry Pi.
Currently, it's recommended to install ROS using docker.
install docker on Raspberry Pi (ref)
prepare workspace
run the container
source files and build inside the container
run examples (see Examples for more)
Ros is designed with distributed computing in mind. Here's a simple example on how to run nodes on different machines.
on host machine (usually more powerful than Raspberry Pi)
run service node on Raspberry Pi
send command from host
using serial library
using ROS service
There are 2 serial ports,which are separately located on 2 expansion sockets (P16, P17) ,on BiBoard.
The serial port 1 on the P16 can be connected to the USB downloader and the external serial device. Please do not use the downloader and the external serial device at the same time. The serial port voltage division will lead to communication errors.
In the Arduino demo, Serial represents the serial port 0, Serial1 represents the serial port 1.Serial and Serial1 send to each other.
Application of ADC which is variable gain on BiBoard (ESP32)
The instructions of ADC on BiBoard
The 34, 35, 36 and 39 pins of the ESP32 module support input only. We configure it as an analog input port on BiBoard, which makes it convenient for developers to connect 4 foot sensors.
The usage of analog input analog-to-digital converter (ADC) on BiBoard is the same as the basic Arduino UNO, but the accuracy is higher (12 bits, UNO is 10 bits), and a programmable gain amplifier is added to make the ADC work in the best range.
When a 1V voltage signal is input, if 12bit access is used according to the normal configuration, the reference voltage is equal to the power supply voltage (3.3V): the corresponding output is 0~1241, a large part of the ADC range will be wasted, resulting in inaccurate data. When we configure the programmable gain, we can make the 1V input signal fill almost the entire ADC range, and the accuracy and resolution are greatly improved.
This demo uses 4 inputs, respectively configured as: 0/2.5/6/11 decibel amplification gain, it should be noted that the default configuration of ESP32 Arduino is 11 decibel amplification gain.
We use "analogSetPinAttenuation(PIN_NAME, attenuation)" to configure the gain of a single input pin, or use "analogSetAttenuation(attenuation)" to configure the gain of all analog input pins.
In the actual test, when the 1V standard voltage is input, the ADC values are: 3850/2890/2025/1050. In future productions, the ADC range can be changed by changing the ADC gain without the replacement of the reference voltage source.
The usage of EEPROM is the same as Arduino UNO, there are two operations: read and write.
Read:
I2C address of EEPROM
The internal address of EEPROM (the address for storing data)
Read data
Write:
I2C address of EEPROM
The internal address of EEPROM (the address for storing data)
Write data
In the BiBoard demo, the address of EEPROM on the I2C bus is 0x54, and the capacity is 8192Bytes (64Kbit). We sequentially write a total of 16 values from 0 to 15 in the EEPROM from the first address, and then read them for comparison. Theoretically, the data written in EEPROM and the data read from the corresponding address should be the same.
In the NyBoard factory test, we also use this method, but it is more complicated. We will use a fixed list to fill the EEPROM and read it out for comparison.
Note: the EEPROM operations, especially write operations, are generally not put into the loop() loop. Although the EEPROM is resistant to erasing (100,000 times), if a certain block is frequently written in the loop, It will cause the EEPROM to malfunction.
Operate the GPIO port of BiBoard
There is no separate GPIO port on BiBoard, but the multiplexed serial port 2 (pin 16, 17) or the PWM pin of the unused PWM servo interface can be used as GPIO port. The GPIO port is also relatively simple to use. After configuring the input and output mode, the usage is exactly the same as that of Arduino UNO. You can use any IO control program of Arduino UNO, just change the number of IO .
Bluetooth Low Energy (BLE, Bluetooth Low Energy) serial port pass-through is widely used. On Apple's iOS platform, Classic Bluetooth requires MFi certification to connect with Apple's iOS devices. The Bluetooth low energy device does not have this restriction.
The protocol stack and principle of Bluetooth low energy will not be repeated here, there are many related articles and videos. In short, the bluetooth service is provided in the form of a profile, and there are N characters with independent IDs (UUID) under the profile of each service. Each character has different permissions (read, write, notify, indicate). After the user defines the character and combines it with the authority, a complete service can be provided.
What BLE pass-through is actually to establish a BLE Service, and there are 2 characters under this profile.
One for TX (transmit data) and one for RX (receive data). For this they have different permissions. The following code is to create a new service and character:
Next are two callback functions, which are performed when there is a connection and when there is a write RX character:
Finally, the main loop is the control of the connection, which determines whether there is a connection and whether it is disconnected.
For the complete code, see the example of the official library: ble_uart, and the debugging tool can use LightBlue.
The sample code mainly demonstrates the mutual forwarding of information between the Bluetooth serial port and the serial port, which is derived from the official demo of ESP32, which is simple and easy to understand. So the description mainly explains the concepts that appear in the code.
At present, the main Bluetooth protocols are divided into two categories, traditional Bluetooth (HS/BR/EDR) based on RFCOMM and Bluetooth low energy (BLE) based on GATT.
Traditional Bluetooth is faster and has many specific application protocols, such as audio-oriented A2DP, Bluetooth serial port SPP, etc. However, the power consumption is high, and access to Apple devices requires MFi (Made For iOS) chips and certification.
Bluetooth Low Energy (BLE) can define various GATT profiles by itself, and it is also equipped with commonly used profiles (such as device information, battery, etc.). It has low power consumption and is widely used. It can be used on Apple devices. The disadvantages is that it is slower than traditional Bluetooth. Bluetooth low energy is mostly used on devices with low data volume but sensitive to power consumption, such as bracelets/smart watches/beacons.
This demo uses the SPP protocol based on traditional Bluetooth, which comes with all serial port protocols. When the computer or Android phone is connected and paired, a serial port number will be automatically generated in the system for communication, and the experience is not much different from that of a normal wired serial port.
The bluetooth low energy serial port will be demonstrated in the next chapter. In essence, it is a profile configured with a serial port and requires host software support.
📚➡️🤖
This is the Petoi robot product documentation hub. We constantly iterate on our models and codes to bring bionic robotic pets to the world. Please read the notes regarding versions carefully before configuring your robot.
If you need help, please write to support@petoi.com or post on our forum at petoi.camp.
You can use the find (Cmd+K/Ctrl+K) feature on this site. It supports Lens, a ChatGPT-based service.
Note that this privacy notice refuses to disappear!
Some USB cables are just for charging and do not have data transfer capability. Using the original data cable in the kit is better for making the uploading successful.
Some new laptops only have USB-C ports, so users use a hub to connect standard USB-B to their computers. However, the intervening hubs prevent the app from recognizing the serial port. The solution was to connect the USB-C cable DIRECTLY to the computer using EITHER a USB-C to USB-C cable OR a tiny C to B adaptor (not a hub).
When you use a USB uploader to upload the firmware for the NyBoard, if there is no serial port in the port list of Device Manager.
Please download and install the USB driver:
When you use a USB type-C data cable to upload the firmware for the BiBoard, if there is no serial port in the port list of Device Manager.
Note: The connection for uploading firmware is to be made directly to the BiBoard and NOT to the outside charging port on the battery.
Please download and install the USB driver:
For more details, please refer to the BiBoard V0 USB Driver to access the serial port.
When you use a USB type-C data cable to upload the firmware for the mainboard BiBoard V1.
On Windows, if there is no serial port in the port list of Device Manager:
On Mac, open the Terminal program under the Applications-Utilities folder and type the following commands. If no serial device name starting with "tty.wchusbserial" or "cu.wchusbserial" is found:
For the macOS(from the version Sequoia), after installing the driver, you need to enable the driver, as follows:
Settings -> General -> Login Items & Extensions -> Driver Extensions
There are two methods to Upload the firmware to the robot:
The simplest method is to use the Petoi Desktop App. No programming is involved. You can play with some preset modes.
If you have some programming experience, you can use the Arduino IDE. You will be able to modify the open-source codes for your new projects.
If you are using NyBoard, please refer to Upload Sketch for NyBoard.
If you are using BiBoard, please refer to Upload Sketch for BiBoard.
If you have a NyBoard(with Bittle and Nybble), we highly recommend using the green USB programmer to upload the firmware. The Bluetooth dongle is not as stable and may cause the mainboard's bootloader to crash if interrupted in the middle.
For BiBoard(with Bittile X), the USB/Bluetooth connections are built on the board already.
Bittle and Bittle X are from the same family and share a lot of common things, except for the microcontroller difference where Bittle X uses BiBoard and Bittle uses NyBoard. So we just refer to Bittle most of the time without specifically mentioning Bittle X.
The differences in specifications of different mainboards are shown in the figure below:
Please refer to the Buzzer beep meaning.
Try turning off the Gyro in the mobile app, as shown in the following picture:
Try turning on the Gyro in the mobile app, as shown in the following picture:
Make sure you calibrate the joints with the included L-shaped tuner and understand the references
Remove the rubber toe covers
Turning off the Gyro will make slow gaits more stable
There's a known bug in one of the older firmware. Please upgrade to the latest firmware.
The error that occurs when uploading the sketch is shown below:
[1]. Do the simple checks as follows:
Make sure there's no other program using the serial port, If you have opened the Arduino IDE and its serial monitor, it may occupy the serial port.
Make sure the uploader is connected to the NyBoard in the right way.
Make sure you're using the USB cable that comes with the kit, some USB cables may only have two wires for powering, but no data wires.
[2]. For this operation, you can use a simple test sketch for convenience.
With the Petoi Desktop App, select the microcontroller type: NyBoard_V1_*, then you can upgrade the Standard firmware.
With Arduino IDE, select the microcontroller type: Board-> Arduino AVR Boards-> Arduino Uno, then you can upload the sketch: File-> Examples->04.Communication->ASCIITable.
[3]. Install the USB uploader driver.
[4]. Reset the bootloader.
There are two calibration steps for different components.
Because the controller board has limited resources, we divide the program into two stages.
In the first stage, we upload the program and large data to the onboard EEPROM (hard disk) and use the remaining programming space to calibrate the IMU, a sensor that measures the body orientation. The board should be leveled and untouched during the (IMU) calibration.
In the second stage, we upload the standard functional code. For the first-time configuration, we need to enter the (joint) calibration state and attach the legs in the right direction.
If you use the Arduino IDE to set up the board, you will handle those stages explicitly. The Petoi Desktop App can finish the two-stage uploading in the background. The mobile app can work only with an already configured board. Its (joint) calibration is only for attaching the legs.
Yes, you still need to use the desktop app/mobile app/Arduino IDE to fine-tune the joints if your robot doesn't walk very stable.
Our microcontrollers are specifically designed for our robots. The open source code is free to use and can be downloaded on GitHub.
You can use Python to control any Petoi robot. The scripts can work either on your computer and connect to the robot wired or wirelessly.
It follows your instructions via the infrared remote, mobile app, or desktop app. It can also do random behaviors if you enable the random mode. Best of all, the program is open source on GitHub, and you can refer to the relevant technical documents to create new skills for your robot.
This is due to the incompatibility of the Python Tk library with MacOS. The temporary solution is that you can press the button and drag the mouse slightly at the same time.
Download the Arduino IDE(e.g. 1.8.19) for Linux from https://github.com/arduino/Arduino/releases/download/1.8.19/arduino-1.8.19.tar.xz
Install it on the Chromebook. Please refer to the video at https://www.youtube.com/watch?v=2cve6n4LZqI
Plug the USB adapter with a USB data cable (for NyBoard) or USB type-C data cable (for BiBoard) into the robot's microcontroller and the Chromebook.
Set the Chromebook Linux VM to recognize the USB port
Settings => Advanced => Developers => Linux development environment => Manage USB devices => USB Serial (turn on)
NOTE: Step 4 must be repeated every time the USB connection is reconnected/powered on.
If you have downloaded and unzipped the OpenCat folder but see the following error:
You should rename the unzipped OpenCat-main folder to OpenCat so that the OpenCat.ino matches the root name.
For more information, please refer to: https://docs.petoi.com/arduino-ide/upload-sketch-for-nyboard#setup-process
BTW, you also can upload the firmware via the Petoi Desktop App:
https://docs.petoi.com/upload-firmware https://docs.petoi.com/desktop-app/firmware-uploader
Try to set "Bluetooth devices discovery" to "Advanced" as follows:
In the Device Manager, if you open the Other devices list, you may see a CP210X device with a triangle exclamation sign. Right-click it to find the "update driver" option, then select the enclosing folder of your downloaded driver to install.
When connecting, the app will send handshake signals to the robot, and the robot should be running the firmware in standard mode to respond correctly. If the app returns a "not Petoi robot" error, it's probably due to a firmware issue. Please follow this debugging process:
[1]. Please check the version of the app as follows:
App Store
Google Play
[2]. For the startup melody in normal mode, please refer to the 00:13 in the video below:
For how to open the serial monitor and input the serial command, please refer to the instructions in the Petoi Doc Center.
[3]. You can upgrade the firmware via the Petoi Desktop App.
For NyBoard, if the firmware can not be upgraded, please refer to NyBoard can't upload firmware
Please check out the forum post discussing installing springs with various tools. Or you can request Bittle upper legs with pre-installed springs
The toe covers are for special experiments that require more friction. They are not required for regular walking and performance. We have removed them from the standard kit recently, and you may order them as optional accessories.
You may contact us. Show the picture of the broken pieces and explain how they broke. You may find the 3D-printable files or get a replacement directly from us.
Please refer to Bittle's instruction in Final Assembly.
The little bone is included in the Intelligent Camera Module box, and it is not being sold separately. You may download its 3D-printable file at: https://github.com/PetoiCamp/NonCodeFiles/blob/master/stl/Bittle_bone.stl
Both Bittle kit and pre-assembled Bittle include one Lithium battery with a built-in charging circuit. You may add more spare batteries.
You can solder the 2x5 socket on the NyBoard and then mount the Rasberry Pi on the NyBoard.
Read more at https://docs.petoi.com/api/raspberry-pi-serial-port-as-an-interface
In some cases, the motor's output gear may disengage with the following gear. It will result in an abnormal buzzing sound inside the servo. You can take off the bottom of the servo and push the motor inward very hard until you hear a clicking sound.
Please refer to the FAQ on the MU camera.
Turn off the battery's power to see if the serial port can appear. Please refer to Connect to BiBoard via USB type-C data cable.
You can use Petoi Coding blocks to do Scratch-like block-based programming with all of Petoi robots.
There's nothing else to purchase.
Joint calibration is vital for the robot to work properly.
The pre-assembled robot should have the legs installed, but you can further improve its performance by fine-tuning the joints' calibration.
Make sure you have uploaded the OpenCat Main function firmware before calibrating.
This is a cool tutorial video made by one of our users, which briefs the process and explains its logic.
You don't know where the servos are pointing before they are powered and calibrated. So if you attach the legs, the legs will rotate to random angles and may collide with the robot's body or other legs and get stuck. If a servo is stuck for a long time, it may break.
The robot has a "calib" posture with all joints set at zero degrees. You can put the robot to the calib posture so that you know all the joints should be rotated to their zero points (though you cannot see because the legs are not attached to the servos yet). Then, you can attach the legs to the servos one joint by one joint, perpendicular to their nearby references on the body frame.
Because the servo's gear teeth are discrete, aligning the legs to the right angles perfectly is impossible. So, you will need to fine-tune the offsets within the software.
The principles are the same for Nybble and Bittle.
Entering calibration mode requires the following preparations:
1. All servo circuits are connected to the motherboard
2. The battery is plugged into the controller board and is turned on (long-press the button on the battery to turn on/off the power)
3. The USB adapter or Bluetooth dongle is used to connect the robot to a computer or mobile phone
If you build the robot from an unassembled kit, do not install the head and leg components before entering the calibration state.
The robot's legs may point to unknown angles when booting up. When entering the calibration state, the joints will be moved to their zero positions. You can see the output gears of the servos rotate and then stop. Then, you can attach the legs and fine-tune the joint offsets in the software interface. There are 3 software interfaces to enter the calibration state and fine-tune the joints.
Use the Mobile App Petoi
Use Arduino IDE
You can also enter the calibration state by booting up the robot with one side up. This method doesn't require any computer, remote, or smartphone app, so it's convenient when you are focused on assembling the robot from the kit.
After completing the joint calibration, install the center screws to fix all the joint parts and servo gears.
We humans and many other legged animals have many joints. They give us the freedom to move in many ways. Though it's difficult to reproduce those complex motions on a robot, we can simplify all those joints to limited numbers of actuators.
When controlling so many joints, the first thing is to index them. We can define an order according to their distance from the torso. For example, the shoulder joint is closer to the torso than the elbow joint, and the joint that let us look around is closer to the torso than the joint that let us nod. If we had tails, it would be as close as the head compared to the shoulder joints.
So we can order the joints in this way: head panning, head tilting, tail panning, tail tilting, 4x shoulder (or hip) roll, 4x shoulder (or hip) pitch, 4x elbows (or knees). For the joints in the same distance group, we can index them clockwise from the front-left corner if the body is looked at from behind.
And when we map those joints to a specific robot, the indexing becomes more practical. The ordering for the joint servo pins on NyBoard is like below:
Although the BiBoard has only 12 pins, the joint index numbers are configured in the same order as the NyBoard. The connection between the joint servo and the pin is shown in the figure below:
A servo plug has three wires. Plug it in the right direction or you may burn the chip. The color of wires may vary for different models. However, the darkest-colored (Black or Brown) wire (GND for ground) is always the GND wire as a convention. The GND wire should be plugged closest to the board.
The index number of the joint servo has no corresponding relationship with the PWM pin number on the main board. You don't even need to read the pin numbers on the PCB board.
The rotation angle range of the joint servo is between [-125~125]. For the leg servo, when viewed from the left side of the robot, when the leg rotates counterclockwise from the 0-degree position around the joint center point (the screw fixing position), the angle is a positive value; clockwise rotation, the angle is a negative value; viewed from the right side of the robot, the leg rotation angle is mirror-symmetrical to the left side (when rotating clockwise from the 0-degree position around the joint center point, the angle is a positive value; Rotate counterclockwise, the angle is negative). For the robot's neck servo, looking down from the top of the robot's head, when the neck rotates counterclockwise from the position of 0 degrees around the joint center point (the position where the screw is fixed), the angle is a positive value; when it rotates clockwise, the angle is a negative value.
For the Nybble head servo (No. 1 servo) observed on the right side of the robot, the head rotates counterclockwise from the 0-degree position around the joint center point (screw fixed position), and the angle is positive; when it rotates clockwise, the angle is negative.
For the Nybble tail servo (No. 2 servo) facing the tail and looking down, the tail rotates counterclockwise from the 0-degree position around the center point (screw fixing position), and the angle is positive; when it rotates clockwise, the angle is negative.
If you want to use Joint Calibrator, Skill Composer in the Petoi Desktop App, or a coding block in Mind+ via computer Bluetooth, you need to pair the mainboard's Bluetooth with the computer first.
Power on the mainboard via the battery (plug in the battery to the mainboard, and long-press the battery button > 3 seconds); after powering on, the mainboard's blue LED and yellow LED should be on.
For Windows, Open the Bluetooth & other devices setting page, and turn on the Bluetooth button as follows:
Add the BiBoard Bluetooth for the first time as follows:
Select the one with the name Bittle**_BLE:
After paired successfully, it shows:
For Windows 11, after the initial Bluetooth pairing, the device might show “not connected” as follows. However, as long as the robot is not rebooted after the pairing, the associated COM port is still registered in the system. You can connect to the serial port within the Petoi application, such as the Desktop app and the Mind+.
Check the outgoing serial port, which we will use later in the Mind+ or Petoi Desktop App in the More Bluetooth options:
If you have already added the BiBoard Bluetooth before, after powering off and powering on the robot, you should remove both of the two devices in the list as follows:
Test in Mind+:
Please refer to the Bluetooth module for NyBoard.
📱🤖
Thanks for choosing Petoi's robot, Bittle or Nybble. This guide will help you set up your robot buddy and provide a simpler UI to calibrate the joints, control the robot, and program it. For advanced users, we recommend you keep the robot updated with the OpenCat firmware on Github for the best compatibility and the newest features.
The app works on both Android and iOS devices.
You can also download the Android APK and install it on your phone. You need to unzip it before installation.
If the Bluetooth dongle blinks while the connection panel within the App shows a blank Bluetooth connection list, first check if you have given the Bluetooth and location permission to the App. If it still shows a blank list, you may try to install the previous stable version.
The v8a version of the app mainly supports most of the current new mobile phone models
The v7a version of the app is compatible with older mobile phone models
You need to plug the Bluetooth dongle into the 6-pin socket on the NyBoard. Pay attention to the Bluetooth dongle's pin order. Long-press the button on the battery to turn on the robot's power.
If the buzzer beeps repetitively after bootup or during use, the battery is low. Please charge it in time. The charging port is on one end of the battery.
If the main board is BiBoard, no need to plug the Bluetooth dongle.
The LED on the Bluetooth dongle should blink, waiting for a connection. Open the app and scan available Bluetooth devices. Don't connect the robot with the phone's system-wide Bluetooth settings! Connect the device with the name Bittle, Petoi, or OpenCat. Remember to open the Bluetooth service and grant the app access to the service. On some devices, you may also need to allow the location service for the app, though we are not using any of that information.
On some Android OS, you need to activate the location service as following:
The app will send a greeting to the Bluetooth device and expects a response from the OpenCat firmware. You must install the full OpenCat code on your robot before connecting to the app. Otherwise, the app will consider it's "not a Petoi device". A pre-assembled robot should already have the firmware installed. Otherwise, you must configure it with Arduino IDE or the Desktop app.
If Bluetooth is connected, its LED will light steadily. The robot will play a three-tone melody. If the robot doesn't respond or malfunctions later, press the reset button on the NyBoard to restart the program on the NyBoard.
The App should automatically detect Nybble or Bittle with the latest OpenCat firmware. Otherwise, it will show the selections for Nybble or Bittle. The option "Select a robot" also can be re-visited in the control panel.
Petoi Desktop App provides a neat graphical user interface to configure the firmware, calibrate the robot, and design customized motions for your robot. The major function modules are the Firmware Uploader, Joint Calibrator, and Skill Composer.
You can download the latest version of the desktop App and unzip it.
Before running the app, you must use the included USB adapter or the Bluetooth dongle to connect to a Petoi robot. You may need to install drivers for USB connection.
Run the UI.exe in the unzipped folder. Do NOT move the UI.exe to another location in Windows.
After downloading the Mac version, you must drag it into the Application folder.
If you see the error message that "Petoi Desktop App" cannot be opened because the developer cannot be verified, you can right-click the icon, hold the Shift key and click Open.
Please see the next chapter to run the app from a terminal
In the case of compatibility issues, or if you want to modify the source and test, you can also run the code from the Terminal.
The Terminal is a built-in interface on Mac or Linux machines. The equivalent environment on Windows machines is called the Command-Line Tool (CMD). It's recommended that you install Anaconda to manage your Python environment. It can also provide the Powershell as a Terminal for older Windows machines.
Depending on your existing Python configuration, you may need to upgrade to Python3 and install the following libraries:
pyserial
pillow
You can install them by entering pip3 install pyserial pillow
in the Terminal or use the package manager in Anaconda.
To run the code:
In the Terminal, use the cd
command to navigate to the OpenCat/pyUI/
folder. You can use the Tab key to auto-complete the path name.
After entering the pyUI/ folder, enter ls
and ensure you can see the UI.py and other python source codes listed.
Enter python3 UI.py
.
For Linux system users, if you encounter the python error message "_tkinter.TclError: no display name and no $DISPLAY environment variable", you can try to install python3-tk, tk-dev, taking Debian / Ubuntu as an example, the command is as follows:
apt install python3-tk
apt install tk-dev
After the installation is complete, reboot the computer.
The source code is written with Tkinker in Python3 and is open source.
UI.py is the general entry for all the modules:
UI.py
-> FirmwareUploader.py
-> Calibrator.py
-> SkillComposer.py
-> translate.py provides multi-language support for the UI. You may help to translate the UI into your language.
You need to turn on Linux on the Chromebook to access the Linux environment via the terminal app.
Then, follow the following steps to install Mind+.
Use the following command to check the processor architecture in the terminal:
uname -m
The output will be similar to "i686", "x86_64" or "armv7":
i686 (or similar) - 32-bit Intel/AMD processor (common in older computers).
x86_64 (or similar) - 64-bit Intel/AMD processors (modern laptops, desktops, and most Chromebooks).
armv7 (or higher) - ARM processor. (Mobile phones, tablets, 2nd and 3rd generation Raspberry Pis running Ubuntu Mate, and some Chromebooks. Most are 32-bit now)
According to different architectures to download different versions:https://mindplus.dfrobot.com/linux
Use the following command in the terminal to install it (Replace ***** with the file name of the installation package):
sudo dpkg -i *****.deb
sudo apt-get -f install
After installed, you can start the Mind+ app in the Chromebook launcher:
Now, you can proceed to the Mind+ tutorial.
Currently, connection via Bluetooth is not supported.
In the control panel, you can control the robot to perform various postures, behaviors, and gaits.
The built-in postures and behaviors can be triggered by pressing the buttons. Don't press the button too frequently and repeatedly. Allow some time for the robot to finish its current tasks.
Press and hold the button and drag to change the button position.
Double-tap the command button to edit it.
You can also create a customized single command/group command by pressing the "+" button.
After pressing the Create Command button, you can see the following interface:
After entering the editing state, there's a serial console to test the command and configure the robot.
You can try the following useful serial commands in the Code text box:
Below are the indexes of the joints for your reference. Observe the patterns of the ordering and try to remember them.
Please see this list of common commands that may be added as customized commands. You can enter the "Voice command" column values as the "Name" values and the "Customized command code for Petoi mobile app" column values as the "Code" values.
A more detailed command table can be found in the Serial Protocol.
You can send the skill file to your phone using Messenger or email and open the file on the phone using the Petoi App. A button will be created for the new skill; you can see it when you open the control panel.
The SkillLibrary folder in Github contains new skills for the OpenCat robot, which can be used for your reference. You can use your mobile browser to access the GitHub page of the OpenCat project, open the skill file (such as Bittle_Fold.md), select the "Code" tab, and share it with Petoi Mobile App(make sure the mobile app is connected to your Petoi robot first), as shown in the figures below. Then you can execute this skill by pressing the newly created command button.
You are welcome to create your new skills(using the Skill Composer or Modifying the source code) and share them by sending merge requests to this folder.
The group command feature lets you chain multiple commands together and play them in sequence.
After pressing the Create Group Command button, you can see the following interface:
You can name the command group in the Name text box and add the command to the Command Group list by clicking the command button in the Command Library selection box. In the Command Group list, you can press and hold the command button and drag to change the command position.
Click the Delete button to Delete the group command.
If your robot doesn't have any random behavior, you may need to upgrade your robot to the latest firmware.
We keep improving the app and will inform you of the updates when available. Please write to support@petoi.com if you have any questions about the app.
If you are familiar with the Petoi coding blocks and Python language, you can change to the Code mode in Mind+ as follows:
The Code mode is a Python3 development environment. You can write any Python script in it and call all the API interfaces of the PetoiRobot library imported by Mind+.
You can find the PetoiRobot library in the following directory. There are all the definitions of API interfaces in the PetoiRobot.py
Windows C:\Users\{username}\AppData\Local\DFScratch\extensions\petoi-robot-thirdex\python\libraries\PetoiRobot.py
MacOS /Users/{username}/Library/DFScratch/extensions/petoi-robot-thirdex/python/libraries/PetoiRobot.py
Here is a sample code :
You can also copy the code in the Auto Generate area in the Blocks mode and then paste it into the code file in the Code mode. Then you can edit and run the code.
After downloading the compressed file(.zip), please unzip it first.
Do NOT move the UI.exe to another location in Windows.
From version 1.2.1, the Petoi Desktop App has included a new module, Debugger. This module provides convenient tools to fix your robot's frequent problems.
It is used to reset the voice command module, simplifying its debugging process. If the voice module does not respond to your voice, you can use this tool to reset it. It's pretty simple to use: click the Reset voice module button.
After clicking the button, please follow the instructions in the message box.
If the problem persists, please email support@petoi.com.
The above interfaces will be displayed when you calibrate for the first time. You can also click to open the upper-right menu in the control panel and select Calibrate to re-access.
Make sure you have uploaded the OpenCat Main function firmware before calibrating.
Only the software version 2.0 is supported to calibrate the joints via this App.
You need to connect the Bluetooth module (for NyBoard only) with computer, install the battery and long-press the button on the battery to power the robot.
After the robot is powered on, there are 2 methods to enter the calibration state:
Click the Start Calibration button.
Click the Calibration button in the calibration interface.
In the calibration state, place the head as close to the central axis as possible and insert its servo shaft into the servo arm of the neck.
Press down on the head so it is firmly attached to the neck.
Install upper leg and lower leg components to the output teeth of the servos when the Bittle is powered on and in the calibration state. Please keep the torso, upper leg, and lower leg installed vertically as much as possible, and do not install the lower leg backward, as shown in the picture.
The pre-assembled robot should already have the legs properly installed. You can do the joint calibration for fine-tuning.
Use the included L-shaped tool as a reference!
When calibrating, first select the index number of the joint servo from the diagram(when adjusting the leg servo, adjust the thigh first, and then adjust the calf), and then click the "+" or "-" button to fine-tune the joint to the right angle state.
If the offset is more than +/- 9 degrees, you need to remove the corresponding part of the servo and re-install it by rotating one tooth, and then press the "+" or "-" button.
For example, if you have to use -10 as the calibration value, take the limb off, rotate by one tooth then attach it back. The new calibration value should be around 4, i.e., they sum up to 14. Avoid rotating the servo shaft during this adjustment.
You can click the skill buttons to switch between Rest, Stand, and Walk to test the calibration effect.
If you want to continue calibrating, please click the Calibration button, and the robot will be in the calibration state again (all servos will move to the calibration position immediately).
Note:
You may need a second round of calibrations to achieve optimal results.
After calibration, remember to click the "Save" button to save the calibration offset. Otherwise, click "<" in the upper left corner to abandon the calibration.
After completing the joint calibration, install the center screws to fix the leg parts and servo gears.
NyBoard is equivalent to a generic Arduino Uno board with rich peripherals. Besides the native Arduino IDE, you can also program it using Mind+ blocks. But be aware that if you use this mode, the original OpenCat firmware will be over-written, and you will need to re-upload the firmware later to resume the default robot animal function.
Setting up the coding environment is as easy as the following steps.
Entering the calibration state requires the following preparations:
Entering the calibration state requires the following preparations:
1. All servo circuits are connected to the motherboard
2. The battery is fully charged
3. Connect the USB adapter and communicate normally
If you build the robot with an unassembled kit, do not install the head and leg components until calibrated.
You need to install the battery and long-press the button on the battery to power the robot.
The calibration has three steps:
1. Power on the robot with battery, and let servos rotate freely to zero angle/calibration state
2. Attach body parts to the servos
3. Fine-tune the offsets in the serial monitor
You must plug the servos and external batteries into the NyBoard and check the position and direction of all servos.
Type ‘c’ in the serial monitor to enter the calibration state. Depending on their initial shaft direction, some may travel larger angles until stopping at the middle point. There will be noise coming from the gear system of the servos. You will see a calibration table like the following:
The first row is the joint indexes; the second row is their calibration offsets:
Index
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Offset
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
-1
Initial values are “-1” or “0” and should be changed by later calibration.
The servos use a potentiometer in the feedback loop for position control. When held at a static position, they tend to vibrate around the target angle. A Parkinson's-like vibration will develop after a short period of use. It won’t affect much during continuous motion. Better servos without these troubles could cost 10 times more, so replacing a failed unit is a more cost-effective solution.
After typing ‘c’ in the serial monitor, with all servos rotated to their zero angles, attach the head, tail, and legs prepared in the previous section to the body. They are generally perpendicular to their linked body frames. The calibration pose is shown below:
If you are building the robot from a kit, install the servo-related components according to the picture above and try to ensure that they are perpendicular to each other (the upper leg is perpendicular to the torso, and the lower leg is perpendicular to the upper leg). Please refer to the related chapter in the user manual for the details:
Nybble
Note: Insert the servo-related components directly into the servo output shaft; do not turn the output shaft during this process.
Rotating the limbs counter-clockwise from their zero states will be positive (same as in polar coordinates). Viewed from the left side of the robot's body, the counter-clockwise rotation of the joint is defined as the positive direction.
The only exception is the tilt angle for the head of Nybble. It’s more natural to say head up, while it’s the result of rotating clockwise.
However, from the right side of the robot's body, the rotation direction's positive and negative are just opposite.
If we look closer at the servo shaft, we can see it has a certain number of teeth. That’s for attaching the servo arms and avoiding sliding in the rotational direction. In our servo sample, the gears divide 360 degrees into 25 sectors, each taking 14.4 degrees(offset of -7.2~7.2 degrees). That means we cannot always get a perfect perpendicular installation.
In the calibration state, place the head as close to the central axis as possible and insert its servo shaft into the servo arm of the neck.
Press down on the head so it is firmly attached to the neck.
Install upper leg and lower leg components to the output teeth of the servos after the Bittle is powered on and in the calibrated neutral position. Please keep the torso, upper leg, and lower leg installed vertically as much as possible, and do not install the lower leg backward, as shown in the picture.
The command for fine-tuning calibration (refer to the serial protocol) is formatted as cIndex Offset
. Notice that there’s a space between cIndex and Offset. The index number of the robot's joints is shown in the pictures below:
For example :
c8 6
This means giving the 8th servo an offset of 6 degrees.
c0 -4
This means giving the 0th servo(the head) an offset of -4 degrees.
The resolution of the correction amount is 1 degree; do not use decimals.
If you find the absolute value of offset is more significant than 9, you are not attaching the limb closest to its zero states. That will decrease the servo's reachable range on either side. Please take off the limb and rotate it by one tooth. It will result in an opposite but smaller offset.
For example, if you have to use -9 as the calibration value, remove the limb, rotate it by one tooth, and then attach it back. The new calibration value should be around 5, i.e., the sum of their absolute values is 14. Avoid rotating the servo shaft during this adjustment.
Find the best offset that can bring the limb to the zero states. It's a process of trial and error.
For the robotic arm, you can use the serial command "c-2" to auto-calibrate the robotic claw joint.
After calibration, remember to type ‘s’ to save the offsets. Otherwise, they will be forgotten when exiting the calibration state. You can even save every time after you’re done with one servo.
When watching something, one's observations will change from different perspectives. When measuring length, one always wants to read directly above a referencing ruler.
You must keep a parallel perspective when calibrating Bittle. Use the 'L'-shaped joint tuner as a parallel reference to avoid reading errors. Align the tips on the tuner with the center of the screws in the shoulder and knee joints and the little hole on the tip of the foot. Look along the co-axis of the centers. For each leg, calibrate the shoulder servos (index 8~11) first, then the knee servos(index 12~15). When calibrating the knee, use the matching triangle windows on both the tuner and shank to ensure parallel alignment.
After calibration, type ‘d’ or ‘kup’ to validate the calibration. This will result in Bittle / Nybble symmetrically moving its limbs between the rest and stand states.
You may need to do a few rounds of calibrations to achieve optimal states.
Take Bittle, for example, as follows:
After completing the joint calibration, install the center screws to fix the leg parts and servo gears.
Try to understand how the robot keeps balance even during walking. If you add new components to the robot, distribute its weight symmetrically about the spine. You may also need to slide the battery holder back and forth to find the best balance spot. Because the battery is heavier in the front, you can insert it in a reversed direction to shift the center of mass more toward the back.
You may need to recalibrate if there's a change to the center of mass.
Please do not force the robot to add heavy objects, which may cause the servos to sweep or get stuck.
This manual for Beginner. Makes it easier for you to get started with the robot(Nybble / Bittle ).
After downloading the compressed file(.zip), please unzip it first.
Do NOT move the UI.exe to another location in Windows.
Petoi Desktop App works on both Nybble and Bittle controlled by NyBoard based on ATmega328P or Bittle X controlled by BiBoard based on ESP32. For NyBoard, more detailed documentation can be found at NyBoard V1_0, NyBoard V1_1, or NyBoard V1_2 (which is similar to NyBoard V1_1).
Use the USB uploader for NyBoard.
For more details, please refer to the Connect NyBoard section in the USB uploader module for specific steps.
You can find the board version number on the NyBoard.
Note:
For NyBoard V1_1, the board version number is here:
Dial the I2C switch(Sw2) to the "Arduino" side
The I2C switch changes the master of I2C devices (gyro/accelerometer, servo driver, external EEPROM). On default “Arduino”, NyBoard uses the onboard ATmega328P as the master chip; On “RPi”, NyBoard uses external chips connected through the I2C ports (SDA, SCL) as the master chip. Always select "Arduino" unless you can connect the I2C devices from the external chip.
Notes:
Sometimes, if you cannot go through the bootup stage, such as repetitively printing "IMU" and restarting, you may have accidentally dialed the switch to the "RPi" side.
Use the USB type-C data cable for BiBoard.
If you cannot find the serial port after connecting to your computer:
You may need to install the driver for the CP210x chip for BiBoard V0.
You may need to install the driver for the CH343 chip for BiBoard V1.
If the battery powers the BiBoard, please long-press the button on the battery >=3s to power off the mainboard so that the board is only powered through the USB cable and only the blue LED is lit up.
You can find the board version number on the BiBoard V0:
On the pre-assembled Bittle X, you can check the version information of BiBoard like this by taking a picture and zooming in to see the version information:
There may be some OS platform compatibility issues with different computers.
You can still run the app directly from your terminal:
Go to OpenCat/pyUI/ in your terminal.
Install pyserial and pillow for your Python. You may get a clean Anaconda environment and pip3 install pyserial pillow
Run python3 UI.py
For NyBoard, the firmware uploader calls the application avrdude to upload firmware files to the mainboard.
Linux OS
For Linux system users, in addition to the above steps, you also need to perform the following steps:
1. Install avrdude
Fedora: dnf install avrdude
CentOS: yum install avrdude
Debian / Ubuntu: apt install avrdude
2. Modify the variable avrdudeconfPath in FirmwareUploader.py
Fedora / CentOS : avrdudeconfPath = '/etc/avrdude/'
Debian / Ubuntu : avrdudeconfPath = '/etc/'
For BiBoard, the firmware uploader calls the application esptool to upload firmware files to the mainboard.
After properly connecting the USB uploader, open the PetoiDesktopApp (for Windows: UI.exe / for Mac: Petoi Desktop App), and select your Model and Language.
If there is no serial port or more than one serial port are detected by the desktop app:
After clicking the Firmware Uploader button, there will be a message box prompt as follows:
Please follow the prompts in the message box. After clicking the Confirm button, If you complete the prompts within 10 seconds, the desktop app will automatically identify the serial port name connecting the robot to the computer. If you complete the operation of unplugging and plugging the USB interface on the computer for more than 10 seconds, the desktop application will enter the manual selection of the serial port name mode:
Click the OK button in the Warning message box first, then you can refresh the serial port list or select one of them (e.g. COM3) and click the OK button in the Manual mode window to open the Firmware Uploader interface as follows:
Once the Firmware Uploader interface is opened, you can also unplug and replug the USB cable from the COMPUTER side. The desktop app will automatically identify the serial port name connecting the robot to the computer.
If unplug the COM5 and replug it on the computer side, it will be discovered by the desktop app as follows:
The 1.0 software won't work properly with the Joint Calibrator, the Skill Composer, and other APIs. Only use it when you want to use CodeCraft (a graphical coding interface by our partner, TinkerGen).
Software version
1.0
2.0 (default)
The 1.0 version is obsolete.
Board version
NyBoard_V1_0 (default) NyBoard_V1_1 NyBoard_V1_2 BiBoard_V0_1
BiBoard_V0_2 BiBoard_V1_0
BiBoard_V0_1 or BiBoard_V0_2 is for Bittle X. BiBoard_V1_0 is for Bittle X V2 only.
Product
Bittle (default) Nybble Bittle X
Mode
Standard (default) RandomMind Voice Mind+ Camera Ultrasonic RandomMind_Ultrasonic Light Touch PIR Gesture IR distance
For NyBoard, these 12 modes can be selected. All of these modes are applicable to both Bittle and Nybble.
For BiBoard, You only need to upload the Standard mode firmware, and you can switch between different modes via serial port commands. [1]
Serial port
Auto detection or by manual selection.
You can find the correct one through unplug and replug the USB socket on the computer side
You can use the serial commands to switch modes for BiBoard: For BiBoard, Mind+ mode is supported by default, so it doesn't require a serial command to switch on. You can learn about the function of each module through the EXTENSIBLE MODULES.
There's no correlation between the board (hardware) version and the code (software) version.
Factory Reset Our factory uses it to improve efficiency. However, it automatically resets all the parameters, including the calibration parameters of the servos and the IMU, so it's not recommended for regular users.
Upgrade the Firmware It will upgrade both the parameters and the main function.
It is mandatory if you just downloaded a new version of this desktop app.
Update the Mode Only If you have upgraded the firmware at least once after downloading a new version of this desktop app, you can switch between the modes without refreshing the parameters. It's faster by skipping the firmware upgrade stage.
After clicking the Upgrade the Firmware button, the uploading process starts immediately. The status bar at the bottom shows the current progress in real time and the results of key processes.
After the Parameters firmware has been successfully uploaded, the board runs the configuration program. Some message windows will pop up in sequence for you to confirm or cancel:
Reset joint offsets? (Y/N)
Select "Yes, " and the program will reset all servo calibration parameters to zero. The status bar will update the corresponding process and result in real time.
Select "No" to preserve the calibration value(so that you don't need to calibrate again if you have done so before).
If you select "Yes," the program will upload all skill configuration parameters, and the status bar will update the corresponding process and result in real-time.
Select "No," and the program will skip this step.
If you upload this version of the software for the first time, be sure to select "Yes"!
For software version 2.0, this choice is automatically processed as Y in the background.
Calibrate IMU? (Y/N)
Select "Yes, " and the program will calibrate the gyroscope (IMU) to balance the robot correctly. The status bar will update the corresponding process and result in real time.
Select "No," and the program will skip this step.
Note:
Ensure the mainboard is positioned horizontally before clicking the "Yes" button.
When uploading this firmware version for the first time, click the "Yes" button!
When all the steps are completed, a message window will appear showing "Parameter initialization complete!" You must confirm to proceed to the second round of uploading the main functional code.
When the above window pops up, there's an optional step to calibrate the servo driver before clicking OK. If later you find one of the servos stops working but can resume working after re-powering it, it's probably due to an inaccurate PWM driver signal. Please redo the previous uploading, and this step CANNOT be skipped.
This calibration makes the servo controller's (PCA9685 chip) angle signal more precise. A short jumper wire is used to connect the PWM pin 3 (the signal pin of one of the servo pins) and Grove pin A3, and the wire is steady. It doesn’t have to be a dedicated jumper wire. Any thin metal wire, such as a straightened paper clip, can work as long as it can connect the pins.
The program measures the pulse width of the signal and automatically calibrates the chip after successively getting three identical readings. It usually takes less than 2 seconds. The board will beep three times to indicate the calibration is done. The calibration offset will be saved to the board for the next bootup. The process should be done at least once, and we have calibrated every board after October 2022. But you can still do it by yourself, just in case.
After the upload, the status bar will update the corresponding result, such as the success or failure of firmware uploading. If the uploading is successful, a message window of "Firmware upload complete!" will pop up simultaneously.
Note:
When you open the software and upload the firmware for the first time, the program will first upload the "Parameters" firmware and then the "Main function" firmware. If you re-upload after a successful upload, the program will only upload the "Main function" firmware as long as you only modify the "Mode" option.
If the NyBoard is not connected to the battery and powered on, you will hear repetitive descending melodies, indicating that the battery is low or disconnected. You need to connect the battery and turn on its power.
If the uploading fails, the following message box will pop up:
The log file is located at:
For Windows: The log file is in the same directory as UI.exe
For macOS: You can check the log file as follows:
When you contact our support@petoi.com, please attach the log file to your email.
If you have Arduino IDE programming experience, you can see the same log message when uploading.
For NyBoard, you can refer to Upload Sketch For NyBoard.
For BiBoard, you can refer to Upload Sketch For BiBoard.
We introduced the position feedback feature for servos manufactured after March 2024. This feature utilizes the same PWM signal wire to return the servo's actual position, opening up a new control interface for the robot.
This feature should be present on all servos with labels or laser marks after May 2024. If the labels are missing, they may still have it. However, the feature is only available on ESP32-based BiBoards (not NyBoards).
To check it, you need to upgrade your robot's firmware. Enter the serial command 'f' in Arduino's serial monitor or the mobile app's customized button. If the monitor keeps printing values that change when you move the servos, they are position feedback. The number of columns corresponds to the number of servos with feedback.
The servos have to be all feedback servos to perform the following features:
Enter 'fF' in the serial monitor, then slowly drag one of the legs. The other legs will follow the motion.
Enter 'c16'. The robot will enter its resting posture. Push the robot down flat to the table, move its head straight towards the front, and enter any character in the serial monitor. The robot will automatically set the calibration values of all its joints. Some joints can still be off and require standard calibration, but it saves most of the time.
Enter 'fl', which means learning new movements. Move the legs to your intended starting position, then keep the robot steady for about 2 seconds. The robot will count down and then beep slightly to indicate that it has started recording. It won't record small movements so that you can pause in the middle. After 124 frames, if you enter any character in the serial monitor or stop moving it for over 2 seconds, it will stop recording. Enter 'fr', which means replay to recall the taught movement.
The skill will also be printed on the serial monitor, and you can import it into SkillComposer and the smartphone app.
If you wish to write new applications based on the feedback servo, refer to the source codes in OpenCatEsp32/src/espServo.h.
You can join multiple serial commands as one task queue:
The token is T_TASK_QUEUE. ('q')
Use 'q' to start the sequence.
Add a sub token followed by the subcommand.
Use ':' to add the delay time (mandatory)
Add '>' to end the sub-command
Example: qk sit:1000>m 8 0 8 -30 8 0:500>
will make the robot sit and then move the shoulder joint.
JointAngle[index]= FunctionOf(amplitude, midpoint, freq, phase, resolution, frame)
The token is T_SIGNAL_GEN. ('o')
The command format is:o resolution speed,jointIdx1 midpoint amplitude frequency phase,jointIdx2 midpoint amplitude frequency phase,...
For example: o 1 0, 0 40 -20 4 0, 1 -30 20 4 30, 8 -70 10 4 60, 12 -10 10 4 0, 15 10 0 4 0
It doesn't matter if you use ',' or space ' ' to separate the numbers. However, using ',' to group can clarify one joint's parameters.
The motion's iterator loops from 0 to 360.
The resolution is how it increases to 360: t += resolution.
The speed defines the transition speed. It will move by [1~125] degrees towards the target angle. 0 is the maximum speed possible.
frequency defines how many cycles the joint can oscillate in one loop.
phase is defined as -120 to 120. So phase = 30 means shifting by Pi/2. 120 is one entire period.
For example, the head’s pan/tilt angles can be bound to form the Lissajous Figure.
Pan+tilt:
qksit:100>o 1 8, 0 0 30 4 0, 1 -30 30 4 30:100>o 1 0, 0 0 30 4 0, 1 -30 30 4 15:100>o 1 0, 0 0 30 4 0, 1 -30 30 8 30:100>o 1 8, 0 0 30 8 0, 1 -30 30 4 30:100>o 1 8, 0 0 30 4 0, 1 -30 30 16 30:100>o 1 0, 0 0 30 32 0, 1 -30 30 8 0:100>Wash face:qksit:100>i0 20 1 0 8 -70 12 0 15 10:0>o1 0, 0 40 -20 4 0, 1 -30 20 4 30, 8 -70 10 4 60, 12 -10 10 4 0, 15 10 0 4 0:100>m0 0 1 -20 2 0:0>ksit:0
For the detailed implementation, refer to the source code in OpenCatEsp32/src/OpenCat.h and reaction.h.
We have defined a set of serial communication protocols for robots:
All the tokens start with a single ASCII-encoded character to specify their parsing format. They are case-sensitive and usually in lowercase.
Some commands, like the c and m commands, can be combined.
For example:
Successive "m8 40", "m8 -35", "m 0 50" can be written as "m8 40 8 -35 0 50".
You can change the limit in the code, but there might be a systematic constraint for the serial buffer.
Try the following serial commands in the serial monitor:
“ksit”
“m0 30”
“m0 -30”
“kbalance”
“kwkF”
“ktrL”
“d”
The quotation mark indicates that they are character strings. Don’t type quotation marks in the serial monitor.
You can refer to the macro definitions in OpenCat.h to utilize the most updated sets of tokens.
Some more available commands for skills:
The complete set of skills in effect is defined in InstinctBittle.h or InstinctNybble.h: For example:
All the skill names in the list can be called by adding a 'k' to the front and deleting the suffix. For example, there's "sitI" in the list. You can send "ksit" to call the sitting posture. If a skill has "F" or "L" as the second last character, it's a gait. It means walking forward or left. Walking right is a mirror of walking left. So you can send "kwkF", "kwkL", "kwkR" to make the robot walk. Similarly, there are other gaits like trot ("tr"), crawl ("cr"), and stepping ("vt").
It's simple to control Nybble / Bittle via the remote controller.
The remote doesn't require pairing. Make sure its plastic insulation sheet is removed, and point the remote‘s transmitter to the receiver on the robot's back when operating. If the robot doesn't respond, you can use your phone‘s camera to check the transmitter. If it doesn't blink when clicking a button, you need to change its battery. If it blinks, it may indicate the program on the robot is not configured correctly.
Only the position of the buttons matters, though those symbols can help you remember the functionalities. It's better to define position-related symbols to refer to those keys, such as K00 for the 1st row and 1st column, and K32 for the 4th row and 3rd column.
Abbreviations for key definitions can reduce SRAM usage. Due to the limited keys of a physical remote, you can change the definitions for convenience.
The following map is just an illustration. Check the #define KXX command
in OpenCat/src/infrared.h for the actual key definitions in effect. They are also open to your customization.
We also made a customized remote panel for future batches. Previous users can download the design file and print it on A4 paper.
Rest puts the robot down and shuts down the servos. It's always safe to click it if Nybble is doing something awkward.
Balance is the neutral standing posture. You can push the robot from the sides and it will try to recover. You can test its balancing ability on a fluctuating board. Balancing is activated in most postures and gaits.
Pressing F/L/R will make the robot move forward/left/right
B will make the robot move backward
Calibrate puts the robot into calibration posture and turns off the gyro
Stepping lets the robot step at the original spot
Crawl/walk/trot are the gaits that can be switched and combined with the direction buttons
Buttons after trot are preset postures or other skills
Gyro will turn on/off the gyro for self-balancing. Turning off the gyro can accelerate and stabilize the slower gaits. But it’s NOT recommended for faster gaits such as trot. Self-righting will be disabled because the robot no longer knows it's flipped.
Different surfaces have different friction and will affect walking performance. The carpet will be too bushy for the robot's short legs. It can only crawl (command kcr) over this kind of tough terrain.
You can pull the battery pack down and slide along the longer direction of the belly. That will tune the center of mass, which is very important for walking performance.
When the robot is walking, you can let it climb up/down a small slope (<10 degrees)
If the robot keeps beeping after you connect the USB uploader, with numbers printed on the serial monitor, it’s the low voltage alarm being triggered. You need to power the mainboard with the battery to pass the threshold.
The servos are designed to be driven by internal gears. Avoid rotating the servos too fast from the outside.
Don’t keep the robot running for too long. It will overheat the electronics and reduce the servos’ life span.
If you feel something is wrong with the robot, press the reset button on the main board to restart the program.
Be kind as if you were playing with a real kitten/puppy. (^=◕ᴥ◕=^)
This chapter is for Advanced users with programming experience.
For the specific parameters of each functional module of BiBoard, please refer to:
Please refer to Chapter 3.2.1 of the BiBoard Quick Start Guide.
For Windows: C:\Users\{username}\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.*\tools\sdk\esp32\qio_qspi\include\sdkconfig.h
For Mac: /Users/{username}/Library/Arduino15/packages/esp32/hardware/esp32/2.0.*/tools/sdk/esp32/qio_qspi/include/sdkconfig.h
For Ubuntu: Arduino root directory/.arduino15 (hidden file)/packages/esp32/hardware/esp32/2.0.12/tools/sdk/esp32/qio_qspi/include/sdkconfig.h
Append a line of code at the end of the file:
Please refer to the option list to set up the board's upload speed, CPU frequency, etc.
There is a setting for the Flash Size and Partition Scheme among the options. For more information, refer to the next section.
The BiBoard V0 uses an ESP32 with a 16M flash. To simplify, you can use the default 4 MB partition map without a problem. There's plenty of programming space for the standard OpenCatEsp32 firmware.
The BiBoard V1 uses an ESP32 with a 4M flash.
You can use the default 4MB with spiffs. You can also use other partition schemes under the 4 MB flash limit, such as "No OTA" or "Huge APP".
Suppose you want to fully utilize the 16 MB flash of BiBoard (it's unnecessary and takes a longer uploading time). You can read the user manual for the Add hardware partition configuration option in Arduino IDE.
We keep updating the codes as an open-source project. You can star-mark and follow our GitHub repository to get the newest features and bug fixes. You can also share your codes with worldwide OpenCatEsp32 users.
Download the OpenCatEsp32 repository from GitHub repository: https://github.com/PetoiCamp/OpenCatEsp32 We suggest you utilize GitHub’s version control feature. Otherwise, make sure you download the WHOLE OpenCatEsp32 FOLDER every time. All the codes have to be the same version to work together.
If you download the Zip file of the codes, you will get an OpenCatEsp32-main folder after unzipping. Please rename it to OpenCatEsp32 before opening the OpenCatEsp32.ino so that the two names match.
No matter where you save the folder, the file structure should be:
There are several test***.ino codes in the ModuleTests folder. You can upload them separately to test specific modules (I recommend using testBuzzer.ino as your first test sketch).
Install the latest version of library (ArduinoJson) in the Library Manager:
Set the serial port in the Arduino IDE:
If you cannot find the serial port after connecting to your computer:
for BiBoard V0:
You need to install the driver for the CP210x chip.
For BiBoard V1:
You need to install the driver as below:
If the battery powers on the BiBoard, please long-press the button on the battery >=3s to power off the BiBoard, so that the BiBoard is only powered through the USB cable and only the blue LED is lit up.
Modify the device type macro definition in OpenCatEsp32.ino according to the device type.
Modify the motherboard model macro definition in OpenCatEsp32.ino according to the mainboard (BiBoard) version.
if the robot(Bittle R) with the robotic arm, you should also activate the macro definition as follows:
Otherwise, please comment out this line code.
After the modification is completed, you can click the Upload button (as below) to upload the sketch OpenCatEsp32.ino, and the changes in the code file will be automatically saved.
If the version date of the currently uploaded sketch is newer than the version date of the mainboard firmware, it will automatically enter the initialization startup mode after the sketch upload is completed.
You can check the version date of the currently uploaded sketch in the source code file (OpenCatEsp32/src/OpenCat.h):
#define DATE "250218" // YYMMDD
When the mainboard is powered on, open the serial monitor and you will see the startup information:
If you do not see the startup information after opening the serial monitor, please short press the Reset button on the mainboard.
Next you will see the following prompt questions:
Send 'Y' to the question, which means resetting all servo corrections to zero.
Send "n" to skip this step.
If you want to keep the previous joint calibration data, please send 'n'.
Send 'Y' to the question, which means calibrating the IMU, i.e. the gyro/accelerometer sensor.
Send "n" to skip this step.
If you want to keep the previous IMU calibration data, please send 'n'.
Halts at the connection stage. To restart it, you can close and reopen the serial monitor or press the reset button on BiBoard. Put the BiBoard FLAT on the table, and don't touch it during calibration.
Sometimes, the program halts at the connection stage. To restart it, you can close and reopen the serial monitor or press the reset button on BiBoard.
The program starts calibration after playing the melody 6 times.
Input 'n' and press Enter to continue. Or you can do nothing, it will Auto skip in 5 seconds.
The details of serial port printing information are as follows:
When the string "Ready!" is output in the serial monitor, the program will enter the regular startup mode.
Every time the mainboard is powered on, it compares the BIRTHMARK in the EEPROM to determine whether the program has been initialized. If the program has already been initialized, it will not enter the initialization startup mode again.
Note: When the mainboard is powered on, the music melodies played in the regular startup mode and the initialization startup mode are completely different. This is convenient for users (no need to open the serial monitor) and can also identify the startup mode.
If you need to clear the calibration parameters of the servo and recalibrate the joint servo, or recalibrate the IMU, you can send the serial command "!" in the serial monitor, and the program will re-enter the initialization startup mode.
The default code runs the Standard mode (including the Voice command function). If you want to switch modes, Please open the serial monitor and send the following serial commands:
XA
Voice. The switch on the extension hat should be dialed to the Voice command side (default mode)
XU
Ultrasonic. The switch on the extension hat should be dialed to the Uart2 side
XC
Camera
XL
Light
XT
Touch
XI
PIR
XG
Gesture
XD
IR distance
XQ
Quick demo
XS
Enable the Serial 2(Tx2, Rx2). The switch on the extension hat should be dialed to the Uart2 side
XB
Enable the back touch funtion.
X
Disable all the module functions above
z
RandomMind (On/Off)
The behavior of the official modules is defined in separate header files in OpenCat/src/. You can find them in OpenCat/src/io.h -> readSignal(). The behavior of Quick demo mode is defined in OpenCat/OpenCat.ino -> quickDemo(). You can study the example code to write your functions.
You can learn about the function of each module through the EXTENSIBLE MODULES.
Long-press the battery button and boot up the robot with one side up. It will enter the calibration state automatically in the regular startup mode. The picture below shows the head, the upper and lower legs installed after the robot enters the calibration state.
Please refer to Chapter 5 🔌 Connect Wires and Chapter 6 📐 Calibration for the complete calibration process.
If you power on the robot and it is upright (with its back upward), the robot will start from the "rest" posture (fold the legs and unlock the servos) in the regular startup mode.
The BiBoard has built-in Bluetooth, and you can connect it with the mobile app to do joint calibration and remote control.
You can check the update history information in the ChangeLog.md.
After uploading the MicroPython firmware on ESP8266, we can use it run MicroPython scripts.
We can execute the python scripts directly in the interpreter.
The NyBoard WiFi module ESP8266 uses the IO2 pin to connect with a red LED to indicate the connection status. This LED is programmable. Write a simple python blink script:
Press the green start button on the toolbar, and the script will be sent to the WiFi module through the serial port, and then run after being interpreted by the built-in MicroPython interpreter of ESP8266. Because the Blink script is an endless loop when it needs to stop, press the red stop button to end the program interruption and reset.
We can click View -> File to open the file toolbar, and the file is displayed on the left side of Thonny. The upper part is the directory of the local machine, and the lower part is the files stored in the MicroPython device. By default, there is only one boot.py file, please do not delete this file, it is the startup file of the MicroPython device.
We save the script as blink.py and save it on the machine, right-click on the file and select Upload to /
:
Select the MicroPython device
in the pop-up window:
There is a blink.py
file on the device. So the file is saved on the device.
ESP8266 can send commands to NyBoard through the serial port. We only need to write a simple serial port sending script to send a series of serial port commands to NyBoard, and then the robot can execute sequence actions.
When the actSeq() function is executed, It can output a series of commands through the serial port. Using the serial monitor we can debug. Use the serial port monitor to monitor the output as follows (for the convenience of reading, please use the automatic frame break of the serial port debugger, in fact, there is no automatic line break).
After we debug the sequence action, unplug the ESP8266 and plug it into the NyBoard, the robot dog does not respond because the actSeq()
function is not running. We want to run the scripts automatically after power on. There are two methods:
Please change the file name to "main.py
" and save to the device (Recommend)
Modify the Boot.py
Realize remote debugging and upload script
The previous tutorial realized the function of the robot to perform sequence actions by editing Python code offline. But this is very inconvenient. Whenever we need to modify the code, we need to unplug the WiFi module for modification, and we cannot flexibly pause and modify parameters during execution. The reason is that ESP8266 only has one serial port, and we need to use it to communicate with NyBoard. Fortunately, MicroPython uses the WiFi function provided by ESP to realize remote wireless Python debugging - WebREPL.
On the basis of official documents, combined with the characteristics of ESP8266, we wrote the following tutorials:
After connecting the device, enter import webrepl_setup
in the shell interface, and input according to the prompt information:
Enable it running on boot: E
Set password for it: your own password(e.g. 1234)
Repeat the password to confirm
Reboot the ESP8266: y
2. The script to setup webREPL
We use the demo script below, to replace the SSID and password with the network information your own around you.
After running the script, it will keep trying to connect to the WiFi network. Once connected, it will automatically start the WebREPL service of the device.
Remember this IP address (automatically assigned by router DHCP), useful when configuring WebREPL.
We are now debugging the Python script through WebREPL, and the previous serial port is used to communicate with NyBoard. So in the options, change the previous USB-COMx interface to WebREPL.
Then we fill in the IP address, port and password of WebREPL, and click OK.
When WebREPL Connected
is displayed, the connection is successful.
We can try some simple scripts, such as blink.py
.
WebREPL saves serial ports and supports wireless debugging. The disadvantage is that the speed is slow (because of network delay), and the waiting time for software reset is relatively long.
Now we can use webREPL to debug the script, but when we open the serial port monitor, we will find that whenever we run the script, the serial port will send out a series of debugging content: These massive strings will cause the NyBoard to be too late to process and crash. As shown below:
We hope that when debugging the program, the serial port only outputs the commands we want to output, not the Debug information. Open the boot.py
on the device, uncomment the line of code uos.dupterm(None, 1)
and save it , and unbind the serial port and REPL debug. Restart the module, and the serial port debugging assistant will no longer print the debug information.
As a supplement, we can output debug information through the print()
statement, which will be displayed in the Shell through WiFi.
So far, you can easily use the ESP8266 to debug robot through webREPL to edit action sequences based on MicroPython.
Skill Composer is a skill development tool specially developed by Petoi for robots (Bittle, Nybble). Good tools are the prerequisite to the success of a job.
To run the Skill Composer, you can use the following methods to connect the robot's mainboard to the computer:
Wired connection: The kit includes a USB Adapter and USB data cable connecting the robot's mainboard to the computer.
Wireless connection(Bluetooth): The kit includes a Bluetooth module connecting the robot's mainboard to the computer.
Wired connection: The kit includes a USB Type-C data cable connecting the robot's mainboard to the computer.
Wireless connection(Bluetooth): The motherboard's built-in Bluetooth communication module allows you to establish a wireless connection between the robot motherboard and the computer.
After downloading the compressed file(.zip), please unzip it first.
Do NOT move the UI.exe to another location in Windows.
The robot must be powered by the battery and running the OpenCat 2.0 firmware to be recognized by the Petoi Desktop App. Before opening the software, please install the battery, and long-press the button on the battery to power the Nybble / Bittle.
Open the Petoi Desktop App (for Windows: UI.exe / for Mac: Petoi Desktop App), click the "Skill Composer" button, and open the skill composer interface.
Note: Most of the buttons on the interface have a tooltip when the mouse hovers over.
Model
Nybble
Bittle
Nybble cat and Bittle dog have different back leg joint directions. Their skill data are not interchangeable. Select the correct model before operating the Skill Composer. Otherwise, some joints may conflict with the robot's body.
Language
Currently, there are English, 中文, and Italian. You may contribute to the translation script.
Utility
We will keep adding small gadgets to the utility tab. We have an eye color picker for the Nybble cat's ultrasonic sensor with built-in LEDs. We also have an entry where you can add your creator credential to the skills you create.
Connect the robot to your computer through either the USB uploader or system Bluetooth settings, then open up this desktop app. It should automatically detect and connect to the robot. The robot's serial port will appear in the following drop-down menu. The button should turn from "Listening" to "Connected". If the robot fails to connect for the first time, you can click the "Listening" button to disconnect all the ports, then press the "Connect" button again.
Note: The desktop app will keep listening to the serial port and send a handshake signal to the newly added device. If the device responds with a pre-defined signal, it will be recognized as a Petoi device and added to the drop-down menu.
The robot's joints will hold position when the force is on. You should NOT rotate them by hand. Turning it off can allow you to rotate the robot's joints freely. It's helpful to quickly pose the robot to plan its center of mass for balancing.
The robot has a gyroscope to detect its body angle and movements. It's used for balancing and roll-recovering. Turning it off can avoid unexpected reactions when rotating the robot.
In certain experimental modes (e.g. RandomMind mode), the robot will move randomly. This button can toggle the behavior on/off.
Like the serial monitor, you can enter a serial command in the text box and send it to the robot by pressing the Enter key or clicking the Send button.
A few preset static postures move the robot's joints to specific positions. You can use them as a starting point to build your motion sequence. We usually start with the "balance" posture, with the robot standing on all four legs.
You can switch between different postures and observe how the sliders in the Joint Controller area update to reflect the changes in joint angles.
The angle sliders can show the robot's current joint angles. They can reversely rotate the robot's joints if you change their values. You can drag the slider bar for large angle adjustments or click above or below the slider bar for fine adjustments (by 1 degree). Some joints will have smaller accessible ranges than the sliders. Try to use angles between -125 and 125 degrees. Sending larger angles will increase the response time.
The sliders correspond to the robot joints if you look down at the robot's body with its head pointing forward. Joints closer to the body are closer to the center of the panel. The robot's joints can be mapped to your own body and become your avatar.
Note: Some sliders with a light yellow background are disabled for joints that don't exist on specific models.
You can control multiple joints by clicking the dial "+" or "-" on each slider. All sliders with their "+" pressed will change by the same increments. Sliders with their "-" button pressed will change by the negative increments. The button can be toggled on and off. Click the "Unbind All" button to disengage all the joints at once.
You can also control the robot's whole body joints with the sliders in the center panel. You can tune these central sliders to adjust the robot's global orientation and translation. The neutral "balance" posture can generate better results than other tilted postures.
Pitch
Adjust the pitch angle
Roll
Adjust the roll angle
Spinal
Move in the spinal direction
Height
Raise or lower the robot's body
The previous functions can modify a single posture. The Skill Editor is a stop-motion animation scheduler. You can add, delete, and insert frames of poses and make the robot perform continuous and smooth motions.
Every frame has a row of buttons and input fields as parameters. The first static row contains the column header to indicate the parameters' names.
You can click the "=" button (the 2nd item of a frame) to activate the corresponding frame and move the robot to the frame's posture. The frame will hold all your new edits on the robot's current posture. The "=" symbol will become bold, and the button will become larger. The "=" symbol will become a red "!" mark if the current frame is edited. You can click this button to save your edits. Otherwise, the current edits will be abandoned if you click the "=" buttons of the other frames.
You can click the "v" button (the 9th item of a frame) to add a frame after the current frame and activate it. The new frame will be identical to the previous activated frame.
Note: The new frame doesn't necessarily copy the "v" button's frame.
You don't always add a new frame after the last frame. You can click the "v" button (the 9th item of a frame) of any intermediate frames to insert a new frame below the "v" button. The new frame carries information identical to the previously activated frame.
You can mirror the activated frame's posture by clicking the ">|<" button.
You can click the "<" button (the 8th item of a frame) to delete the current frame holding the button. All the following frames will shift up. If the activated frame is deleted, its preceding frame will be activated. If the activated frame is the first frame and is deleted, its following frame will be activated.
You may lose track of what each frame holds with multiple edits to the frame list. Switching to individual frames can be time-consuming. We provide a "Note" field (the 7th item of a frame) where you can add short keywords to identify the frames. By default, a random animal name will be added to a frame when created.
If a joint's angle is the same in the current frame and the next frame, editing and saving its angle will also update the angles in the following frames until the angle differs. For example, if joint 8's angles are 4,4,4,4,6,7 in all the frames, changing the angle in the second frame to 8 will update the sequence to 4,8,8,8,6,7.
Besides manually clicking the "=" button (the 2nd item of a frame) to view the single posture, you can click the "Play" button to show the postures in order starting from the activated frame. During playing time, the button's text becomes "Stop" to allow you to stop in the middle.
After clicking the "Export" button, you can choose a location and filename to save the skill (from the activated frame. If the activated frame is the last action frame, all action frames in the action frame list are exported) as a text file. You can cancel the savings to skip. The desktop app will still send the skill to the robot for real-time performance. And you can call the last exported skill by the serial token "T." There are two ways:
Open the serial monitor and input the serial command "T."
Open the mobile app, use the Create Command function, and enter the serial port command "T" in the Code text box.
The last skill exported by the Skill Composer is stored in temporary memory. It can stay after the power is off and rebooted but will be overwritten by a new export.
From version 1.1.3, When exporting a skill, the desktop app automatically saves it to /Users/{username}/.config/Petoi/SkillLibrary/. Note the .config is a hidden directory but can be visited in the terminal or through a specific view setting. Therefore, you can easily manage the skills in Mind+.
The Skill Creation chapter focuses on the code and data structure so that you can integrate any number of new skills into the source code. The skill data array in the exported text file (*.txt or *.md) content can be copied and pasted into the Instinct**.h file to be used as a skill array.
Export the skill as a customized button in the mobile app. It can be permanent even if you create multiple skills.
You will see a pop-up window after clicking the "Import" button. It allows you to copy-paste a skill data array in the text editor or import an existing skill file you or other users created. You can find example skill data in OpenCat/src/InstinctBittle.h or InstinctNybble.h. A complete skill format should include the "{ }" pair and the numbers between them. Only the first one will be imported if there are multiple skill arrays. The importer will do some simple format checks.
The SkillLibrary folder in Github is a collection of new skills of the OpenCat robot, which can be used for your reference (after downloading, use the import function to save a single skill to the robot's memory, and then use the play or export to view the specific effect).
You are welcome to share your new skills by sending merge requests to this folder.
You can use the "Restart" button to clear the Skill Editor panel and start over.
If you need some consecutive action frames in the action frame list to run multiple times in a loop, you can first enter the number of loops in the Repeat text box above the action frame list (on the left side of the label "Set"), and then use the left mouse button to select them in turn, The index numbers (the 1st item of a frame) of the first and last two frames of the continuous action frame that want to achieve cyclic motion (the index number button will appear in a recessed state after selection), as shown in the following figure:
If you enter -1 in the Repeat text box, the looping action frames will keep looping forever unless you press the reset button on the main board of the robot.
In the action frame list, you can set the running speed of each frame of action (the 3rd item of a frame). There are the following 9 options for you to choose from (speed up the running speed in the order of numerical value):
1,2,4,8,12,16,32,48,max
Note:
In the options box, you can also enter any integer value in the range of 0~125 (0 means max).
By clicking the "Play" button in the "Skill Editor" area, you can NOT see the real running speed effect of the action; only after clicking the "Export" button will you see the real running speed effect.
Moving at the fastest speed for a long time will cause damage to the servo, so it is generally recommended NOT to set it to "max".
When the "Gyro" button in the "State Dials" area is turned on (the font color is green), after adjusting the joint angle value in the action frame or the running speed of the action frame, play it to view the debugging effect, or export the action behavior, the robot It will try to maintain its own body balance in real-time, so it may be seen that when the robot is doing preset actions (especially when running relatively violent actions), its body will shake back and forth or even overturn, and the robot will automatically recover. Action may disrupt your original operation steps. Therefore, it is recommended that you click the "Gyro" button when designing the action to turn off the gyroscope (the font color changes to red), and the robot will not perform balance feedback actions in real-time. When turning on the gyroscope, click the "Gyro" button again.
In the action frame list, the "Delay" option (the 6th item of a frame) in each action frame indicates how long the robot delays before doing the next frame of action after the action of this frame is completed.
There are 17 presets for you to choose from: 0,50,100,200,300,400,500,600,700,800,900,1000,2000,3000,4000,5000,6000.
Of course, you can also enter any integer value in the range of 0~6000 in the "Delay" option box. The unit is milliseconds (ms).
The "Trigger" option (the 4th item of a frame) in the action frame is used to set the body rotation direction when the robot triggers the next action frame. There are the following 5 setting options:
None means that there is no trigger and the angle condition is set
Pitch means the robot body rotates nose-down
-Pitch means the robot body rotates nose-up
Roll means that the robot body rolls to its left side (counter-clockwise when looking from the tail)
-Roll means the robot body rolls to its right side (clockwise when looking from the tail)
The "Angle" option (the 5th item of a frame) is defined with reference to the angle of the polar coordinate system. As shown in the figure above, when the body is horizontal, the angle of the polar coordinate axis is 0 degrees. If the polar coordinate axis rotates counterclockwise, the angle is positive and gradually increases. The angle setting range is an integer value between -125~125.
When a specific trigger and angle are set in the action frame, the next frame of action will be triggered only when the robot rotates over the trigger angle in the trigger's direction. If a delay time is also set in this action frame, it will delay an additional time after the trigger condition is met before moving to the next frame.
When creating actions related to the rotation of the robot body (such as backflips, doing high bar exercises, etc.), it's vital to trigger the motion at a certain body angle whose timing can be hard to estimate, and it may also change during the motion. We can use the gyroscope to monitor the rotation angle of the robot body in real-time, so that the robot can trigger the joint servo at the exact time of the trigger event.
When exporting the action frames, if you want to mirror all the action frames in the action frame list (the robot's left and right side joints will be exchanged, as if seen in a mirror), you can first click the "MirrorAll" button, and then click the "Export" button. If you want to cancel the mirrored export, you can deselect the "MirrorAll" button.
Before exporting action frames, select the "Behavior/Gait" options in the "Skill Editor" area as "Behavior". After clicking the "Export" button, the program will run on the robot and automatically interpolate between these action frames to make the robot move smoothly. All action frames will execute for only one round.
If the "Gait" option is selected before you click the "Export" button, the robot will continue to execute in a loop, and each action frame will run at the fastest speed; NO interpolation between action frames will be added. The motion can be quite brutal. Therefore, it is recommended that beginners always use the "Behavior" option to develop new skills.
When importing some pre-built skill array, the desktop app will automatically select the "Behavior/Gait" option according to the data format. The frames will be loaded into the frame editor, and the robot will automatically move to the first frame's posture.
After sending a command, the desktop app will wait for the robot to return a confirmation token. It may freeze if the robot's program halts or the connection is lost. You don't need to close the desktop app and lose the unsaved action frames but press the "reset" button on the robot's main board to break the app's waiting loop. If the program still does not respond, you can click a posture button in the "Preset Postures" area or try to reconnect the robot using the "Connect/Listening" button.
The desktop app supports the connection of multiple robots through their own serial ports (such as the Bluetooth communication module) to achieve simultaneous control of multiple robots. After a physical connection, the app can only recognize a serial port as a robot. So after the robot is powered on normally:
USB
First, connect the USB uploader to the main board of the robot, and then use the data cable to connect it to the computer's USB interface.
Bluetooth
First, plug the Bluetooth module into the main board of the robot (no need for the ESP32-based board) and pair the board with the computer's Bluetooth setting interface. The desktop app will keep detecting if there is a new serial port connection. When multiple serial ports are successfully connected, the serial port option button in the "State Dials" area will change to "All." Click the drop-down list to view all serial ports that have been successfully connected. All robots will be synchronized in real-time in this way. You can also select any one of the serial ports to control the corresponding robot.
If you unplug a USB serial port on the computer (or disconnect the Bluetooth module in the Bluetooth setting interface), the corresponding serial port will be removed from the drop-down list in real-time.
If you unplug all USB serial ports (disconnect all Bluetooth modules), the serial port option button displays "None," and the left button displays "Listening." The desktop app still automatically detects whether there is a serial port connection. When a robot is reconnected to the computer through the serial port, the button on the left side of the drop-down menu will display "Connected." The corresponding serial port name is displayed in the serial port option button.
If you want the desktop app to stop detecting serial connections, click the "Connected" / "Listening" button. The text in the button will change to "Connect," and all serial connections will be disconnected. Click the "Connect" button again to restart the real-time detection function.
You can modify the source code of the Skill Composer in OpenCat/pyUI/SkillComposer.py.
This function requires the servos after March 2024, the BiBoard, and the latest firmware.
We have added the position feedback feature to recent batches of Petoi servos. The servo can reply to a specific PWM pulse (3500µs) with its current position in the form of pulse length. The central controller (BiBoard) can convert the signal to angles for more interaction.
First, send the robot a serial command "xl" to start the learning process. In the demo, it's triggered by our customized voice command. The robot's servo driver will switch to reading mode. Joint jigs can occur during this transition. Organize the robot's legs and then hold it still. The learning starts when no significant movements are detected.
Pull the legs, and the movement will be recorded. Stopping in the middle is okay because identical postures will be skipped. The recording will stop if the maximal frame is reached or the robot's joints are not moved for 2 seconds.
The recorded command can be called by "xp" to replay. The skill data is also printed to the screen so you can save it and import it into the Skill Composer or other OpenCat interfaces.
The control logic is defined in OpenCatEsp32/src/reaction.h and motion.h.
The tutorial of using the WiFi module as a MicroPython controller
USB Uploader (CH340C)
WiFi ESP8266
Insert the ESP8266 module into the module configuration interface of the USB uploader, and find the corresponding COM port in the Windows device manager.
Download the latest version of Thonny, an out-of-the-box Python editor that natively supports MicroPython.
Download address: https://thonny.org/
The compiled ESP8266 firmware is provided on the MicroPython official website, because our WiFi module is 4MB, please select the latest firmware with the name of ESP8266 with 2MiB+ flash, and download the bin file.
Firmware download address: https://micropython.org/download/esp8266/
There are two ways to upload the MicroPython firmware to the ESP8266 module:
Using the ESPtool download tool, you can more precisely control the partition and use of Flash.
Using Thonny's built-in tool.
For convenience, we use Thonny's built-in tool. The specific steps are as follows:
Open the Thonny, the main interface is as shown below. Thonny uses the Python interpreter in the installation directory by default.
Open Tools -> Options to enter the options page. In the first tab General, we can choose the language we need (needs to be restarted).
Open the second tab Interpreter, we replace the default Python3 interpreter with MicroPython (ESP8266) and select the corresponding port.
At this time, the ESP8266 module has not yet uploaded the MicroPython firmware. Click "Install or update firmware" in the lower right corner of the above picture to update the firmware using the built-in tool.
Select the port (COMx) where the ESP8266 module is located, and select the location where the downloaded MicroPython firmware (.bin file) is located. Check the flash mode: from image file (keep) (the speed will be slower, but it only needs to be burned once and it is not easy to make mistakes), and check the option Erase flash before installing. Press the Install button.
The progress will be displayed in the lower-left corner of the interface, erase the Flash first, and then write the firmware. When the word Done appears, it means that the programming has been completed.
The software preparation work is over, and the following display will appear after closing the download interface. The red text is garbled because ESP8266 will print a string of codes with a baud rate other than 115200 when it starts up. This code cannot be recognized by MicroPython Shell. When Python’s iconic symbol >>> appears, it means that the firmware is uploaded successfully.
OpenCat software works on both Nybble and Bittle, controlled by NyBoard based on ATmega328P. More detailed documentation can be found at the NyBoard V1_0 or NyBoard V1_1.
Note: the version number is here
The I2C switch changes the master of I2C devices (gyro/accelerometer, servo driver, external EEPROM). On default “Arduino”, NyBoard uses the onboard ATmega328P as the master chip; On “RPi”, NyBoard uses external chips connected through the I2C ports (SDA, SCL) as the master chip.
Notes:
Sometimes if you cannot go through the bootup stage, such as repetitively printing "IMU" and restarting, maybe you have accidentally dialed the switch to the "RPi" side.
The setup process for Nybble is almost the same, except that you need to change the model definition to #define NYBBLE.
Make sure you read through the following detailed steps.
You will need the newest Arduino IDE to set up the environment. Older versions tend to compile larger hex files that may exceed the memory limit.
With NyBoard V1_*, you can simply choose Arduino Uno.
Only if the bootloader of NyBoard collapsed, which is very unlikely to happen
Every NyBoard has to go through functionality checks before shipping, so they should already have a compatible bootloader installed. However, in rare cases, the bootloader may collapse then you won't be able to upload sketches through Arduino IDE.
Well, it's not always the bootloader if you cannot upload your sketch:
Sometimes your USB board will detect a large current draw from a device and deactivate the whole USB service. You will need to restart your USB service, or even reboot your computers;
You need to install the driver for the FTDI USB 2.0 to the UART uploader;
You haven't selected the correct port;
Bad contacts;
Bad luck. Tomorrow is another day!
If you really decide to re-burn the bootloader:
please refer to the chapter Burn Bootloader for NyBoard
This step does not require the NyBoard to be mounted on the robot.
For specific steps, please refer to the Connect NyBoard section in the USB uploader module.
For specific steps, please refer to the Connect NyBoard section in the Dual-Mode Bluetooth Module.
On Mac, the Bluetooth may lose connection after several uploads. In that case, delete the connection and reconnect to resume the functionality.
The Bluetooth dongle is not included in the kit sold by Seeed Studio or its partners. Please write to support@petoi.com for more information.
We keep updating the codes as an open-source project. You can star and follow our GitHub repository to get the newest features and bug fixes. You can also share your codes with worldwide OpenCat users.
Download a fresh OpenCat repository from GitHub: https://github.com/PetoiCamp/OpenCat. It’s better if you utilize GitHub’s version control feature. Otherwise, make sure you download the WHOLE OpenCat FOLDER every time. All the codes have to be the same version to work together.
If you download the Zip file of the codes, you will get an OpenCat-main folder after unzipping. Rename it to OpenCat before opening the OpenCat.ino, so that the two names match.
Arduino requires the .ino file to be put in a folder with the same name. You must rename the OpenCat-main folder as OpenCat (i.e. delete the -main suffix). Otherwise, Arduino will create another OpenCat folder and move OpenCat.ino into it. It will break the path dependency of related files.
No matter where you save the folder, the file structure should be:
There are several testX.ino codes in ModuleTests folder. You can upload them to test certain modules separately. Open any testX.ino sketch with prefix “test”. (I recommend using testBuzzer.ino as your first test sketch)
Open up the serial monitor and set up the baud rate. With NyBoard V1_*, choose the board as Arduino Uno and later set the baud rate to 115200 in both the code and the serial monitor.
Compile the code. There should be no error messages. Upload the sketch to your board and you should see Tx and Rx LEDs blink rapidly. Once they stop blinking, messages should appear on the serial monitor.
To configure the board, please follow these steps:
Open the file OpenCat.ino and select your robot and board version. For example:
The symbol // deactivates the line of code and turns them into comments. Make sure you have only one line of the parallel options activated.
Comment out #define MAIN_SKETCH
so that it will turn the code to the board configuration mode. Upload and follow the serial prompts to proceed.
If you activate #define AUTO_INIT
, the program will automatically set up without prompts. It will not reset joint offsets but calibrate the IMU. It's just a convenient option for our production line.
Install the driver if no USB port is found under Arduino -> Tools -> Port.
For specific steps, please refer to the Connect NyBoard section in the USB uploader module.
Press the upload button.
You can find the button either under Tools, or at the top-right corner of the IDE.
Set the serial monitor as No line ending and 115200 baud rate.
The serial prompts:
Input ‘Y’ and hit enter if you want to reset all the joint offsets to 0.
The program will do the reset and then update the constants and instinctive skills in the static memory.
To pass this step, you must enter ‘Y’ or ‘n’. Otherwise, the following parameters, including the skill data, will not be updated on the board.
The serial prompts:
Input ‘Y’ and hit enter, if you have never calibrated the IMU or want to redo calibration.
Put the robot flat on the table and don't touch it. The robot will long beep six times to give you enough time. Then it will read hundreds of sensor data and save the offsets. It will beep when the calibration finishes.
When the serial monitor prints "Ready!", you can close the serial monitor to do the next step.
If you don't want to calibrate PCA9685(the servo driver), Step 9 can be skipped. The do Step 10 Upload the major functionalities sketch, and calibrate the joint servos if you have never calibrated the joints.
After the IMU calibration, there's an optional step to calibrate the servo driver.
If later you find one of the servos stops working but can resume working after re-powering it, it's probably due to an inaccurate PWM driver signal. You must redo the previous uploading, and this step CANNOT be skipped.
This calibration makes the servo controller (PCA9685 chip)'s angle signal more precise. Use a short jumper wire to connect the PWM pin 3 (the signal pin of one of the servo pins) and Grove pin A3 and hold the wire steady. It doesn’t have to be a dedicated jumper wire. Any thin metal wire, such as a straightened paper clip, can work as long as it can connect the pins.
The program will measure the pulse width of the signal and automatically calibrate the chip after getting three identical readings successively. It usually takes less than 2 seconds. The board will beep three times to indicate the calibration is done. The calibration offset will be saved to the board for the next time of bootup. The process should be done at least once, and we have calibrated every board after October 2022. But you can still do it by yourself, just in case.
The servo has a backdoor signal to modify its parameters defined by the manufacturer. The PWM signal is 2700us with a tolerance window (2650 to 2750 us). The PCA9685's internal crystal has a frequency between 23MHz and 27MHz. The standard Adafruit servo library just set it to 25MHz if not calibrated. The regular servo PWM signal ranges between 500 and 2500 us. The error (27-25)/25 = 8% usually can be tolerated by the system. But when the joint signal falls in the range of 2700us, the servo will enter the configuration mode. Only powering off will break it out of the loop.
The optional step can be a quick fix. It utilizes the input pin of the main chip, which has an accurate external crystal clock, to measure the signal from PCA9685. It compares the measured pulse width and expected value, calculates a calibrating factor, and stores it in the chip. The process can be less than 1 second or several seconds. As long as it's done once, you don't need to do it again unless the temperature changes a lot. Calibrating the signal can also make the movements more precise if you are a professional who needs to conduct motion-related research.
The calibration can be applied to all the PCA9685-based servo drivers that omit an external crystal. To recalibrate, just run the program's first round again and connect the two pins after the IMU calibration. The calibration value can be seen in Arduino's serial monitor and should be pretty consistent.
Uncomment #define MAIN_SKETCH
to make it active. This time the code becomes the normal program for the major functionalities. Then upload the code.
Open the serial monitor. When the serial monitor prints "Ready!", the robot is ready to take your next instructions.
Please calibrate the joint servos after uploading the major functionalities sketch.
The default code runs the standard mode. If you have some extensible modules, you may uncomment the macro definition of a specific module. It will disable the Gyro code to save some programming space and activate the demo of the module.
The behavior of the official modules is defined in separate header files in OpenCat/src/. You can find them in OpenCat/src/io.h -> readSignal(). The behavior of OTHER_MODULES is defined in OpenCat/OpenCat.ino -> otherModule(). You can study the example code to write your own functions.
In certain cases, you may want to modify the "joint - pin" mapping of the robot. You can modify it in OpenCat/src/OpenCat.h. Make sure you are modifying the code block corresponding to the board version at the beginning of OpenCat.ino. After the modification, remember to save the changes and redo the uploading process from step 2.
Congratulations! Now, you have finished the standard setup steps. You may read the source codes if you want to dive deeper into the program. The skills are saved in multiple places on a NyBoard due to ATmega328P's limited resources. The following diagram may give you some hints to help you understand.
There are different storage on 328P (OpenCat):
The SRAM is only 2K. It's used for the whole program, so storing all the skill data is impossible. Only one skill is loaded to the SRAM before execution for easier and faster calculations.
The skill data are stored in the PROGMEM in the first upload round. During the program’s runtime, they will be stored in the external I2C chip, and their addresses will be stored in the onboard EEPROM.
In the second round of uploading, the skill data in PROGMEM are not enabled, so I have more memory to write the main program's logic and UI.
To accelerate tuning the skills, I allow a few skills to be stored in the PROGMEM, even in the main program. They are called the "Newbility" compared to the finalized "Instincts". So I don’t need to upload it twice to tune its skill data.
Now, I have a better serial protocol that can take a long skill data array in real time, so I don't need to re-upload to tune a skill. The token is 'K'.
The onboard EEPROM is only 1K. It stores the skill name string and addresses in PROGMEM or I2C EEPROM. It even stores the melodies from its tail.
On ESP32, the Flash is large enough, so I don’t need to save the skill data to I2C EEPROM. However, transferring one active skill to the SRAM is still necessary to avoid keeping all the skill arrays in the SRAM.
How to use C++ to play with Nybble😼 or Bittle🐶
The project is built as a dynamic library so that the program can easily link to it. The recommended practice to use the library is to clone it as a git submodule:
If you are using cmake, simply create a CMakeLists.txt
file and link the library to your executable:
Below is a very simple example on how to use the library.
see examples for a more comprehensive example.
You can solder a 5-pin socket on BiBoard V1 to plug in a Raspberry Pi.
After plug in the Raspberry Pi board , power on the BiBoard via USB data cable or Battery. Then open the serial monitor, and send serial command XS to enable the Serail 2 working mode.
You can also modify the source code (OpenCat.h) and upload the sketch for BiBoard to enable the Serail 2 working mode:
Generally, the serial port name on Raspberry Pi 3 and 4 is "/dev/ttyS0," and the one on Raspberry Pi 5 is "/dev/ttyAMA0." If the Pi can't open the serial port after it is connected to the mainboard, you can uncomment the line of code as follows to check all the serial ports on the Raspberry Pi in the terminal when the Python script(ardSerial.py) is running.
Robot doesn't need a Pi to move.
You need to unplug the 6-pin USB adpter for the NyBoard before mounting the Pi to the board.
You can solder a 2x5 socket on NyBoard to plug in a Raspberry Pi. Pi 3A+ is the best fit for NyBoard's dimension.
After you solder on the socket, you won't be able to install the back cover of Bittle.
The red Pi standoff can be 3D printed.
As shown in the serial protocol, the arguments of tokens supported by Arduino IDE's serial monitor are all encoded as Ascii char strings for human readability. While a master computer (e.g. RasPi) supports extra commands, mostly encoded as binary strings for efficient encoding. For example, when encoding angle 65 degrees:
Ascii: takes 2 bytes to store Ascii characters '6' and '5'
Binary: takes 1 byte to store value 65, corresponding to Ascii character 'A'
What about value -113? It takes four bytes as an Ascii string but still takes only one byte in binary encoding, though the content will no longer be printable as a character.
Obviously, binary encoding is much more efficient than the Ascii string. However, the message transferred will not be directly human-readable. In the OpenCat repository, I have put a simple Python script ardSerial.py that can handle the serial communication between NyBoard and Pi.
In Pi's terminal, type sudo raspi-config
Under the Interface option, find Serial. Disabled the serial login shell and enable the serial interface to use the primary UART:
Run raspi-config with sudo privilege: sudo raspi-config
.
Find Interface Options -> Serial Port.
At the option Would you like a login shell to be accessible over serial?
select 'No'.
At the option Would you like the serial port hardware to be enabled?
select 'Yes'.
Exit raspi-config and reboot for changes to take effect.
You also need to DISABLE the 1-wire interface of Pi to avoid repeating reset signals sent by Pi's GPIO 4.
If you plug Pi into NyBoard's 2x5 socket, their serial ports should be automatically connected at 3.3V. Otherwise, pay attention to the Rx and Tx pins on your own AI chip and its voltage rating. The Rx on your chip should connect to the Tx of NyBoard, and Tx should connect to Rx.
Note: If you installed Ubuntu OS on Raspberry Pi, please config it as follows:
add enable_uart=1
to /boot/config.txt
remove console=serial0,115200
from /boot/firmware/cmdline.txt
on Ubuntu and similar to/boot/cmdline.txt
on Raspberry Pi OS
disable the serial console: sudo systemctl stop serial-getty@ttyS0.service && sudo systemctl disable serial-getty@ttyS0.service
make sure you have pyserial
installed if you're using the python serial library, not python-serial from apt.
create the following udev file (I created /etc/udev/rules.d/50-tty.rules
):
reload your udev rules: sudo udevadm control --reload-rules && sudo udevadm trigger
change the group of the new serial devices:
The devices are now under the tty group. Need to add the user to the tty group and dialout group:
update the permissions for group read on the devices:
reboot
Or just create a script that will do this automatically.
If you are using generic Linux system, once the uploader is connected to your computer, you will see a “ttyUSB#” in the serial port list. But you may still get a serial port error when uploading. You will need to give the serial port permission. Please go to this link and follow the instructions: https://playground.arduino.cc/Linux/All/#Permission
If you want to run it as a bash command, you need to make it executable:
chmod +x ardSerial.py
You may need to change the proper path of your Python binary on the first line:
#!/user/bin/python
NyBoard has only one serial port. You need to UNPLUG the USB adapter if you want to control Bittle with Pi's serial port.
Typing ./ardSerial.py <args>
is almost equivalent to typing <args> in Arduino's serial monitor. For example, ./ardSerial.py kcrF
means "perform skill crawl Forward".
Both ardSerial.py and the parsing section in OpenCat.ino need more implementations to support all the serial commands in the protocol.
For Nybble:
Reduced motion capability may happen when connected to Pi! A stronger battery is needed.
With the additional current drawn by Pi, Nybble will be less capable for intense movements, such as trot (the token isktr
). The system is currently powered by two 14500 batteries in series. You may come up with better powering solutions, such as using high drain 7.4 Lipo batteries, or 2S-18650. There are a bunch of considerations to collaborate software and hardware for balanced performance. With Nybble's tiny body, it's better to serve as a platform for initiating the communication framework and behavior tree rather than a racing beast.
How to use python scripts to have fun with the robots
Install python (version≥ 3.6, such as Anaconda3-5.2.0-Windows-x86_64.exe)
Install pyserial library (version 3.5)
When using a USB adapter to connect to the NyBoard or USB type-C data cable to connect to the BiBoard, there should be only one serial port number:
When using the Bluetooth function, there can be two serial port numbers:
Download a fresh OpenCat repository from GitHub:
https://github.com/PetoiCamp/OpenCat
Please utilize GitHub’s version control feature. Otherwise, make sure you download the WHOLE OpenCat FOLDER every time.
Open a Terminal (such as Anaconda Prompt) and enter the path where the Python API is located (***/OpenCatPythonAPI). Then, run the two example scripts in the folder(petoiRobotExample.py and ardSerialExample.py). The script will automatically identify the serial port number at the beginning and complete the connection.
ardSerial.py contains the core communication functions. robot.py is a wrapper module that provides more user-friendly functions. Our Mind+ coding blocks is a graphical UI for this library.
ardSerialExample.py demonstrates how to call the functions defined in ardSerial.py(in the ***/OpenCatPythonAPI/PetoiRobot)
The list testSchedule in ardSerialExample.py is used to test various serial port commands. Run the following script code to see the execution effect of each serial port command in the list:
You can also refer to the content of the testSchedule list (in ***/serialMaster/demos/hlw.py), write a list of behaviors according to your actual needs, and realize your creativity. 🤩 It was used in a Halloween puppet show.
Note: When running the scripts under the path of /serialMaster/demos, you must first use the "cd demos" command to enter the path where the scripts are located (/serialMaster/demos) and then use the python3 command to run the script (e.g., "python3 hlw.py")
Explanation of the serial port commands in the list testSchedule:
'kup' indicates the command to control Bittle to stand normally
2 indicates the postponed time after finishing the command in seconds.
m indicates the command to control the rotation of the joint servo
0 indicates the index number of joint servo
-20 indicates the rotation angle (this value is expressed relative to the reference 0 value used after calibration). The unit is in degrees.
1.5 indicates the postponed time after finishing the command in seconds. It can be a float number.
['M', [0, 45, 0, -45, 0, 45, 0, -45], 2]
The meaning of this example is the same as the previous command.
Using the 'm' control command, the index number of joint servo and rotation angle values are stored as ASCII strings.
Using the 'M' control command, the index number of joint servo and rotation angle values is stored as a byte string, a byte sequence (binary form).
d indicates the command to put the robot down and shut down the servos
2 indicates the postponed time after finishing the command in seconds
c indicates the command to enter calibration mode
2 indicates the postponed time after finishing the command in seconds. After these motion commands are completed, the next command will be executed after a 2-second delay.
c indicates the command to enter calibration mode
0 indicates the index number of joint servo
-9 indicates the rotation angle. The unit is in degrees.
2 indicates the postponed time after finishing the command in seconds
Using this format, you can enter the calibration mode to calibrate the angle of a specific joint servo. Note: If you want the correction value in this command to take effect, you need to enter the "s" command after executing this command.
The meaning of this example is that the joint servo with serial number 0 rotates -9 degrees. After these motion commands are completed, the next command will be executed after a 2-second delay.
m indicates the command to control the rotation of the joint servo
0 indicates the index number of joint servo
-20 indicates the rotation angle (this angle refers to the origin rather than the additive). The unit is in degrees.
1.5 indicates the postponed time after finishing the command in seconds. It can be a float number.
Using this format, multiple joint servo rotation commands can be issued in a list. These commands are executed sequentially, not simultaneously. The joint angles are treated as ASCII characters so humans can enter them directly.
This example means that the joint servo with index number 0 is first rotated to the 45-degree position, then to the -45-degree position, and so on. After these motion commands are completed, the following command will be executed after a 2-second delay.
Using this format, multiple joint servo rotation commands can be issued in a list and executed AT THE SAME TIME. The joint angles are treated as ASCII characters so humans can enter them directly.
The meaning of this example is that the joint servos with index numbers 8 and 9 are rotated to the -15 and -20 degree positions simultaneously. After these motion commands are completed, the following command will be executed after a 2-second delay.
M indicates the command to rotate multiple joint servos SEQUENTIALLY. The angles are encoded as BINARY numbers for efficiency.
8, 9, 10, 11, and 0 indicate the index numbers of joint servos
50, 50, 50, 50, 0 indicate the rotation angle (this angle refers to the origin rather than additive ). The unit is in degrees
3 indicates the postponed time after finishing the command in seconds
The meaning of this example is the same as the previous command.
Using the 'i' control command, the index number of the joint servo and rotation angle values are stored as ASCII strings.
Using the 'I' (the uppercase of the letter 'i')control command, the index number of the joint servo and rotation angle values are stored as a byte string.
'I' indicates the command to control all joint servos to rotate AT THE SAME TIME (currently, the command supports 16 degrees of freedom, that is, 16 servos). The angles are encoded as BINARY numbers for efficiency.
20,0,0,0,0,0,0,0,45,45,45,45,36,36,36,36 indicate the rotation angle of each joint servo corresponding to 0-15 (this angle refers to the origin, rather than additive). The unit is in degrees.
5 indicates the postponed time after finishing the command. The unit is in seconds.
Here, 'l' is the lowercase form of the letter 'L'.
b indicates the command to control the buzzer to beep
10 indicates the music tone
2 indicates the lengths of duration, corresponding to 1/duration second
2 indicates the postponed time after completing the tone. The unit is in seconds
b indicates the command to control the buzzer to beep
0, 14, 14, 21... indicate the music tones
1, 8, 8, 8 indicates the lengths of duration, corresponding to 1/duration second
The last '3' indicates the postponed time after playing the music melody. The unit is in seconds.
Using this format, multiple-tone commands can be issued at once, and a simple melody can be played.
The meaning of this example is to play a simple melody and delay 3 seconds after the music melody is played.
ck = [
-3, 0, 5, 1,
0, 1, 2,
45, 0, 0, 0, 0, 0, 0, 0, 45, 35, 38, 50, -30, -10, 0, -20, 6, 1, 0, 0,
-45, 0, 0, 0, 0, 0, 0, 0, 35, 45, 50, 38, -10, -30, -20, 0, 6, 1, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 30, 30, 30, 30, 30, 30, 30, 30, 5, 0, 0, 0,
]
'K' indicates the skill data to send to Bittle in real-time
The skill array is sent to the robot on the go and executed locally on the robot
You may insert the skills in the skill library or InstinctX.h in this format
For the description of other serial port commands, please refer to Serial Commands.
petoiRobotExample.py demonstrates how to call the functions defined in robot.py(in the ***/OpenCatPythonAPI/PetoiRobot)
Below are the supported function calls in the library (robot.py):
Here is a sample code in the petoiRobotExample.py:
When the system recognizes that there are multiple serial port numbers, the script will automatically identify all serial port numbers that have been connected to the robot (you can send serial commands to multiple robots at the same time). When the script starts running, it will print out the following prompt information:
Please help the robots find their sparks. Wish you have fun! 😍
Petoi Group Control Solution
ESP-NOW is another wireless communication protocol developed by Espressif that enables multiple devices to communicate without or using Wi-Fi. This protocol is similar to the low-power 2.4GHz wireless connection commonly found in wireless mice—the devices are paired before they can communicate. After pairing, the connection between the devices is continuous, peer-to-peer, and does not require a handshake protocol. It is a fast communication technology with short data transmission and no connection, which allows low-power controllers to directly control all smart devices without connecting to a router. It is suitable for scenarios such as smart lights, remote control, and sensor data return.
After using ESP-NOW communication, if a certain device suddenly loses power, as long as it restarts, it will automatically connect to the corresponding node to resume communication.
The communication modes supported by ESP-NOW are as follows:
one-to-one communication
one-to-many communication
many-to-one communication
many-to-many communication
ESP-NOW supports the following features:
Unicast packet encryption or unicast packet unencrypted communication;
Mixed use of encrypted paired devices and non-encrypted paired devices;
Can carry payload data up to 250 bytes;
Support setting sending callback function to notify the application layer of frame sending failure or success.
At the same time, ESP-NOW also has some limitations:
Broadcast packets are not supported temporarily;
There are restrictions on encrypted paired devices
In Station mode,a maximum of 10 encrypted paired devices are supported;
In SoftAP or SoftAP + Station mixed mode, a maximum of 6 encrypted paired devices are supported;
The number of non-encrypted paired devices is supported, and the total number of encrypted devices does not exceed 20;
Valid payloads are limited to 250 bytes.
Petoi group control can use the ESP-NOW communication function of the ESP8266.
In this case, two Bittles (equipped with ESP8266) and one computer connected with ESP8266 are prepared.
See below for program uploading and MAC address acquisition of the module in the figure.
Install Thonny on the computer to facilitate the debugging of MicroPython of the ESP8266 module. When using the ESP-NOW protocol, special MicroPython firmware is required (see Github). Because the normal version of the 8266-MicroPython firmware will prompt that the library cannot be found.
Open Thonny and use the USB uploader to connect the ESP8266 module, enter in the shelll interface:
If there is an error prompt such as "cannot find espnow module", it means that there is a problem with the firmware uploading; if there is no prompt, it means that the firmware uploading is successful.
If after burning the ESP-NOW firmware, the symbolic >>>
symbol of Python does not appear in the shell interface, it means that the firmware burning failed. You can try to use the Flash burning tool NodeMCU-PyFlasher.exe, and the burning configuration is shown in the figure below :
The group control code is divided into 3 parts:
Query the MAC address of the module
Transmitter program
receiver program
The MAC address is an address used to confirm the location of a network device, and is responsible for the second layer (data link layer) of the OSI network model. The MAC address is also called the physical address and the hardware address. It is burned into the non-volatile memory (such as EEPROM) of the network card when it is produced by the network equipment manufacturer.
The length of the MAC address is 48 bits (6 bytes), usually expressed as 12 hexadecimal numbers. The first 3 bytes represent the serial number of the network hardware manufacturer, which is assigned by IEEE (Institute of Electrical and Electronics Engineers), and the last 3 bytes represent the serial number of a certain network product (such as a network card) manufactured by the manufacturer. As long as you don't change your MAC address, the MAC address is unique in the world. Visually speaking, the MAC address is like the ID number on the ID card, which is unique.
The easiest way to use ESPNOW is to send it by MAC address. We use a small program to query the MAC address of the module.
After running in Thonny, print out the MAC address in the terminal. At this time, you can use a self-adhesive sticker to write the MAC address of the module and paste it on the module.
The transmitter program consists of the following parts:
Enable the WiFi function of the module
Configure the ESP-NOW protocol and enable it
Add a node (peer) that needs to communicate
Send a message
The specific code is as follows:
The receiver program is mainly composed of the following parts:
Enable the WiFi function of the module
Configure the ESP-NOW protocol and enable it
Add a node (peer) that needs to communicate
Receive and decode the message, and send commands to NyBoard through the serial port
The specific code is as follows:
This code is encapsulated in a function named espnow_rx()
for the convenience of automatically starting the program after power-on.
There are two ways to realize automatic startup after power-on:
Rename the code file to main.py
;
Modify the boot.py
;
For beginners, we recommend the first method.
Writing the serial command conversion at the receiving end will make the program too complicated and difficult to maintain. We can create a new function in which to perform instruction conversion and output commands.
Linux is a feature that lets you develop software using your Chromebook. Install Linux command line tools, code editors, and IDEs (integrated development environments) on your Chromebook. These can be used to write code, create apps, and more.
Important: If you use your Chromebook at work or school, you might be unable to use Linux. For more information, contact your administrator.
Linux is off by default. You can turn it on at any time from Settings.
On your Chromebook, at the bottom right, select the time.
Next to "Linux development environment," select Turn On.
Follow the on-screen instructions(default settings). Setup can take 10 minutes or more.
A terminal window opens. You have a Debian 11 (Bullseye) environment. You can run Linux commands, install more tools using the APT package manager, and customize your shell.
Once the setup is complete, a terminal window will open. You can use the following commands to update the package list and install basic development tools:
How to use the extension library specially developed for the Petoi robot in Mind+
Download the latest version from Mind+ official website
Windows: >= V1.7.0
Mac: version: >= V1.7.3 RC2.0
If you cannot download the software from Mind+'s official website, you can download a stable version from the Google Drive folder. However, we strongly recommend that you download and use the official latest version.
After the installation is complete, you can open Mind+
If the default installation language is Chinese, you can switch to English as follows:
We provide a series of video tutorials on using Petoi Coding Blocks with the free Scratch-like robotics coding curriculum. Be sure to click next to go through all the videos.
For the Bittle X, all functional blocks in Mind+ are supported by default. You can skip to the next section Import Petoi Mind+ extension library.
For Nyboard products (Nybble, Bittle), there are two ways to upload the firmware (Mind+ mode), which supports the Mind+ extension library:
If you just downloaded a new version of this Desktop App. You should click the Upgrade the Firmware button. You can select 'N' to preserve the calibration values.
If you have upgraded the firmware at least once after a new download, You can click the Update the Mode Only button. It's faster to only switch the modes without refreshing the parameters.
Using the Arduino IDE
Please download the latest code from GitHub. Follow the steps for uploading. Set up the configuration mode and activate this line of code in OpenCat.ino
#define MAIN_SKETCH
#define GROVE_SERIAL_PASS_THROUGH
Then, upload the major functionalities sketch and power on the robot. Use the data cable and USB uploader to connect with the computer or the Bluetooth module and complete the pairing.
Note that the gyroscope function is turned off with the Mind+ mode on NyBoard to save memory space. The robot won't be able to self-balance and auto-recover.
If you don't use the "Read or Write analog/digital pin" function block, you can upload the Standard mode sketch for Bittle / Nybble and use the Mind+ extension library. Note:
When the robot is in Mind+ mode, the gyroscope function is turned off, and the robot cannot balance or auto-recover.
Wired connection: The kit includes a USB Adapter and USB data cable connecting the robot's mainboard to the computer.
Wireless connection(Bluetooth): The kit includes a Bluetooth module connecting the robot's mainboard to the computer.
For BiBoard products (such as Bittle and Bittle X), there is no need to modify any software code. By default, all functional blocks in Mind+ are supported.
Wired connection: The kit includes a USB Type-C data cable connecting the robot's mainboard to the computer.
Wireless connection(Bluetooth): The motherboard's built-in Bluetooth communication module allows you to establish a wireless connection between the robot motherboard and the computer.
Paste the GitHub URL(https://github.com/PetoiCamp/Petoi_MindPlusLib) in the text box of the import interface:
For macOS (<=V1.7.2 RC3.0), you need to download PetoiRobot.zip and copy the extracted folder (PetoiRobot) to /Users/{your username}/Documents/mindplus-py/environment/Python3.6.5-64/lib/python3.6/site-packages/
Petoi Coding Blocks is a user-extended library of Mind+.
If you open Mind+ by double-clicking the code file(suffix mp or sb3) that uses this extension library or load these code files after opening Mind+, Mind+ will automatically load this extension library.
This extension library can control the robot without compiling and uploading the code to the robot's main board. Click the "Run" button directly to run the program on the Python level and send instructions to the robot's serial port. If you need to stop the program while running, you can click the "Stop" button anytime. The process of the program can be divided into three steps:
Open the serial port
Control the robot
Close the serial port
There are two ways to open the serial port:
If it fails to open the serial port, you can refer to the printed information in the terminal window to replace the name of the serial port:
When the gyroscope function is turned on, the robot can balance its body in real-time. It may be seen that when the robot is doing preset actions (especially when performing more violent actions), the body will shake back and forth, and even the body will tip over. The robot will automatically perform recovery actions, which may disrupt your preset steps.
If the uploaded sketch is Mind+ mode sketch(#define GROVE_SERIAL_PASS_THROUGH
this line is activated), the gyroscope function will be turned off, and the robot will not be able to balance or auto-recover, so there is no need to add this block.
If the robot is in standard mode, you'd better deactivate the Gyro after the serial port-opening block. It deactivates the gyroscope function to prevent the robot from performing balance feedback actions in real-time. For example:
Use this block to let the robot perform skills pre-built on the robot's main board. Skills from "sit" to "zero" are postures (containing only one action frame). Skills from "boxing" to "sniff" are behaviors (containing multiple posture frames and are performed only once). Skills from "stepping" to "trotRight" are gaits (containing multiple posture frames, and are repeated in periodical loops until stopped).
After finishing the current block's task, the program will wait a short time (delay xx seconds) before moving to the next block.
Use this block to let the robot perform the last skill exported from the Skill Composer.
It is equivalent to inputting the serial command 'T' in the serial monitor and then delaying the preset time.
Use this block to let the robot perform the skill in the skill files, which are in the following directory:
Windows: C:\Users\{your user name}\.config\Petoi\SkillLibrary\{model}
MacOS : /Users/{your user name}/.config/Petoi/SkillLibrary/{model}
Linux: /home/{your user name}/.config/Petoi/SkillLibrary/{model}
The folder name {model} is Bittle or Nybble. When exporting a skill file from the Skill Composer, it will automatically save the skill file to this directory.
Tips: you can also copy & paste the SkillLibrary folder from the source code of the OpenCat project on GitHub to the .config/Petoi directory. Therefore, you can use some sample skills for your Mind+ program, and there is no need to use the export function in the Skill Composer.
The folder .config is a hidden directory on MacOS/Linux but can be visited in the terminal or through a specific view setting:
MacOS open the directory /Users/{username} in Finder, then press the “Command” + “Shift” + “.” (period) keys at the same time.
Use this block to control one joint or multiple joints to rotate in sequence. There are several ways to use the blocks for reference:
Controls individual joint rotations to an absolute angle value.
Controls individual joint rotations to a relative angle value.
Control multiple joints to rotate sequentially to absolute angle values or relative angle values.
Use the joint angle list to control multiple joints to rotate to absolute angle values in a sequence.
Using this block can control multiple joints to rotate at the same time. There are several ways to use the blocks for reference:
Control multiple joints to rotate to absolute angle values or relative angle values at the same time
Use the joint angle list to control the simultaneous rotation of multiple joints to absolute angle values.
Use this block to get the current angle value of the selected joint. It is recommended to assign it to a variable first and then use the variable and algorithm to control other joints to rotate.
The return value of this block is only an angle value, which cannot be filled in the "Turn sequentially" and "'Turn simultaneously" blocks alone.
Demo code:
Use this block to control all joints to rotate at the same time. Please use it with the "Action frame" block. As shown below:
The "Action frame" block represents a list of 16 angle values. Each angle value corresponds to the absolute angle value to which the corresponding joint index servo rotates.
Use this block to control the robot to play music. There are several ways to use blocks together for reference:
A list made up of multiple "Tone + Duration" blocks
Using a tone duration list
Consists of one or more pairs of Tone + Duration, the specific format is as follows:
[tone, duration, tone, duration, tone, duration...]
Use this block to send a serial command to the robot, which can provide you with more and more flexible control methods. For example, you can input "kkcL" (kick the left front leg), and "khiR" (raise the right front leg to say hello). For more serial port commands, please refer to the serial protocol.
Use this block to write an analog value to a specified pin. Analog value range: 0~255
Use this block to read an analog value from a specified pin.
Use this block to write a high/low-level value to the specified pin. High-level: 1; Low-level: 0.
Use this block to read the high/low-level value of the specified pin.
Use this block to read the distance value from the ultrasonic sensor.
For the Petoi RGB Ultrasonic Sensor (or RUS-04), you can set the two pins ( Trigger and Echo) like this:
NyBoard (connects to the D6 and D7 pins)
BiBoard (connects to the Rx and Tx pins)
For other ultrasonic sensor models (e.g., HC-SR04 connects to the D6 and D7 pins), you can set the two pins like this:
Generally, at the end of the program, it is recommended to use this block to close the serial port communication.
We provide some demos to download for reference in the GitHub repository (Petoi_MindPlusLib/examples).
There are two ways to establish a serial port connection:
Connect the USB adapter to the mainboard and select the correct serial port. Refer to the Connect NyBoard section in the USB Adapter(Uploader) Module for specific steps.
Please refer to the Connect NyBoard section in the Dual-Mode Bluetooth Module for the specific steps.
On Mac, the Bluetooth may lose connection after several uploads. In that case, delete the connection and reconnect to resume the functionality.
The Bluetooth dongle is not included in the kit sold by Seeed Studio or its partners. Please write to support@petoi.com for more information.
Select the port in the Arduino IDE(recommend version 1.8.19).
If you can't determine which port is correct, unplug and re-plug the USB data cable on the computer side and check the difference in the Tools menu.
You may install the drivers if no new port is shown in the menu list.
Open the serial monitor.
Config the parameter of the serial monitor.
In the serial monitor, set "No line ending" and the baud rate to 115200.
With the USB adapter / Bluetooth module connecting NyBoard and computer, you have the ultimate interface - Serial Monitor to communicate with NyBoard and change every byte on it(via sending the serial commands based on the serial protocol).
There are two ways to establish a serial port connection:
Connect the mainboard and computer using a USB type-C data cable(you should use the original one in the kit).
Connect the mainboard with a computer / mobile app via Bluetooth.
The setup steps in the Arduino IDE are identical to those in Ablove.
BiBoard Hat V1.0 is the extension board of BiBoard V0, which allows for convenient connection of the voice command and other Grove extensible modules.
The extension hat has an onboard voice command module and four grove sockets.
1x Serial2 port (GPIO16, 17).You must dial the slide switch to UART2 to free it for regular serial communication or GPIO. In that case, the Tx pin (GPIO 17) can be used to write.
1x I2C port (GPIO21, 22). It's already used by the main program to read sensors. If you use the BiBoard as a regular ESP32 board without Bittle's firmware, they can be configured as regular GPIO pins to read and write.
2x input-only pins (GPIO 34, 35, 36, 39).
1
A built-in module on the BiBoard
2
UART2/Voice command switch
Connect grove port to UART2 or the Voice command module
3
4 Gove sockets
4
Inter-board connectors
Connect the Grove ports to the top BiBoard
It's equivalent to the independent Grove voice module introduced in the extensible modules.
We adopted the Grove sockets for convenient plug-and-play connections. There are three types of sockets:
Grove Socket
Pin Number
Function
G1
I2C: SDA (GPIO21), SCL (GPIO22)
I2C with 3.3V logic signal
G2
TX (GPIO17), RX (GPIO16)
UART2 (Serial2 port) with 3.3V logic signal
G3
I34, I35
Analog input; 0-3.3V logic, 5V power
G4
I36, I39
Analog input; 0-3.3V logic, 5V power
BiBoard provides the 5V power supply of the grove sockets, while the 5V comes from the battery. So the devices connected to the Grove sockets can only work when connected to the BiBoard and powered by the battery.
BiBoard's 3.3V powers the voice module. The 3.3V can be supplied from the USB. So it can work without battery power.
UART2 shares the GPIO ports with the voice command module. When the switch is dialed to VOICE COMMAND, the Serial2 port can NOT be used. You can dial the slide switch to UART2 to free it for regular serial communication or GPIO.
The function of the switch is shown in the figure below:
NyBoard V1 is an upgraded version considering the users' feedback on NyBoard V0. It's compatible with previous versions, yet has some new design to make it easier to use.
It still uses Atmel ATMega328P as the main chip but adopts 16MHz without accelerating it to 20MHz. Now the board is fully compatible with Arduino Uno, much easier for new users to Arduino.
It keeps driving 16 PWM channels with PCA9685. The pin order is altered, but you don't even need to read the indexes on the board, because the pin mapping is handled within the software.
Now the 6-axis motion sensor MPU6050 is designed on the PCB, rather than a stand-alone module soldered above the board. It supports a built-in DMP (Digital Motion Processor) to calculate the motion data, as well as providing raw data for your own fusion and filtering algorithms.
It continues to use an 8KB onboard I2C EEPROM to save constants for skills.
The power system is redesigned to provide a more stable supply. The structure for peripherals is also optimized.
From Jan 1st, 2021, We start to include an official Bluetooth dongle for wirelessly uploading and communication. The default baud rate for all the communication ports is set to be 115200.
The reset button is more accessible on the back of the board.
We added 4 Grove socket to plug-and-play Seeed Studio's extensible modules. We still provide standard 2.54mm through-holes besides the socket.
We added 7 WS2812 RGB LEDs on the board as another form of output and status indicator.
The socket for the battery is now anti-reverse.
The configuration of NyBoard V1_0 is shown as below:
NyBoard V1_0 uses Atmel ATMega328P-MUR as the main controller. We adopted its smaller version of QFN32 for better layout, and it's near-identical to regular TQFP32.
ATMega328P works at 16MHz with a 5V supply. It has 2KB SRAM, 32KB Flash, and 1KB on-chip EEPROM. With the same bootloader of Arduino Uno, you can upload sketches through the serial port.
The main chip runs at 5V, while the other peripherals run at a 3.3V logic level. We use PCA9306 to convert the I2C bus of ATMega328P to 3.3V. We also added an I2C switch on the bus. By dialing it to "Arduino" or "Raspberry Pi", you can change the I2C master of the onboard peripherals.
MPU6050 is widely used in many DIY projects to acquire the motion state of devices. It detects the 3 acceleration and 3 angular motion states. It also includes a DMP to calculate the state directly, without using the main controller's computational resources.
On NyBoard V1_0, its I2C address is 0x68. The interrupt pin is connected to the PD2 port of ATMega328P (or the D2 pin of Arduino Uno).
There are a lot of available MPU6050 libraries and we are using I2CDev/6050DMP. You can also use other versions:
Name
Author
Feature
I2Cdev
jrowberg
built-in DMP
Adafruit MPU6050
Adafruit
standard MPU6050 library
Kalman Filter
TKJ Electronics
with Kalman filter
PCA9685 fans out 16 PWM 12-bit channels with instructions from the I2C port. Its address is set to 0x40. There are 16 PWM indexes printed on the PCB, but you don't really need to read them because the pin-mapping is done in the software. The physical wiring pattern is the same as the previous boards. You do need to check the direction of the servo pins. Regular servos have 3 pins for PWM, power(2S), and ground (GND). The ground should connect to the black wire of the servo.
On NyBoard V1_0, the servos' power connects to the 2S Li-ion battery. We designed our servos to be compatible with 8.4V input. Regular servos usually run at 6V. You should not connect regular 9g servos like the SG90 to the board directly.
We use Adafruit PWM Servo Driver Library for PCA9685.
We save the motion skills with an 8KB onboard I2C EEPROM AT24C64. Its I2C address is 0x54. The lookup table of skills is saved in the 1KB on-chip EEPROM of ATMega328P. It uses <EEPROM.h>. You need to pay attention to their differences when developing new codes.
The buzzer is driven by PD5 (or the D5 of Arduino UNO). The current is amplified by 2N7002 MOS.
We use VS1838B as the Infrared receiver, connected to PD4 (or D4 on Arduino Uno). It's driven by the IRremote library of Arduino, the corresponding remote is encoded in NEC format. You may disable the other protocols in IRremote.h to save Flash (about 10%!)
The two LEDs in the Petoi logo indicates the powering state of the board. The left eye is blue for the logic chips. The right eye is yellow for the servos' power. When NyBoard is connected to the battery, both LEDs should lit up. When NyBoard is powered by the USB downloader, only the blue LED will lit up.
There's an anti-reverse socket for the battery. The battery's output is connected to ADC7 (or A7 of Arduino Uno) and is not threaded to an open pin. ADC7 collects the voltage over a voltage divider. The actual voltage is approximately 2x of the reading. A safe range of battery voltage is below 10V.
You should charge the battery in time when the battery is lower than 7.4V.
We added 7 WS2812 RGB LEDs (or the NeoPixel) on the NyBoard. The pin number is D10. They are powered by the 5V DC-DC power chip for Raspberry Pi and are independent of the 5V network of ATMega328P. So you need to plug in the battery to power the LEDs.
We adopted the Grove sockets for convenient plug-and-play connections. There are three types of socket:
Grove Socket
Pin Number
Function
G1
I2C: SCL, SDA
I2C with 3.3V logic signal
G2
A2, A3
Analog input; 0-5V
G3
PD8, PD9
Digital I/O; 0-5V
G4
PD6, PD7
Digital I/O; 0-5V
The main chips are powered by a Low-dropout (LDO) linear regulators for noise removal and better stability. We use LM1117-5V and XC6206P-3.3V to power 5V and 3.3V chips. The 3.3V LDO is connected in serial after the 5V LDO for better efficiency.
There's a diode between the battery and LM1117-5V to prevent damage by the wrong connection. There's a self-recover fuse (6V 500mA) on the USB uploader to limit the current and protect the USB port.
The Raspberry Pi consumes much more power, so we choose TPS565201 DC-DC to provide a 5V 3A output. The peak output can be 5A and with high-temperature/current/voltage protection. It will cut off the power when the chip keeps outputting >4A and over 100 Celcius degrees until the temperature drops to normal. The WS2812 RGB LEDs are also powered by this DC-DC source.
The servos are powered by 2S Li-ion batteries directly. Pay attention not to short connect the power or any pins on the NyBoard.
Last updated: Jan 13, 2021
BiBoard is a robot dog controller based on ESP32 developed by Petoi LLC. Unlike NyBoard, which is for regular users and robot lovers, BiBoard mainly faces developers and geeks. High-performance processors, larger memory and storage (16 MB of Flash), and wireless connections. Audio function is also included.
The function partition for BiBoard is shown below:
Power 1
Battery Socket
Connects to Bittle's battery or provides external 8.4V power
Bittle battery or external 8.4V battery
2
Power LED
Indicates power status: Blue for 5V/3.3V, Orange for 8.4V servo power
3
Power
Provides 5V and 3.3V power
ICS
4
USB
Enables program download and soft reset of the controller
5
IMU
6-axis Inertial Measurement Unit (IMU) for motion sensing
6
EEPROM
External memory for storing data
7
DAC Amp
Amplifies audio signal for speaker output
8
IRDA receiver
Receives infrared signals
Extension
9
PWM Servo
Provides 12 pulse-width modulation (PWM) outputs for controlling servos
10
3 extensions
Offers additional connectivity options: 4 analog inputs, 2 serial ports, 1 I2C interface, and 5V DC-DC power (max 3A)
Buttons
11
Boot and Reset buttons
Press the reset button to restart the program
Block diagram for BiBoard is shown below:
There're 2 ways to power the BiBoard: USB 5V and battery socket 7.4V.
When using USB power, there’s no power output for DC-DC 5V extension and servo. So USB power mainly supplies ICs.
When using battery power at 7.4V (maximum: 8.4V). Both servos and 5V power will be supplied. You can use 5V powering the Raspberry Pi.
Note:
Arduino IDE 2.0 cannot add the large_spiffs_16MB (4.5MB APP with OTA/6.93MB SPIFFS) configuration option currently.
The SPIFFS file upload plugin in Arduino IDE 1.8.* is written in Java. And Arduino IDE 2.0 is written in a different language (TypeScript + Golang), so the previous upload plugin cannot be used in Arduino IDE 2.0. There is no support for the Arduino IDE 2.0 SPIFFS file upload plugin currently.
So it is recommended that you temporarily install and use the Arduino IDE 1.8.* IDE.
Open “Preferences” in Arduino, add ESP32 development board URL:
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
Save it and then exit.
Open “Boards Manager...” and wait for updates from external board support links. Search “esp32” and install the support package.
Please install the latest available version 2.0.12. Installing version 2.0.13 and above may cause the motherboard to fail to startup.
After shown “INSTALLED”, the BiBoard board support package is finished.
There’s no USB circuit in the ESP32, so we use the CP2102 USB bridge as officially recommended. The maximum download baud is 921600. The bridge is connected to serial 1 of the ESP32.
We use the USB Type-C port; 2 resistors, CC1 and CC2, are added as the identifier.
We tried the automatic download circuit designed by ESP and the NodeMCU, but none of them works perfectly. So we modified the circuit by adding the third transistor and enlarger the capacitor.
The transistors receive standard serial modem signals DTR and RTS and trigger a unique timing-sequence forcing ESP32 into download mode and then reboot. The detail of the automatic download circuit is shown below.
We use Invensense MPU6050, the most widely used IMU. Its I2C address is 0x68, and DMP’s interrupt is connected to IO26 of the ESP32.
With the help of Jrowberg’s MPU6050 DMP library, you can easily get the motion status of the Bittle. The Jrowberg’s MPU6050 library must be modified to adapt ESP32. The data types of “int8” and “PGMSpace” should be pre-defined instead of 8-bit AVR macros. We offer the modified library of MPU6050. You can replace the original library so that both AVR boards and ESP boards would be worked normally.
There is a 64Kbit EEPROM on the BiBoard. You can directly use the EEPROM read and write a program that is used on the Arduino UNO. You can use it to store calibration data.
There is also an example program named “EEPROM” in the ESP32 support package. This is not the demo code of the I2C EEPROM. That’s the demo of the simulated EEPROM by ESP32’s QSPI flash memory.
We use DAC output and a class-D amplifier instead of a PWM buzzer to make Bittle more vivid. You can use 3 ways to drive the audio module:
Use Arduino “Tone()” function.
Use ESP32 “dacWrite()” function like “analogWrite()” in Arduino. The data quality produced by the DAC is better than the PWM.
Use ESP MP3 decode library developed by XTronical, you can play MP3 files. You should configure a file system like SPIFFS or FAT in the flash before you use this MP3 decoder.
URL:https://www.xtronical.com/basics/audio/dacs-on-esp32/
The IR sensor on Nyboard and BiBoard are the same, so you can directly use the sketch from the Nyboard. The BiBoard’s flash is large enough so that you don’t have to disable macros in IRremote.h.
There’re 12 PWM servo sockets on the BiBoard, and the pin number is marked near the socket.
We transform the direction of the PWM servo socket by 90 degrees since the size of the ESP32 module. You should connect the wires first before you screw the BiBoard on the cage.
There’re 3 extension sockets on the BiBoard that marked with P15, P16 and P17.
This socket is used for analog input extension, you can try to connect foot press sensors to this socket.
This socket is used for bus extension of the ESP32.
You can use this interface to connect to the Raspberry Pi, but you cannot directly mount the Raspberry Pi above the BiBoard. Use wires or adapters instead.
At present, there are 3 versions of NyBoard: NyBoard V1_0, NyBoard V1_1 and NyBoard V1_2.
There are just a few differences between NyBoard V1_1 and NyBoard V1_2:
V1_2 has one NeoPixel LED attached to Pin D10.
V1_2 supports both ATmega328p AU (bigger) and MU (smaller) chips.
NyBoard V1_1 is a V1 refreshed version mainly focused on the shortage of the ATMEGA328P-MU in our supply chain.
Replace the ATMEGA328P-MU(QFN32=)with the ATMEGA328P-AU(TQFP32)
Removed 7 WS2812 LEDs to optimize the area.
A green LED is connected to the D10 port with PWM functions.
There's no changes of sockets and pin definitions from V1_0, the bootloader and the OpenCat sketchs is fully compatible.
NyBoard V1 is an upgraded version considering the users' feedback on NyBoard V0. It's compatible with previous versions, yet has some new design to make it easier to use.
It still uses Atmel ATMega328P as the main chip but adopts 16MHz without accelerating it to 20MHz. Now the board is fully compatible with Arduino Uno, much easier for new users to Arduino.
It keeps driving 16 PWM channels with PCA9685. The pin order is altered, but you don't even need to read the indexes on the board, because the pin mapping is handled within the software.
Now the 6-axis motion sensor MPU6050 is designed on the PCB, rather than a stand-alone module soldered above the board. It supports a built-in DMP (Digital Motion Processor) to calculate the motion data, as well as providing raw data for your own fusion and filtering algorithms.
It continues to use an 8KB onboard I2C EEPROM to save constants for skills.
The power system is redesigned to provide a more stable supply. The structure for peripherals is also optimized.
From Jan 1st, 2021, We start to include an official Bluetooth dongle for wirelessly uploading and communication. The default baud rate for all the communication ports is set to be 115200.
The reset button is more accessible on the back of the board.
We added 4 Grove socket to plug-and-play Seeed Studio's extensible modules. We still provide standard 2.54mm through-holes besides the socket.
The socket for the battery is now anti-reverse.
The configuration of NyBoard V1_0 is shown as below:
NyBoard V1_0 uses Atmel ATMega328P-AU, the same MCU of the Arduino Nano (UNO Compatible).
The ATMega328P works at 16MHz with a 5V supply. It has 2KB SRAM, 32KB Flash, and 1KB on-chip EEPROM. With the same bootloader of Arduino Uno, you can upload sketches through the serial port.
The WS2812 serial RGB LEDs are replaced by a single green LED. You can easily use it with standard Arduino GPIO control commands.
The main chip runs at 5V, while the other peripherals run at a 3.3V logic level. We use PCA9306 to convert the I2C bus of ATMega328P to 3.3V. We also added an I2C switch on the bus. By dialing it to "Arduino" or "Raspberry Pi", you can change the I2C master of the onboard peripherals.
MPU6050 is widely used in many DIY projects to acquire the motion state of devices. It detects the 3 acceleration and 3 angular motion states. It also includes a DMP to calculate the state directly, without using the main controller's computational resources.
On NyBoard V1_0, its I2C address is 0x68. The interrupt pin is connected to the PD2 port of ATMega328P (or the D2 pin of Arduino Uno).
There are a lot of available MPU6050 libraries and we are using I2CDev/6050DMP. You can also use other versions:
Name
Author
Feature
I2Cdev
jrowberg
built-in DMP
Adafruit MPU6050
Adafruit
standard MPU6050 library
Kalman Filter
TKJ Electronics
with Kalman filter
PCA9685 fans out 16 PWM 12-bit channels with instructions from the I2C port. Its address is set to 0x40. There are 16 PWM indexes printed on the PCB, but you don't really need to read them because the pin-mapping is done in the software. The physical wiring pattern is the same as the previous boards. You do need to check the direction of the servo pins. Regular servos have 3 pins for PWM, power(2S), and ground (GND). The ground should connect to the black wire of the servo.
On NyBoard V1_0, the servos' power connects to the 2S Li-ion battery. We designed our servos to be compatible with 8.4V input. Regular servos usually run at 6V. You should not connect regular 9g servos like the SG90 to the board directly.
We use Adafruit PWM Servo Driver Library for PCA9685.
We save the motion skills with an 8KB onboard I2C EEPROM AT24C64. Its I2C address is 0x54. The lookup table of skills is saved in the 1KB on-chip EEPROM of ATMega328P. It uses <EEPROM.h>. You need to pay attention to their differences when developing new codes.
The buzzer is driven by PD5 (or the D5 of Arduino UNO). The current is amplified by 2N7002 MOS.
We use VS1838B as the Infrared receiver, connected to PD4 (or D4 on Arduino Uno). It's driven by the IRremote library of Arduino, the corresponding remote is encoded in NEC format. You may disable the other protocols in IRremote.h to save Flash (about 10%!)
The two LEDs in the Petoi logo indicates the powering state of the board. The left eye is blue for the logic chips. The right eye is yellow for the servos' power. When NyBoard is connected to the battery, both LEDs should lit up. When NyBoard is powered by the USB downloader, only the blue LED will lit up.
There's an anti-reverse socket for the battery. The battery's output is connected to ADC7 (or A7 of Arduino Uno) and is not threaded to an open pin. ADC7 collects the voltage over a voltage divider. The actual voltage is approximately 2x of the reading. A safe range of battery voltage is below 10V.
You should charge the battery in time when the battery is lower than 7.4V.
We adopted the Grove sockets for convenient plug-and-play connections. There are three types of socket:
Grove Socket
Pin Number
Function
G1
I2C: SCL, SDA
I2C with 3.3V logic signal
G2
A2, A3
Analog input; 0-5V
G3
PD8, PD9
Digital I/O; 0-5V
G4
PD6, PD7
Digital I/O; 0-5V
The main chips are powered by a Low-dropout (LDO) linear regulator for noise removal and better stability. We use LM1117-5V and XC6206P-3.3V to power 5V and 3.3V chips. The 3.3V LDO is connected in serial after the 5V LDO for better efficiency.
There's a diode between the battery and LM1117-5V to prevent damage by the wrong connection. There's a self-recover fuse (6V 500mA) on the USB uploader to limit the current and protect the USB port.
The Raspberry Pi consumes much more power, so we choose TPS565201 DC-DC to provide a 5V 3A output. The peak output can be 5A and with high-temperature/current/voltage protection. It will cut off the power when the chip keeps outputting >4A and over 100 Celcius degrees until the temperature drops to normal.
The servos are powered by 2S Li-ion batteries directly. Pay attention not to short connect the power or any pins on the NyBoard.
The usage of DAC
The purpose of the DAC is the opposite of that of the ADC. The DAC converts a digital signal into an analog signal for output.
Remember the music when NyBoard is turned on? It is using PWM to make music sound which uses high-speed switching to adjust the duty cycle to output voltage.
Compared with PWM, the DAC will directly output the voltage without calculating the duty cycle. ESP32 integrates a 2-channel 8-bit DAC with a value of 0-255. The voltage range is 0-3.3V. Therefore, the formula for calculating the output voltage of the DAC is as follows:
The demo is as follows:
BiBoard is equipped with an infrared sensor, which is connected to the 23rd pin. The use of infrared is exactly the same as which is on Arduino UNO based on AVR.
First download the 2.6.1 version of the IRremote library, you need to manually select the 2.6.1 version. Because the infrared-related codes have changed in later versions, if you use the 3.X version, the commands will not be translated. In order to be compatible with our previous products, we decided to use the 2.6.1 version after testing.
When using NyBoard, in order to ensure that the code can be compiled smoothly, we need to remove unnecessary code in the IRremote library, that is, remove the encoder/decoder that we don't use, and only keep the NEC_DECODER, which is the 38KHz signal decoder in NEC format.
Due to the flash memory capacity of BiBoard is “huge”, we don’t need to remove unnecessary code in the IRremote library.
Finally, a demo is attached, which accepts infrared signals and prints via the serial port. You can also use official demo for testing.
The ESP32 used by BiBoard is different from the 328P used by UNO. Because the PWM of ESP32 uses the matrix bus, it can be used on unspecified pins.
The PWM of ESP32 is called LED controller (LEDC). The LED PWM controller is mainly used to control LEDs, and it can also generate PWM signals for the control of other devices. The controller has 8 timers, corresponding to 8 high-speed channels and 8 low-speed channels, totaling 16 channels.
Compared with UNO, directly use "analogWrite()" to input any duty ratio between 0-255. The PWM control of ESP32 on BiBoard is more troublesome. The parameters that need to be controlled are as follows:
Manual selection of PWM channels (0-15) also improves the flexibility of the use of pins
The number of bits of the PWM waveform determines the resolution of the duty cycle of the PWM waveform. The higher the number of bits, the higher the accuracy.
The frequency of the PWM waveform determines the speed of the PWM waveform, the higher the frequency, the faster the speed.
The frequency of the PWM waveform and the number of bits are relative, the higher the number of bits, the lower the frequency. The following example is quoted from the ESP32 programming manual:
For example, when the PWM frequency is 5 kHz, the maximum duty cycle resolution can be 13 bits. This means that the duty cycle can be any value between 0 and 100%, with a resolution of ~0.012% (2 ** 13 = 8192 discrete levels of LED brightness).
The LED PWM controller can be used to generate high-frequency signals, enough to clock other devices such as digital camera modules. Here the maximum frequency can be 40 MHz, and the duty cycle resolution is 1 bit. In other words, the duty cycle is fixed at 50% and cannot be adjusted.
The LED PWM controller API can report an error when the set frequency and duty cycle resolution exceed the hardware range of the LED PWM controller. For example, if you try to set the frequency to 20 MHz and the duty cycle resolution to 3 bits, an error will be reported on the serial port monitor.
As shown above, we need to configure the channel, frequency and number of bits, and select the output pin.
Step 1: Configure the PWM controller
Step 2: Configure the PWM output pins
Step 3: Output PWM waveform
In the demo, we choose IO2 as the output pin, connect IO2 to an LED, and you can observe the effect of the LED breathing light.
MPU6050 is the most widely used 6-axis gyroscope, which can not only measure 3-axis angular velocity and 3-axis acceleration more accurately, but also use the built-in digital motion processor (DMP) for hardware based attitude fusion calculation. So novices can use it very conveniently. For this reason, we also use MPU6050 gyroscope.
There are many demos of MPU6050 on Arduino UNO, the most famous is jrowberg's I2Cdev and MPU6050DMP library:
Unfortunately, this library cannot be run directly on BiBoard based on ESP32. We found the ported library on Github, which is easy to use. This library adds the definition of PGMSpace for the ARM and ESP series, adds the calibration function, and removes the FIFO overflow processing function (friends who are interested can use Beyond Compare for code comparison). The library contains I2Cdev and MPU6050, the address and compressed package are as follows:
After the download is complete, create a MPU6050 folder under Documents/Arduino/library, and copy the library files in the compressed package into it. The library of this modified MPU6050 is also compatible with ARM and AVR, so if you have the original I2Cdev and MPU6050 libraries in your computer, you can delete them.
We can use the official MPU6050_DMP6 demo.
ESP32 File System SPIFFS Configuration Guide
On BiBoard (ESP32), in addition to the regular program area and boot area, we use the file system in the Flash partition.
The role of a file system with independent partitions is as follows:
Save the data at the specified address and will not be deleted due to re-update (such as calibration data, gait data)
No external SD card needed, saving hardware resources
Common file systems include Windows NTFS, exFAT, and Linux log file systems Ext and XFS. But in the embedded field, these large file systems are too large. We use the lightweight SPIFFS (SPI Flash File System), an embedded file system for SPI NOR flash devices, and support functions such as wear leveling and file system consistency checking.
Because of its light weight, the biggest feature of SPIFFS is that it does not support tree directories, that is, all files are stored in the same layer. SPIFFS provided by ESP32 has the following features:
Currently, SPIFFS does not support directories, it produces a flat structure. If SPIFFS is mounted under /spiffs, then creating a file with the path /spiffs/tmp/myfile.txt will create a file called /tmp/myfile.txt in SPIFFS, instead of myfile.txt in the directory /spiffs/tmp.
It is not a real-time stack. One write operation might take much longer than another.
For now, it does not detect or handle bad blocks.
You can create/save and delete files with your own Arduino code, but the operation is cumbersome. You need to put data or even binary files into Arduino Sketch and create files by running the program.
However, there is a very useful tool that can directly upload files from the computer to the file system. Although it is slightly more troublesome than the "drag-and-drop" copy of the "removable storage", whether it is MP3 audio or HTML web files, all can be easily uploaded to flash memory. Let's learn how to use this plugin.
Please install Arduino IDE (Version: 1.8.* ) and the ESP32 support package of Arduino IDE (refer to Chapter 3.2.1 of the BiBoard Quick Start Guide.).
Download the compressed package of the ESP32FS plug-in at:
Go to the "Arduino" directory and open the "tools" folder
C:\Users\{YourUserName}\Documents\Arduino\tools
Unzip the downloaded .zip folder to the Tools folder. You should have a similar folder structure:
C:\Users\{YourUserName}\Documents\Arduino\tools\ESP32FS\tool\esp32fs.jar
Finally, restart the Arduino IDE.
To check whether the plug-in has been successfully installed, open the Arduino IDE. Select your ESP32 development board (ESP32 Dev Module), go to "Tools", and then check if there is an "ESP32 Sketch Data Upload" option.
To upload files to the ESP32 file system, follow the steps below:
Create an Arduino project (e.g.: Test.ino) and save
To open the project directory, you can use the "Sketch - Show Sketch Folder" option
Inside this folder, create a new folder named "data"
In the "data" folder, you should put the file which you want to save into the SPIFFS file system. e.g., create a .txt file that contains some text named "test_example". as following:
Please click "Tools - ESP32 Sketch Data Upload" in the Arduino IDE
When you see the "SPIFFS Image Uploaded" prompt message, the file has been successfully uploaded to the SPIFFS partition.
The demo of the file system SPIFFS_Test.ino(C:\Users\{YourUserName}\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.*\libraries\SPIFFS\examples\SPIFFS_Test
)comes from the official ESP32 without modification. The code implements the basic operation of "addition, deletion, modification, and check", and provides an SPI flash IO test program.
If necessary, it is recommended to directly use the code of the demo to operate ESP32 SPIFFS.
The flash memory of the ESP32 board has 16M, and the range of the storage address expressed in hexadecimal is 0x0-0x01000000.
This is the partition table that has been configured by the system, as shown in the figure below:
The storage location of this partition table file on the computer:
C:\Users\{YourUserName}\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.*\tools\partitions\large_spiffs_16MB.csv
It can be seen from the above partition table: APP0 area and APP1 area are 4.5M each; the data area is SPIFFS, and the size is 6.9M.
But in the Arduino IDE, this configuration is not included in the hardware partition configuration options of the ESP32 Dev Module:
We need to add this configuration to the ESP32 Dev Module.
Open the development board configuration file:
C:\Users\{YourUserName}\AppData\Local\Arduino15\packages\esp32\hardware\esp32\2.0.*\boards.txt
Locate the name of the development board: esp32.name=ESP32 Dev Module, as shown in the figure below:
The line of text in the ESP32 Dev Module partition configuration in the configuration file:
Add the following 3 lines of text below this line:
The following explains the meaning of the three lines of text:
The name of the ESP32 partition configuration, we named it BiBoard V0 (4.5M APP with OTA /6.9 MB SPIFFS), or it can be replaced with other names you are familiar with.
The partition configuration file information is the file large_spiffs_16MB.csv . You can also write a partition file to adjust the file size of the APP and data area.
This line of text specifies that the maximum upload program size is 4685824 bytes.
Let's try to compile a simple program to test whether the above configuration is set successfully.
Reopen the Arduino IDE, we can see the BiBoard just configured:
After compiling the program, the result is as shown in the figure below:
Compilation is complete, using 213KB of Flash (4%), and the maximum usable size is 4,685,824 bytes.
In this passage, “4685824 bytes” is specified in the third line of text just added to the configuration file.
If you use Arduino IDE 2.0.*, the partition option may not appear automatically. To fix:
Select File > Quit from the Arduino IDE menu to close all active Arduino windows and quit the process.
Delete the "User data" folder:
Windows:
Linux:
macOS:
Restart the Arduino IDE.
The custom board options menus should now reflect any changes that were made to boards.txt
.
So far, you have completed the configuration of the development board with the largest flash memory space in Arduino IDE.
There is a demo named testMP3 in the "OpenCatEsp32/ModuleTests" file directory. The main function of this demo is to play .mp3 files stored in the SPIFFS file system. Users can choose to play different .mp3 files by inputting 0~6 numbers (.mp3 file index number) in the serial monitor.
Note:
Arduino IDE 2.0 cannot add the large_spiffs_16MB (4.5MB APP with OTA/6.93MB SPIFFS) configuration option currently.
Of course, you can also use VS Code + PlatformIO to upload the sketch and .mp3 files. For details, please refer to the following documents:
Before uploading the sketch and .mp3 files, please move the "data" folder to the project root directory, store the code files in the "src" directory, and configure the partition option "board_build.partitions" in the platformio.ini in the project root directory, as shown in the following figure:
Biboard V1 is a development board based on the high-performance ESP32 MINI 1 module. The module employs an Xtensa dual-core 32-bit LX6 processor featuring 4 MB of Flash memory, 2.4 GHz Wi-Fi, and Bluetooth Low Energy. With its powerful computing capabilities and diverse expansion interfaces, it can meet various projects' personalized needs and complex embedded development requirements. It is widely used in fields such as the Internet of Things, industrial automation, and education and research. Biboard V1 is the ideal choice for any embedded developer.
Real-time high-load power supply
High-speed UART debugging IC
Flight Controller-Grade Six-Axis Motion Sensor
12-channel PWM servo interface
Universal extensible interface (Grove socket)
Stand-alone intelligent voice recognition with bilingual multi-word support
High-fidelity audio speaker
Zero-latency, high-sensitivity capacitive touch
Strong EMC anti-interference and anti-radiation performance
[1]. BiBoard V1 supports 12 PWM servos by default, but if you need to read the feedback angle of the 12th servo (Pin 27), please disconnect JP1. After that, LED27 cannot be used.
[2]. The newest firmware has implemented the external EEPROM's functionality with the built-in flash. You can purchase it elsewhere and solder it to the mainboard if needed. Model: M24C64-FMC6TG.
[3]. If the firmware burning process is interrupted due to external factors, it may lead to a situation where the firmware cannot be burned again. In this case, you need to power off the mainboard, press and hold the BOOT button, and then power on the mainboard again to force the ESP32 into Download mode. After the burning process is complete, power on the mainboard again.
The Nyboard V1 used by robot uses the Atmel ATMEGA328P controller, which only supports only one serial port. We separate the serial port of Nyboard to support more modules. The pins of the serial port are compatible with the 6-pin Arduino Pro Mini. Pin definitions are shown in the table below:
The default serial baud rate is 115200bps.
There're 3 communication modules for the NyBoard V1:
This module uses the ESP8266EX's official model ESP-WROOM-02D, which has 4MB of QSPI Flash. It is certified by the FCC in the United States, CE-RED in Europe, TELEC in Japan, and KC in South Korea.
The module is fully opened. You can program it separately. This is not a simple, transparent transmission module.
Connect to the NyBoard:
Update sketches through USB uploader:
We use the Arduino IDE as the development environment.
Then open the Board Manager and input ESP8266 or 8266 to search for the board support package:
Download the latest version of ESP8266 from ESP8266 Community.
After downloading the board support package, we select Board -> ESP8266 -> Generic ESP8266 Module.
Then we set the parameters:
After configuration, we used the Arduino classic "Blink" program to test the ESP8266 development board.
Open the Blink project, configure the development board, plug the module into the communication module debugging interface of the USB uploader (USB Adapter), and upload the Blink sketch.
Compared with the Arduino UNO, the compilation time is slightly longer. After Linking, the uploading progress will be displayed as follows:
There are seven files in the project:
ESP8266WiFiController.ino: Arduino sketch with server core code.
mainpage.h: welcome page (HTML) in a char array.
actionpage.h: action controller page (HTML) in a char array.
actions.h
actions.json
calibrationpage.h
commons.h
Please open the ESP8266WiFiController.ino in the Arduino IDE and install the library WiFiManager and Dictionary in the Library Manager:
Then, upload the sketch to the ESP8266 WiFi module.
After the sketch is uploaded to the WiFi module, we strongly recommend running it with your USB uploader (USB Adapter) so you can get the serial output in the serial monitor of Arduino IDE.
Open the serial monitor in Arduino IDE as follows. Then, unplug and re-plug the WiFi module into the USB uploader.
Open your smartphone's WiFi scanner and find an unencrypted access point named "Bittle-AP." Connect it.
If your smartphone automatically optimizes your network connection, it will cut the connection of "Bittle-AP" because there is no Internet connection. Your smartphone may connect to the WiFi with an Internet connection or even use your cellular data. Please turn off your smartphone's network connection optimization function and force it to connect to the "Bittle-AP" hotspot.
Your smartphone may auto-jump to the "WiFiManager" page when connecting to "Bittle-AP."
If not, please open your browser and enter 192.168.4.1 to enter the WiFi connection configuration page manually.
On the WiFiManager page, Please click the Configure WiFi button. The WiFi module will automatically search for and display all nearby WiFi SSIDs. After you click on your WiFi SSID and enter the password, the WiFi module will connect to this network first.
After successfully connecting to the network, the WiFi module will print out the IP address assigned by DHCP through the serial port on the serial monitor.
Enter the WiFi module's IP address in the web browser, and you can now control the Bittle through WiFi!
The sample code is a simple web server example, including 2 HTML pages. The two pages are stored in two header files in the form of string constants. The advantage is to avoid calling the client. print function constantly.
Before we start our web server, we should configure the WiFi to connect to your local area network(LAN). We used to enter the WiFi SSID and password in the program, but it is very inconvenient when we need to change the network environment.
We use the WiFi manager library to configure the WiFi information online.
Create a new web server and configure port 80 (commonly used HTTP server port)
The HTTP response function is to handle the incoming HTTP requests.
The handleMainPage and handleActionPage response 200 (OK) and corresponding web HTML code for your web browser (client).
The HandleAction function is slightly different. This is an HTTP request processing function with parameter passing. When the parameter is "gyro," the WiFi module's serial port sends out the command ("g", switch IMU) so that our Bittle will execute the command.
So, how is this "gyro" parameter generated and passed? Because we sent such an HTTP request with a value to the server:
The server parses the action parameter by the function and resolves that the name is "gyro".
We can directly enter this URL in the browser and execute it with the keyboard. The more common method is to add a link to the "Walk" button on the ActionPage web page. When the gyro button is pressed, the above URL will be sent to the host.
The complete walk button configuration is as follows:
We will send the action page again after parsing the "name" parameter.
We bond the handler method with the corresponding URLs.
Compared to the ATMega328P on the NyBoard, the ESP8266 has more hardware and software resources, so you can do more experiments with it.
Connect your Bittle to IoT platforms with HTTP restful APIs.
MQTT and node-red.
OTA with WiFi.
Make ESP8266 a strong co-processor for NyBoard for motion data fusion.
The Bluetooth module is a standard transparent transmission module, which sends serial port data to devices connected to Bluetooth.
The connection between the Bluetooth module and the NyBoard is shown in the figure below, you need to plug the Bluetooth module into the 6-pin socket on the NyBoard. Note the pin order of the Bluetooth module. Once the battery is connected to the NyBoard, press and hold the button on the battery to power the robot. A blinking LED on the Bluetooth module indicates waiting for a connection.
You need to connect the dongle within the Petoi App, rather than your phone's system Bluetooth settings. On some phones, you need to grant Bluetooth and location services permissions to the app.
In your system's Bluetooth settings, search for a Bluetooth device name started with Petoi or Bittle, and connect. The default PIN for pairing is “0000“ or “1234”. After the pairing is successful, the system will assign a serial port name.
On Mac, go to System Preference -> Bluetooth, find a device name started with Petoi or Bittle, and connect.
On Windows, add the Bluetooth device in the system settings.
For Win10 users, the system will assign the "incoming" COM port and the "outgoing" COM port to Bluetooth. Please use the "outgoing" COM port. For details, please check in the "More Bluetooth options" of Win10 as below:
You can then select it under Tools->Port in the Arduino IDE, using the same method as the USB uploader. After opening the serial monitor, please select: No line ending, and the baud rate is set to 115200.
The Bluetooth connection with the computer may occasionally drop. Keeping the serial monitor open can make it more stable. But note it will also occupy the port and block other applications that want to connect.
If you want to configure the Bluetooth module, please refer to "JDY-23 AT Command List". Plug the Bluetooth module into the USB adapter debugging interface. As shown below:
The commonly used commands are listed below:
When you use the serial terminal like "Arduino serial monitor" to set JDY-23 with AT commands, you must set "NL and CR", and the baud rate is set to 115200, or the JDY-23 module will not identify any AT command you send.
If you are a developer, you can use Lightblue or other tools to connect the dongle's BLE service.
The sensor integrates two photoresistors (depending on the light intensity adjustment resistance) to detect the light intensity. The photoresistor is a particular resistance that uses the photoconductive effect, and its resistance is directly related to the intensity of the incident light. When the light intensity increases, the resistance decreases; when the light intensity decreases, the resistance increases. The output signal is an analog value. The brighter the brightness, the larger the value. You can realize the function you want by judging the value of the detected light intensity, such as the function of a robot tracing light.
Connecting to the NyBoard with wire as shown in the following picture:
With NyBoard V1_*, you can choose Arduino Uno.
For example, to modify the code for Bittle as shown below:
Suppose you want to test a light sensor's function alone or learn more about its principles. You can use the Arduino IDE to upload the test code(testDoubleLight.ino):
For specific use, the end connected to the sensor can be fixed on the robot's head (included in Bittle's mouth or attached to the top of Nybble's head). Of course, you can also use your creativity according to your needs.
The Arduino demo of ESP32 provides the function of OTA (updating/uploading a new program to ESP32 using Wi-Fi)
The configuration of our BiBoard is 16MB Flash, and the specific partitions are as follows:
OTA mainly operates OTA data areas, namely APP1 and APP2 areas. The principle is:
BiBoard runs the firmware with OTA function, at this time, the boot points to the APP1 area.
The OTA command is sent to ESP32 via Wi-Fi, and the binary file of the upgrade program is transferred to the APP2 area.
If the transmission of APP2 is completed and the verification is successful, OTAdata points to the APP2 area, and the next time it starts from the updated firmware area (APP2), the APP1 data is retained. Next time, OTA will write to APP1 area to overwrite the old firmware.
If the transmission of APP2 is not completed due to a network transmission error, because APP2 has not passed the verification, OTAdata does not point to the APP2 area. The program in the APP1 area will still be executed after the reset is started, and the damaged APP2 area will be completely erased and overwritten during the next OTA.
In the demo, first configure WiFi, and configure the WiFi mode as STA (Station, base station mode). Enable the WiFi function and pass in the account password "WiFi.begin(ssid, password);"
When the Wi-Fi is successfully connected, the IP address will be printed via the serial port; if the connection is wrong, the ESP32 will restart.
In the demo, you can configure the port number, the OTA key or the hash of the key, and the area and type of the OTA (commented by default).
The following are several code snippets similar to callback functions, which are used to judge the state of each stage of OTA.
After configuring according to the demo, call "ArduinoOTA.handle();" in the loop function. The following analogWrite function is to distinguish the effects of different firmware updates (by changing the value).
The first time you use the serial port to download, the python tool "esptool" is called. You can use OTA after the download is complete. In the port options, you will find an extra port based on the IP address, which is the OTA address.
Select this address, the lower right corner is the IP address of ESP32 Dev Module on your BiBoard (192.168.1.178)
At the same time, a warning will pop up: "Serial monitor is not supported on network ports such as 192.168.1.178 for the ESP32 Dev Module in this release".
The ESP32 OTA of Arduino is only suitable for updating the program and cannot complete the serial port debugging work. If you need to debug BiBoard, please connect the USB-C interface.
Download the program, as shown in the figure.
For Python 3.8 and above, the calling syntax is different for the definition of type. This script is compatible with this, but you need to comment and uncomment several corresponding statements in the script according to the version of Python you have installed. For example, the following script supports Python versions below 3.8:
This script can control only one robot alone, or control multiple robots at the same time, which can be realized by modifying the following statement in example.py:
The module is also called USB Adapter. It uses a CH340C USB bridge. Windows 10, Linux, and macOS are all drive-free. The specific interface is shown in the following figure:
NyBoard download interface: used to connect to NyBoard, download program firmware to the robot, and communicate with the computer via serial port.
Communication module debugging interface: used to connect the Bluetooth or WiFi module, update the module program and debug the parameters. In order to avoid the cumbersome operation when connecting with Dupont wires, the pin ordering is slightly different from the NyBoard download interface - the TX/RX interface is reversed, and a GND pin becomes an RTS pin. For details on how to use the debugging interface of the communication module, see the following chapters.
Do not plug in the NyBoard and the other module(WiFi or Bluetooth) at the same time! That will block the serial port.
Insert the 6-pin(H1) of the USB uploader to the NyBoard's uploader socket and then use the included USB data cable to insert one end into the MicroUSB interface of the USB upload module; the other end into the USB interface of the PC.
Right-click on "This PC" on the Windows desktop, and then click on "Manage" with the left mouse button (of course, you can also operate in the folder browser), as shown in the figure below, and then select "Device Manager" in the "Computer Management" page to check the connected serial port:
Open the Arduino IDE, or the Desktop App Firmware Uploader interface, and select the corresponding COM port to upload the firmware for the NyBoard and use the serial monitor to communicate.
The uploader has three LEDs: power, Tx, and Rx. Right after the connection, the Tx and Rx should blink for one second indicating initial communication, then dim. Only the power indicator LED should keep lighting up. You can find a new port under Tool->Port as
“/dev/cu.usbserial-xxxxxxxx” (Mac)
“COM#” (Windows)
“ttyUSB#” (Linux)
If Tx and Rx keep lighting up, there’s something wrong with the USB communication. You won’t see the new port. It’s usually caused by overcurrent protection by your computer, if you’re not connecting NyBoard with an external power supply and the servos move all at once.
If you cannot find the serial port after connecting to your computer, you may need to install the driver for the CH340 chip.
The CH343G version should install the driver automatically on most systems. However, if you are using the module on Mac to configure the ESP8266 module, please download the driver. It will be recognized as two USB devices (usbserial and usbmodem). You may try either one to connect.
For ChromeOS:
Plug the Bittle USB adapter into the robot and the Chromebook.
Set the Chromebook Linux VM to recognize the USB port
Settings => Advanced => Developers => Linux development environment => Manage USB devices => USB Serial (turn on)
NOTE: Step 4 must be repeated every time when the USB connection is reconnected/powered on.
The sensor contains two touch parts (left and right) and can detect changes in capacitance when a finger approaches. This means the touch sensor will output a high level whether your finger touches lightly or presses hard. You can realize the function you want by judging the detected value (1 for high level, 0 for low level).
Connecting to the NyBoard with wire as shown in the following picture, connect to the NyBoard Grove interface, which includes D6, D7:
With NyBoard V1_*, you can choose Arduino Uno.
For example, to modify the code for Bittle as shown below:
If you want to test a touch sensor's function alone or learn more about its principles. You can use the Arduino IDE to upload the test code(testDoubleTouch.ino):
You can upload the firmware via the Petoi Desktop App:
Or you can upload the OpenCat.ino as follows, uncomment the line #define GROVE_SERIAL_PASS_THROUGH
in the OpenCat.ino:
For BiBoard, you can skip this step.
For specific use, the end connected to the sensor can be fixed on the robot's head (included in Bittle's mouth or attached to the top of Nybble's head). Of course, you can also use your creativity according to your needs.
Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
The head of Bittle is designed as a clip to hold extensible modules. We compiled a sensor pack with some popular modules, but its contents may change. Thanks to the rich content of the Arduino and Raspberry Pi communities, you can also wire other add-ons.
To use the following sensors:
You can also purchase the following third-party sensors (such as Seeed studio):
The touch, reflection, and PIR sensors can generate digital 1 or 0 as a switch signal. So, they should be connected to the digital Grove socket. We use the fourth socket with D6 and D7 in the demo code.
Petoi Intelligent Vision Sensor can recognize many objects with a deep-learning algorithm. For example, it can detect color blocks, balls, the human body, and cards. Its detection result can be transmitted through the UART or I2C interface. MU is compact, has low power consumption, processes all algorithms locally, and can be widely used in intelligent toys, AI+STEAM lessons, creators, and other products or fields.
After uploading the firmware, switch the dial switches on the MU Vision Sensor and connect to the mainboard with wire as shown in the following picture:
Use the latest OpenCat code to finish the setup. For example, to modify the code for Bittle as shown below:
If you have already uploaded the latest OpenCat code to make Bittle walk, you only need to uncomment #define CAMERA
At the beginning of OpenCat.ino, then upload the code.
The demo video is as follows:
Note: The position of the left and right switches (left: down and up; right: down and down) must be dialed to the position shown in the figure.
Fix the end connected to the camera to the robot's head (included in Bittle's / Bittle X's mouth).
Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
Use the latest OpenCatESP32 source code to finish the setup. For example, to modify the code for Bittle as shown below:
If the MU Vision Sensor cannot identify the target object, please press the reset button on the camera and then the reset button on the main board.
While the MU Vision Sensor connects with BiBoard if the white LED on the back of the MU Vision Sensor isn't lit up.
Please plug the battery into the BiBoard and long-press the button on the battery to power the BiBoard. Then, click the camera's reset button and the main board's reset button in order.
This module also supports the following developing environment:
MicroPython APIs
Mixly IDE
MakeCode IDE
Petoi RGB Ultrasonic Sensor is a new module that integrates RGB LED and ultrasonic ranging. Only one GPIO is needed to operate the ultrasonic transceiver. While the ultrasonic probe measures the distance, the other GPIO pin can drive RGB LEDs with various light effects.
The previous one:
Connecting to the NyBoard with wire as shown in the following picture:
The previous one:
Use the latest OpenCat code to finish the setup. For example, to modify the code for Nybble as shown below:
If you have already uploaded the latest OpenCat code to make Nybble walk, you only need to uncomment the #define ULTRASONIC
at the beginning of OpenCat.ino, then upload the code.
Ultrasonic module code realization function: The probe inside the ultrasonic module lights up with different-colored lights according to the different distances monitored by the ultrasonic module in real-time, and Nybble will make different action responses at the same time.
The demo video is as follows:
Connecting to the BiBoard with wire as shown in the following picture:
The dial switch on the bottom of the BiBoard extension hat is dialed to UART2 .
For NyBoard, please refer to .
For BiBoard, please refer to .
Then re-do the Step 3.
Don't add the one with the name Bittle**_SSP that auto-generates a PIN code: Click the button Cancel to quit.
The left panel sets both the robot's gaits and directions and send combined command, such as "walk left" and "trot forward". The robot will only move if an initial gait and direction are selected. The "step" has no direction, and "backward" has left and right directions. The pause button "||" will pause the robot's motion and turn off the servos, so that you can rotate the joints to any angle. The "Turbo" button ( ) turns on/off the gyro, a sensor to detect the robot's body orientation. Turning it on will make the robot keep adjusting to body angles, and will know when it's upside down. Turning it off will reduce calculation and make it walk faster and more stable.
Click the Test or Play () button to test the function of the command group. click the Pause () button to interrupt the command list execution flow.
Before uploading the firmware, please ensure that no I2C device is connected to the I2C interface of the mainboard. Otherwise, the firmware upload will fail. The location of the I2C interface is as shown below (in the red box):
For software version 1.0, there is a warning message window of "Update Instincts? (Y/N)" will pop up as follows:
Please open the serial monitor and set the configuration parameters of the serial port monitor to 115200 baud rate and No line ending.
You can send the serial command "?" in the serial monitor to check the version date of the mainboard firmware:
Before uploading the firmware, please make sure not to connect any I2C device to the I2C interface of the mainboard, otherwise, the firmware upload will fail. The location of the I2C interface is as shown below (in the red box):
Select Settings Advanced Developers.
You can access your Linux environment through the terminal app in your Chromebook launcher.
Files created in Linux are stored in a container and are separate from Chrome OS files. You can access them using the "Linux files" app.
You can set the shared folders in the file browser and manage them in the Settings:
If you open Mind+ by double-clicking the icon, it will not automatically load this extension library, and you need to re-import it manually every time you open the app.
Automatically identify and open the serial port
Enter the name of the serial port to open the serial port
, represents a list consisting of a joint index and an angle value. For example, [Head panning to 30 degrees] represents the list [0, 30].
It consists of one or more pairs of joint index + angle value, and the specific format is as follows: [joint index, angle value, joint index, angle value...]
You can choose the "Serial Monitor" in the Tools menu bar or click the button to open the serial monitor window:
Before compiling the demo, please (, development board esp32 2.0.*, library , ).
After compiling, use the latest SPIFFS file upload plugin to upload the .mp3 file to the SPIFFS file system partition of BiBoard. For details, please refer to the chapter .
The in Arduino IDE 1.8.* is written in Java. And Arduino IDE 2.0 is written in a different language (TypeScript + Golang), so the previous upload plugin cannot be used in Arduino IDE 2.0. There is no support for the Arduino IDE 2.0 SPIFFS file upload plugin currently.
So it is recommended that you temporarily install and use the to upload sketch and .mp3 file.
dual mode(EDR & BLE)JDY-23
ESP8266
The module includes an automatic upload circuit and a communication module. The automatic upload circuit recommends using 2 S8050 transistors to receive the RTS and DTR signals from the (CH340C or CH343G) and trigger the upload sequence.
You must download and install first.
URL:. Paste it into the Additional Boards Manager URLs in the Arduino IDE preferences.
Project URL:
You can wirelessly upload firmware or control the motion of the robot through a Bluetooth connection. You can even control the robot using our smartphone app . We have included our official Bluetooth module in the standard robot kit. As shown below:
A more detailed setup can be found in the section.
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Light, so press the Upgrade the Firmware button. for example, Nybble, NyBoard_V1_2, COM5 as follows:
You can use to upload and modify the source code.
The code using this sensor has been integrated into the project. Uncomment the line #define DOUBLE_LIGHT
In the OpenCat.ino, as shown in the figure below, use the Arduino IDE to upload the sketch to the robot main board, which can reproduce the example function of integrating the robot action.
The test code is in the OpenCat project source code ()
This test code implements real-time printing of the analog values of the two analog pins (A2 and A3) in the . You can also use the serial plotter to view the two analog pins (A2 and A3) more intuitively. The waveform graph is generated by the analog value of the pin output along the time axis.
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, and use the serial command "XL" to switch to using the light sensor mode.
You can use to (OpenCatEsp32.ino). Use the latest OpenCatESP32 source code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, and use the serial command "XL" to switch to using the light sensor mode.
Please refer to the instruction of the and use the to open the sample program (ESP8266WiFiController.ino) to upload the WiFi control firmware for the ESP8266 moudle.
Install Python3, and download to control the robot.
Refer to of the WiFi ESP8266 to assign the IP address to the ESP8266 module and then insert it into the main board of the robot. After the robot is powered on normally, you can use python to run the script example.py to control the robot wirelessly. You can modify the following script statements (modify the content of the list) according to your actual needs to make the robot perform various actions:
For currently supported skill action commands, please refer to the code file actions.h (in ).
For Linux, once the uploader is connected to your computer, you will see a “ttyUSB#” in the serial port list. But you may still get a serial port error when uploading. You will need to give the serial port permission. Please go to this link and follow the instructions:
Mac:
Windows:
Linux:
Download the Arduino IDE(e.g. 1.8.19) for Linux from
Install it on the Chromebook. Please refer to the video at
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Touch, so press the Upgrade the Firmware button. for example, Nybble, NyBoard_V1_2, COM5 as follows:
You can use to upload and modify the source code.
The code using this sensor has been integrated into the project. Uncomment the line #define DOUBLE_TOUCH
in the OpenCat.ino, as shown in the figure below, use the Arduino IDE to upload the sketch to the robot main board, which can reproduce the example function of integrating the robot action.
The test code is in the OpenCat project source code ()
This demo sketch implements real-time printing of the detection values of D6 and D7 pins in the :
2. Follow to import the Petoi Coding Blocks in the app Mind+, and load the Mind+ code file.
Connect the robot and computer with the (USB uploader) or .
Power on the robot and click the Run button in Mind+.
You can use the within the Petoi Desktop App.
After uploading, and use the serial command "XT" to switch to using the touch sensor mode.
You can use to (OpenCatEsp32.ino).
After uploading, and use the serial command "XT" to switch to using the touch sensor mode.
The test code is in the OpenCatESP32 project source code ()
For NyBoard, you need to in a different mode.
For BiBoard, you can use the serial commands to .
(Built-in on Bittle X)
(Built-in on Nybble)
The loudness and light level modules can generate for the corresponding signals and should be connected to the analog Grove socket.
The , , and module should be connected to the I2C Grove socket.
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Camera, so press the Upgrade the Firmware button. for example, Bittle, NyBoard_V1_2, COM5 as follows:
You can use to upload and modify the source code.
First, download and install the into your Arduino IDE.
2. Use the latest code to finish the setup.
If unsure, you need to finish the (Step 1 to Step 10) to ensure everything is configured correctly, then upload the code in the camera mode.
If the camera code is uploaded correctly, Bittle maintains the rest position. Success messages are printed on the of Arduino IDE. When the MU Vision Sensor recognizes a target, the two LEDs will turn blue, and Bittle's head can follow the target and swing left and right. The demo code will auto-switch the target between a yellow tennis ball and a human body if it fails to find any object.
You can use the within the Petoi Desktop App.
After uploading, and use the serial command "XC" to switch to using the camera mode.
First, download and install the into the .
2. Use Arduino IDE to (OpenCatEsp32.ino).
After uploading, and use the serial command "XC" to switch to using the camera mode.
For more details, please refer to .
Attach the ultrasonic sensor to .
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Ultrasonic, so press the Upgrade the Firmware button. for example, Nybble, NyBoard_V1_2, COM5 as follows:
You can use to upload and modify the source code.
If you are unsure, you need to finish the (Step 1 to Step 10) to ensure everything is configured correctly, then upload the code in the Ultrasonic mode.
If the Ultrasonic code is uploaded correctly, you can see success messages printed on the of Arduino IDE. As shown below:
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, and use the serial command "XU" to switch to using the ultrasonic sensor mode.
You can use to (OpenCatEsp32.ino). Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, and use the serial command "XU" to switch to using the ultrasonic sensor mode.
Processor
ESP32-U4WDH
SRAM
520KB
ROM
448KB
Flash
4MB
External EEPROM
Customizable
Input Voltage
7 - 9V
Operating voltage
5V
Operating current
0.1 - 0.2A
Baud rate
115200
Bluetooth protocol
4.2 BR/EDR and low energy Bluetooth standard
Wi-Fi protocol
802.11b/g/n
Onboard Grove expansion socket
UART2, I2C, 4x Analog input
Raspberry Pi port
Support Raspberry Pi 3A+, 4, 5 (need to install a 5-pin socket)
1
Programmable LED [1]
2
DC-DC chip
3
12 x PWM servo socket
4
MPU6050 gyroscope
5
Voice command Module
6
External EEPROM [2]
7
Grove Sockets (G1: UART2; G2: I2C; G3: 2x Analog input; G4: 2x Analog input)
8
Speaker
9
2.54mm Battery Input
10
Raspberry Pi port
11
ESP32 Mini
12
CH343P serial chip
13
BOOT button [3]
14
Reset button
15
8.4V Power indicator (Yellow LED)
16
5V power indicator (Blue LED)
17
Touch pad socket
Pin No.
Name
Usage
1
DTR
Modem signal DTR, reset NyBoard after serial download finished.
2
RX
ATMEGA328P RX (receive)
3
TX
ATMEGA328P TX (send)
4
5V
5V power for MCU and chips
5
GND
Ground
6
GND
Ground
Parameters
Settings
Builtin Led
2
Upload Speed
921600(Auto-negotiation during uploading, 115200 is too slow)
CPU Frequency
160MHz
Flash Size
4MB
Reset Method
DTR reset
lwIP variant
V2 Lower memory
Erase Flash
Only sketch
Usage
Command
Demo
Check BT module version
AT+VER
AT+VER
>+VER=JDY-23A-V2.21,Bluetooth V3.0+BLE
(BT module version infomation)
Check BT broadcast name
AT+NAME
AT+NAME
>+NAME=BITTLE
Change BT broadcast name
AT+NAME(name)
AT+NAMEPuppy
>+OK
AT+NAME
>+NAME=Puppy
Change BT BLE broadcast name
AT+NAMB(name)
AT+NAMBPuppy
>+OK
AT+NAMB
>+NAMB=Puppy
Check serial baud rate
AT+BAUD
AT+BAUD
>+BAUD=8 (8 = 115200, 7=57600)
Change serial baud rate
AT+BAUD
AT+BAUD7
>+OK (Set serial monitor to 57600)
AT+BAUD
>+BAUD=7
This chapter is divided into three subsections. The first subsection is model training, which explains how to train the model on the local computer or in the cloud and how to produce the dataset. In addition, we have implemented a DIY training function for the COCO dataset, which allows you to select any number of labels of interest for model training.
The second subsection is model quantization, which reduces the computational complexity of the model and makes it easier to deploy in embedded systems. Similarly, we consider the difference between local and cloud training models, which can be subjected to model quantization.
The third section is the model deployment. It explains how to download the model to Grove Vision AI V2 and implement the communication between it and the robot dog so that we have completed the learning of the whole process from model training to model deployment. We believe that through the detailed explanation in this chapter, you can learn how to deploy your favorite model on our robot dog and be amazed by its powerful functions.
If you encounter problems using the Grove Vision AI V2 module applied to Petoi robotic dogs, you can email sunkaiwei13791222268@gmail.com for a solution. We will reply to you ASAP!
The sensor features advanced gesture detection, proximity detection and digital ambient light sensing. Gesture detection can accurately sense "up, down, left and right" and more complex movements.
You can use the Firmware Uploader within the Petoi Desktop App.
You can use Arduino IDE to upload and modify the source code.
The code using this sensor has been integrated into the OpenCat project. Uncomment the line #define GESTURE
in the OpenCat.ino, as shown in the figure below, and then use the Arduino IDE to upload the sketch to the robot main board, which can reproduce the example function of integrating the robot action.
With NyBoard V1_*, you can choose Arduino Uno.
After uploading the sketch, connect to the NyBoard with wire, as shown in the following picture:
You can use the Firmware Uploader within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, open the serial monitor and use the serial command "XG" to switch to using the gesture sensor mode.
You can use Arduino IDE to upload the sketch(OpenCatEsp32.ino). Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, open the serial monitor and use the serial command "XG" to switch to using the gesture sensor mode.
For specific use, the end connected to the sensor can be fixed on the robot's head (included in Bittle's mouth or attached to the top of Nybble's head); of course, you can also use your creativity according to your needs.
If you want to test a gesture sensor's function alone or learn more about its principles. You can upload the demo sketch(ModuleTests/testGesture) using the Arduino IDE.
This testing sketch implements real-time printing of various directional gestures (up, down, left, and right) made by the user in front of the gesture sensor in the serial monitor.
Petoi AI Vision Module is based on the Arm Cortex-M55, and Ethos-U55 embedded vision module. The Ethos-U55 has 64 to 512 GOP/s of arithmetic power to meet the growing demand for downloading machine learning.
Fix the end connected to the camera to the robot's head (included in Bittle's / Bittle X's mouth or attached to Bittle X+Arm's robotic arm).
You can use the Firmware Uploader within the Petoi Desktop App.
Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, open the serial monitor and use the serial command "XC" to switch to using the camera mode.
Install the library ArduinoJson
Upload the sketch(OpenCatEsp32.ino).
Use the latest OpenCatESP32 source code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, open the serial monitor and use the serial command "XC" to switch to using the camera mode.
If the camera mode can't be activated, as following:
You can use the web debug GUI to upgrade the camera firmware and upload the Face Detection model.
To run the example code in the library Seeed_Arduino_SSCMA, you should add the library to your Arduino IDE by selecting Sketch > Include Library > Add .ZIP Library and choosing the downloaded file.
Or you can install the library in the Library Manager of the Arduino IDE as follows:
This sensor allows you to detect animals' movement, usually humans' movement within its detection range. Just connect it to the NyBoard and program it, and when anyone moves within its detection range, the sensor will output a high potential on its SIG pin.
You can use the Firmware Uploader within the Petoi Desktop App.
You can use Arduino IDE to upload and modify the source code.
The code using this sensor has been integrated into the OpenCat project. Uncomment the line #define PIR
in the OpenCat.ino, as shown in the figure below, and use the Arduino IDE to upload the sketch to the robot main board, which can reproduce the example function of integrating the robot action.
With NyBoard V1_*, you can choose Arduino Uno.
Connecting to the NyBoard with wire as shown in the following picture:
You can use the Firmware Uploader within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, open the serial monitor and use the serial command "XI" to switch to using the PIR motion sensor mode.
You can use Arduino IDE to upload the sketch(OpenCatEsp32.ino). Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, open the serial monitor and use the serial command "XI" to switch to using the PIR motion sensor mode.
For specific use, the end connected to the sensor can be fixed on the robot's head (included in Bittle's mouth or attached to the top of Nybble's head). Of course, you can also use your creativity to meet your needs.
If you want to test a PIR motion sensor's function alone or learn more about its principles. You can use the Arduino IDE to upload the demo sketch(test_Touch_Reflection_PIR.ino):
This demo sketch implements real-time printing of sensor detection results in the serial monitor - when anyone moves within its detection range, print 1; otherwise, print 0.
There are two ways to play a melody with the robot:
Using the Petoi Coding Blocks in Mind+.
Using the Serial Protocol in Mind+, Arduino IDE, Python, and the Petoi mobile app.
You can use this coding block to make one tone.
There are several ways to join multiple tones together to make a melody:
To better understand the format, you can continue reading the next section.
The melody starts with the letter 'b', indicating a buzzer command. (No quotation marks are needed in the final command).
Notes are represented by numbers, with 0 or -1 for silence. Use 1-35 for the best effect on a buzzer.
Durations are also numbers, indicating how many parts a whole second is divided into (e.g., 2 = 1/2 second). This plays a single middle C (C3 = 14) for 1/2 second with no delay:
The space between the starting 'b' and the first number can be omitted:
A note longer than 1 second can be represented by two notes:
A difference of 1 in note number represents a half-scale tone (semitone), while a difference of 2 represents a whole-scale tone. You can define any note as the base (e.g., middle C3 = 14). This sets the reference point for your melody. So D3 will be 16, E3 will be 18, F3 will be 19, G will be 21, A will be 23, B will be 25, and C4 will be 26. C4 - C3 = 12. That's the so-called 12-Tone Equal Temperament. You may write a map in the code for quick conversion.
You can define multiple note-duration pairs separated by spaces or commas. It's easier to read if you use spaces to separate the notes within a sentence and use commas to separate sentences.
For example:
The Serial Monitor uses ASCII encoding and only allows a short melody of around 200 bytes. b 14 4 takes six bytes to store.
Use brackets []
to define a list. The numbers should all be separated by ','. The above example becomes:
or
The Python version with the 'B' token uses a more efficient Binary encoding to allow a longer melody. On NyBoard, it allows around 450 bytes, i.e., 250 notes. On BiBoard, it allows around 2500 bytes, i.e. 1250 notes.
After playing the melody, you can add a number at the end to define an optional delay (in seconds).
Refer to the example to send it to the robot using Python.
Copy and paste the number part of the command, and separate each number with ',' as the example in section 1.
In this example, we'll use C3 (base tone 14). But you can choose any note within the 5-30 range.
Write down the sequence of notes you want to play, considering half- and whole-tone jumps. Use numbers based on your chosen base tone (14). Include silent notes (0) for pauses.
Decide how long each note should play. Use numbers to represent fractions of a second (e.g., 4 = 1/4 second).
Command with the 'b' token
B,14,4,14,4,21,4,21,4,23,4,23,4,21,2,0,4,19,4,19,4,18,4,18,4,16,4,16,4,14,2
or
You can also test the following examples:
Play around with tones and duration sequences to create your own melodies. For more complex pieces, there are online resources and software that can translate musical notation to this format. You may even write prompts to let AI generate a melody for you!
For example, using Gemini to give you a raw melody sequence to start with:
You may share your prompt, which works directly with our community, at www.petoi.camp.
Remember, this is just the beginning—have fun composing!
Bittle can be equipped with a robotic arm, which we will call it Bittle X+Arm. This arm has more functions than Bittle and can perform more complex skills, such as grabbing objects for display or moving them to different places.
When the robot arm is in motion, please do not put your hands between the robot claws to avoid being pinched.
This robot arm is already fully assembled. You only need to install the servo with the neck structure in the servo slot with two M2*5 self-tapping screws.
The robot arm must be finely calibrated to make it more precise when performing actions and to prevent the robot claw from jamming and overheating.
Then, install the battery and long-press the button on the battery to power the robot.
After the robot is powered on, there are two methods to enter the calibration state:
It will enter the calibration state automatically when you click the Joint Calibrator button.
Click the Calibrate button in the calibrator interface.
BiBoard_V1_*
The servo slider is not available in the interface's light yellow background area.
Click the corresponding slider track of the robot arm and adjust the robot arm by calibrating the posture as shown below:
"Pick up"
"Put it down"
"Hunt"
"Show off the object"
"Put away"
"Throw away"
"Shoot"
"Clap"
"Throw out"
Once you have finished recording your voice commands, say "Stop learning" to exit the custom voice command mode.
The meaning of the voice commands:
"Pick up": To pick up the object.
"Put it down": To put the object down.
"Hunt": To grab the object quickly.
"Show off the object": To show off the object.
"Put away": To put away the object.
"Throw away": To throw the object aside.
"Shoot": To throw the object forward.
"Clap": To clap the claw.
Throw out": To throw the object out.
For example:
The source code also needs to be modified. The sample demo code is being written, so stay tuned.
With deep learning networks can learn data features from large amounts of data, which can be applied to a variety of detection, segmentation tasks.
To use deep learning to solve specific problems, it is important to understand how to train a network model with known data. Therefore, we first explained how to train a deep-learning neural network. The content of this section is as follows:
Model training locally
Model training in the cloud
Make your training datasets
This subsection describes how to perform model training on a personal PC. You will need to have the following hardware:
A laptop or desktop computer with an NVIDIA graphics card and Windows installed (if your computer does not contain an NVIDIA graphics card, we recommend using the cloud for your model training).
Please install Anaconda software to manage your Python environment. There are three versions of Anaconda available for Windows, Max, and Linux; please choose the one that corresponds to your system.
Install VScode as your code editing software.
Use anaconda to create the environment we will use to train our model:
Open the Anaconda Prompt below
Enter the following commands to enter the work command, activate the environment, and open vscode (note that you replace the working directory and environment names with your corresponding names).
Enter the following command in Terminal:
When you're done, type
Uninstalling and installing the GPU-friendly version of Torch.
Before installing, please check the Cuda driver installed on your card and install pytorch and torchvision corresponding to the Cuda version. e.g., my cuda version is higher than 12.1, so I install
At this point, you have completed all the environment configurations required for model training, and you can happily train the model below 😊. To train the model, you need to execute the following commands:
Where model is the path to the model you need to train, the current Grove Vision V2 only supports the deployment of yolov8n.pt, so please choose yolov8n.pt. data is the path to the training set needed for model training, here we use a very small dataset as a test, later in this section we will explain how to create the training set for training. In addition, we have implemented custom partial label training for the coco dataset, which allows you to select specific labels for training according to your preferences and uses, enabling more flexible inference. imgsz is the image size accepted as input to the model, which must be 192. epochs is the number of times the model has been trained. In general, the more times it has been trained, the better the model fits the data.
At the end of the training, you can find your trained model at the location where the model is saved as shown on the command line (e.g. my model is saved at runs\detect\train3)
Unfortunately, if you don't have a computer with an NVIDIA graphics card, you can't train the model locally. However, you can train it in the cloud, and both training methods will give you the same model results. We use ultralytics for cloud model training. Below is the link to the Ultralytics HUB. Open the link, and you will see an introduction and tutorial on how to use it.
You need a GitHub, Google, or Apple account to use the Ultralytics HUB.
The ultralytics hub supports the training of users' own datasets. See the subsequent section for how to make and upload a dataset.
Set the Advanced Model Configuration. If you are using Google Colab for model training in the future, it is recommended to change the Epochs to 30 because although Google Colab is free, there is a time limit for using it, and 30 training is about 2 hours, which is just within the time limit. If we want to deploy the model on the Grove Vision V2 module, we also need to change the image size to 192, which is more in line with our actual application scenario. In addition, a Google mailbox is required to use Google Colab.
If you want to detect labels outside the open-source dataset, you need to make your own dataset. The dataset should include the images and the corresponding labels.
The following is the dataset format specified by yolov8
We use the Make Sense online data labeling tool to complete the training set production process:
For information on how to use Make Sense, see:
After labeling the dataset labels, you need to merge the image and label data to form a complete dataset. The dataset needs to meet the following format:
You need to copy the label data generated by Make Sense to the appropriate location. For example, if you tagged the labeled data for training, the images required for training should be located in images/train and the labeled data should be located in labels/train. Additionally, you need to write a dataset.yaml file. This file needs to be placed in the dataset directory with the contents of the file: (! (Note: the dataset.yaml naming should match the folder naming. Otherwise, you will encounter problems when uploading the dataset to ultralytics)
Names need to correspond to the labels used for Make Sense annotation. If you are training locally, it is recommended that you change the paths of train, val, and test to absolute paths, which is not required for training in the cloud. At this point, you are ready to train your model with the made dataset; just change the path from ‘data=coco128.yaml’ to dataset.yaml in your made dataset.
If you are training in the cloud, you must upload your dataset to the ultralytics hub. The upload process is very simple:
With your dataset in the Ultralytics HUB, you can now use your own dataset for model training.
In this section, we will learn how to upload the model to the hardware and complete communication with the Petoi robot dog.
Grove Vision AI V2 can be deployed via an online website, which itself has a rich resource of models for you to choose from, so in addition to training your own models you can also use the models directly from the website.
At the top of the page, you will see three columns titled: AI Models, Device Workspace, and About SenseCraft AI. click on Device Workspace and select Grove - Vision AI V2.
In the Models area, you can select models provided by SenseCraft AI or upload your own trained models.
It takes a little while to upload the model, so you will need to be patient.
In the preview section, you can observe the output results of the Grove Vision V2 's inference in real time, for example, it successfully detects cats after downloading the pet detection function.
In the ‘Device Logger’ section, the device sends real-time inspection data to the computer, and the data in the ‘Boxes’ section is:
Communicating with Petoi robot dogs using Grove Vision AI V2
You can use the Arduino IDE to modify our open source programme to use Grove Vision AI V2. Our programme integrates target tracking with Grove Vision AI V2. You only need to modify the code to enable this feature. For details on how to use it, see:
In addition, you can develop richer functionality using the APIs associated with the SSCMA library.
In the ‘Model Training’ section, we explained how to train a yolov8 model, but in order to deploy it on Grove Vision V2, we need to further quantify the model. This section is described below:
Model INT8 quantification
Model optimisation
First of all, we need to get the pt model file. In ‘Model Training’, I explained that we can get the trained pt model file through local training and cloud training.
Here's the translation:
Create a new environment using Anaconda (for example, you can name it petoi_convert_local
), and in the new environment, execute the following commands in sequence:
(! Note: We have used anaconda to create a new petoi_train_local environment in the model training section, while the petoi_convert_local environment and petoi_train_local environment used in this section are two different environments, and petoi_train_local environment must not be used for the following operations.)
Next, we need to quantify the model and execute it:
You will see a yolov8n_saved_model folder
in the current folder containing the yolov8n_full_integer_quant.tflite
model file.
Next, we will perform model optimization. If you are using a Windows computer, you need to install Microsoft C++ Build Tools. If you are a Mac or Linux user, you do not need to install it."
Execute:
Create vela_config.ini, copy the following to vela_config.ini
Execute in the terminal:
Replace ${Save path of the optimised model}
with the directory you want to output to.
Replace ${The path of the tflite model that needs to be optimised}
with the quantized model file you just got.
You will then get the model ending in ‘_vela’, which is the model file that can be used for deployment on Grove Vision V2.
This remote controller is a Micro: Bit-based gamepad. It includes a 4-direction joystick and four undefined buttons. To enhance the gaming experience, it is also paired with a buzzer and vibration motor. It is compact in appearance, comfortable in hand, and can be remotely controlled.
Micro: Bit V1 has a smaller memory. So, the full functionality requires Micro: Bit V2.
We recommend you use the Chrome browser.
Alternatively, you can click "New Project" and drag the program file into the coding window to load it.
Connect your PC to the Micro: Bit V2 using a USB cable.
After a successful connection, a disk drive named MICROBIT
is recognized on the computer.
Select BBC micro:bit CMSIS-DAP
in the pop-up window and then select Connect. At this point, our Micro: Bit has connected successfully.
Click to download the program.
Power on the robot. During the bootup, it can connect to the controller automatically via Bluetooth. If there are many remote controllers and robots, the connection is one-to-one and first-come-first-served.
This module integrates two IR distance sensors; it measures distance through reflected light waves and is used to detect the presence of an object within a specific range. The sensor comprises an IR LED and a photosensor (phototransistor) pair. The light emitted by the IR LED is reflected by any object placed in front of the sensor, and this reflection is detected by the photosensor(phototransistor). Any white (or lighter) colored surface reflects more than a black (or darker) colored surface. It is suitable for measuring complex objects, such as tracing an object.
Install the latest version of the Adafruit NeoPixel library using the Arduino IDE.
With NyBoard V1_*, you can choose Arduino Uno.
Connecting to the NyBoard with wire as shown in the following picture:
For specific use, the end connected to the sensor can be fixed on the robot's head (included in Bittle's mouth or attached to the top of Nybble's head). Of course, you can also use your creativity according to your needs.
If you want to test this sensor's function alone or learn more about its principles. You can use the Arduino IDE to upload the demo sketch(testDoubleInfraredDistance.ino) :
This section describes how to extract some of the labels and data from the COCO dataset for training using the scripting tool provided by Petoi.
Below is a brief description of the COCO dataset:
The COCO dataset is approximately 20GB in size, with a large amount of data and many labels, enabling detection of up to 80 different labels. However, this comes with a trade-off in detection accuracy. To meet users' needs for balancing the number of recognized categories and recognition accuracy in different scenarios, Petoi has implemented a way to recreate the dataset with any number of labels from the COCO dataset.
Copy the following code into a file named coco_download.py
. Place the script in the parent directory of the target location for the COCO dataset.
Execute:
python .\coco_download.py
If you find that there is no way to download the full COCO dataset due to unstable network or other reasons during the download process, then please download the COCO dataset manually and unzip the zip archive to the appropriate location.
The final dataset format is guaranteed to be:
The COCO DIY dataset is extracted using the following script, which can be named coco_remake.py
Before running the script, please change src_coco_path
to the path of COCO2017 and dst_coco_path
to the path of DIY_COCO dataset. Change src_yaml_file
to the path of the official COCO2017 YAML file and dst_yaml_file
to the path of the YAML file for DIY_COCO.
You can write the YAML file for DIY_COCO in the following style, where the labels need to be selected from the labels that already exist in the COCO dataset. But the order of the labels does not have to be the same as in the COCO dataset, they just need to be counted from 0.
This YAML file includes the paths to the train and val directories as well as the label order and corresponding labels. For local training, use absolute paths. For cloud training, this YAML file needs to be modified to the following format:
And, when training in the cloud, be sure to follow this organisation of the dataset below:
Combined with the steps in the Model Training section, you can train your own model based on the COCO DIY dataset!
If your dataset was downloaded manually, you will also need to download COCO.yaml
manually.The download link is below:
You may check a more detailed tutorial in the following post.
Let the robot be your Avatar!
In this tutorial, we will introduce how to use the Ailia in python language to implement an OpenCat robot to imitate various human body movements.
To clone or download the code from the GitHub repository, you can clone the code with the following command:
Requirements
Python 3.6 and later
Open the Anaconda Prompt (Windows) or the Terminal (Linux / macOS) and enter the following commands to create and activate a virtual environment (the environment name is "venv", and can also be customized to other names):
conda create --name venv
conda activate venv
Use the USB uploader or Bluetooth module to connect the robot and power it on. The computer needs to be connected to a camera device.
Run the following command to start the OpenCat Imitation program:
You can execute run.sh within OpenCat-Imitation/ with your shell command directly. It wraps up the above commands.
You may want to run the demo on a Jetson Nano to experiment with some GPU features.
The developer kit uses a microSD card as a boot device and for main storage. It’s important to have a card that’s fast and large enough for your projects; the minimum requirement is a 32GB UHS-1 card. Many projects with Jetson Nano 2GB Developer Kit will utilize swap space on the MicroSD Card due to only 2GB physical memory. For this reason, we recommend 64GB or larger microSD cards. High-endurance microSD cards are also recommended.
2. Use a network cable to connect the Jetson Nano development board to a router or other computer hosts so that it can access the Internet.
pip install -r requirements.txt
4. Install the relevant python library files using the following command:
To connect the USB uploader, you need to use the following command:
sudo usermod -a -G dialout $USER
to increase user rights.
Using this module, you can control the Petoi robot to do various skills through voice without using wake words. Currently, the module supports 40 fixed voice commands in two languages (English and Chinese) and ten customized commands by recording any sound clips.
The module can be installed on NyBoard via the Grove interface.
Connecting to the NyBoard with wire as shown in the following picture, connect to the NyBoard Grove interface, which includes D8, D9:
Petoi Desktop App
Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
Arduino IDE
Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, the firmware is in Voice mode by default. If you need to switch, please open the serial monitor and input the serial command XA
to switch to Voice mode.
When the robot is restarted, the voice module will be automatically reset to its default language setting. The robot's default language setting is English.
This feature is exclusively designed for robots using BiBoard as their mainboard.
There are two ways to set the default language:
Using the serial commands
To set the default language to English, use the command: XAa
.
To set it to Chinese, use the command: XAb
.
To set the default language to English, create a mobile app command called English and use the code: X65,97
.
To set it to Chinese, create a mobile app command called Chinese and use the code: X65,98
.
Using the voice commands
To set the default language to English, you need to say the voice command "Lizheng" (phonetic) first and then say "Bing-Bing" (phonetic).
To set it to Chinese, you need to say the voice command "Attention" first and then say "Di-Di"(phonetic).
To switch to English, you can say "Bing-Bing" (phonetic)
Switch to Chinese, you can say "Di-Di" (phonetic)
Note: Use this method after rebooting the robot. The language will switch to the default language setting. Therefore, if you accidentally switch the language mode, you can restore the default language setting by restarting the robot.
To turn on
Speak Play sound
To turn off
Speak Be quiet
You can refer to the list of available voice commands shown below:
To avoid inadvertently triggering the robot to respond to voice commands, you can say Be quiet to the robot to disable the voice module, such as when talking with others.
For example, you can share your behavior like this:
In some cases, the voice module may not respond to your voice. Please check the following:
1. On Bittle X, the dial switch on the bottom of the BiBoard extension hat is dialed to Voice Command.
2. Say Play sound to check if the robot responds with Do-Re-Mi. Sometimes, the voice may be accidentally set to muted mode triggered by Be Quiet.
3. If the module doesn't make any sound with Play sound, say Bing-Bing to switch to English mode. You may try different tones and speeds to say Bing-Bing. The robot should respond with Switch English if not in English mode. It won't react with anything if it's already in English.
4. If the voice module still doesn't make any sound, you can try to reset it in our software tools.
From version 1.2.0 of the mobile app, you can create a new button with the compound code:
^X65,99;!1000;X65,98;!1000;X65,97
To reset the voice module to English mode.
X65,97
or input XAa
in the serial monitor is equivalent to saying Bing-Bing, but excludes the chance that the voice is not recognized. Then you can try to say Play sound again.
From version 1.2.1, you can use the debugger tool to reset the voice module.
The above steps validate that the voice module is working. It's powered separately from the motion unit and should work regardless of the robot's status.
Next, if you say Hello, the robot should wave its hand and validate that the complete reaction loop is good. Then, you can try other voice commands.
Try powering off the mainboard by disconnecting the USB data cable, long-pressing the battery's button, and then re-powering the mainboard.
If the above steps cannot fix the problem, contact support@petoi.com for help.
When the robot works in English mode, you can speak Start learning (or input the serial command XAe in the serial monitor) into the custom voice command mode and record your voice commands in order.
You can record up to 10 voice commands, each with no more than six syllables.
To exit the custom voice command mode in the middle, you can speak Stop learning (or input the serial command XAf in the serial monitor).
After exiting the custom voice command mode, speak one of the recorded voice commands to trigger the reaction.
Speak Clear the learning data to delete all the recordings at once (you cannot delete a specific recording).
There are ten skill strings as custom replies already defined (but only the first five can see the actual reaction of the robot because they are predefined serial commands ) in the voice.h
:
The response actions (kpu1
means single-handed pushups, kmw
means moonwalk) are already defined in the program.
Other serial commands are also supported as responses, such as joint movements(e.g. m0 80 0 -80
means shaking the head left and right) and playing a melody(e.g. b14,8,14,8,21,8,21,8,23,8,23,8,21,4
)
To use these custom replies above, you need to enter the custom voice command mode, record ten voice commands (such as Single-handed Pushup, Shake Head, Moonwalk, Twinkle Star), and then exit the custom voice command mode.
If you have recorded a voice command and the corresponding custom reply is not a predefined serial command((e.g.,5th
), there is no actual demonstration effect; it only prints a simple message on the serial monitor when you speak the corresponding voice command.
Convert the voice command collected by the microphone in the module into a serial command.
Send the serial command to the mainboard MCU through the soft serial port Serial2.
After receiving the serial command, the MCU parses it into the corresponding skill command, and finally, the reaction module, according to the skill command, controls the robot to respond accordingly.
Upload the demo sketch testVoiceCommander.ino, and you can see every serial command that is sent to MCU(including the custom voice command if you have recorded it)
After you speak the voice command to the robot, the Returned value (X A 11
or X A 21 kup
) is the corresponding serial command sent to the mainboard MCU. The third number(11 or 21) is an invisible character. To understand it, we convert it to a numeric value and print it out.
There are seven related serial commands for configuration; you can input them into the serial monitor.
After inputting the command above in the message box, press Enter to send the command to the robot.
Using the task queue to create a sequence of motions, please refer to the source code in the voice.h
as below:
tQueue is the task queue defined in OpenCat.h; using the method "addTask" of this object, the robot can do some simple skills sequentially as a custom voice command response.
Modify voice.h to bind the customized voice command to the new skills: insert 'k'+the new skill name into the string variable(e.g.voice1[]
If you want to bind the first customized voice command )
NOTE: If you want to recover (upload) the OpenCatEsp32 firmware. You need to delete this library first.
In the , choose the model Bittle X+Arm, then click the Firmware Uploader button to upload the firmware for the robot with an arm.
You can use the to calibrate it.
You must connect the motherboard to the computer via a USB data cable or wireless.
BiBoard_V0_*
The joint index corresponding to the claw is 2. It can be auto-calibrated by pressing the Auto button or inputting the serial command "c-2" on the of Arduino IDE. You can also manually click the corresponding slider track and adjust the gear on the servo output shaft to the position shown in the figure above.
The robot program defaults to voice mode. Before controlling the robotic arm with voice commands, you must say "Start learning" to activate the custom voice command mode. Then, follow the voice prompts to in the following order to call predefined skill actions:
You can use the Perform robot arm skill block in the to do some pre-defined skills.
After connecting the motherboard to the computer via a USB data cable or wireless, you can use the following commands in the Arduino IDE
You can use the in the Petoi Desktop App to create new skills for the robot arm and them to the mobile app, the , or the .
This robot arm can be used in combination with other sensors. The installation method is shown in the figure below. e.g., adding the module:
.
This tool is used to compile a neural network model into an optimised version that can run on an embedded system containing an .
The Joystick's source code is now open-sourced. It can control Bittle X, Bittle X+Arm (Bittle with a robotic arm), and Nybble Q. For more information, please refer to our .
You can download the program file(), then import the program to as follows:
Click on the bottom left corner of the button, Select Connect Device
.
Click button.
Click
to the robot (mainboard type: BiBoard)
Install 2 x #7 AAA batteries and plug in the Micro: Bit V2 to the remote controller. Then power on the remote controller as follows:
After a successful Bluetooth connection, the robot automatically disconnects every 20 minutes (indicated by an hourglass animation on the LED matrix). To re-establish the Bluetooth connection, touch the Micro: Bit's logo (a touch button) and hold the controller vertically with the left joystick at the lower side, as shown in the figure: After a successful reconnection, you will hear a prompt tone, and the LED matrix will play an animated hourglass flowing reversely.
You can use the within the Petoi Desktop App.
You can use to upload and modify the source code.
The code using this sensor has been integrated into the project. Uncomment the line #define DOUBLE_INFRARED_DISTANCE
in the OpenCat.ino, as shown in the figure below, and use the Arduino IDE to upload the sketch to the robot main board. The sketch can reproduce the example function of integrating the robot action.
You can use the within the Petoi Desktop App. Please select the correct Product type, Borard version, and Serial port. The mode should be Standard, so press the Upgrade the Firmware button. for example, Bittle, BiBoard_V0_2, COM5 as follows:
After uploading, and use the serial command "XD" to switch to using the IR distance sensor mode.
You can use to (OpenCatEsp32.ino). Use the latest OpenCatESP32 code to finish the setup. For example, to modify the code for Bittle as shown below:
After uploading, open the and use the serial command "XD" to switch to using the IR distance sensor mode.
This demo sketch implements real-time printing of the analog values (rL, rR) and data that have been processed (dL,dR) of the two analog pins (A2 and A3 for NyBoard / 34 and 35 for BiBoard) in the . You can also use the serial plotter to view the two analog pins (A2 and A3 for NyBoard / 34 and 35 for BiBoard) more intuitively. The waveform graph is generated by the analog value of the pin output along the time axis.
It is recommended to install the IDE. For the specific installation method, please refer to the following link:
Follow to install the Ailia SDK, it will be used for pose detection. The guide mainly includes the following steps: download and install the ailia SDK and the related python library files.
When downloading the Ailia SDK, you need to enter the correct email address to receive the download link address and license file. The free license is valid for only one month. The SDK is about 2GB, so it takes time to download.
Move the downloaded license file (AILIA.lic) to the directory where bootstrap.py
is located ({ailia sdk directory}/python
), and then follow the steps to continue installing the Ailia SDK.
cd {ailia sdk directory}/python
python3 bootstrap.py
pip3 install .
Download the from this page () to the directory where bootstrap.py
is located before running the following command:
pip install -r requirements.txt.
It may take 30 minutes.
Please refer to to record the system image file () into the microSD card and complete the system initialization.
The system image file link in the user guide () points to JetPack 4.6.1, download and burn it to a microSD card After that, system initialization may fail when the Jetson Nano is started. So we recommend using the earlier version: JetPack 4.6.
3. Clone or download the code from , and install the Ailia SDK according to , the specific method is the same as the above step 3 in Run on the host computer, but NO need to execute the statement:
5. Connect the camera and complete its configuration by referring to .
Please refer to the technical documentation to complete the setup if you use a USB camera to complete the setup.
6. Start the program, please refer to step 4 and 5 of .
Now the OpenCat imitation program can run on the Jetson Nano development board. You can refer to other relevant technical documents to improve the program's performance, such as .
You can use the within the Petoi Desktop App.
You can use to upload and modify the source code.
The module code is integrated into the project. Uncomment the line #define VOICE
in the OpenCat.ino, as shown in the figure below. Then, use Arduino IDE to upload the sketch to the robot's main board. The robot will work in Voice mode. This sketch will allow the robot to behave under voice commands.
It is built into the as follows:
You can use the within the Petoi Desktop App.
You can use to (OpenCatEsp32.ino).
Open the :
In the :
Create called "Enable voice" and use the code: X65,99
Create called Disable voice and use the code: X65,100
See for the latest version.
If the above voice commands don't take effect in English mode, try to use the mobile app and create a new button with the code: X65,100
, or input XAd
in the to disable the voice module.
You can say Play sound to the robot to enable the voice module.
Use the mobile app and create a new button with the code: X65,99
, or input XAc
in the to enable the voice module.
The voice command Climb-up is a challenge for you. You can by yourself. Then, you can post it on the or email support@petoi.com. We may adopt it in our official firmware and send you a gift!
X65,99
, or input XAc
in the enables the voice module.
If the module is not in English mode, you can speak Bing-Bing (or input the serial command XAa
in the ) to switch to English mode.
You can open to check the raw return values of every voice command.
The test sketch is in the OpenCat repository on GitHub (specific path: OpenCat/ModuleTests/testVoiceCommander). You can visit our GitHub repository to download the complete code, as shown in the following picture:
For the robot in , to improve the utilization rate of custom voice control commands, you can modify the last six skill strings to the skill names with actual action responses.
Using and binding the customized voice command to the new skills
Use SkillComposer to design new skills and then them into InstinctX.h
pick
pickF
pickL
pickR
pickD
drop
dropF
dropL
dropR
dropD
put
putF
putL
putR
putD
toss
tossF
tossL
tossR
tossD = launch
hunt
showOff
clap
XAa
X65,97
Set the default language to English
XAb
X65,98
Set the default language to Chinese
XAc
X65,99
Turn on the reply tone and enable reaction
XAd
X65,100
Turn off the reply tone and disable reaction
XAe
X65,101
Enter custom voice command mode
XAf
X65,102
Exit custom voice command mode
XAg
X65,103
Delete all the custom voice commands
Robots can be precisely calibrated using the Petoi Desktop App.
After downloading the compressed file(.zip), please unzip it first.
Do NOT move the UI.exe to another location in Windows.
Make sure you have uploaded the OpenCat Main function firmware before calibrating. Only the software version 2.0 can calibrate the joints via this App.
For NyBoard, you need to connect the USB adapter and USB data cable or Bluetooth module (for NyBoard only ) to the computer, install the battery, and long-press the button on the battery to power the robot.
For BiBoard, the USB data cable connection for joint calibration must be made directly to the BiBoard and NOT to the outside charging port on the battery. You can also connect to the computer via Bluetooth.
After the robot is powered on, there are 2 methods to enter the calibration state:
It will enter the calibration state automatically when you click the Joint Calibrator button.
Click the Calibrate button in the calibrator interface.
Note: Since Nybble uses two more servos (head and tail) than Bittle, the joint index numbers of Nybble and Bittle servos are different, and the calibration poses of Nybble and Bittle after entering the calibration state are also different, as shown in the following picture( The servo slider is not available in the light yellow background area in the interface):
You need to install the battery and long-press the button on the battery to power the robot before installation.
In the calibration state, place the head as close to the central axis as possible and insert its servo shaft into the servo arm of the neck.
Press down on the head so it is firmly attached to the neck.
Install upper leg and lower leg components to the output teeth of the servos after the Bittle is powered on and in the calibrated neutral position. Please keep the torso, upper leg, and lower leg installed vertically as much as possible, and do not install the lower leg backward, as shown in the picture.
The pre-assembled robot should already have the legs properly installed. You can do the joint calibration for fine-tuning.
Use the included L-shaped tool as a reference during calibration. According to the index numbers of the joints shown at the top of the interface (when calibrating the servos, adjust the upper leg first, then adjust the lower leg). Drag the corresponding slider (below the index number), or click the blank part of the slider track to fine-tune the joint to right angles.
If the offset is more than +/- 9 degrees, you need to remove the corresponding leg and re-install it by rotating one tooth, and then drag the corresponding slider. For example, when it is adjusted to +9 and is still not right, remove the corresponding leg and shift one tooth when attaching it. Then you should get a smaller offset in the opposite direction.
You can switch between "Rest", "Stand up" and "Walk" to test the calibration effect.
If you want to continue calibrating, please click the Calibration button, and the robot will be in the calibration state again (all servos will move to the calibration position immediately).
Note:
You may need a second round of calibrations to achieve optimal results.
After calibration, remember to click the "Save" button to save the calibration offset. Otherwise, click the "Abort" button to abandon the calibration data. You can save the calibration in the middle in case your connection is interrupted.
When you close this window, there is a message box shown below:
If you want to save the calibration data, please click the "Yes" button; otherwise, click the "No" button. Click the "Cancel" button to cancel to quit.
After completing the joint calibration, install the center screws to fix the leg parts and servo gears.
After turning on Linux on the Chromebook, you can access the Linux environment via the terminal app.
Please follow the following steps to install the Arduino IDE:
Open the website (www.arduino.cc/en/software) and download the corresponding type of Legacy Arduino IDE:
After downloading complete, set the folder Downloads in the file browser to share with Linux, as mentioned above. Use the following commands to install the Arduino IDE, e.g., arduino-1.8.19-linux64.tar.xz is the downloading file.
You can open the Arduino IDE as follows:
For more details, please refer to Upload Sketch for NyBoard.
After using the USB uploader and USB data cable to connect the NyBoard and Chromebook, you will see a prompt: Please click Connect to Linux.
and check in the Settings interface, and it should be enabled as follows:
After downloading the project file OpenCat-main.zip from GitHub: https://github.com/PetoiCamp/OpenCat, use the following commands to unzip it to the Downloads folder.
For more details, please refer to Upload Sketch for BiBoard.
After using the USB data cable to connect the BiBoard and Chromebook, you will see a prompt: Please click Connect to Linux.
and check in the Settings interface, and it should be enabled as follows:
Use the following commands to install the library pyserial for uploading the sketch for BiBoard
After downloading the project file OpenCatEsp32-main.zip from GitHub: https://github.com/PetoiCamp/OpenCatEsp32, use the following commands to unzip it to the Downloads folder.
Give a man a fish and you feed him for a day; teach a man to fish and you feed him for a lifetime.
The simplest way to generate a skill array is to use the Skill Composer. It can stay after the power is off and rebooted. However, the skill exported by the Skill Composer is stored in temporary memory and will be overwritten by a new export, and you can not easily manage two new skills in that routine.
This chapter focuses on the code and data structure so that you can integrate any number of new skills into the source code.
Get familiar with uploading the firmware (Chapter 3 of the Nybble/Bittle User Manual), the assembly process (Chapter 4 of the Nybble/Bittle User Manual), and calibrating the servo (Chapter 6 of the Nybble/Bittle User Manual). Use an IR remote to verify that the following functions work as expected.
Press the button on the IR remote's 2nd row, 2nd column (as shown in the picture below). Later it will be expressed by (2, 2). You can also connect a USB adapter and enter the serial command "kbalance" in the serial monitor. The robot will stand up.
Press the (7, 3) button on the IR remote. You can also connect a USB adapter and enter the serial command "kzero" in the serial monitor. All the robot's servos are turned to the 0-degree position, the "Zero" skill (as shown in the figure below).
All skill arrays of the robot are defined in the Instinct***.h
file.
Nybble: InstinctNybble.h
Bittle: InstinctBittle.h
Here is an abbreviated example of an Instinct***.h
file:
The meaning of the data structure of the skill array is shown in the figure below:
The 1st element in the skill array indicates the total number of all action frames contained in the skill. If there is a minus sign (-) before the value, it means that the skill is a behavior.
In the above data structure figure, the rest is a posture. It has only 1 action frame (1 row of data).
The crF (Crawl forward) is a gait. It contains 36 action frames (36 rows of data).
The 2nd and 3rd elements in the skill array represent the expected value of the body direction, that is, the inclination angle of the robot's body when performing skill actions, corresponding to the body's roll angle (Roll) and pitch angle (Pitch), respectively. When the robot performs a skill action, if the body tilt deviates from the expected value, the balance algorithm will adjust the angle value of the relevant leg servos to keep the body tilt as close as possible to the expected value.
The robot's pitch angle (Pitch) and roll angle (Roll) shown in the figure above are both at 0 degrees. In the picture on the left, the robot body rotates counterclockwise from the 0-degree position around the center point, and the pitch angle is positive; when it rotates clockwise, the pitch angle is negative. In the picture on the right, the robot body rotates counterclockwise from the 0-degree position around the center point, and the roll angle is positive; when it rotates clockwise, the roll angle is negative.
Take a look at the following sample code, standing:
Sitting:
The 2nd and 3rd elements in the array represent the expected value of the body direction (corresponding to the roll angle and pitch angle of the body), and the unit is degree.
When the gyroscope is activated, Bittle's body is slightly rotated, and when the body tilts away from the expected value of the body direction, the balance algorithm will keep the body in this posture as much as possible.
The index numbers of the servo are shown in the figure below:
Please control the rotation angle range of the joint servo between [-125~125]. For the leg servo, when viewed from the left side of the robot, the leg rotates counterclockwise from the 0-degree position around the joint center point (the screw fixing position), the angle is a positive value; clockwise rotation, the angle is a negative value; viewed from the right side of the robot, the leg rotation angle is mirror-symmetrical to the left side (rotating clockwise from the 0-degree position around the joint center point, the angle is a positive value; Rotate counterclockwise, the angle is negative). For the robot's neck servo, looking down from the top of the robot's head, the neck rotates counterclockwise from the position of 0 degrees around the joint center point (the position where the screw is fixed), and the angle is a positive value; when it rotates clockwise, the angle is a negative value.
For the Nybble head servo (No. 1 servo) observed on the right side of the robot, the head rotates counterclockwise from the 0-degree position around the joint center point (screw fixed position), and the angle is positive; when it rotates clockwise, the angle is negative.
For the Nybble tail servo (No. 2 servo) facing the tail and looking down, the tail rotates counterclockwise from the 0-degree position around the center point (screw fixing position), and the angle is positive; when it rotates clockwise, the angle is negative.
Each action frame in the skill array contains the rotation angle values of multiple servos.
In the above data structure figure, the rest action frame contains 16 joint servo angle values, and the corresponding servo index numbers are arranged from small to large starting from 0.
Each action frame in the crF (crawling forward) contains 8 joint servo angle values, and the corresponding servo index numbers are arranged from small to large, starting from 8.
The 4th element in the skill array represents the angle ratio. The angle ratio value can be increased when it is necessary to store angle values outside the range of -128 to 127. For example, if the angle ratio is set to 2, the angle value of all joint servos in the skill array multiplied by 2 is the actual rotation angle of the servo.
Take a look at the following example skill array rc (return to standing after being on all fours):
The 4th element (2) in the array represents the angle ratio. This means that the actual angle value of all joint rotations is equal to the angle value of each joint in the array (starting from the 8th element) multiplied by this angle ratio.
The posture array contains only one action frame. Taking Bittle as an example, find the zero posture array in InstinctBittle.h
:
Modify some of the joint servo angle values:
Save the modification and upload the main function program OpenCat.ino to the Bittle mainboard. After the upload is complete, click the button (7, 3) on the IR remote to see the modified zero skill, and the new posture is shown in the figure below:
The first element (1) in the array represents the total number of frames of the skill, and 1 means it is a posture skill.
The 4th element (1) in the array represents the angle ratio. This means all index joint angles below are actual angles (because each is multiplied by 1).
The 5th to 20th elements in the array represent the respective angle values of the 16 joints in the current frame.
For Bittle, the 5th element in the array (70, corresponding to the No.0 servo) means that the servo on Bittle's neck rotates 70 degrees counterclockwise. Bittle's head turned to the left side of the body.
The 13th element in the array (-60, corresponding to No.8 servo) indicates that Bittle's left front thigh rotates 60 degrees clockwise around the joint center point.
The 17th element in the array (60, corresponding to No.12 servo) indicates that Bittle's left front calf rotates 60 degrees counterclockwise around the center of the joint.
The other joint angles remain unchanged at 0 degrees.
The gait array contains multiple coherent action frames executed repeatedly in a sequential cycle. Unless the robot receives a new skill command, it will continue executing. For example, the bk (walk backward) gait array is defined as follows:
The 1st element in the array (35) means the skill has 35 action frames. Starting from the second line of data, each line is an action frame, which contains the angle values of 8 joint servos, and the corresponding servo index numbers are arranged from small to large, starting from 8 (a total of 35 lines).
For gait skills, each action frame in the future may contain 12 joint servo angle values, and the corresponding servo index numbers will be arranged from small to large, starting from 4, depending on the number of leg servos participating in the movement.
The behavior array also contains multiple coherent action frames, and all the action frames are only executed for one round in order, but some of the continuous action frames can be executed multiple times in a loop. For example, the pu(push-up) behavior array is defined as follows:
This data structure contains more information than pose and gait:
The meanings of the 4 elements in line 1 are as mentioned above, and the first element (total number of frames) is a negative number, indicating that this skill is a behavior.
The 3 elements in line 2 indicate the loop structure contained in this behavior: start frame, end frame, and loop times:
6, 7, 3 in the example means that this behavior is executed 3 times from the 7th frame to the 8th frame (the frame index number starts from 0). The motion sequence of the entire behavior is performed in one round rather than in a continuous loop-like gait.
Each action frame contains 20 elements. The first 16 elements represent the angles of the joint servos as mentioned above, and the corresponding servo index numbers are arranged from small to large, starting from 0. The last 4 elements have the following meanings:
The 1st represents the speed factor. The default speed factor is 4, which can be changed to an integer from 1 (slow) to 127 (fast). Units are degrees per step. If set to 0, the servo will rotate to the target angle at maximum speed (about 0.07 seconds/60 degrees). Values greater than 10 are not recommended unless you understand the risks.
The 2nd represents the delay time. The default delay is 0. The range that can be set is 0 to 127, and the unit is 50 milliseconds (if it is set to 2, the actual delay is 100 milliseconds).
The 3rd represents the trigger axis. It sets the body rotation direction when the robot triggers the next action frame. There are the following 5 setting options:
0 means there is no trigger axis, and the trigger angle condition setting
1 means positive pitch, the robot body is bent forward and rotated in the downward direction
-1 means negative pitch, the robot body rotates backward
2 indicates positive roll, the robot rolls to its left side
-2 means negative roll, the robot rolls to its right side
The 4th represents the trigger angle. Angle values have the same positive and negative meanings as body orientation expectations. Trigger angle setting range: an integer value between -125 and 125.
Note:
The trigger axis and trigger angle need to be used together: only when the robot completes the frame of motion and rotates by the set body rotation direction to exceed the trigger angle, the next frame of motion will be triggered. The trigger angle is meaningless if the trigger axis is set to 0. Therefore, when the trigger axis is set to 0, the trigger angle is generally also set to 0.
If a delay time is also set in the action frame, then when the robot runs this action frame, it must not only meet the trigger conditions set by the trigger axis and trigger angle but also reach the delay setting time before triggering the next frame of action.
The erasing and writing times of EEPROM are limited (1,000,000 times). To minimize write operations, two skills are defined: Instinct and Newbility. Their addresses are stored in the built-in EEPROM (1KB) of the chip (ATmega328P) as a lookup table, but the data of the main body exists in different storage units:
I2C EEPROM (8KB) memory Instincts. Instincts are fixed skills (or occasional fine-tuning), which can be compared to "muscle memory".
Flash (shares 32KB storage space with Arduino program code) Storage Newbilities. Newbilities refer to user-defined skills (possibly modified, added, or deleted). They will not be written into the static EERPOM but uploaded to the flash memory (Flash) together with the Arduino program code. Their addresses are assigned in real-time when the code is executed, and this value rarely changes as long as the total number of skills (including all instincts and newbilities) remains the same.
The specific sample code is as follows:
Add a suffix to each skill array name in the character pointer array skillNameWithType, "N" means Newbility, and "I" means Instinct.
const char* progmemPointer[] = {crF, pu, rest, zero, };
This part of the code is active when uploading the configuration mode sketch. It contains data and pointers for all abilities.
const char* progmemPointer[] = {zero};
This part of the code is active when uploading the major functionalities sketch. Since the instincts are already saved in the external I2C EEPROM, their data is omitted here to save space. If you only need to adjust the actions of existing new skills (such as zero
), you don't need to re-upload the configuration mode sketch.
The following two methods can be used when authoring or debugging skill actions:
Control the robot to make actions by Python scripts. For details, please refer to the serialMaster User Guide.
Use the Skill Composer in the Desktop App to control the robot to do actions, and then use the "Export the skill" function to copy and paste the contents of the debugged skill array to the Instinct***.h
file for use. Please refer to the data structure for the specific format.
This GitHub repo is a good starting point if you want to develop a customized gait. If you are going to do some inverse kinematics calculations, you may use the following key dimensions to build your model:
The "SkillLibrary" folder in GitHub repo is a collection of new skills that OpenCat robots can perform, which can be used for your reference.
You are also welcome to share your new skills by sending merge requests to this folder.
Another direction is to set up a simulation for Bittle and then test the model in reality. You may use this Unified Robot Description Format (URDF) file for Bittle to set up an NVIDIA Omniverse simulation.
To add a new skill(testI) array ending with I, you need to add the skill array variable name (test) to the first branch of the sample code macro judgment. The specific code modification is as follows:
To add a new skill(testN) array ending with N, you need to add the skill array variable name (test) to both branches of the sample code macro judgment. The specific code modification is as follows:
After the code modification, please upload the sketch to the mainboard. For more details, please refer to:
Open Arduino IDE serial monitor and you can see the following prompt:
After inputting 'Y' or 'n', all instinct arrays will be stored in the I2C EEPROM at one time, and the index addresses of all skills will also be generated and stored in the built-in EERPOM of the chip, and then upload the major functionalities sketch. Please refer to the relevant chapters in uploading the sketch to the mainboard for the detailed operation processes.
When verifying the skill action, you can open the serial monitor and call through the serial port command with 'k' token. For example, Bittle can transform into a sitting posture by "ksit".
By adding some extensible modules (such as a gesture sensor), it can help the robot to better perceive the environment and even make decisions. By accumulating these automatic behaviors and designing a decision tree, the robot's fully automatic intelligent operation is finally realized!