Skip to content
NickLDPublic

About

CR-BYOB (Bring-Your-Own-Bridge) is a DIY Scan Bridge for Creality 3D scanners, running on an Android phone (unofficial/community)

Topics

Resources

Stars

19 stars

Watchers

2 watching

Forks

Latest commit

 

History

16 Commits

Folders and files

Repository files navigation

CR-BYOB logo

CR-BYOB

Bring-Your-Own-Bridge for Creality 3D scanners

Turn an Android phone into a DIY Scan Bridge. Plug the scanner into the phone, and Creality Scan on your PC finds it over the network like the real thing.

Latest release Android 8.0+ License: MIT Ko-fi

Download  ·  Quick start  ·  Supported devices  ·  Using the app

Dashboard while streaming    Mirror viewer during a scan

Note

Unofficial project. CR-BYOB is a community project. It is not affiliated with, endorsed by or supported by Creality or Orbbec. "Creality", "CR-Scan", "Otter" and "Creality Scan" are trademarks of their owners and are used here only to describe compatibility. Use it at your own risk.

Features

  • Works with Creality Scan as it is. The PC discovers the phone the same way it discovers a Scan Bridge. Nothing to install on the PC.
  • Four ways to connect: Ethernet, Wi-Fi Direct, your home Wi-Fi, or this phone only.
  • No PC needed if you want. This phone only (Local Mobile App Scanning) feeds the CrealityScan app on the same phone.
  • Mirror viewer. Creality Scan's color, IR and 3D views on the phone, with Start, Pause, Finish and Delete, new-scan setup, fill light and exposure, and Creality Scan's messages and pop-ups.
  • Up to 30 fps (experimental). Creality Scan asks a Scan Bridge for 15 fps from an Otter; the frame-rate override gets 20 or 30 on a fast link, with nothing changed in Creality Scan.
  • Live dashboard. Scanner and power status, per-stream frame rates, link quality and session statistics.
  • Updates from GitHub Releases, downloaded and installed inside the app, with release notes after each update.

Scanning a die grinder with a CR-Scan Otter and a phone running CR-BYOB, in a workshop   A CR-Scan Otter, power bank, USB-C hub and phone mounted on a 3D-printed grip
Left: scanning a die grinder in a detached workshop, a separate building from the scanning PC, over a shared network. All three streams run at the full 15 fps. Right: the handheld rig, with the Otter, a power bank, a USB-C hub and the phone on a 3D-printed grip (parts and model).

Scanning an armchair with a CR-Scan Otter on a grip, the phone showing the mirror viewer in landscape
Scanning an armchair over home Wi-Fi 7 with the frame-rate override on Max: all three streams at about 30 fps. The mirror viewer shows Creality Scan's 3D, color and IR views, the scan controls, and the Wi-Fi link.

The four connection choices   Session statistics
Left: pick where the bridge runs. Right: session statistics, with data sent, bitrate and frame delivery per stream.

Supported devices

Scanners

