mycroft.client.text.text_client Namespace Reference

Classes
class	LogMonitorThread
	Log file monitoring. More...
class	MicMonitorThread
class	ScreenDrawThread

Functions
def	_do_gui (gui_width)
def	_do_meter (height)
def	_get_cmd_param (cmd, keyword)
	Main UI lopo. More...
def	add_log_message (message)
def	center (str_len)
def	clamp (n, smallest, largest)
	Helper functions. More...
def	clear_log ()
def	connect (bus)
def	connect_to_messagebus ()
def	connect_to_mycroft ()
def	ctrl_c_handler (signum, frame)
def	ctrl_c_pressed ()
def	do_draw_help (scr)
def	do_draw_main (scr)
def	draw (x, y, msg, pad=None, pad_chr=None, clr=None)
	"Graphic primitives" More...
def	gui_main (stdscr)
def	handle_cmd (cmd)
def	handle_is_connected (msg)
def	handle_message (msg)
	Capturing the messagebus. More...
def	handle_reconnecting ()
def	handle_speak (event)
	Capturing output from Mycroft. More...
def	handle_utterance (event)
def	handleNonAscii (text)
def	init_screen ()
	Screen handling. More...
def	load_mycroft_config (bus)
def	load_settings ()
def	make_titlebar (title, bar_length)
def	num_help_pages ()
def	rebuild_filtered_log ()
def	save_settings ()
def	scroll_log (up, num_lines=None)
def	set_screen_dirty ()
def	show_help ()
def	show_next_help ()
def	show_skills (skills)
	Skill debugging. More...
def	simple_cli ()
def	start_log_monitor (filename)
def	start_mic_monitor (filename)

Variables
bool	auto_scroll = True
bool	bSimple = False
	bus = None
list	chat = []
int	CLR_CHAT_QUERY = 0
int	CLR_CHAT_RESP = 0
int	CLR_CMDLINE = 0
int	CLR_FIND = 0
int	CLR_HEADING = 0
int	CLR_INPUT = 0
int	CLR_LOG1 = 0
int	CLR_LOG2 = 0
int	CLR_LOG_CMDMESSAGE = 0
int	CLR_LOG_DEBUG = 0
int	CLR_LOG_ERROR = 0
int	CLR_METER = 0
int	CLR_METER_CUR = 0
dictionary	config = {}
	config_file = os.path.join(os.path.expanduser("~"), ".mycroft_cli.conf")
	Settings. More...
bool	ctrl_c_was_pressed = False
int	cy_chat_area = 7
list	default_log_filters = ["mouth.viseme", "mouth.display", "mouth.icon", "DEBUG"]
	event_thread = None
list	filteredLog = []
	find_str = None
int	FULL_REDRAW_FREQUENCY = 10
list	gui_text = []
int	help_longest = 0
list	help_struct
	Help system. More...
list	history = []
bool	is_screen_dirty = True
	last_full_redraw = time.time()-(FULL_REDRAW_FREQUENCY-1)
string	last_key = ""
string	line = ""
list	log_files = []
	log_filters = list(default_log_filters)
int	log_line_lr_scroll = 0
int	log_line_offset = 0
	log_lock = Lock()
int	longest_visible_line = 0
int	max_log_lines = 5000
list	mergedLog = []
int	meter_cur = -1
int	meter_peak = 20
int	meter_thresh = -1
	preferred_encoding = locale.getpreferredencoding()
	scr = None
int	SCR_HELP = 1
int	SCR_MAIN = 0
int	SCR_SKILLS = 2
	screen_lock = Lock()
	screen_mode = SCR_MAIN
	show_gui = None
bool	show_last_key = False
bool	show_meter = True
int	size_log_area = 0
int	subscreen = 0

Function Documentation

def mycroft.client.text.text_client._do_gui (   gui_width )

private

Definition at line 624 of file text_client.py.

