Releases: OpenScan-org/OpenScan3
v0.11.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Changes
Firmware
- API version 0.9 with:
- enhanced configuration management with clear model
ScannerDeviceConfig photoendpoint supports different formats and can now deliver metadata- new endpoints to configure firmware settings (e.g. wifi qr code scanner Task startup behavior)
- new endpoint
camera-reportindeveloprouter for diagnosing camera issues - new endpoint to cleanly delete cloud credentials
- extended status for Endstops
- enhanced configuration management with clear model
- Improved camera detection routine.
- Fixes a logging bug when capturing dng format with picamera2
- Wifi QR Code Scanner Task is now disabled when LAN is connected
- Drops support for legacy API versions v0.6 and v0.7
Frontend
- Dynamicly support different API versions in the frontend.
- Settings Page (API v0.9):
- Add endstop setting section.
- Add firmware setting section.
- Possibility to add new motors, endstops and lights and redetect cameras.
- Add download button for a camera report for diagnosing camera-related issues.
- Improve the handling of cloud tokens and fix falsely reported token status errors.
- Adds bulk dismiss action to cancelled/errored tasks in task drawer.
This release can be safely updated from the previous version v0.10 using the updater.
v0.10.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Firmware
- Wifi QR Code Scanner: if not already connected to wifi, the scanner will watch out for qr-codes containing wifi configuration (seems to work with Android & iOS, feedback is appreciated!)
- Motors report a
calibratedflag and can now be recalibrated using endstops via API
smaller changes:
- fix(scan_task): other formats than jpeg work again
- fix(device): (re)initialization now works as intended
Frontend
- Improved motor control toolbar, allowing automatic endstop rotor calibration
- Improved initial setup wizard, allowing manual and automatic endstop rotor position calibration
- Improved the layout of the about page and added a sponsor section
- Improved settings page and add motor controls and show motor angular position
Images
- new: compatibility with Raspberry Pi Imager v2 when using our repository (see below)
- BREAKING: Switch most of the permission handling for the openscan system user to polkit from sudo (will break e.g. shutdown and reboot on older images)
- only on develop images: enabled SSH and login for openscan user with default password
openscan(This is obviously a great security risk, but we're all adults here, eh?) -> Only use the develop images if you know what you are doing
It is recommended to grab a fresh copy of the images to get the latest changes, especially regarding the permission changes and qr-code wifi setup.
Refer to the Documentation for instructions on flashing the image and getting started.
Download the image for your camera below or use our Dropbox mirror.
New: Using the Raspberry Pi Imager v2
To use customization options and download the firmware images you can now point your Raspberry Pi Imager to our repository URL: https://openscan.eu/rpi-repo.json. You can set custom URLs if you click "Add Options" -> "Edit" Content Repository.
Setting up a new user, enabling SSH and setting up wifi seem to work well with Imager v2.0.6.
Note on Raspberry Pi Imager v1.x
The OpenScan3 images are built on top of Raspbian Lite Trixie, which is not supported by earlier Raspberry Pi Imager versions (see here).
However, using imager v1.9.6, we successfully added a user and enabled ssh. But wifi configuration is not applied correctly and needs nmcli radio wifi on to be run once from the cmd on the device before it works. That said, other imager (or image) versions won't work or fail and thus using imager v1.x AND customization at the same time is not recommended.
v0.9.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Changes
Firmware
PR #61 by MicioMax
- configurable device sleep timer for motors and lights
- improved robustness of motor homing calibration with endstops
- configurable endstop calibration strategies, e.g. on motor wake-up
- fixed status reporting for active-high endstops
- support for custom "Shield" PCBs and example config files
Other firmware changes
- improved status reporting for cloud Tasks
- fixed slow project download speeds and general responsiveness when a camera preview was running
- added API endpoints for awb calibration, Task cleanup and overriding motor angles
Frontend
- new drawer for Tasks and cloud project status
- performance improvements
- various UI and UX improvements
This release can be safely updated from the previous version v0.8.x using the updater.
v0.8.2
- Improve API responsiveness while capturing photos with Picamera2-Controller
v0.8.1
- Fix #53: Interrupted Scans are now resumable
- Fix logging issues caused by a legacy module name in the config file
- Improve pausing / cancelling of scans with focus stacking
- Improve project name validation to allow Unicode characters
- Enhance documentation and help file and add
CONTRIBUTING.md
Note: Since there has been a change in the logging configuration files, it is advised to NOT keep your previous settings while updating.
v0.8.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Changes
Firmware
- Simplified and stabilized Task system initialization for the upcoming beta release.
- Centralized directory structure to allow persistent and reliable storage of data.
- Added
next-API-Endpoints for calibrating automatic white balance for Arducams and motor angle overwrite for convenience.
Frontend
- Added a camera restart button, especially useful when Hawkeye fails and gets stuck.
- Fixed the settings page not accepting changes for motors and lights.- Better indication when the scanner is not connected.
- UI improvements, notably clearer sections and more consistency across all pages.
Images
- Persistent Projects and Scan data.
- Updated dependencies.
- Optional: new developer images (see below).
It is recommended to grab a fresh copy of the images to get the latest changes, especially regarding persistent save locations for projects. Updating from v0.6.0 images may still work for testing, though.
Refer to the Documentation for instructions on flashing the image and getting started.
Download the image for your camera below or use our Dropbox mirror.
Developer Images
We created developer images with convenient access to the source code, logs, client, and project files. These images come with autodiscovery enabled and override core Tasks to make development easier. Please keep in mind the security implications this has and refer to the docs.
You can find the dev images on Dropbox.
v0.7.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Firmware Changes
- Support for generic LinuxPy/V4L2 cameras.
- Improve project handling and added thumbnails, filesize, photo indices and path metadata.
- Fix OpenScanCloud related issues.
- Improve camera preview API endpoint to support different FPS and snapshots.
- Add API endpoints for retrieving photos (plus metadata) of a Scan.
Frontend Changes
This firmware release should work with Github/OpenScan3-Client v0.2.0
- Added OpenScanCloud support.
- Varoius UI and UX tweaks.
Updating Images
This release can be safely updated from the previous version v0.6.0 using the updater.
v0.6.1
- Fixes orientation mismatch between preview and photo when using the hawkeye camera
v0.6.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or creating Issues.
Features
Frontend
This firmware release should work with Github/OpenScan3-Client v0.1.2
Please keep in mind we're at an alpha stage, where we put a lot of moving parts together. The Frontend is still a prototype, in which we used generated types and labels from the backend, so expect some improper descriptions and placeholders here and there.
Firmware
- PR #31 Changed the firmware package name to
openscan_firmware. - PR #32 Moved FastAPI router to separate folders.
- Light config: renamed
pwmtopwm_support; legacy device JSON/test fixtures must update field names! - Improved docs and field descriptions strings.
Image
- The built-in updater now points to official repositories and the main branch of the firmware.
- Optimized installing of dependencies when updating.
Please backup all your scans before updating. We can't guarantee integrity during alpha development stage.
Raspberry Pi Images
Since this is a new minor release, you need to download a new image (or build your own).
Instructions:
- Download the image (imx519 or hawkeye)
- Flash the image to a microSD card using Raspberry Pi imager (optionally setup wifi and user through the imager settings)
- Insert the microSD card and start the device, the interface will be available at http://openscan3-alpha.local/
For more detailed information and the source code for the image generation see GitHub/OpenScan3-pi-gen
Feedback
We would love to hear your suggestions or bug reports. If you encounter bugs please submit the logs along. You can download the logs from within the new Frontend.
v0.5.0
At this point, the firmware is in alpha stage, so overall functionality is given, but we will add/change things regularly. Please help us with those improvements by joining the discussion on Discord or create Issues.
Features
Frontend
This release features a fresh approach to a modern responsive UI built with Quasar based on Github/OpenScan3-Client.
Please keep in mind we're at an alpha stage, where we put a lot of moving parts together. The Frontend is a prototype, in which we used generated types and labels from the backend so expect some improper descriptions and placeholders here and there.
We decided to not include the node-RED frontend from previous builds in this release.
Firmware
- #28: see PR description for changes.
- #29: adds root path for uvicorn to make the API accessible on
/api.
Future Updates
With the built-in updater script, it is possible to update both the Frontend and the Firmware backend. We will constantly ship new updates and they will be applicable with the updater.
Please backup all your scans before updating. We can't guarantee integrity during alpha development stage.
Raspberry Pi Images
Since this is a new minor release you need to download a new image (or build your own).
Instructions:
- Download the image (imx519 or hawkeye) and flash it to a microSD card using Raspberry Pi imager (optionally setup wifi and user through the imager settings)
- Insert the microSD card and start the device, the interface will be available at http://openscan3-alpha.local/
For more detailed information and the source-code for the image generation see GitHub/OpenScan3-pi-gen
Feedback
We would love to hear your suggestions or bug reports. If you encounter bugs please submit the logs along, you can easily download them from within the new Frontend.
Note: We expect to reach Beta milestone in February and Release milestone in May 2026.
Happy Scanning!