Added Cryomagnetic docs

Author: AlexShkarin

docs/devices/Cryomagnetics.rst

@@ -0,0 +1,40 @@
+.. _sensors_cryomagnetics:
+
+.. note::
+    Basic sensors communication concepts are described on the corresponding :ref:`page <basic_sensors_basics>`
+
+Cryomagntics level monitor
+==============================
+
+Cryomagnetics manufactures cryogenic liquid level monitors, which are used for mintoring liquid nitrogen or helium levels inside cryostats. The two level meters supported in the package are LM-500 and LM-510; despide difference in appearance, their functionalities are very similar, so their interfaces are nearly identical.
+
+The main device classes are :class:`pylablib.devices.Cryomagnetics.LM500<.Cryomagnetics.base.LM500>` and :class:`pylablib.devices.Cryomagnetics.LM500<.Cryomagnetics.base.LM510>`.
+
+
+Software requirements
+-----------------------
+
+LM-500 provides a bare RS232 interface, so any appropriate USB-to-RS232 adapter should work. LM-510 has a USB interface with a built-in USB-to-RS232 adapter, which is automatically recognized as a serial port, so no additional software is required.
+
+
+Connection
+-----------------------
+
+Since the devices are identified as COM ports, they use the standard :ref:`connection method <devices_connection>`, and all you need to know is their COM-port address (e.g., ``COM5``)::
+
+    >> from pylablib.devices import Cryomagnetics
+    >> sensor = Cryomagnetics.LM510("COM5")
+    >> sensor.close()
+
+
+
+Operation
+-----------------------
+
+
+The operation of this temperature sensor is fairly straightforward, but there is a couple of points to keep in mind:
+
+    - Upon connection the devices are automatically switched into the remote mode, which disables manual controls. If this mode is manually switched off (e.g., using ``Local`` button in LM-510), the device will no longer obey the remote commands, even though the readout would still work.
+    - There are no specific commands for stopping a refill or resetting the timeout state after a timed-out refill. However, both can be achieved using :meth:`.LM500.reset` method.
+    - Only LM-510 supports switchingthe automated refill option on and off using :meth:`.LM510.set_control_mode` method.
+    - Like most similar devices, querying the level using :meth:`.LM500.get_level` immediately returns the most recently measured value. Re-measurement is periodically initiated by the devices itself, or can be initiated manually using :meth:`.LM500.start_measurement` or :meth:`.LM500.measure_level`.

docs/devices/basic_sensors_list.txt

@@ -2,6 +2,7 @@
 - :ref:`Ophir <sensors_ophir>`: optical power and energy meters. Tested with Ophir Vega.
 - :ref:`Lakeshore <sensors_lakeshore>`: temperature sensors. Tested with Lakeshore 218.
 - :ref:`Cryocon <sensors_cryocon>`: temperature sensors. Tested with CryoCon 14C.
+- :ref:`Cryomagnetics <sensors_cryomagnetics>`: liquid nitrogen or helium level sensor. Tested with LM-500 and LM-510 sensors.
 - :ref:`Pfeiffer <sensors_pfeiffer>`: pressure gauges. Tested with TPG261 and DPG202 controllers.
 - :ref:`Leybold <sensors_leybold>`: pressure gauges. Tested with ITR90 gauge.
 - :ref:`Kurt J. Lesker <sensors_kjl>`: pressure gauges. Tested with KJL300 gauge.

docs/devices/basic_sensors_root.rst

@@ -18,6 +18,7 @@ Currently supported sensors:
     Ophir
     Lakeshore
     Cryocon
+    Cryomagnetics
     Pfeiffer
     Leybold
     KJL