def mycroft.client.text.text_client._do_meter (   height )

private

Definition at line 560 of file text_client.py.

def mycroft.client.text.text_client._get_cmd_param (   cmd,   keyword  )

private

Main UI lopo.

Definition at line 1046 of file text_client.py.

def mycroft.client.text.text_client.add_log_message

(

message

)

Show a message for the user (mixed in the logs) 

Definition at line 362 of file text_client.py.

def mycroft.client.text.text_client.center

(

str_len

)

Definition at line 1037 of file text_client.py.

def mycroft.client.text.text_client.clamp	(		n,
			smallest,
			largest
	)

Helper functions.

Force n to be between smallest and largest, inclusive 

Definition at line 130 of file text_client.py.

def mycroft.client.text.text_client.clear_log

(

)

Definition at line 379 of file text_client.py.

def mycroft.client.text.text_client.connect

(

bus

)

Run the mycroft messagebus referenced by bus.

    Arguments:
        bus:    Mycroft messagebus instance

Definition at line 440 of file text_client.py.

def mycroft.client.text.text_client.connect_to_messagebus

(

)

Connect to the mycroft messagebus and launch a thread handling the
    connection.

    Returns: WebsocketClient

Definition at line 1421 of file text_client.py.

def mycroft.client.text.text_client.connect_to_mycroft

(

)

Connect to the mycroft messagebus and load and register config
    on the bus.

    Sets the bus and config global variables

Definition at line 159 of file text_client.py.

def mycroft.client.text.text_client.ctrl_c_handler	(		signum,
			frame
	)

Definition at line 110 of file text_client.py.

def mycroft.client.text.text_client.ctrl_c_pressed

(

)

Definition at line 115 of file text_client.py.

def mycroft.client.text.text_client.do_draw_help

(

scr

)

Definition at line 899 of file text_client.py.

def mycroft.client.text.text_client.do_draw_main

(

scr

)

Definition at line 650 of file text_client.py.

def mycroft.client.text.text_client.draw	(		x,
			y,
			msg,
			pad = None,
			pad_chr = None,
			clr = None
	)

"Graphic primitives"

Draw a text to the screen

Args:
    x (int): X coordinate (col), 0-based from upper-left
    y (int): Y coordinate (row), 0-based from upper-left
    msg (str): string to render to screen
    pad (bool or int, optional): if int, pads/clips to given length, if
                                 True use right edge of the screen.
    pad_chr (char, optional): pad character, default is space
    clr (int, optional): curses color, Defaults to CLR_LOG1.

Definition at line 460 of file text_client.py.

def mycroft.client.text.text_client.gui_main

(

stdscr

)

Definition at line 1182 of file text_client.py.

def mycroft.client.text.text_client.handle_cmd

(

cmd

)

Definition at line 1067 of file text_client.py.

def mycroft.client.text.text_client.handle_is_connected

(

msg

)

Definition at line 1173 of file text_client.py.

def mycroft.client.text.text_client.handle_message

(

msg

)

Capturing the messagebus.

Definition at line 452 of file text_client.py.

def mycroft.client.text.text_client.handle_reconnecting

(

)

Definition at line 1178 of file text_client.py.

def mycroft.client.text.text_client.handle_speak

(

event

)

Capturing output from Mycroft.

Definition at line 420 of file text_client.py.

def mycroft.client.text.text_client.handle_utterance

(

event

)

Definition at line 431 of file text_client.py.

def mycroft.client.text.text_client.handleNonAscii

(

text

)

    If default locale supports UTF-8 reencode the string otherwise
    remove the offending characters.

Definition at line 135 of file text_client.py.

def mycroft.client.text.text_client.init_screen

(

)

Screen handling.

Definition at line 500 of file text_client.py.

def mycroft.client.text.text_client.load_mycroft_config

(

bus

)

Load the mycroft config and connect it to updates over the messagebus.

Definition at line 152 of file text_client.py.

