Go to file
2017-01-30 16:46:33 +01:00
autostart/systemd Update fenrir.service 2016-11-16 14:10:03 +01:00
config Update settings.conf.storm 2017-01-30 16:00:36 +01:00
contrib/fenrir-git Updated PKGBUILD stuff. 2016-11-04 17:49:14 -04:00
docu Update development.txt 2016-09-15 16:28:55 +02:00
experimental make setup.py experimental 2016-12-23 16:18:57 +01:00
play zone add demo, load ignore screen again 2017-01-16 23:04:29 +01:00
src Update dummyDriver.py 2017-01-30 16:24:05 +01:00
tools Update fenrir-conf 2016-12-23 12:33:24 +01:00
.gitignore Cleanup more setup.py leftovers and added to gitignore. 2016-10-22 09:59:49 -08:00
Changelog v1.0.txt restructure management files 2016-12-23 16:36:16 +01:00
install.sh remove wrong intention 2016-11-04 21:32:35 +01:00
known bugs.txt restructure management files 2016-12-23 16:36:16 +01:00
LICENCE add licence LGPLv3 2016-12-30 19:54:27 +01:00
Maintainer restructure management files 2016-12-23 16:36:16 +01:00
README.md Update README.md 2017-01-30 16:46:33 +01:00
TODO v2.0 Update TODO v2.0 2017-01-30 16:25:19 +01:00

Fenrir

An TTY screenreader for Linux. In theorie its not limited to linux. but i currently only provide drivers for that because I do not have an ohter 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 for that)
  • python3 >= 3.3
  • screen, input, speech, sound or braille drivers see "features, drivers".

features, drivers

Input Drivers:

  • "evdevDriver" input driver for linux evdev
    • python-evdev
    • loaded uinput kernel module
    • ReadWrite permission
      • /dev/input
      • /dev/uinput

Screen Drivers:

  • "vcsaDriver" screen driver for linux VCSA devices
    • Read permission to the following files:
      • /sys/devices/virtual/tty/tty0/active
      • /dev/vcsa[1-64]

Speech Drivers:

  • "espeakDriver" speech driver for espeak:
    • python-espeak
  • "speechdDriver" speech driver for speech-dispatcher:
    • speech-dispatcher
    • python-speechd
  • "dummyDriver" speech driver for debugging

Braille Drivers:

  • "brlttyDriver" braille driver (WIP):
    • brltty (configured and running)
    • python-brlapi
  • "dummyDriver" braille driver for debugging

Sound Drivers:

  • "genericDriver" sound driver for sound as subprocess:
    • sox
  • "gstreamerDriver" sound driver for gstreamer
    • gstreamer 1.x
    • GLib
  • "dummyDriver" sound driver for debugging

Extra:

  • spellchecker
    • python-pyenchant
    • aspell-YourLanguageCode (example aspell-en for us english)
  • unix daemon:
    • python-daemonize

installation

  • Archlinux: PKGBUILD in AUR
  • install.sh (there is currently no uninstall)
  • run from git: You can just run the following as root: cd src/fenrir-package/ sudo ./fenrir Settings "settings.conf" is located in the "config" directory. Take care that the used drivers in 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