microscope.controllers.zaber._ZaberReply Class Reference

Public Member Functions
None	__init__ (self, bytes data)
bytes	address (self)
bytes	flag (self)
bytes	status (self)
bytes	warning (self)
bytes	response (self)

Detailed Description

Wraps a Zaber reply to easily index its multiple fields.

Definition at line 61 of file zaber.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.zaber._ZaberReply.__init__	(		self,
		bytes	data
	)

Definition at line 64 of file zaber.py.

    def __init__(self, data: bytes) -> None:
        self._data = data
        if (
            data[0] != _AT_CODE
            or data[-2:] != b"\r\n"
            or any([data[i] != _SPACE_CODE for i in (3, 5, 8, 13, 16)])
        ):
            raise ValueError("Not a valid reply from a Zaber device")
 

Member Function Documentation

address()

bytes microscope.controllers.zaber._ZaberReply.address

(

self

)

The start of reply with device address and space.

Definition at line 74 of file zaber.py.

    def address(self) -> bytes:
        """The start of reply with device address and space."""
        return self._data[1:3]
 

References microscope.controllers.zaber._ZaberReply._data.

flag()

bytes microscope.controllers.zaber._ZaberReply.flag

(

self

)

The reply flag indicates if the message was accepted or rejected.

Can be `b"OK"` (accepted) or `b"RJ"` (rejected).  If rejected,
the response property will be one word with the reason why.

Definition at line 79 of file zaber.py.

    def flag(self) -> bytes:
        """The reply flag indicates if the message was accepted or rejected.
 
        Can be `b"OK"` (accepted) or `b"RJ"` (rejected).  If rejected,
        the response property will be one word with the reason why.
        """
        return self._data[6:8]
 

References microscope.controllers.zaber._ZaberReply._data.

response()

bytes microscope.controllers.zaber._ZaberReply.response

(

self

)

Definition at line 107 of file zaber.py.

    def response(self) -> bytes:
        # Assumes no checksum
        return self._data[17:-2]
 
 

status()

bytes microscope.controllers.zaber._ZaberReply.status

(

self

)

``b"BUSY"`` when the axis is moving and ``b"IDLE"`` otherwise.

If the reply message applies to the whole device, the status
is `b"BUSY"` if any axis is busy and `b"IDLE"` if all axes are
idle.

Definition at line 88 of file zaber.py.

    def status(self) -> bytes:
        """``b"BUSY"`` when the axis is moving and ``b"IDLE"`` otherwise.
 
        If the reply message applies to the whole device, the status
        is `b"BUSY"` if any axis is busy and `b"IDLE"` if all axes are
        idle.
        """
        return self._data[9:13]
 

References microscope.controllers.zaber._ZaberReply._data.

warning()

bytes microscope.controllers.zaber._ZaberReply.warning

(

self

)

The highest priority warning currently active.

This will be `b'--'` under normal conditions.  Anything else
is a warning.

Definition at line 98 of file zaber.py.

    def warning(self) -> bytes:
        """The highest priority warning currently active.
 
        This will be `b'--'` under normal conditions.  Anything else
        is a warning.
        """
        return self._data[14:16]
 

References microscope.controllers.zaber._ZaberReply._data.

---

The documentation for this class was generated from the following file:

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/controllers/zaber.py