def mycroft.client.text.text_client.load_settings

(

)

Definition at line 171 of file text_client.py.

def mycroft.client.text.text_client.make_titlebar	(		title,
			bar_length
	)

Definition at line 827 of file text_client.py.

def mycroft.client.text.text_client.num_help_pages

(

)

Definition at line 892 of file text_client.py.

def mycroft.client.text.text_client.rebuild_filtered_log

(

)

Definition at line 391 of file text_client.py.

def mycroft.client.text.text_client.save_settings

(

)

Definition at line 195 of file text_client.py.

def mycroft.client.text.text_client.scroll_log	(		up,
			num_lines = None
	)

Definition at line 541 of file text_client.py.

def mycroft.client.text.text_client.set_screen_dirty

(

)

Definition at line 642 of file text_client.py.

def mycroft.client.text.text_client.show_help

(

)

Definition at line 954 of file text_client.py.

def mycroft.client.text.text_client.show_next_help

(

)

Definition at line 964 of file text_client.py.

def mycroft.client.text.text_client.show_skills

(

skills

)

Skill debugging.

    Show list of loaded skills in as many column as necessary

Definition at line 978 of file text_client.py.

def mycroft.client.text.text_client.simple_cli

(

)

Definition at line 1398 of file text_client.py.

def mycroft.client.text.text_client.start_log_monitor

(

filename

)

Definition at line 285 of file text_client.py.

def mycroft.client.text.text_client.start_mic_monitor

(

filename

)

Definition at line 355 of file text_client.py.

Variable Documentation

bool mycroft.client.text.text_client.auto_scroll = True

Definition at line 54 of file text_client.py.

bool mycroft.client.text.text_client.bSimple = False

Definition at line 43 of file text_client.py.

mycroft.client.text.text_client.bus = None

Definition at line 44 of file text_client.py.

list mycroft.client.text.text_client.chat = []

Definition at line 48 of file text_client.py.

int mycroft.client.text.text_client.CLR_CHAT_QUERY = 0

Definition at line 95 of file text_client.py.

int mycroft.client.text.text_client.CLR_CHAT_RESP = 0

Definition at line 94 of file text_client.py.

int mycroft.client.text.text_client.CLR_CMDLINE = 0

Definition at line 96 of file text_client.py.

int mycroft.client.text.text_client.CLR_FIND = 0

Definition at line 93 of file text_client.py.

int mycroft.client.text.text_client.CLR_HEADING = 0

Definition at line 92 of file text_client.py.

int mycroft.client.text.text_client.CLR_INPUT = 0

Definition at line 97 of file text_client.py.

int mycroft.client.text.text_client.CLR_LOG1 = 0

Definition at line 98 of file text_client.py.

int mycroft.client.text.text_client.CLR_LOG2 = 0

Definition at line 99 of file text_client.py.

int mycroft.client.text.text_client.CLR_LOG_CMDMESSAGE = 0

Definition at line 102 of file text_client.py.

int mycroft.client.text.text_client.CLR_LOG_DEBUG = 0

Definition at line 100 of file text_client.py.

int mycroft.client.text.text_client.CLR_LOG_ERROR = 0

Definition at line 101 of file text_client.py.

int mycroft.client.text.text_client.CLR_METER = 0

Definition at line 104 of file text_client.py.

int mycroft.client.text.text_client.CLR_METER_CUR = 0

Definition at line 103 of file text_client.py.

dictionary mycroft.client.text.text_client.config = {}

Definition at line 45 of file text_client.py.

mycroft.client.text.text_client.config_file = os.path.join(os.path.expanduser("~"), ".mycroft_cli.conf")

Settings.

Definition at line 149 of file text_client.py.

bool mycroft.client.text.text_client.ctrl_c_was_pressed = False

Definition at line 107 of file text_client.py.

int mycroft.client.text.text_client.cy_chat_area = 7

