storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1,553 Commits 2 Branches 19 Tags 8.9 MiB
Python 96.7%
Shell 3.3%
e91fd4fff0
Go to file
chrys e91fd4fff0 improve vim/emaces
2017-02-25 16:15:40 +01:00
autostart/systemd Update fenrir.service 2016-11-16 14:10:03 +01:00
config finalize: custom command zone; auto screen detection 2017-02-24 18:46:12 +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
locale/es/LC_MESSAGES Updated spanish translation 2017-02-20 04:52:44 -06:00
play zone sync example 2017-02-25 01:19:27 +01:00
src improve vim/emaces 2017-02-25 16:15:40 +01:00
tools Updated translation catalog 2017-02-20 10:45:22 +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 Fixed some capitalisation, slight wording and an echo stating name of settings.conf.bak 2017-02-20 12:27:26 +11:00
known bugs.txt Update known bugs.txt 2017-02-23 11:46:30 +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-02-23 11:45:05 +01:00
TODO v2.0 Update TODO v2.0 2017-02-23 15:33:47 +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
  • 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

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