brailleDisplayDrivers.eurobraille package

Braille display driver for eurobraille displays.

Submodules

brailleDisplayDrivers.eurobraille.constants module

brailleDisplayDrivers.eurobraille.driver module

brailleDisplayDrivers.eurobraille.driver.bytesToInt(byteData: bytes)

Converts bytes to its integral equivalent.

class brailleDisplayDrivers.eurobraille.driver.BrailleDisplayDriver(*args, **kwargs)

Bases: BrailleDisplayDriver, ScriptableObject

Constructor @param port: Information on how to connect to the device.

Use L{_getTryPorts} to normalise to L{DeviceMatch} instances. - A string (from config “config.conf[“braille”][name][“port”]”). When manually configured.

This value is set via the settings dialog, the source of the options provided to the user is the BrailleDisplayDriver.getPossiblePorts method.

  • A L{DeviceMatch} instance. When automatically detected.

name = 'eurobraille'

The name of the driver; must be the original module file name. @type: str

description = 'Eurobraille displays'

A description of the driver. @type: str

isThreadSafe: bool = True

Whether this driver is thread-safe. If it is, NVDA may initialize, terminate or call this driver on any thread. This allows NVDA to read from and write to the display in the background, which means the rest of NVDA is not blocked while this occurs, thus resulting in better performance. This is also required to use the L{hwIo} module.

supportsAutomaticDetection: bool = True

Whether this driver is supported for automatic detection of braille displays.

timeout: float = 0.2

Maximum timeout to use for communication with a device (in seconds). This can be used for serial connections. Furthermore, it is used to stop waiting for missed acknowledgement packets.

supportedSettings: SupportedSettingType = (<autoSettingsUtils.driverSetting.BooleanDriverSetting object>,)

Typing for auto property L{_get_supportedSettings}

classmethod registerAutomaticDetection(driverRegistrar: DriverRegistrar)

This method may register the braille display driver in the braille display automatic detection framework. The framework provides a L{bdDetect.DriverRegistrar} object as its only parameter. The methods on the driver registrar can be used to register devices or device scanners. This method should only register itself with the bdDetect framework, and should refrain from doing anything else. Drivers with L{supportsAutomaticDetection} set to C{True} must implement this method. @param driverRegistrar: An object containing several methods to register device identifiers for this driver.

classmethod getManualPorts()

Get possible manual hardware ports for this driver. This is for ports which cannot be detected automatically such as serial ports. @return: An iterator containing the name and description for each port.

_awaitingFrameReceipts: Dict[int, Any]
_dev: IoBase
terminate()

Terminate this display driver. This will be called when NVDA is finished with this display driver. It should close any open connections, perform cleanup, etc. Subclasses should call the superclass method first. @postcondition: This instance can no longer be used unless it is constructed again.

_prepFirstByteStreamAndData(data: bytes) -> (<class 'bytes'>, typing.Union[_io.BytesIO, hwIo.base.IoBase], <class 'bytes'>)
_onReceive(data: bytes)
_handleAck(frame: int)

Base implementation to handle acknowledgement packets.

_handleSystemPacket(packetType: bytes, data: bytes)
_handleKeyPacket(group: bytes, data: bytes)
_sendPacket(packetType: bytes, packetSubType: bytes, packetData: bytes = b'')
_sendHidPacket(packet: bytes)
display(cells: List[int])

Display the given braille cells. @param cells: The braille cells to display. @type cells: [int, …]

_get_hidKeyboardInput()
_set_hidKeyboardInput(state: bool)
scriptCategory = 'Braille'
_abc_impl = <_abc._abc_data object>
property hidKeyboardInput
script_toggleHidKeyboardInput(gesture: InputGesture)

Toggle HID keyboard simulation

__gestures = {'br(eurobraille):switch1Left+joystick1Down': 'toggleHidKeyboardInput', 'br(eurobraille):switch1Right+joystick1Down': 'toggleHidKeyboardInput', 'br(eurobraille.esytime):l1+joystick1Down': 'toggleHidKeyboardInput', 'br(eurobraille.esytime):l8+joystick1Down': 'toggleHidKeyboardInput'}
gestureMap: inputCore.GlobalGestureMap | None = <inputCore.GlobalGestureMap object>

Global input gesture map for this display driver.

brailleDisplayDrivers.eurobraille.gestures module

class brailleDisplayDrivers.eurobraille.gestures.InputGesture(*args, **kwargs)

Bases: BrailleDisplayGesture, BrailleInputGesture

source = 'eurobraille'
_abc_impl = <_abc._abc_data object>
_propertyCache: Set[GetterMethodT]