Scanner Status
CR-Scan Otter ✅ Tested
CR-Scan Otter Lite, Otter Lite Basic ❔ Untested (same design as the Otter)
CR-Scan Raptor, Raptor X, Raptor Pro, Raptor Pro Max ❔ Untested
CR-Scan Ferret Pro ✅ Tested (fw 1.2.7, device report by @Xalies)
CR-Scan Ferret ❔ Untested (same design as the Ferret Pro)
Sermoon X1, Sermoon S1 ❔ Untested
Sermoon P1, Sermoon P1 Lite, Creality Pika ❌ Not supported (self-contained wireless scanners: they don't work through a Scan Bridge)

Tip

Have an untested scanner? Please try it and file a Device report, whether it works or not. That's how scanners move from untested to supported.

Phones

Any Android 8+ phone with USB host (OTG) support and a USB 3 port should work. USB 3 is required: the scanner's streams need more bandwidth than USB 2 provides.

Phone Android Ethernet Wi-Fi Wi-Fi Direct This phone only (Local Mobile App Scanning) Reported by
Google Pixel 10 Pro XL 16 ✅ ✅ ✅ ✅ @NickLD
Google Pixel 6 17 — ✅ ✅ — @Xalies
Google Pixel 5 14 ✅ 🟡 🟡 ⚠️ @NickLD
Samsung Galaxy S23 Ultra 16 — — — ✅ @lihomanovdv
Samsung Galaxy Z Flip 8 17 — ✅ — — @SelfMadeDiesel

✅ Full performance  ·  🟡 Works, with limits  ·  ⚠️ Not recommended  ·  — Not tested  ·  Notes per phone

Tip

Tested CR-BYOB on your phone? File a Device report and say which connections you tried, whether it worked well, poorly or not at all. Your phone gets added to this table, credited to your GitHub username.

Choosing a connection

With a CR-Scan Otter at full rate the bridge sends about 265 Mbit/s (other scanners differ; higher-resolution ones need more), so the link matters more than the phone.

Connection Best for What you need
Ethernet The most reliable link A powered USB-C hub with a Gigabit Ethernet port (100 Mbit is too slow), cabled to the router or switch your PC is on
Wi-Fi Direct No router involved Phone and PC with Wi-Fi 5 (802.11ac) or newer on 5 GHz, in the same room. Wi-Fi 6 or newer is better
Home Wi-Fi Convenience A Wi-Fi 5 or newer router on 5 GHz, with the phone close to it. On 2.4 GHz or a weak signal the frame rate drops
This phone only (Local Mobile App Scanning) Scanning without a PC Nothing: the video never leaves the phone

One powered USB-C hub with Gigabit Ethernet covers it all: the scanner's USB 3 port, charging, and the wired link. Thin, flat Ethernet cables are cheap and easy to route.

Quick start

You need the scanner, an Android phone with a USB 3 port, and a USB 3 hub with power passthrough so the scanner doesn't run on the phone's battery.

flowchart LR
    PWR["Power supply"] -- "USB-C PD" --> H["Powered USB 3 hub"]
    S["Creality scanner"] -- "USB 3" --> H
    H <-- "USB-C<br/>(data + charging)" --> P["Android phone<br/>running CR-BYOB"]
    H -. "Gigabit Ethernet<br/>(optional)" .-> PC["Creality Scan<br/>on your PC"]
    P -- "Wi-Fi or<br/>Wi-Fi Direct" --> PC
    P -. "This phone only<br/>(Local Mobile App Scanning)" .-> M["CrealityScan app<br/>on the same phone"]
Loading

A CR-Scan Otter plugged into a USB hub on an Android phone, a power bank powering the hub, and Creality Scan running on a laptop
A real setup, scanning the laptop on the left: the Otter goes into a USB 3 hub on the phone, a power bank powers both, and Creality Scan on the right laptop sees the bridge over the network.

  1. Download CR-BYOB-<version>-github.apk from Releases and install it.
  2. Open CR-BYOB, allow the permissions it explains, and plug in the scanner.
  3. Pick a connection (which one?) and tap Start. For Wi-Fi Direct, join the network shown in the app from the PC's Wi-Fi menu, like any Wi-Fi network. Creality Scan's own Wi-Fi list won't show it (why). Once the PC is on it, the bridge shows up in Creality Scan by itself.
  4. Start Creality Scan on the PC (or CrealityScan on the phone). The bridge shows up like a Scan Bridge.

More in Using the app.

Security

Important

Like the device it replaces, the bridge's network services have no authentication: anyone on the same network or Wi-Fi Direct group can view the streams and send control commands. Use it on networks you trust, or choose This phone only, where only apps on the phone itself can reach it.

Documentation

Support

CR-BYOB is free. If it saved you buying a Scan Bridge and you'd like to say thanks:

ko-fi

License

MIT

About

CR-BYOB (Bring-Your-Own-Bridge) is a DIY Scan Bridge for Creality 3D scanners, running on an Android phone (unofficial/community)

Topics

Resources

Stars

19 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages