mirror of
https://github.com/lowobservable/oec.git
synced 2026-03-07 11:39:38 +00:00
312 lines
9.7 KiB
Python
312 lines
9.7 KiB
Python
"""
|
|
oec.controller
|
|
~~~~~~~~~~~~~~
|
|
"""
|
|
|
|
import os
|
|
import time
|
|
import logging
|
|
import selectors
|
|
from textwrap import dedent
|
|
from coax import poll, poll_ack, load_control_register, get_features, PollAction, \
|
|
KeystrokePollResponse, TerminalType, Feature, ReceiveTimeout, \
|
|
ReceiveError, ProtocolError
|
|
|
|
from .terminal import Terminal, UnsupportedTerminalError, read_terminal_ids
|
|
from .keyboard import Key
|
|
from .session import SessionDisconnectedError
|
|
|
|
class Controller:
|
|
"""The controller."""
|
|
|
|
def __init__(self, interface, get_keymap, create_session):
|
|
self.logger = logging.getLogger(__name__)
|
|
|
|
self.running = False
|
|
|
|
self.interface = interface
|
|
self.get_keymap = get_keymap
|
|
self.create_session = create_session
|
|
|
|
self.terminal = None
|
|
self.session = None
|
|
|
|
self.session_selector = None
|
|
|
|
# Target time between POLL commands in seconds when a terminal is connected or
|
|
# no terminal is connected.
|
|
#
|
|
# The connected poll period only applies in cases where the terminal responded
|
|
# with TR/TA to the last poll - this is an effort to improve the keystroke
|
|
# responsiveness.
|
|
self.connected_poll_period = 1 / 10
|
|
self.disconnected_poll_period = 5
|
|
|
|
self.last_poll_time = None
|
|
self.last_poll_response = None
|
|
|
|
def run(self):
|
|
"""Run the controller."""
|
|
self.running = True
|
|
|
|
self.session_selector = selectors.DefaultSelector()
|
|
|
|
while self.running:
|
|
self._run_loop()
|
|
|
|
self._terminate_session()
|
|
|
|
self.session_selector.close()
|
|
|
|
self.session_selector = None
|
|
|
|
if self.terminal:
|
|
self.terminal = None
|
|
|
|
def stop(self):
|
|
self.running = False
|
|
|
|
def _run_loop(self):
|
|
poll_delay = self._calculate_poll_delay(time.perf_counter())
|
|
|
|
# If POLLing is delayed, handle the host output, otherwise just sleep.
|
|
if poll_delay > 0:
|
|
if self.session:
|
|
try:
|
|
self._update_session(poll_delay)
|
|
except SessionDisconnectedError:
|
|
self._handle_session_disconnected()
|
|
else:
|
|
time.sleep(poll_delay)
|
|
|
|
try:
|
|
poll_response = self._poll()
|
|
except ReceiveTimeout:
|
|
if self.terminal:
|
|
self._handle_terminal_detached()
|
|
|
|
return
|
|
except ReceiveError as error:
|
|
self.logger.warning(f'POLL receive error: {error}', exc_info=error)
|
|
return
|
|
except ProtocolError as error:
|
|
self.logger.warning(f'POLL protocol error: {error}', exc_info=error)
|
|
return
|
|
|
|
if not self.terminal:
|
|
try:
|
|
self._handle_terminal_attached(poll_response)
|
|
except UnsupportedTerminalError as error:
|
|
self.logger.error(f'Unsupported terminal: {error}')
|
|
return
|
|
|
|
if poll_response:
|
|
self._handle_poll_response(poll_response)
|
|
|
|
def _handle_terminal_attached(self, poll_response):
|
|
self.logger.info('Terminal attached')
|
|
|
|
jumbo_write_strategy = _get_jumbo_write_strategy()
|
|
|
|
# Read the terminal identifiers.
|
|
(terminal_id, extended_id) = read_terminal_ids(self.interface)
|
|
|
|
self.logger.info(f'Terminal ID = {terminal_id}, Extended ID = {extended_id}')
|
|
|
|
if terminal_id.type != TerminalType.CUT:
|
|
raise UnsupportedTerminalError('Only CUT type terminals are supported')
|
|
|
|
# Get the terminal features.
|
|
features = get_features(self.interface)
|
|
|
|
self.logger.info(f'Features = {features}')
|
|
|
|
if Feature.EAB in features:
|
|
if self.interface.legacy_firmware_detected and jumbo_write_strategy is None:
|
|
del features[Feature.EAB]
|
|
|
|
_print_no_i1_eab_notice()
|
|
|
|
# Get the keymap.
|
|
keymap = self.get_keymap(terminal_id, extended_id)
|
|
|
|
# Initialize the terminal.
|
|
self.terminal = Terminal(self.interface, terminal_id, extended_id,
|
|
features, keymap,
|
|
jumbo_write_strategy=jumbo_write_strategy)
|
|
|
|
(rows, columns) = self.terminal.display.dimensions
|
|
keymap_name = self.terminal.keyboard.keymap.name
|
|
|
|
self.logger.info(f'Rows = {rows}, Columns = {columns}, Keymap = {keymap_name}')
|
|
|
|
if self.terminal.display.has_eab:
|
|
self.terminal.display.load_eab_mask(0xff)
|
|
|
|
self.terminal.display.clear(clear_status_line=True)
|
|
|
|
# Show the attached indicator on the status line.
|
|
self.terminal.display.status_line.write_string(0, 'S')
|
|
|
|
# Start the session.
|
|
self._start_session()
|
|
|
|
def _handle_terminal_detached(self):
|
|
self.logger.info('Terminal detached')
|
|
|
|
self._terminate_session()
|
|
|
|
self.terminal = None
|
|
|
|
def _handle_session_disconnected(self):
|
|
self.logger.info('Session disconnected')
|
|
|
|
self._terminate_session()
|
|
|
|
# Restart the session.
|
|
self._start_session()
|
|
|
|
def _start_session(self):
|
|
self.session = self.create_session(self.terminal)
|
|
|
|
self.session.start()
|
|
|
|
self.session_selector.register(self.session, selectors.EVENT_READ)
|
|
|
|
def _terminate_session(self):
|
|
if not self.session:
|
|
return
|
|
|
|
self.session_selector.unregister(self.session)
|
|
|
|
self.session.terminate()
|
|
|
|
self.session = None
|
|
|
|
def _update_session(self, duration):
|
|
while duration > 0:
|
|
start_time = time.perf_counter()
|
|
|
|
selected = self.session_selector.select(duration)
|
|
|
|
if not selected:
|
|
break
|
|
|
|
for (key, events) in selected:
|
|
session = key.fileobj
|
|
|
|
session.handle_host()
|
|
|
|
duration -= (time.perf_counter() - start_time)
|
|
|
|
def _handle_poll_response(self, poll_response):
|
|
if isinstance(poll_response, KeystrokePollResponse):
|
|
self._handle_keystroke_poll_response(poll_response)
|
|
|
|
def _handle_keystroke_poll_response(self, poll_response):
|
|
scan_code = poll_response.scan_code
|
|
|
|
(key, modifiers, modifiers_changed) = self.terminal.keyboard.get_key(scan_code)
|
|
|
|
if self.logger.isEnabledFor(logging.DEBUG):
|
|
self.logger.debug((f'Keystroke detected: Scan Code = {scan_code}, '
|
|
f'Key = {key}, Modifiers = {modifiers}'))
|
|
|
|
# Update the status line if modifiers have changed.
|
|
if modifiers_changed:
|
|
self.terminal.display.status_line.write_keyboard_modifiers(modifiers)
|
|
|
|
if not key:
|
|
return
|
|
|
|
if key == Key.CURSOR_BLINK:
|
|
self.terminal.display.toggle_cursor_blink()
|
|
|
|
self._load_control_register()
|
|
elif key == Key.ALT_CURSOR:
|
|
self.terminal.display.toggle_cursor_reverse()
|
|
|
|
self._load_control_register()
|
|
elif key == Key.CLICKER:
|
|
self.terminal.keyboard.toggle_clicker()
|
|
elif self.session:
|
|
self.session.handle_key(key, modifiers, scan_code)
|
|
|
|
def _poll(self):
|
|
self.last_poll_time = time.perf_counter()
|
|
|
|
poll_action = self.terminal.get_poll_action() if self.terminal else PollAction.NONE
|
|
|
|
poll_response = poll(self.interface, poll_action, receive_timeout=1)
|
|
|
|
if poll_response:
|
|
try:
|
|
poll_ack(self.interface)
|
|
except ReceiveError as error:
|
|
self.logger.warning(f'POLL_ACK receive error: {error}', exc_info=error)
|
|
except ProtocolError as error:
|
|
self.logger.warning(f'POLL_ACK protocol error: {error}', exc_info=error)
|
|
|
|
self.last_poll_response = poll_response
|
|
|
|
return poll_response
|
|
|
|
def _calculate_poll_delay(self, current_time):
|
|
if self.last_poll_response is not None:
|
|
return 0
|
|
|
|
if self.last_poll_time is None:
|
|
return 0
|
|
|
|
if self.terminal:
|
|
period = self.connected_poll_period
|
|
else:
|
|
period = self.disconnected_poll_period
|
|
|
|
return max((self.last_poll_time + period) - current_time, 0)
|
|
|
|
def _load_control_register(self):
|
|
load_control_register(self.interface, self.terminal.get_control_register())
|
|
|
|
def _get_jumbo_write_strategy():
|
|
value = os.environ.get('COAX_JUMBO')
|
|
|
|
if value is None:
|
|
return None
|
|
|
|
if value in ['split', 'ignore']:
|
|
return value
|
|
|
|
self.logger.warning(f'Unsupported COAX_JUMBO option: {value}')
|
|
|
|
return None
|
|
|
|
def _print_no_i1_eab_notice():
|
|
notice = '''
|
|
**** **** **** **** **** **** **** **** **** **** **** **** **** **** **** ****
|
|
|
|
Your terminal is reporting the existence of an EAB feature that allows extended
|
|
colors and formatting, however...
|
|
|
|
I think you are using an older firmware on the 1st generation, Arduino Mega
|
|
based, interface which does not support the "jumbo write" required to write a
|
|
full screen to the regen and EAB buffers.
|
|
|
|
I'm going to continue as if the EAB feature did not exist...
|
|
|
|
If you want to override this behavior, you can set the COAX_JUMBO environment
|
|
variable as follows:
|
|
|
|
- COAX_JUMBO=split - split large writes into multiple smaller 32-byte writes
|
|
before sending to the interface, this will result in
|
|
additional round trips to the interface which may
|
|
manifest as visible incremental changes being applied
|
|
to the screen
|
|
- COAX_JUMBO=ignore - try a jumbo write, anyway, use this option if you
|
|
believe you are seeing this behavior in error
|
|
|
|
**** **** **** **** **** **** **** **** **** **** **** **** **** **** **** ****
|
|
'''
|
|
|
|
print(dedent(notice))
|