utility module

Utility

contains various utility methods used by many of the modules

exception utility.FormfeedConversionException

Bases: exceptions.Exception

exception utility.LinefeedConversionException

Bases: exceptions.Exception

utility.alpha_to_pin_num(alpha)

convert a single alpha, digit or some punctuation to 6 pin braille will raise Formfeed or Linefeed ConversionExceptions if they are found other unknown characters will be logged and a space will be returned.

utility.dimensions(state)

utility.find_files(directory, extensions)

recursively look for files that end in the extensions tuple (case insensitive)

utility.find_ui_update(config)

recursively look for firmware in the usb_dir, firmware file is called canute-ui.tar.gz returns first one found

utility.flatten(l)

utility.format_title(title, width, page_number, total_pages, capitalize=True)

format a title like this:

• title on the top line.
• use two dot-six characters to indicate all uppercase for the title.
• page numbers all the way at the right,

e.g. ‘,,library menu #1/#3’.

utility.freeze(writable)

utility.get_max_pages(data, height)

utility.get_methods(cls)

utility.get_page_num_width(state)

utility.pad_line(w, line)

utility.pin_num_to_alpha(numeric)

for sorting & debugging

utility.pin_num_to_unicode(pin_num)

used by the gui to display braille

utility.pin_nums_to_alphas(numerics)

used to convert plain text to pin pattern numbers

utility.set_page(book, page, height)

utility.test_book(dimensions, content=None)

returns a book of 8 pages with each page showing all possible combinations of the 8 rotor positions

utility.test_pattern(dimensions)

creates a repeating pattern of all possible dot patterns

utility.to_braille(alphas)

convert a list of alphas to pin numbers using alpha_to_pin_num() form feed and line feed characters are supressed

utility.unfreeze(frozen)

utility.unicode_to_pin_num(uni_char)

converts a unicode braille character to a decimal number that can then be used to load a picture to display the character

used to convert PEF format to CANUTE format http://en.wikipedia.org/wiki/Braille_Patterns