zlp_projector_manager module

This module imports all the other modules and manages the functionalities provided from a layer of abstraction, simplifying the task of developing advanced applications.

class z_laser_zlp1.zlp_projector_manager.ZLPProjectorManager(projector_IP='192.168.10.10', server_IP='192.168.10.11', connection_port=9090, lic_path='')[source]

Bases: object

This class envolves the methods from the modules imported.

Parameters:
  • projector_IP (str) – IP number of projector device
  • server_IP (str) – IP number of service running at projector device
  • connection_port (int) – connection port number
projector_client

ProjectorClient object from utils library

Type:object
__init__(projector_IP='192.168.10.10', server_IP='192.168.10.11', connection_port=9090, lic_path='')[source]

Initialize the ZLPProjectorManager object.

connect_and_setup()[source]

Prepare projector to be used: connect, load license and activate.

Raises:SystemError
client_server_connect()[source]

Connect to thrift server of ZLP-Service.

Raises:ConnectionError
client_server_disconnect()[source]

Disconnect from thrift server of ZLP-Service.

Raises:ConnectionError
get_connection_status()[source]

Get connection status of projector device.

Returns:true if projector is connected, false otherwise
Return type:bool
load_license(license_path)[source]

Transfer license file to service.

Parameters:license_path (str) – path of the license file
Raises:FileNotFoundError
activate()[source]

Activate projector once it is connected and license is transferred.

Raises:SystemError
deactivate()[source]

Deactivate projector.

Raises:SystemError
geotree_operator_create()[source]

Create geotree operator to handle reference systems and projection elements.

Raises:SystemError
start_projection()[source]

Start projection of elements associated to the active reference system.

Raises:
stop_projection()[source]

Stop projection of all elements.

Raises:SystemError
get_coordinate_systems_list()[source]

Get list of all defined reference systems.

Raises:SystemError
Returns:list of defined coordinate systems string: name of the active coordinate system if it exists
Return type:list
get_coordinate_system_params(cs_name)[source]

Get parameters values of a defined coordinate system.

Parameters:cs_name (str) – name of reference coordinate system
Raises:SystemError
define_coordinate_system(cs_params, do_target_search)[source]

Define a new coordinate reference system.

Parameters:cs_params (list) – list of necessary parameters to define a new reference system
Raises:SystemError
set_coordinate_system(cs_name)[source]

Set the active reference system.

Parameters:cs_name (str) – name of reference system
Raises:SystemError
show_coordinate_system()[source]

Project the reference points of the active reference system on the projection surface.

Raises:SystemError
hide_coordinate_system()[source]

Hide the reference points of the active reference system.

Raises:SystemError
remove_coordinate_system(cs_name)[source]

Delete a reference system.

Parameters:cs_name (str) – name of reference system
Returns:true if the reference system to remove is the active coordinate system, false otherwise
Return type:bool
Raises:SystemError
create_polyline(proj_elem_params)[source]

Create a polyline as new projection element, associated to the active reference system.

Parameters:proj_elem_params (object) – object with the necessary parameters to define a new polyline
Raises:SystemError
create_curve(proj_elem_params)[source]

Create a curve (circle, oval, arc) as new projection element, associated to the active reference system.

Parameters:proj_elem_params (object) – object with the necessary parameters to define a new curve
Raises:SystemError
create_text(proj_elem_params)[source]

Create a text as new projection element, associated to the active reference system.

Parameters:proj_elem_params (object) – object with the necessary parameters to define a new text
Raises:SystemError
get_proj_elem(params)[source]

Get the parameters of a defined projection element.

Parameters:params (object) – object with the necessary parameters to identify a projection element
Raises:SystemError
hide_proj_elem(params)[source]

Hide a projection element from active reference system.

Parameters:params (object) – object with necessary parameters to identify a projection element
Raises:SystemError
unhide_proj_elem(params)[source]

Unhide a projection element from active reference system.

Parameters:params (object) – object with necessary parameters to identify a projection element
Raises:SystemError
remove_proj_elem(params)[source]

Delete a projection element from active reference system.

Parameters:params (object) – object with necessary parameters to identify a projection element
Raises:SystemError
monitor_proj_elem(params)[source]

Monitor transformation operations (translation, rotation, scalation) to a specific projection element on real time projection by the use of keyboard.

Parameters:

params (object) – object with necessary parameters to identify a projection element

Raises:
create_pointer(proj_elem_params)[source]

Create a pointer to be scanned as new projection element, associated to the active reference system.

Parameters:proj_elem_params (object) – object with the necessary parameters to define a new pointer
Raises:SystemError
scan_pointer(reflection_callback=None)[source]

Set callback for reflection state change and start pointers scanning.

Parameters:reflection_callback (object) – callback function
Raises:SystemError
show_frame()[source]

Project the origin axes and frame of the active reference system on the projection surface.

Raises:SystemError
hide_frame()[source]

Hide the origin axes and frame of the active reference system.

Raises:SystemError
cs_axes_create(cs_params)[source]

Create the projection elements of the origin axes for the user reference system.

Parameters:cs_params (object) – object with the parameters of the new reference system defined
Raises:SystemError
cs_frame_create(cs_params)[source]

Create the projection element of the system frame for the user reference system.

Parameters:cs_params (object) – object with the parameters of the new reference system defined
Raises:SystemError
cs_axes_unhide()[source]

Unhide user reference system origin axes.

Raises:SystemError
cs_axes_hide()[source]

Hide user reference system origin axes.

Raises:SystemError
cs_frame_unhide()[source]

Unhide frame of user reference system.

Raises:SystemError
cs_frame_hide()[source]

Hide frame of user reference system.

Raises:SystemError
projector_IP

Get or set the projector IP address.

server_IP

Get or set IP address of server running at projector device.

connection_port

Get or set connection port number.

license_path

Get or set license file path.