Definition at line 70 of file text_client.py.

list mycroft.client.text.text_client.default_log_filters = ["mouth.viseme", "mouth.display", "mouth.icon", "DEBUG"]

Definition at line 66 of file text_client.py.

mycroft.client.text.text_client.event_thread = None

Definition at line 46 of file text_client.py.

list mycroft.client.text.text_client.filteredLog = []

Definition at line 65 of file text_client.py.

mycroft.client.text.text_client.find_str = None

Definition at line 69 of file text_client.py.

int mycroft.client.text.text_client.FULL_REDRAW_FREQUENCY = 10

Definition at line 86 of file text_client.py.

list mycroft.client.text.text_client.gui_text = []

Definition at line 60 of file text_client.py.

mycroft.client.text.text_client.help_longest = 0

Definition at line 886 of file text_client.py.

list mycroft.client.text.text_client.help_struct

Help system.

Definition at line 834 of file text_client.py.

list mycroft.client.text.text_client.history = []

Definition at line 47 of file text_client.py.

bool mycroft.client.text.text_client.is_screen_dirty = True

Definition at line 89 of file text_client.py.

mycroft.client.text.text_client.last_full_redraw = time.time()-(FULL_REDRAW_FREQUENCY-1)

Definition at line 87 of file text_client.py.

string mycroft.client.text.text_client.last_key = ""

Definition at line 57 of file text_client.py.

string mycroft.client.text.text_client.line = ""

Definition at line 49 of file text_client.py.

list mycroft.client.text.text_client.log_files = []

Definition at line 68 of file text_client.py.

mycroft.client.text.text_client.log_filters = list(default_log_filters)

Definition at line 67 of file text_client.py.

int mycroft.client.text.text_client.log_line_lr_scroll = 0

Definition at line 52 of file text_client.py.

int mycroft.client.text.text_client.log_line_offset = 0

Definition at line 51 of file text_client.py.

mycroft.client.text.text_client.log_lock = Lock()

Definition at line 62 of file text_client.py.

int mycroft.client.text.text_client.longest_visible_line = 0

Definition at line 53 of file text_client.py.

int mycroft.client.text.text_client.max_log_lines = 5000

Definition at line 63 of file text_client.py.

list mycroft.client.text.text_client.mergedLog = []

Definition at line 64 of file text_client.py.

int mycroft.client.text.text_client.meter_cur = -1

Definition at line 77 of file text_client.py.

int mycroft.client.text.text_client.meter_peak = 20

Definition at line 76 of file text_client.py.

int mycroft.client.text.text_client.meter_thresh = -1

Definition at line 78 of file text_client.py.

mycroft.client.text.text_client.preferred_encoding = locale.getpreferredencoding()

Definition at line 41 of file text_client.py.

mycroft.client.text.text_client.scr = None

Definition at line 50 of file text_client.py.

int mycroft.client.text.text_client.SCR_HELP = 1

Definition at line 81 of file text_client.py.

int mycroft.client.text.text_client.SCR_MAIN = 0

Definition at line 80 of file text_client.py.

int mycroft.client.text.text_client.SCR_SKILLS = 2

Definition at line 82 of file text_client.py.

mycroft.client.text.text_client.screen_lock = Lock()

Definition at line 88 of file text_client.py.

mycroft.client.text.text_client.screen_mode = SCR_MAIN

Definition at line 83 of file text_client.py.

mycroft.client.text.text_client.show_gui = None

Definition at line 59 of file text_client.py.

bool mycroft.client.text.text_client.show_last_key = False

Definition at line 58 of file text_client.py.

bool mycroft.client.text.text_client.show_meter = True

Definition at line 75 of file text_client.py.

int mycroft.client.text.text_client.size_log_area = 0

Definition at line 71 of file text_client.py.

int mycroft.client.text.text_client.subscreen = 0

Definition at line 85 of file text_client.py.