2017-01-30 10:45:01 -05:00
# Fenrir
2016-10-02 02:36:53 -04:00
An TTY screenreader for Linux.
2017-01-24 19:10:10 -05:00
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.
2016-12-30 13:54:27 -05:00
This software is licensed under the LGPL v3 .
2016-07-05 05:16:34 -04:00
2016-11-16 06:00:21 -05:00
# requirements (core)
2017-01-30 10:45:01 -05:00
- linux (currently only screen and input drivers available for that)
- python3 >= 3.3
- screen, input, speech, sound or braille drivers see "features, drivers".
2016-07-07 08:37:10 -04:00
2017-01-30 10:45:01 -05:00
# features, drivers
2017-01-30 10:46:33 -05:00
# Input Drivers:
2017-01-30 10:45:01 -05:00
- "evdevDriver" input driver for linux evdev
- python-evdev
- loaded uinput kernel module
- ReadWrite permission
- /dev/input
- /dev/uinput
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Screen Drivers:
2017-01-30 10:45:01 -05:00
- "vcsaDriver" screen driver for linux VCSA devices
- Read permission to the following files:
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Speech Drivers:
2017-01-30 10:45:01 -05:00
- "espeakDriver" speech driver for espeak:
2016-11-16 05:59:16 -05:00
- python-espeak
2017-01-30 10:45:01 -05:00
- "speechdDriver" speech driver for speech-dispatcher:
2016-11-16 05:59:16 -05:00
- speech-dispatcher
- python-speechd
2017-01-30 10:45:01 -05:00
- "dummyDriver" speech driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Braille Drivers:
2017-01-30 10:45:01 -05:00
- "brlttyDriver" braille driver (WIP):
2016-11-16 05:59:16 -05:00
- brltty (configured and running)
- python-brlapi
2017-01-30 10:45:01 -05:00
- "dummyDriver" braille driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Sound Drivers:
2017-01-30 10:45:01 -05:00
- "genericDriver" sound driver for sound as subprocess:
2016-11-16 05:59:16 -05:00
- sox
2017-01-30 10:45:01 -05:00
- "gstreamerDriver" sound driver for gstreamer
2016-11-16 05:59:16 -05:00
- gstreamer 1.x
- GLib
2017-01-30 10:45:01 -05:00
- "dummyDriver" sound driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Extra:
2016-11-16 05:59:16 -05:00
- spellchecker
- python-pyenchant
- aspell-YourLanguageCode (example aspell-en for us english)
- unix daemon:
- python-daemonize
2016-09-16 05:50:53 -04:00
2016-07-05 05:18:35 -04:00
# installation
2016-11-07 04:49:32 -05:00
- Archlinux: PKGBUILD in AUR
- install.sh (there is currently no uninstall)
- run from git:
You can just run the following as root:
2016-10-01 20:43:31 -04:00
cd src/fenrir-package/
2016-11-07 04:49:32 -05:00
sudo ./fenrir
2016-11-16 05:59:16 -05:00
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:
2017-01-30 10:45:01 -05:00
- sound driver: genericDriver (via sox, could configured in settings.conf)
- speech driver: speechdDriver
- braille driver: brlttyDriver (WIP)
- input driver: evdevDriver
