No Description

chrys87 c7a8fd3925 Update terminalManagement 19 hours ago
autostart c4f0355a87 Update fenrir.service 9 months ago
config 0436dcbd81 add lable 1 week ago
contrib bdb366d9c3 change contrib structure, prepare rrpm, update AUR 4 weeks ago
docu 3bdd41948f update wiki 5 days ago
experimental e39a5b301c make setup.py initial work 2 months ago
locale d43aab85fb Updated spanish translation 5 months ago
play zone c7a8fd3925 Update terminalManagement 19 hours ago
src 8c81b24987 change debug level of an message 5 days ago
tools 8cf405bad1 Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 1 week ago
.gitignore 71c84dec64 make setup.py work 3 weeks ago
Changelog.txt ea4884819e Update Changelog.txt 4 weeks ago
LICENCE dd8f7e05f9 add licence LGPLv3 7 months ago
Maintainer 4401c503ba restructure management files 8 months ago
README.md 8cf405bad1 Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 1 week ago
TODO v2.0 fc46ec7c99 Update TODO v2.0 20 hours ago
bugs 8cf405bad1 Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 1 week ago
check-dependencies.py 8963f8d476 Rename check-dependencys.py to check-dependencies.py 2 weeks ago
install.sh 8cf405bad1 Fixed lots of grammatical errors, install scripts using -f for copy to avoid errors whilst installing. 1 week ago
known bugs.txt 58e0451350 restructure Todos 4 weeks ago
setup.py 6bcc57b18d remove sox 6 days ago
uninstall.sh d9d7acf00b added some -f lags to suppress warnings 1 week ago

README.md

Fenrir

A TTY screenreader for Linux. In theory it's not just limited to Linux. but i currently only provide drivers for that since I do not have another system here. If you want to help, or write drivers to make it work on other systems, just let me know. This software is licensed under the LGPL v3 .

Requirements (core)

  • Linux (currently only screen and input drivers available)
  • python3 >= 3.3
  • python-configargparse
  • screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencies

Input Drivers:

  1. "evdevDriver" input driver for linux evdev
    • python-evdev >=0.6.3
    • python-pyudev
  2. This is commonly referred to as python3-evdev by your distribution
    • loaded uinput kernel module
    • ReadWrite permission
    • /dev/input
    • /dev/uinput

Screen Drivers:

  1. "vcsaDriver" screen driver for linux VCSA devices
    • python-dbus
    • Read permission to the following files and services:
    • /sys/devices/virtual/tty/tty0/active
    • /dev/tty[1-64]
    • /dev/vcsa[1-64]
    • read logind DBUS

Speech Drivers:

  1. "EspeakDriver" speech driver for Espeak:
    • python-espeak
  2. "speechdDriver" speech driver for Speech-dispatcher:
    • Speech-dispatcher
    • python-speechd
  3. "dummyDriver" speech driver for debugging

Braille Drivers:

  1. "BrlttyDriver" braille driver (WIP):
    • brltty (configured and running)
    • python-brlapi
  2. "dummyDriver" Braille driver for debugging

Sound Drivers:

  1. "genericDriver" sound driver for sound as subprocess:
    • Sox
  2. "gstreamerDriver" sound driver for gstreamer
    • gstreamer >=1.0
    • GLib
  3. "dummyDriver" sound driver for debugging

Extras:

  1. spellchecker
    • python-pyenchant
    • aspell-YourLanguageCode (example aspell-en for us English)
  2. Unix daemon (also needed for Systemd):
    • python-daemonize
  3. Modify system volume:
    • pyalsaaudio (needs libasound2's headers).

installation

  • Archlinux: PKGBUILD in AUR
  • Manual: run install.sh and uninstall.sh as root
  • you also can just run it from Git without installing: You can just run the following as root: if you are in Fenrir Git rootfolder: cd src/fenrir/ sudo ./fenrir Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings. Take care to use drivers from the config matching your installed drivers. By default it uses:
  • sound driver: genericDriver (via sox, could configured in settings.conf)
  • speech driver: speechdDriver
  • braille driver: brlttyDriver (WIP)
  • input driver: evdevDriver

Documentation

You can see all information on the Wiki: https://wiki.linux-a11y.org/doku.php?id=fenrir_user_manual&s[]=fenrir