OpenScan3 Firmware: Quick Start & Troubleshooting

This post explains how to get started with OpenScan3 and covers the most common setup issues during installation and first boot.

Install OpenScan3 with Raspberry Pi Imager

The easiest way to install OpenScan3 is with Raspberry Pi Imager using the OpenScan image repository.

Note: Advanced customization such as hostname, username, password, and Wi-Fi is confirmed to work with Raspberry Pi Imager version 2.x. Older versions may not apply these settings correctly.

1. Open Raspberry Pi Imager.
2. Click ADD OPTIONS.
3. Select EDIT Content Repository.
4. Choose Use custom URL and enter: https://openscan.eu/rpi-repo.json
5. Click Apply and restart.
6. Select your Raspberry Pi model.
7. Choose the image matching your camera variant.

Important: Make sure to select the image that matches your camera model. Using the wrong image may prevent the camera from working properly and can potentially damage hardware.

1. Select the storage device you want to flash.
2. Adjust settings such as hostname, username, password, and Wi-Fi if needed.
3. Write the image to the card.
4. Insert the card into the Raspberry Pi and power it on.

Open the web interface

If you did not change the default hostname during flashing, you should be able to access the OpenScan3 web interface from another device in the same network at:

• http://openscan/
• http://openscan.local/ if mDNS is available on your network

The API documentation is available at:

• http://openscan/api/latest/docs
• or http://openscan.local/api/latest/docs

Run the setup wizard

After connecting to the web interface for the first time, you will see the dashboard with a notice that the device still needs to be configured.

Follow the setup wizard to complete the initial setup of your scanner.

No Wi-Fi configured? Use Wi-Fi QR setup

If you did not configure Wi-Fi during flashing and do not want to connect the device via Ethernet, you can provide Wi-Fi credentials using a QR code shown to the camera.

1. Create a Wi-Fi QR code on your Android or iOS device.
2. Hold the phone in front of the camera.
3. The device will read the Wi-Fi credentials and try to connect to your network.
4. Once connected, you should be able to open the web interface using the hostnames above.

Troubleshooting

I cannot reach the device

Make sure the Raspberry Pi has finished booting and is connected to the same network as your computer or phone.

If you configured a custom hostname during flashing, use that hostname instead of openscan.

If http://openscan/ does not work, try:

• http://openscan.local/
• the device IP address from your router or network scanner

If you did not configure Wi-Fi and are not connected via Ethernet, use the Wi-Fi QR setup described above.

The device does not detect the camera

First, check that the camera cable is connected correctly and inserted in the proper orientation.

Also make sure that you flashed the image matching your camera model.

For more detailed diagnostics, you can check the camera report here:

http://openscan.local/api/latest/develop/camera-report?format=text

You may also want to inspect the system logs for additional clues.

If the issue persists, feel free to open an issue on GitHub or ask for help on Discord.

I cannot SSH into the device

Most likely, no user account was created during the flashing process.

By default, the standard OpenScan3 images do not include a default login. The exception is the develop image, which is intended for development and testing.

Also note that if you used an older Raspberry Pi Imager version, customization settings such as user creation may not have been applied correctly.

In that case, reflash the card with a current Raspberry Pi Imager version and make sure to configure a user during setup.

Need help?

If you get stuck, you can always:

• open an issue on GitHub
• ask for help on our Discord Server