PYME.Acquire.acquire_client module

class PYME.Acquire.acquire_client.AcquireClient(url='127.0.0.1', port=8999)

Bases: object

Client for the Acquire server. Offers a pythonic interface to the PYMEAcquire REST API.

spooling_finished()

Returns True if the spooling is finished, False otherwise.

spooling_info()

Returns information about the current spooling.

TODO - Use the long-polling endpoint???

start_spooling(filename='', preflight_mode='abort', settings={})

Starts spooling images to disk. If filename is not provided, the default filename will be used.

property state

Returns the current state of the server (as given by long-polling). Starts polling the first time it is called.

update_scope_state(state: dict)

Updates the scope state with the provided dictionary.