storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,581 Commits 1 Branch 17 Tags 8.5 MiB
Python 87.3%
Roff 9.1%
Shell 3.6%
a45425ae6c
Go to file
Jeremiah Ticket a45425ae6c Merge branch 'master' of https://github.com/chrys87/fenrir
2017-02-27 11:14:12 -09:00
autostart/systemd Update fenrir.service 2016-11-16 14:10:03 +01:00
config Moved alsa volume controls to linux specific in keyboard configs 2017-02-27 09:05:31 -06: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
locale/es/LC_MESSAGES Updated spanish translation 2017-02-26 17:02:13 -06:00
play zone Update detectDevices.py 2017-02-27 17:50:07 +01:00
src fix syntax problem 2017-02-27 21:03:58 +01:00
tools Updated translation template 2017-02-26 22:19:55 +00: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 let install script also install settings if they dont exist 2017-02-26 18:33:31 +01:00
known bugs.txt update known bugs 2017-02-26 14:54:40 +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 Merge branch 'master' of https://github.com/chrys87/fenrir 2017-02-27 11:14:12 -09:00
TODO v2.0 Update TODO v2.0 2017-02-27 14:45:34 +01:00
uninstall.sh Update and rename deinstall.sh to uninstall.sh 2017-02-17 10:11:00 +01:00

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 for that)
  • python3 >= 3.3
  • python-configargparse
  • python-dbus for interaction with logind
  • screen, input, speech, sound or braille drivers see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencys

Input Drivers:

  1. "evdevDriver" input driver for linux evdev
  • python-evdev >=0.6.3
  • 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/vcsa[1-64]
    • read systemd DBUS

Speech Drivers:

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

Braille Drivers:

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

Sound Drivers:

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

Extra:

  1. spellchecker
  • python-pyenchant
  • aspell-YourLanguageCode (example aspell-en for us english)
  1. unix daemon (also needed for systemd):
  • python-daemonize
  1. 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 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