OpenScan3

About The Project

OpenScan3 is a firmware for controlling OpenScan devices, a family of OpenSource and OpenHardware devices designed to make photogametry accessible to everyone.

(back to top)

Getting Started

To run a copy of the firmware in your RPi you can follow of two routes

Install OpenScanPi image (recommended)

TO BE DONE

Install manually

Prerequisites

• RPi running the latest image of Raspberry OS

Installation

1. Clone the repo

git clone https://github.com/OpenScan-org/OpenScan3.git

2. cd into the repo

cd OpenScan3

3. Install the necessary dependencies

pip install -r requirements.txt

(back to top)

Usage

To run the api backend run:

uvicorn app.main:app --host 0.0.0.0

Now the api should be accessible from http://local_ip:8000

To access an api playground go to http://local_ip:8000/docs

For more information, please refer to the Documentation

Add ramdisk to improve capturing speed (if space available)

#/etc/fstab

proc            /proc           proc    defaults          0       0
PARTUUID=e46ea0e2-01  /boot           vfat    defaults          0       2
PARTUUID=e46ea0e2-02  /               ext4    defaults,noatime  0       1
# a swapfile is not a swap partition, no line here
#   use  dphys-swapfile swap[on|off]  for that


tmpfs /mnt/ramdisk tmpfs nodev,nosuid,size=256M 0 0

Then start the server

TMPDIR=/mnt/ramdisk uvicorn app.main:app --host 0.0.0.0

(back to top)

Roadmap

• Full camera control
• Full motor and other hardware control
• Extra features
  • Network drive
  • ...

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 license. See LICENSE for more information.

(back to top)

Contact

TO BE DONE

(back to top)