User interface for the Canute electronic Braille reader.
Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
books
tests Fix driver Pi call in test Jul 26, 2018
ui Merge pull request #168 from Bristol-Braille/fix-not-ignoring-trash Jul 31, 2018
.gitignore Move library into module folder Jul 17, 2017
.travis.yml Update travis config Jul 26, 2018
INSTALL.md Fix fstab instructions Jul 26, 2018
LICENSE Initial import May 20, 2015
README.md Remove pi-buttons option Jul 26, 2018
canute_ui Move canute_ui code into main.py Dec 6, 2017
config.rc.in Update travis config Jul 26, 2018
config.rc.travis Update travis config Jul 26, 2018
fix Update lint scripts Jul 26, 2018
fstab Fix fstab instructions Jul 26, 2018
lint Move driver stuff into sub-folder Jan 9, 2018
rc.local Clean up rc.local Jul 26, 2018
requirements-pi.txt Remove pi-buttons option Jul 26, 2018
requirements.txt Implement state saving/loading from toml files Jan 11, 2018
run.sh Remove --pi-buttons option from run.sh Jul 26, 2018
test Start adapting tests Jun 2, 2017

README.md

Canute UI Travis CI Status

This is the repository for UI (user interface) development for the Canute electronic Braille reader.

Usage

./canute_ui runs a graphical display to emulate the hardware by default. The emulated hardware has the same interface as the real hardware, but also runs a graphical program called qt_display.py. This shows how the machine will look, and provides the buttons.

usage: canute_ui [-h] [--pi-buttons] [--debug] [--text] [--tty TTY]
                 [--delay DELAY] [--real] [--both] [--fuzz FUZZ_DURATION]
                 [--dummy]

Canute UI

optional arguments:
  -h, --help            show this help message and exit
  --debug               debugging content
  --text                show text instead of braille
  --tty TTY             serial port for the display and button board
  --delay DELAY         simulate mechanical delay in milliseconds in the
                        emulator
  --real                do not run the graphical emulator, run with real
                        hardware
  --both                run both the emulator and the real hardware at the
                        same time
  --fuzz FUZZ_DURATION  run with dummy display (emulated but without any
                        graphics) and press random buttons for duration (in
                        seconds), for debugging
  --dummy               run with the dummy display but without fuzz testing
                        button presses, for debugging

Getting started

Read INSTALL.md for installation instructions.

Development

Run the tests:

./test

Run the linter:

./lint

Copy and amend the config file

cp config.rc.in config.rc
$EDITOR config.rc

Copy the test books to the home directory (or wherever you specified in config.rc):

cp -r books ~/

Run the UI using the emulator:

./canute_ui