Instructions for setting up

N.B. These install instructions are a work in progress and have not been vigorously tested by BBT.

Download the repository:

$ cd ~/
$ git clone https://github.com/brltty/brltty.git
$ cd ~/brltty

Optional but recommended (where-6.3-is-the-latest-release,-or-no-lower-than-6.1,-when-Canute-was-first-supported):

$ git checkout BRLTTY-6.3

Configure and make:

$ ./autogen

You may get the following:

/usr/bin/env: ‘tclsh’: No such file or directory

In which case:

$ $ sudo apt-get install tclsh
$ ./autogen

Then:

$ ./configure
$ make

If the make command fails with errors something like:

"Variables of the format BRLAPI_KEY_FLG_<some word> are undeclared" 

… Then you must be using a distro which is using mawk instead of gask. The solution:

$ sudo apt-get install gawk
$ ./autogen
$ ./configure
$ make

Install BRLTTY

You don’t need to actually install brltty as you can also just use the run-brltty script in the top-level directory of brltty’s source tree. It takes the very same options, etc, but sets things up so that what’s run is what you just built (with-make).

However if you do want to install then:

$ make install

If you regret doing that…

$ make uninstall

You may have to run ‘make install’ as root by starting the command with ‘sudo’.

Start running BRLTTY with Canute

First plug your Canute it to the mains (but-not-the-PC-yet) and turn it on.

Next whilst you are waiting, on your PC, run BRLTTY either as a script…

$ cd ~/brltty
$ ./run-brltty -b cn -L log.txt -n

… Or, if you installed it, like so…

$ brltty -b cn -L log.txt -n

If either of those commands brings up an error like…

brltty: USBFS open error: /dev/bus/usb/002/002: Permission denied

… Then you may have to run it as root by starting the command with ‘sudo’.

Here’s what that command means…

Braille device = Canute:

-b cn

Save log output to ~/brltty/log.txt (optional):

-L log.txt

Run in the foreground, not as a daemon (optional,-useful-for-being-able-to-cancel-it-with-ctrl-c):

-n

When your Canute has finished starting up take a USB-A to USB-B cable (a-typical-printer-cable), plug the USB-B connexion (the-larger-end) into the left side of the Canute, and the USB-A connexion into your PC.

If at this stage you see the Braille message on you Canute display like…

screen not in text mode

… Then you’re using a graphical console but not running Orca. Switch to a text console (ctrl-alt-F2) and it should work.


All mistakes are BBT’s, otherwise thanks goes to Dave Mielke.

See BRLTTY(http://brltty.app/contact.html)