rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Started updating documentation

Browse source
This commit is contained in:
Joel Collins 2020-01-15 15:03:58 +00:00
parent be74b92bd7
commit 802f5ba0c2
17 changed files with 248 additions and 368 deletions
Download patch file Download diff file Expand all files Collapse all files

66
docs/source/config.rst
View file

@ -1,5 +1,5 @@
Microscope configuration
========================
Microscope settings
===================
.. toctree::
:maxdepth: 2
@ -7,65 +7,15 @@ Microscope configuration
.. _MicroscopeRC:
Microscope RC file
------------------
Microscope settings file
------------------------
Microscope configuration is made persistent via a microscope runtime-config (RC) file. By default, this
file exists at ``~/.openflexure/microscope_settings.json``, and contains basic parameters to set up the microscope.
Microscope settings are made persistent via a microscope settings file. By default, this
file exists at ``~/.openflexure/microscope_settings.json``.
Additionally, by default, configurations for specific pieces of hardware (i.e. the stage and camera) are located
in separate "auxillary" config files, and are linked together by adding the config file's path to your main
microscope RC file.
The class :class:`openflexure_microscope.config.OpenflexureSettingsFile` provides functionality for loading a JSON-format settings file as a Python dictionary, and merging changed settings back into the file.
The default settings are loaded by the :attr:`openflexure_microscope.config.user_settings`, which can be imported anywhere in the microscope server application to allow reading and writing of persistent settings.
Loading the runtime-config
++++++++++++++++++++++++++
By default, a microscope object will load the a runtime-config from the default location.
This RC can then be passed to any hardware attached to the microscope. This can be particularly
useful when creating a dummy microscope object before attaching hardware. For example:
.. code-block:: python
from openflexure_microscope import Microscope
from openflexure_microscope.camera.pi import StreamingCamera
from openflexure_stage import OpenFlexureStage
# Create an empty microscope
api_microscope = Microscope(None, None)
# Create a picamera StreamingCamera, using our config
camera_obj = StreamingCamera(config=api_microscope.rc.read())
# Create an OpenFlexure Stage attached to /dev/ttyUSB0
stage_obj = OpenFlexureStage("/dev/ttyUSB0")
# Attach devices to the Microscope object
api_microscope.attach(camera_obj, stage_obj)
Alternatively, a config can be loaded prior to creating a microscope, allowing the microscope
hardware to be created and attached in a single line. For example:
.. code-block:: python
from openflexure_microscope.config import OpenflexureConfig
from openflexure_microscope import Microscope
from openflexure_microscope.camera.pi import StreamingCamera
from openflexure_stage import OpenFlexureStage
# Create a runtime-config from the default location
rc = OpenflexureConfig(expand=True)
# Create a populated microscope
api_microscope = Microscope(
StreamingCamera(config=rc),
OpenFlexureStage("/dev/ttyUSB0"),
config=rc
)
Config module and OpenflexureConfig class
-----------------------------------------
.. automodule:: openflexure_microscope.config
:members: