focus.py

#! /usr/bin/env python
## kaleidoscope-focus -- Bidirectional communication plugin, host helper
## Copyright (C) 2017  Gergely Nagy
##
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.

import serial
import serial.tools.list_ports
import sys
import time
import os
import atexit
import argparse

RAISE_VIDPID = '1209:2201'

try:
    import readline
except ImportError:
    import pyreadline as readline


class Commander(object):

    def run(self):
        try:
            cmd = raw_input("> ")
        except NameError:
            cmd = input("> ")

        if cmd == "quit" or cmd == "exit":
            sys.exit(0)

        if cmd == "":
            return

        print("")

        hadOutput = False
        with serial.Serial(args.port, 9600, timeout = 1) as ser:
            ser.write(str.encode(cmd + "\n"))
            while True:
                resultLine = ser.readline().decode('utf-8')

                if resultLine == "\r\n" or resultLine == "\n":
                    resultLine = " "
                else:
                    resultLine = resultLine.rstrip()

                if resultLine == ".":
                    break

                if resultLine:
                    hadOutput = True
                    print("< %s" % resultLine)

        if hadOutput:
            print("")


if __name__ == '__main__':

    parser = argparse.ArgumentParser(description="talk to the Kaleidoscope keyboard via serial to Focus Plugin")
    parser.add_argument('--port') # allow override
    args = parser.parse_args()

    # by default, find an attached raise
    if not args.port:
        ports = serial.tools.list_ports.grep(RAISE_VIDPID)
        for port in ports:
            print("found %s port on %s" % (port.usb_description(), port.device))
            args.port = port.device

    commander = Commander()

    histfile = os.path.join(os.path.expanduser("~"), ".kaleidoscope-commander.hist")
    try:
        readline.read_history_file(histfile)
    except IOError:
        pass
    atexit.register(readline.write_history_file, histfile)

    while True:
        try:
            commander.run()
        except EOFError:
            sys.exit(0)
        except serial.serialutil.SerialException as e:
            print("WARNING: Connection to serial lost, sleeping 10s...")
            time.sleep(10)
            print("WARNING: Sleep over, resuming!")
            pass