Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a bunch of new service docs pages #185

Merged
merged 6 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/services/aimtti_plp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Aim TTi PL-P Series Power Supply
================================



Configuration
-------------


Properties
----------
None.

Commands
--------
None.

Datastreams
-----------
None.
73 changes: 73 additions & 0 deletions docs/services/allied_vision_camera.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
Allied Vision Camera
====================

This service controls an Allied Vision camera. It is a wrapper around the Vimba SDK, which requires its installation.
The service uses the Python API for Vimba SDK, called ``VimbaPython``.

Vimba SDK is now superceded by Vimba X SDK. The service might be updated in the future to use the Vimba X SDK and its
Python API ``VmbPy`` instead.

Vimba SDK and Vimba X SDK: `https://www.alliedvision.com/en/products/software/ <https://www.alliedvision.com/en/products/software/>`_
``VimbaPython`` Python API: `https://github.com/alliedvision/VimbaPython <https://github.com/alliedvision/VimbaPython>`_
``VmbPy`` Python API: `https://github.com/alliedvision/VmbPy <https://github.com/alliedvision/VmbPy>`_

The service has been successfully tested with the following camera models:
- Alvium 1800 U-158m
- Alvium 1800 U-500m

Configuration
-------------

.. code-block:: YAML

camera1:
service_type: allied_vision_camera
simulated_service_type: camera_sim
requires_safety: false

camera_id: "DEV_1AB22C011222"
device_name: AV Alvium 1800 U-158m

offset_x: 0
offset_y: 0
width: 32
height: 32
sensor_width: 1456
sensor_height: 1088

exposure_time: 200
gain: 0

Properties
----------
``exposure_time``: Exposure time of the camera.

``gain``: Gain of the camera.

``brightness``: Brightness of the camera.

``width``: The width of the camera.

``height``: The height of the camera.

``offset_x``: The x offset of the camera.

``offset_y``: The y offset of the camera.

``sensor_width``: The width of the sensor.

``sensor_height``: The height of the sensor.

Commands
--------
``start_acquisition()``: This starts the acquisition of images from the camera.

``end_acquisition()``: This ends the acquisition of images from the camera.

Datastreams
-----------
``temperature``: The temperature as measured by this sensor in Celsius.

``images``: The images acquired by the camera.

``is_acquiring``: Whether the camera is currently acquiring images.
20 changes: 20 additions & 0 deletions docs/services/empty_service.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Empty Service
=============



Configuration
-------------
None.

Properties
----------
None.

Commands
--------
None.

Datastreams
-----------
None.
21 changes: 21 additions & 0 deletions docs/services/ni_daq.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
NI DAQ
======



Configuration
-------------



Properties
----------
None.

Commands
--------
None.

Datastreams
-----------
None.
14 changes: 14 additions & 0 deletions docs/services/nkt_superk.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
NKT Super K Compact Tunable Laser
=================================

Configuration
-------------

Properties
----------

Commands
--------

Datastreams
-----------
14 changes: 14 additions & 0 deletions docs/services/thorlabs_cld101x.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Thorlabs Compact Laser Diode
============================

Configuration
-------------

Properties
----------

Commands
--------

Datastreams
-----------
14 changes: 14 additions & 0 deletions docs/services/thorlabs_pm.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Thorlabs Picomotor
==================

Configuration
-------------

Properties
----------

Commands
--------

Datastreams
-----------
Loading