Reporting an issue on GitHub

When something in the software does not work — on the robot, or while you develop with the SDK or the simulator — this is how to report it on RainbowRobotics/RBQ issues as "this does not work, please take a look". The first step comes before you write anything: check again on the latest nightly.

Where to file

What you have	Where it goes
Software that does not work on the robot, app, SDK or simulator	GitHub Issues — this page
A question about usage, settings or specifications	GitHub Discussions
A fault that needs inspection or repair	A/S support request
Anything that must not be public (private · business · licensing)	rbq.support@rainbow-robotics.com

⚠ Anyone can read an issue

The repository is public, so everything you post and attach is public too. Do not post customer or site details, passwords, or photos and videos with people in them. Send that kind of material to the email above.

1. Check again on the latest nightly

Issues are checked against the latest nightly. A nightly comes out every night with every fix made up to that day, so a problem you hit on the stable release may already be fixed. Bring the app and the robot — and the SDK or simulator, if you use them — up to the latest nightly, repeat the same steps, and report only what still fails.

The app

Install the nightly app from the nightly docs' Downloads page: RBQ Nightly on Android and on Linux · Steam Deck, the TestFlight beta on iPhone and iPad.

If it is already installed, look at the GUI Version line under Update → Software update. If an update button shows, press it to bring the app up to date; if it reads You're on the latest version, you are set.

Robot software

In the nightly app, Update → Software update lists nightly builds only. Download the build marked Latest, send it with Send robot software, and reboot with the robot sitting down. The steps and cautions are on Software Update.

Without the app, pick the (nightly) entry on the Software card of the robot's web UI Dashboard and press Update.

SDK · simulator

The repository's nightly branch is the same source as the latest nightly. Use the commands below instead of the git clone in the C++ · Python · ROS 2 quick starts; the remaining steps are the same.

git clone -b nightly --single-branch https://github.com/RainbowRobotics/RBQ.git RBQ-nightly
cd RBQ-nightly

The nightly branch is recreated every night with no earlier history, so git pull fails on it. Bring a folder you already have up to date with the two lines below, then run the quick start's build steps again.

git fetch origin nightly
git checkout -B nightly origin/nightly

⚠ If the robot is in field use

Nightlies do not go through release verification (Stable and nightly). To put the robot back into field use after you have checked, return it to the stable release with Version rollback.

2. Write down the versions

A nightly version ends in -nightly.<8-character commit>, so that one string pins the exact build. The app and robot versions are both on the Update → Software update screen.

What to write	Where to read it
App version	The GUI Version line. The NIGHTLY badge must be there for it to be the nightly app
Robot version	Version on the Current robot card
Do the app and robot match	Matches robot or Differs from robot next to the GUI Version line
SDK · simulator version (if you use them)	The version: line at the top of nightly.txt in the cloned folder

3. Write the issue

Opening a new issue gives you an empty editor (you need a GitHub account). Put what does not work in the title in one line, then copy the block below into the body and fill it in. Korean or English is fine. If you have several problems, file one issue for each.

[What does not work]
One line. (e.g. The robot collapses about 3 s after switching to WALK)

[Versions — latest nightly]
App: v1.2609.0-nightly.b5635a91 (NIGHTLY)
Robot: 1.2609.0-nightly.b5635a91 (Matches robot)
SDK · simulator: v1.2609.0-nightly.b5635a91 (if used, nightly.txt)
On an earlier version: worked (last good v1.2609.0) / same problem / don't know

[Environment]
Real robot / simulator (MuJoCo · Gazebo)
App on: Android · iPhone/iPad · Linux · Steam Deck · web UI
SDK: C++ · Python · ROS 2 (if used)

[Steps]
1. Robot on level ground, auto start completed
2. STAND → WALK
3. Push the left joystick forward

[Expected]
The robot walks forward.

[Actual]
It collapses about 3 s later. App log shows:
[ERROR] ...

[How often]
8 times out of 10

[Attached]
Black Box zip, screenshots, the code that fails (SDK)

⚠ Paste error messages verbatim

Do not summarize or retype an error message. A few characters' difference is enough to make it unfindable. Copy the line as it appeared, even if it is long.

Drag files into the editor to attach them.

• Black Box zip — the most useful thing for anything momentary, such as a fall or an emergency stop. How to make one is in Black Box zip.
• System log — download it as in System log and zip it.
• SDK code — cut the failing part down to a few lines and paste it as a code block.
• Walking problems — also give the payload you have fitted and the values entered in the app (The payload you have fitted).

4. After you file

• Replies come as comments on the issue. If more detail is asked for, add it as a comment on the same issue rather than opening a new one.
• Once it is fixed, the issue is told which nightly carries the fix and is closed. The fix is also in the next stable release.
• If that nightly still shows the problem, file a new issue and include the earlier issue number (#number).
• If the team decides not to change it, the issue is told so and closed.

See also

• Requesting support (C/S · A/S) — usage questions, repairs, and making logs to attach
• Software Update — checking and updating the app and robot versions
• Stable and nightly — how the two channels differ
• Version rollback — going back to stable