https://pycertifspec.readthedocs.io/en/latest/ Recent content in Home on pycertifspec Hugo -- gohugo.io en-us https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/client/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/client/ pycertifspec.Client # [view_source] Client Objects # class Client() [view_source] Connection to SPEC You should only need one instance of this class and use it to create Motor, Variable, etc. instances __init__ # | __init__(host: str = "localhost", port: int = None, port_range: Tuple[int, int] = (6510, 6530), ports: List[int] = [], timeout: float = 0.5, log_messages: bool = False) [view_source] Attempt to create a connection to SPEC https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/motor/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/motor/ pycertifspec.Motor # [view_source] Motor Objects # class Motor(object) [view_source] SPEC motor position # [view_source] Get the motor position in user units (setting a value will NOT move the motor but change the position offset) dial_position # [view_source] Get motor position in dial units (setting a value will NOT move the motor) offset # [view_source] The current user offset in dial units step_size # [view_source] https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/specsocket/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/specsocket/ pycertifspec.SpecSocket # [view_source] SpecMessage # [view_source] NamedTuple representing a response from SPEC. Fields are named the same as in the server documentation: https://www.certif.com/spec_help/server.html#protocol Properties: magic - Spec magic number (4277009102) vers - Protocol version number size - Size of the header sn - Serial number (same as request if response) sec - Time when sent usec - Time when sent cmd - Command code (One of pycertifspec.EventTypes) type - Type of body data (One of pycertifspec. https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/variables/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/variables/ pycertifspec.ArrayVar # [view_source] ArrayVar Objects # class ArrayVar(Var, collections.MutableSequence) [view_source] Represents a SPEC array and behaves like a regular python list. Values assigned to array indices will be pushed to SPEC. The connection to SPEC decreases performance since the array gets fetched every time it is accessed. Therefore, for expensive computations, store the .value to a different variable and use that. You usually don’t need to instantiate this class since it is easier to just use client. https://pycertifspec.readthedocs.io/en/latest/docs/getting-started/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/getting-started/ Getting Started # Installation # With python >=3.4 pip install git+https://github.com/SEBv15/pycertifspec.git Usage # Starting SPEC # The library needs a SPEC session to communicate with. To start SPEC in server mode simply start the shell with the -S [port] flag. When the port is not specified, one off 6510 - 6530 will be used. Example: spec -S 6510 This also works for specfe: specfe fourc -S More on the official documentation https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/constants/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/constants/ pycertifspec.DataTypes # [view_source] DataTypes Objects # class DataTypes() [view_source] All supported SPEC data types SV_DOUBLE # [view_source] Not used by SPEC (np.double) SV_STRING # [view_source] Regular string. Basically used for everything by SPEC SV_ERROR # [view_source] An error occurred SV_ASSOC # [view_source] Associative array (dict) SV_ARR_DOUBLE # [view_source] Array of np.double SV_ARR_FLOAT # [view_source] Array of np.single SV_ARR_LONG # [view_source] Array of np. https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/commanddetector/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/commanddetector/ pycertifspec.bluesky.CommandDetector # [view_source] CommandDetector Objects # class CommandDetector() [view_source] __init__ # | __init__(client: SPECClient, name: str, start_command: str, poll_command: Optional[str] = None, evaluate_poll: Callable[[SpecMessage, str], bool] = lambda _, __: True) [view_source] Create a bluesky combatible detector backed by SPEC commands. For each run, the response to all commands will be saved as metadata. In addition, it is possible to configure a description string which can be used to store, for example, the location of the data files for later reference. https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/counter/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/counter/ pycertifspec.bluesky.Counter # [view_source] Counter Objects # class Counter() [view_source] __init__ # | __init__(client, name="SPEC", visualize_counters=[]) [view_source] Create a bluesky combatible detector from SPEC counters Arguments: client - An instance of the Client class name string - Name to be used in bluesky visualize_counters list - List of counter names to use for best-effort visualization configure # | configure(duration: float) [view_source] Configure the time (in seconds) to count https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/motor/ Mon, 01 Jan 0001 00:00:00 +0000 https://pycertifspec.readthedocs.io/en/latest/docs/api-documentation/bluesky/motor/ pycertifspec.bluesky.Motor # [view_source] Motor Objects # class Motor() [view_source] Class representing a SPEC motor that can be used with bluesky __init__ # | __init__(motor) [view_source] Create a bluesky motor from a SPEC motor Arguments: motor pycertifspec.Motor - A pycertifspec motor configure # | configure(offset: float = None) [view_source] Configure settings for the motor Arguments: offset number - Set by what amount the reported position should deviate from the measured