Brothers brscan-skey nutzbar machen

Update 27.03.2021

Da es nun schon zwei Kommentare mit Nachfragen zu dem Thema gab, dachte ich mir das ich hier kurz ein Update Kommentar dazu verfasse. Es ist wohl letztes Jahr eine neue Version des brscan-skey Paketes erschienen, mit welchem meine Scripte zum Teil nicht mehr funktionieren. Hauptsächlich betrifft es wohl scantofile, wo nur noch ein leeres PDF raus fällt. Ich habe letztens erst die Linux Version auf dem Laptop meiner Mutter installiert, allerdings das Scankey Tool ignoriert, da sie es in den vergangenen 5 Jahren nicht einmal genutzt hat. Wenn ich Zeit und Lust habe werde ich mir die neue Version nochmal anschauen und die Skripte anpassen, allerdings kann ich nicht sagen wann das sein wird. Vielen Dank auf jeden Fall für die Kommentare von Peter und Michél, die mich darauf aufmerksam gemacht haben und an den Kommentator Wade, der sich offensichtlich sogar aktiv zu dem Thema mit Brother auseinander gesetzt hat/auseinander setzt.

Update

Die Scripts liegen mittlerweile auch auf Github. Diese haben auch schon ein paar Updates erhalten, unter anderem auch scan2mail.

Ausgangsituation

Meine Mutter hat seit ein paar Monaten einen neuen Laptop und da sie nicht so viel Ahnung von PC’s hat und quasi noch ein unbeschriebenes Blatt ist, bekam sie von mir Linux drauf, um genauer zu sein Linux Mint mit Cinnamon, womit sie auch wunderbar klar kommt. Leider konnte sie damals die Scanner Funkionalität des Druckers nicht nutzen, da mein Vater diesen über einen propritären „Druckserver“ ins Netzwerk gehangen hat, welcher natürlich nur unter Windows richtig funktionierte.
Nun hat sich mein Vater endlich einen neuen Drucker gekauft, wodurch der „Druckserver“ endlich entsorgt werden konnte. Bei dem neuen Drucker handelt es sich um einen Brother MFC-J470DW mit WLAN, welcher auch Linux Unterstützung mit sich bringt. Ich gehe jetzt hier nicht auf die Installation der Treiber und so ein, mir geht es primär um das Scankey-Tool (brscan-skey), welches ermöglicht das man die Scanbuttons am Drucker nutzen kann.

Scankey-Tool und Anpassungen

Das ganze Tool besteht aus einem Binary File and ein paar Shell Scripten, welche nach /opt/brother/scanner/brscan-skey installiert werden. Im Unterordner script/ findet man nach der Installation 4 Scripte, also für jeden Button einen. Da ich festellte das die Scans alle als .ppm Dateien gespeichert werden und meine Mutter damit natürlich nichts anfangen kann, schaute ich mir mal die einzelnen Scripte an. Ich würde nicht behaupten das das, was ich manchmal schreibe als gutes scripten/programmieren durchgeht, aber diese Scripte sehen aus, als ob die ein Azubi im ersten Lehrjahr geschrieben hat. Ich hatte dann den starken Wunsch das alles nochmal ordentlich zu machen, unter anderem mit Convertierung der Dateien. Folgendes kam dabei heraus: Neuere Versionen der Skripte findet ihr auf Github

scantox.sh

#!/bin/bash

scan_path=~/Dokumente/Scans
scan_path_tmp=$(mktemp -d)
#logfile=/tmp/scan_logfile.log
resolution=300
output_filename=scan_$(date +%Y%m%d%H%M%S)
output_file="$scan_path/$output_filename"
output_file_tmp="$scan_path_tmp/$output_filename%03d.tiff"

#exec &> $logfile

function checkscanpath() {
    if [[ ! -d $scan_path ]]; then
        mkdir -p $scan_path
    fi
}

function scantox() {
    scanimage --device-name "$device" --resolution $resolution -l 0 -t 0 \
-x 210.00 -y 295.00 --format=tiff --batch=$output_file_tmp
}

