Install the Pi3D PictureFrame software with one click (2024 Edition, Raspberry Pi 2/3/4/5)

arp -a

pi5.fritz.box (192.168.178.74) at 2c:cf:67:3d:38:9f on en8 ifscope [ethernet]

ssh pi@192.168.178.74

sudo nano picframe.sh

#!/bin/bash

# Path to store progress and log file
PROGRESS_FILE="/home/pi/install_progress.txt"
LOG_FILE="/home/pi/install_log.txt"
SERVICE_NAME="install_script_service"

# Function to log messages
log_message() {
    echo "$1" | tee -a "$LOG_FILE"
}

# Function to update progress
update_progress() {
    echo "$1" > "$PROGRESS_FILE"
}

# Function to get the last completed step
get_last_completed_step() {
    if [ -f "$PROGRESS_FILE" ]; then
        cat "$PROGRESS_FILE"
    else
        echo "0"
    fi
}

# Function to add a systemd service to resume the script after reboot
add_systemd_service() {
    local script_path=$(realpath "$0")
    SERVICE_FILE="/etc/systemd/system/$SERVICE_NAME.service"
    sudo tee "$SERVICE_FILE" > /dev/null <<EOL
[Unit]
Description=Resume install script after reboot

[Service]
ExecStart=$script_path
Type=oneshot
RemainAfterExit=true

[Install]
WantedBy=multi-user.target
EOL
    sudo systemctl enable $SERVICE_NAME
    log_message "Added systemd service for reboot resume."
}

# Function to remove the systemd service after completion
remove_systemd_service() {
    sudo systemctl disable $SERVICE_NAME
    sudo rm /etc/systemd/system/$SERVICE_NAME.service
    log_message "Removed systemd service after completion."
}

# Function to reboot and resume
reboot_and_resume() {
    add_systemd_service
    update_progress "$1"
    log_message "Rebooting to complete the installation. The script will continue after reboot."
    sudo reboot
    exit 0
}

# Function to check for a working internet connection
check_internet_connection() {
  log_message "Checking for an active internet connection..."
  while ! ping -c 1 -W 1 google.com &> /dev/null; do
    log_message "No internet connection. Retrying in 5 seconds..."
    sleep 5
  done
  log_message "Internet connection confirmed."
}

# Ensure the "pi" user has passwordless sudo for specific commands in Step 5
sudoers_entry="pi ALL=(ALL) NOPASSWD: /home/pi/venv_picframe/bin/picframe, /home/pi/venv_picframe/bin/pip, /usr/bin/python3, /bin/mkdir"

# Check if the entry already exists in the sudoers file to avoid duplication
if ! sudo grep -qF "$sudoers_entry" /etc/sudoers; then
    echo "$sudoers_entry" | sudo tee -a /etc/sudoers > /dev/null
    echo "Configured passwordless sudo for the 'pi' user."
else
    echo "Passwordless sudo for 'pi' user is already configured."
fi

# Main install script

# Get the last completed step
LAST_COMPLETED_STEP=$(get_last_completed_step)

# Step 1: Update the operating system...
if [ "$LAST_COMPLETED_STEP" -lt 1 ]; then
    check_internet_connection
    log_message "Step 1: Updating operating system..."
    sudo apt-get update && sudo apt upgrade -y
    reboot_and_resume 1
fi

# Step 2: Update raspi-config to boot in console as Pi...
if [ "$LAST_COMPLETED_STEP" -lt 2 ]; then
    log_message "Step 2: Updating raspi-config..."
    sudo raspi-config nonint do_boot_behaviour B2
    reboot_and_resume 2
fi

# Step 3: Install Samba and set up user with error handling
if [ "$LAST_COMPLETED_STEP" -lt 3 ]; then
    check_internet_connection
    log_message "Step 3: Installing Samba and configuring user..."
    
    # Attempt to install Samba
    sudo apt-get install samba -y

    # Ensure expect is installed for automating smbpasswd
    if ! command -v expect > /dev/null; then
        sudo apt-get install -y expect
    fi

    # Check if the Samba user 'pi' already exists, if not, add it using expect for reliable password setting
    if ! sudo pdbedit -L | grep -q "^pi:"; then
        sudo expect <<EOL
spawn sudo smbpasswd -a pi
expect "New SMB password:"
send "pi\r"
expect "Retype SMB password:"
send "pi\r"
expect eof
EOL
    fi

    # Modify Samba config file
    SAMBA_CONFIG="/etc/samba/smb.conf"
    sudo tee "$SAMBA_CONFIG" > /dev/null <<EOL
[global]
security = user
workgroup = WORKGROUP
server role = standalone server
map to guest = never
encrypt passwords = yes
obey pam restrictions = no
client min protocol = SMB2
client max protocol = SMB3

# Additional macOS fine-tuning for users; optional for Windows

vfs objects = catia fruit streams_xattr
fruit:metadata = stream
fruit:model = RackMac
fruit:posix_rename = yes
fruit:veto_appledouble = no
fruit:wipe_intentionally_left_blank_rfork = yes
fruit:delete_empty_adfiles = yes

[pi]
comment = Pi Directories
browseable = yes
path = /home/pi
read only = no
create mask = 0775
directory mask = 0775
EOL

    # Restart Samba service
    sudo systemctl restart smbd
    update_progress 3
    log_message "Samba installation and configuration completed."
