dragonfly.implementations.prologix_provider module

Some template vars

Members: PrologixProvider Functions: Classes:

<this should say something useful>

Summary

class dragonfly.implementations.prologix_provider.PrologixProvider(addr, response_terminator=None, **kwargs)

Bases: dragonfly.implementations.prologix_provider.PrologixProvider

A Provider class intended for GPIB devices that implement the full IEEE 488.2 (488.1 or 488 need to use some other class). It expects to have a set of *Spime endpoints which return SCPI commands.

Keyword Arguments:
 
  • addr (int) – GPIB address of instrument
  • response_terminator (str) – optional terminator to check responses for and strip off
  • repeat_target (str) – name of service to send OP_SEND to
  • timeout (float) – time in seconds for request to timeout
  • name (str) – unique identifier across all dripline services (used to determine routing key)
  • calibration (str||dict) – string use to process raw get result (with .format(raw)) or a dict to use for the same purpose where raw must be a key
  • get_on_set (bool) – flag to toggle running ‘on_get’ after each ‘on_set’

addr (int): GPIB address of instrument response_terminator (str): optional terminator to check responses for and strip off

add_endpoint(endpoint)
cmd(target, method_name, value=[], payload={}, lockout_key=False, timeout=None, ignore_retcode=False)
endpoint(endpoint)
endpoint_names
endpoints
get(target, timeout=None, ignore_retcode=False)
handle_request(channel, method, properties, request)
is_locked
list_endpoints()
lock(*args, **kwargs)
lockout_key
logging_status
on_cmd(*args, **kwargs)

WARNING! if you override this method, you must ensure you deal with lockout properly

on_config(attribute, value=None)

configure a property again

WARNING! if you override this method, you must ensure you deal with lockout properly

on_send(*commands)
on_set(*args, **kwargs)
ping(*args, **kwargs)

ignore all details and respond with an empty message

schedule_status
send(cmd, timeout=None)
set(target, value, lockout_key=False, timeout=None, ignore_retcode=False)
set_condition(*args, **kwargs)

To actually do something inside a class, the set_condition should be implemented in the class itself.

unlock(*args, **kwargs)

End of modules condition

Data:

End of data condition