add wigglecam docs

docs/stylesheets/extra.css

@@ -6,4 +6,4 @@
   --md-accent-fg-color:        #16a890;
   --md-accent-fg-color--light: #3bc5ae;
   --md-accent-fg-color--dark:  #0b7e6b;
-}
+}

docs/wigglegramcamera/build.md

@@ -0,0 +1,31 @@
+
+# Build Your Wigglegram Camera
+
+!!! info
+    This is all experimental! 🧪
+
+<figure markdown>
+  ![frontpage](./assets/cae-front.png){ width="400" }
+  <figcaption>Front of the wigglegram camera with 4 individual cameras.</figcaption>
+</figure>
+
+<figure markdown>
+  ![frontpage](./assets/cae-rear.png){ width="400" }
+  <figcaption>Rear of the wigglegram camera with touchscreen and on/off switch.</figcaption>
+</figure>
+
+## Prepare Components
+
+The camera is 3d printed, find the latest reference design in the [wigglecam-3d repository](https://github.com/photobooth-app/wigglecam-3d).
+
+TODO
+
+- List materials used.
+
+## Wiring Diagram
+
+![frontpage](./assets/wiringdiagram.png){ width="400" }
+
+## Assembly
+
+TODO

docs/wigglegramcamera/index.md

@@ -0,0 +1,44 @@
+# Wigglegram Camera
+
+There is more to your photobooth! Starting from v5 the photobooth-app integrates with our new multicamera backend.
+It allows to capture photos from several cameras at the same time to create 3d effect GIFs.
+
+In this subsection, the build and setup of the wigglecam is described.
+
+!!! info
+    This is all experimental! 🧪
+
+Excited? This is how the the camera looks like:
+
+<figure markdown>
+  ![frontpage](./assets/wigglegram-demo1.gif){ width="400" }
+  <figcaption>Wigglegram taken with 2 cameras and interpolated using the RIFE model</figcaption>
+</figure>
+
+<figure markdown>
+  ![frontpage](./assets/cam1.jpg){ width="400" }
+  <figcaption>First version of the camera, front.</figcaption>
+</figure>
+
+<figure markdown>
+  ![frontpage](./assets/cam2.jpg){ width="400" }
+  <figcaption>First version of the camera, back.</figcaption>
+</figure>
+
+## 😍 What it is
+
+🧪 Python software to capture wigglegrams using multiple cameras  
+🧪 Software synchronized Raspberry Pi camera modules, using picamera2  
+🧪 3d printed camera housing  
+🧪 Creating smooth videos from just two images using frame interpolation AI algorithms  
+
+## Current Version [![current release](https://img.shields.io/pypi/v/wigglecam)](https://pypi.org/project/wigglecam/)
+
+The wigglecam is not yet released. Use the links below to find out more before tackling to build your camera.
+
+## Links
+
+- [Github source](https://github.com/photobooth-app/wigglecam/)
+- [3d printable case](https://github.com/photobooth-app/wigglecam-3d)
+- [Issues](https://github.com/photobooth-app/wigglecam/issues)
+- [Discussions](https://github.com/photobooth-app/photobooth-app/discussions)

docs/wigglegramcamera/installation.md

@@ -0,0 +1,173 @@
+# Installation
+
+## Software Setup
+
+### Prepare the Systems
+
+#### Basic Installation
+
+```sh
+sudo apt update
+sudo apt full-upgrade
+
+sudo usermod --append --groups gpio $(whoami)
+
+sudo apt install -y python3-picamera2 python3-opencv python3-pip pipx git vim
+pipx ensurepath # reboot afterwards!
+
+pipx install --system-site-packages git+https://github.com/photobooth-app/wigglecam.git
+```
+
+#### Basic configuration
+
+On all systems edit `/boot/firmware/config.txt` as follows:
+
+```ini
+# add to all section
+[all]
+# disable UART because it would interfere with the clock and trigger events on GPIO14/15 detected as event in the app
+enable_uart=0
+# REMOVE or comment any of the following in the file:
+# console=serial0,115200
+
+# camera
+# rotate=0 because camera is upside down in case
+dtoverlay=imx708,rotation=0
+
+# depending on the camera resolution you might need little more cma memory, for example:
+dtoverlay=vc4-kms-v3d,cma-320
+
+# display (primary node)
+display_auto_detect=0
+dtoverlay=vc4-kms-dsi-waveshare-800x480,invx,invy #https://github.com/raspberrypi/linux/issues/6414
+
+# master clock (primary node)
+dtparam=audio=off # because GPIO18 interferes with audio
+dtoverlay=pwm,pin=18,func=2 # GPIO18 reserved for hardware pwm
+
+
+# shutdown button signal
+# TODO
+```
+
+On the primary node, edit `/boot/firmware/cmdline.txt` prepend the following `video=DSI-1:800x480M@60,rotate=180` to the existing text. The result could look like this:
+
+```sh
+video=DSI-1:800x480M@60,rotate=180 console=tty1 root=PARTUUID=0dfd3080-02 rootfstype=ext4 fsck.repair=yes rootwait cfg80211.ieee80211_regdom=DE
+```
+
+### Configure the Nodes
+
+The nodes are configured using .env files
+
+#### Primary Node
+
+The primary node has a display attached and is responsible to generate the clock signal the secondary nodes synchronize to. To save hardware, a primary node can be used as secondary node simultaneously.
+
+Edit `~/.env.primary` and place following for the reference 3d printed wigglecam:
+
+```sh
+# enable clock generator and trigger forwarding on primary:
+acquisition__is_primary="True"
+# io config:
+acquisition__io_backends__active_backend="Gpio" # default "VirtualIo"
+acquisition__io_backends__gpio__fps_nominal=5
+acquisition__io_backends__gpio__pwmchip="pwmchip0" # or pwmchip2 for Pi5
+acquisition__io_backends__gpio__pwm_channel=0 # or 2 for Pi5
+# cam config:
+acquisition__camera_backends__active_backend="Picamera2"    # default "VirtualCamera"
+acquisition__camera_backends__picamera2__enable_preview_display="True"
+```
+
+Edit `~/.env.node` and place following for the reference 3d printed wigglecam:
+
+```sh
+# likely empty... haha
+```
+
+### First Start of the node
+
+After installation AND reboot, following commands are available:
+
+- `wigglecam_minimal`: Useful for first testing and a very basic setup for the 3d printed camera. There is no need to have an active ethernet connection between the nodes in the wild.
+- `wigglecam_api`: Currently a very basic implementation providing a HTTP server and a REST api to automate the capture and data collection from all nodes. The REST api documentation is available browsing to `http://localhost:8000/api/docs` on the same device after starting the api. This command is the default on secondary nodes.
+
+On the node with the display, there might be issues on startup QT complaining about missing drivers on the lite system. Try different platform drivers by prepending an environment variable for example as follows:
+
+- `QT_QPA_PLATFORM=linuxfb wigglecam_minimal` or
+- `QT_QPA_PLATFORM=eglfs wigglecam_minimal`
+
+### Automatic Startup After Boot
+
+Create following folder and file `~/.local/share/systemd/user/wigglecam.service` with content as follows:
+
+```ini
+[Unit]
+Description=wigglecam
+After=default.target
+
+[Service]
+Type=simple
+Restart=always
+# working directory is used as datafolder
+WorkingDirectory=%h/
+Environment="QT_QPA_PLATFORM=linuxfb"
+#ExecStart=/home/pi/.local/bin/wigglecam-mobile # true for pipx install
+#ExecStart=/home/pi/.local/bin/wigglecam-gui # true for pipx install
+ExecStart=/home/pi/.local/bin/wigglecam-node # true for pipx install
+
+[Install]
+WantedBy=default.target
+```
+
+```sh
+systemctl --user daemon-reload
+systemctl --user enable wigglecam.service
+systemctl --user start wigglecam.service
+```
+
+## Troubleshooting
+
+### Test the Hardware PWM
+
+Pi3, Pi4 it's pwmchip0 channel 0
+
+```sh
+echo 0 > /sys/class/pwm/pwmchip0/export
+pi@wigglecam-main:/sys/class/pwm/pwmchip0/pwm0 $ echo 100000000 > period
+pi@wigglecam-main:/sys/class/pwm/pwmchip0/pwm0 $ echo 50000000 > duty_cycle
+pi@wigglecam-main:/sys/class/pwm/pwmchip0/pwm0 $ echo 1 > enable
+pi@wigglecam-main:/sys/class/pwm/pwmchip0/pwm0 $ echo 0 > enable
+```
+
+Pi5 it's pwmchip2 channel 2
+
+```sh
+echo 2 > /sys/class/pwm/pwmchip2/export
+pi@wigglecam-main:/sys/class/pwm/pwmchip2/pwm0 $ echo 100000000 > period
+pi@wigglecam-main:/sys/class/pwm/pwmchip2/pwm0 $ echo 50000000 > duty_cycle
+pi@wigglecam-main:/sys/class/pwm/pwmchip2/pwm0 $ echo 1 > enable
+pi@wigglecam-main:/sys/class/pwm/pwmchip2/pwm0 $ echo 0 > enable
+```
+
+### QT app
+
+```sh
+QT_DEBUG_PLUGINS=1 QT_MEDIA_BACKEND=ffmpeg QT_QPA_PLATFORM=linuxfb pdm run wigglecam-gui
+QT_DEBUG_PLUGINS=1 QT_MEDIA_BACKEND=gstreamer QT_QPA_PLATFORM=linuxfb pdm run wigglecam-gui
+```
+
+## Local dev installation
+
+```sh
+cd ~
+git clone https://github.com/photobooth-app/wigglecam.git
+cd wigglecam
+
+# to allow system site packages be used in venv (picamera2)
+pdm venv create --force 3.11 --system-site-packages
+
+pdm install
+
+pdm run wigglecam_minimal # or wigglecam_api, maybe add QT_QPA_PLATFORM=linuxfb if display is used.
+```

mkdocs.yml

@@ -91,6 +91,10 @@ nav:
       - support/index.md
       - support/troubleshooting.md
       - support/faq.md
+  - Wigglegram Camera:
+      - wigglegramcamera/index.md
+      - wigglegramcamera/build.md
+      - wigglegramcamera/installation.md
   - Extras:
       - extras/index.md
       - extras/buzzer.md