fi

# Step 4: Install additional packages
if [ "$LAST_COMPLETED_STEP" -lt 4 ]; then
    check_internet_connection
    log_message "Step 4: Installing additional packages..."
    sudo apt-get install git libsdl2-dev xwayland labwc wlr-randr -y
    # Create Pictures and DeletedPictures directories
    su - pi -c "mkdir -p /home/pi/Pictures /home/pi/DeletedPictures"
    log_message "Directories 'Pictures' and 'DeletedPictures' created."
    # Install Mosquitto for MQTT
    sudo apt-get install -y mosquitto mosquitto-clients
    log_message "Mosquitto Server installed."
    reboot_and_resume 4
fi

# Step 5: Installing picframe
if [ "$LAST_COMPLETED_STEP" -lt 5 ]; then
    check_internet_connection
    log_message "Step 5: Installing picframe..."
    log_message "Creating virtual environment for picframe..."
    su - pi -c "mkdir -p /home/pi/venv_picframe" 2>&1 | tee -a "$LOG_FILE"

    log_message "Setting up Python virtual environment..."
    su - pi -c "python3 -m venv /home/pi/venv_picframe" 2>&1 | tee -a "$LOG_FILE"

    log_message "Activating virtual environment..."
    su - pi -c "source /home/pi/venv_picframe/bin/activate" 2>&1 | tee -a "$LOG_FILE"

    log_message "Installing picframe..."
    su - pi -c "/home/pi/venv_picframe/bin/pip install picframe" 2>&1 | tee -a "$LOG_FILE"

    # Initialize Picframe and confirm default directories
    log_message "Initializing Picframe with default directories..."
    if (echo -e "\n\n\n" | su - pi -c "/home/pi/venv_picframe/bin/picframe -i /home/pi/" 2>&1 | tee -a "$LOG_FILE"); then
        log_message "Picframe initialized with default directories."
        update_progress 5
    else
        log_message "Error: Failed to initialize Picframe."
        exit 1
    fi
fi

# Step 6: Create autostart script for Picframe as user "pi"
if [ "$LAST_COMPLETED_STEP" -lt 6 ]; then
    log_message "Step 6: Creating autostart script for Picframe as user 'pi'..."

    # Create autostart script for Picframe
    AUTOSTART_SCRIPT="/home/pi/start_picframe.sh"
    su - pi -c "cat > $AUTOSTART_SCRIPT" <<'EOL'
#!/bin/bash
source /home/pi/venv_picframe/bin/activate  # Activate Python virtual environment
picframe &  # Start Picframe in the background
EOL

    # Make the autostart script executable
    su - pi -c "chmod +x $AUTOSTART_SCRIPT"
    log_message "Autostart script created and made executable: $AUTOSTART_SCRIPT."

    # Mark step as completed
    update_progress 6
    log_message "Directory setup and autostart script creation completed."
fi

# Step 7: Configure autostart for Picframe using labwc and set up systemd service as user "pi"
if [ "$LAST_COMPLETED_STEP" -lt 7 ]; then
    log_message "Step 7: Configuring autostart for Picframe with labwc and setting up systemd service as user 'pi'..."

    # Create labwc autostart directory and configuration file
    su - pi -c "mkdir -p /home/pi/.config/labwc"
    AUTOSTART_FILE="/home/pi/.config/labwc/autostart"
    su - pi -c "cat > $AUTOSTART_FILE" <<'EOL'
/home/pi/start_picframe.sh
EOL
    log_message "Created labwc autostart configuration: $AUTOSTART_FILE"

    # Create labwc rc.xml for window decorations
    RC_XML_FILE="/home/pi/.config/labwc/rc.xml"
    su - pi -c "cat > $RC_XML_FILE" <<'EOL'
<windowRules>
    <windowRule identifier="*" serverDecoration="no" />
</windowRules>
EOL
    log_message "Created labwc rc.xml configuration for window decoration: $RC_XML_FILE"

    # Create systemd user service to start labwc on boot
    su - pi -c "mkdir -p /home/pi/.config/systemd/user"
    SYSTEMD_SERVICE_FILE="/home/pi/.config/systemd/user/picframe.service"
    su - pi -c "cat > $SYSTEMD_SERVICE_FILE" <<'EOL'
[Unit]
Description=PictureFrame on Pi

[Service]
ExecStart=/usr/bin/labwc
Restart=always

[Install]
WantedBy=default.target
EOL
    log_message "Created systemd service for Picframe: $SYSTEMD_SERVICE_FILE"

    # Enable the user systemd service for autostart
    su - pi -c "systemctl --user enable picframe.service"
    log_message "Enabled systemd user service for Picframe autostart."

    # Mark step as completed and reboot to apply changes
    log_message "Autostart configuration for Picframe completed. Rebooting to apply changes."
    reboot_and_resume 7
fi

# Final step: Remove the systemd service only if all steps are completed
if [ "$LAST_COMPLETED_STEP" -ge 7 ]; then
    remove_systemd_service
    log_message "Installation script completed, and systemd service removed. Rebooting now..."
    sudo reboot
fi

sudo chmod +x picframe.sh

./picframe.sh