AFL.automation.APIServer.Client

Classes

Client([ip, port, username, interactive])	Communicate with APIServer
ServerDiscovery()	ServerDiscovery class

class AFL.automation.APIServer.Client.Client(ip=None, port='5000', username=None, interactive=False)

Communicate with APIServer

This class provides an interface to generate HTTP REST requests that are sent to an APIServer, monitor the status of those requests, and retrieve the results of those requests. It is intended to be used as a client to the APIServer class.

__init__(ip=None, port='5000', username=None, interactive=False)

classmethod from_server_name(server_name, **kwargs)

logged_in()

login(username, populate_commands=True)

driver_status()

get_queue()

wait(target_uuid=None, interval=0.1, for_history=True, first_check_delay=5.0)

get_quickbar()

server_cmd(cmd, **kwargs)

enqueued_base(**kwargs)

unqueued_base(**kwargs)

get_unqueued_commands(inherit_commands=True)

get_queued_commands(inherit_commands=True)

enqueue(interactive=None, **kwargs)

set_config(interactive=None, **kwargs)

get_config(name, print_console=True, interactive=None)

get_server_time()

query_driver(**kwargs)

reset_queue_daemon()

pause(state)

clear_queue()

clear_history()

debug(state)

halt()

queue_state()

remove_item(uuid)

move_item(uuid, pos)

set_driver_object(**kw)

get_driver_object(name)

deposit_obj(obj, uid=None)

Deposit an object in the dropbox obj : object, the object to deposit id : str, the uuid to deposit the object under if not specified, a new uuid will be generated

retrieve_obj(uid, delete=True)

Retrieve an object from the dropbox id : str, the uuid of the object to retrieve delete : bool, if True, delete the object after retrieving

set_object(serialize=True, **kw)

get_object(name, serialize=True)