2017-01-30 10:45:01 -05:00
# Fenrir
2017-02-19 20:21:30 -05:00
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.
2016-12-30 13:54:27 -05:00
This software is licensed under the LGPL v3 .
2016-07-05 05:16:34 -04:00
2017-01-30 10:50:22 -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
2017-02-17 04:04:22 -05:00
- python-configargparse
2017-01-30 10:50:07 -05:00
- screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".
2016-07-07 08:37:10 -04:00
2017-02-23 05:43:31 -05:00
# Features, Drivers, Extras, Dependencys
2017-01-30 10:46:33 -05:00
# Input Drivers:
2017-02-23 05:33:08 -05:00
1. "evdevDriver" input driver for linux evdev
2017-02-13 15:42:31 -05:00
- python-evdev >=0.6.3
2017-01-30 10:45:01 -05:00
- 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-02-23 05:33:08 -05:00
1. "vcsaDriver" screen driver for linux VCSA devices
- python-dbus
2017-02-23 05:43:31 -05:00
- Read permission to the following files and services:
2017-01-30 10:45:01 -05:00
- /sys/devices/virtual/tty/tty0/active
- /dev/vcsa[1-64]
2017-02-23 05:43:31 -05:00
- read systemd DBUS
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Speech Drivers:
2017-02-23 05:33:08 -05:00
1. "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-02-23 05:33:08 -05:00
2. "dummyDriver" speech driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Braille Drivers:
2017-02-23 05:43:31 -05:00
1. "brlttyDriver" braille driver (WIP):
2016-11-16 05:59:16 -05:00
- brltty (configured and running)
- python-brlapi
2017-02-23 05:43:31 -05:00
2. "dummyDriver" braille driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Sound Drivers:
2017-02-23 05:33:08 -05:00
1. "genericDriver" sound driver for sound as subprocess:
2016-11-16 05:59:16 -05:00
- sox
2017-02-23 05:33:08 -05:00
2. "gstreamerDriver" sound driver for gstreamer
2017-02-13 15:42:31 -05:00
- gstreamer >=1.0
2016-11-16 05:59:16 -05:00
- GLib
2017-02-23 05:33:08 -05:00
3. "dummyDriver" sound driver for debugging
2017-01-30 10:47:13 -05:00
2017-01-30 10:46:33 -05:00
# Extra:
2017-02-23 05:43:31 -05:00
1. spellchecker
2016-11-16 05:59:16 -05:00
- python-pyenchant
- aspell-YourLanguageCode (example aspell-en for us english)
2017-02-23 05:43:31 -05:00
2. unix daemon (also needed for systemd):
2016-11-16 05:59:16 -05:00
- python-daemonize
2017-02-26 19:39:19 -05:00
3. Modify system volume:
- pyalsaaudio (needs libasound2's headers).
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
2017-02-17 04:07:42 -05:00
- Manual: run install.sh and uninstall.sh as root
2017-02-19 20:21:30 -05:00
- you also can just run it from Git without installing:
2016-11-07 04:49:32 -05:00
You can just run the following as root:
2017-02-23 05:45:05 -05:00
if you are in Fenrir Git rootfolder:
cd src/fenrir/
2016-11-07 04:49:32 -05:00
sudo ./fenrir
2017-02-19 20:21:30 -05:00
Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings.
2016-11-16 05:59:16 -05:00
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