function convert2() {
    if [[ "$1" == "pic" ]]; then
        c=0
        for file in $(find $scan_path_tmp -type f); do
            convert $file -quality 90 $output_file-$c.jpg
            c=$[$c+1]
        done
    elif [[ "$1" == "file" ]]; then
        convert $scan_path_tmp/* $output_file.pdf
    fi
}

function finish() {
    if [[ -d $scan_path_tmp ]]; then
        rm -r $scan_path_tmp
    fi
    if which nemo > /dev/null; then
        nemo $scan_path &
    fi
}

scantoimage.sh

#! /bin/sh
set +o noclobber

device=$1
. /opt/brother/scanner/brscan-skey/script/scantox.sh

sleep  1

checkscanpath
scantox
convert2 pic
finish

scantofile.sh

#! /bin/sh
set +o noclobber

device=$1
. /opt/brother/scanner/brscan-skey/script/scantox.sh

sleep  1

checkscanpath
scantox
convert2 file
finish

Die Scipte für OCR und Mail werde ich wahrscheinlich auch noch anpassen und werden dann ergänzt. Wenn ihr diese Scripte hier verwenden wollt, beachtet das wenn ihr die Filenames ändert ihr auch die .cfg einen Ordner höher anpassen müsst.

Probleme, Bugs etc.

Das die Scripte des Scankey Tools ziemlich schlecht geschrieben sind steht ja schon weiter oben, aber es gibt noch ein paar weitere Bugs:

Mehrere Seiten scannen über Flachbett nicht möglich

Der Drucker hat sowohl einen normales Flachbett als auch einen Dokumenteneinzug zum scannen. Wenn man nun über das Flachbett scannt, fragt er nach der ersten Seite ob man noch eine Weitere scannen möchte. Bejaht man das, fängt er an, bricht dann aber nach etwa 1/5 ab und man bekommt die Fehlermeldung (sofern man es mitloggt):

scanimage: sane_start: Device busy

Selbst wenn man die Zeile händisch ausführt, mit der expliziten Angabe das er bitte als Quelle das Flachbett nutzen soll, bekommt man bei der zweiten Seite einen Fehler, auch wenn es diesmal ein anderer ist:

scanimage --device-name "$device" --source FlatBed --resolution 300 -l 0 -t 0 \
-x 210.00 -y 295.00 --format=tiff --batch=$output_file_tmp --batch-prompt

scanimage: sane_start: document feeder out of documents

Mir scheint es so als ob er bei der ersten Seite noch mitbekommt das er das Flachbett nutzen soll, danach aber auf den Standart umspringt, welche ADF(left align) ist.
Wenn man hingegegen von Anfang an den Dokumenteneinzug zum scannen nutzt, funktionieren mehrere Seite ohne Probleme. Der Nachteil ist da natürlich, wenn man Dokumente hat, wo die Vorder- und Rückseite bedruckt ist, denn diese muss man so manuell zusammenführen.

Wenn jemand auch dieses Problem hat und es sogar gelöst hat, würde ich mich sehr über einen entsprechenden Kommentar freuen.

brscan-skey –help

Da ich mir mal anschauen wollte was ich mit dem Consolentool brscan-skey so machen kann führte ich es mal mit -h und –help aus. Beides brachte das selbe Ergebnis und zwar die Versionsausgabe. Als ich mir dann das Script mal anschaute, sah ich auch wieso:

if [ "$1" = "-h" ] || [ "$1" = "--help" ]; then
  if [ "$2" = "2" ];then
    --- gekürzt ---
    echo '   -h --help                :help'
  fi
  echo '   Copyright 2007-2012 Brother Industries, Ltd'
  exit 0
fi

Man muss also um die Help-Ausgabe zu bekommen -h 2 oder –help 2 eingeben. Wieso? Wusste der Entwickler nicht das -V geläufgier ist für die Versionsausgabe?

Versionsnummern

Das Paket kommt in der Version 0.2.4-1. Offenbar hatte der Entwickler vor dem Release keine Muse diese Versionsnummer überall anzupassen. So hat das Binaryfile noch die Version 0.2.4-0. Des Weiteren ist in der brscan-skey-0.2.4-1.sh als $BINVERSION ebenfalls noch die Version 0.2.4-0. Dieses Script ist dafür zuständig die Scripte unter script/ zu generieren, was zu einem weiteren Phänomen führt.

brscan-skey –reset

Führt man das nämlich aus, bekommt man die wunderschöne Fehlermeldung:

Can't open /opt/brother/scanner/brscan-skey/brscan-skey-0.2.4-0.sh

Ja klar, weil die auch brscan-skey-0.2.4-1.sh heißt. Passt man nun den Namen des Scripts an funktioniert –reset auch, nur haben dann alle Scripte unter script/ plötzlich eine Versionsnummer tiefer. Grund dafür ist das es neben $BINVERSION noch die Variable $VERSION gibt, welche zumindest schonmal nicht statisch vergeben ist, allerdings auch nicht, wie man denkt durch Abfrage der Paketversion gesetzt wird, nein, man schaute sich die Versionsnummer des ausgeführten Scripts an und setzt sie danach.
Das verursacht jetzt keine Probleme, da die brscan-skey-0.2.4-0.cfg auch entsprechend angepasst wird, aber dennoch…

brscan-skey -l / –list

Das ist einfach – diese Option hat einfach keine Funktion. Also zumindest zeigt sie weder unter Ubuntu noch unter Debian irgendwas an.

Fazit

Es funktioniert und macht, mit ein paar Anpassungen, weitesgehend das was es soll, aber dieses ganze Paket schreit einem quasi die Lust des Entwicklers ins Gesicht. Ich frag mich dann immer warum Unternehmen sowas machen. Wenn sie keinen Bock haben Linux Pakete zu bauen, schön, dann sollen sie den Code für das Binary irgendwohin werfen und sagen „Da habter den Code, macht es selbst, wir haben da keinen Bock zu.“ Das würde denen doch nicht mal jemand übel nehmen…