horiba-micro-hr

Horiba Jobin-Yvon Micro-Hr monochromator.

external links ¶

bugtracker
example-configs
manufacturer
source

installation ¶

The horiba-micro-hr daemon can be installed using the following package managers:

PyPI
conda-forge

traits ¶

The horiba-micro-hr daemon is composed of the following traits:

has-limits
has-position
has-turret
is-daemon
is-homeable

hardware ¶

The horiba-micro-hr daemon has been tested with the following hardware:

horiba/microhr

configuration ¶

Example configuration files.

enable (boolean) default: True
Disable this daemon. The kind entry-point will not attempt to start this daemon.
from is-daemon

gratings ({'type': 'map', 'values': 'horiba_grating'}) default: {'default': {}}
Map which gives a label to a grating with its lines/mm and index

limits (array) default: [-inf, inf]
Configuration limits are strictly optional.
from has-limits

log_level ({'name': 'level', 'symbols': ['debug', 'info', 'notice', 'warning', 'error', 'critical', 'alert', 'emergency'], 'type': 'enum'}) default: info
Set daemon log-level.
from is-daemon

log_to_file (boolean) default: False
Optionally force logging to a file.
from is-daemon

make (['null', 'string']) default: Horiba Jobin-Yvon
from is-daemon

model (['null', 'string']) default: MicroHR
from is-daemon

out_of_limits (enum) default: closest
Control behavior of daemon when set_position is given a value outside of limits.
from has-limits

port (int)
TCP port for daemon to occupy.
from is-daemon

serial (['null', 'string']) default: None
Serial number for the particular device represented by the daemon
from is-daemon

state ¶

The horiba-micro-hr daemon will provide the following state information:

destination (double)
from has-position

hw_limits (array)
from has-limits

position (double)
from has-position

turret (['null', 'string'])
Current turret index
from has-turret

messages ¶

The horiba-micro-hr daemon will expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.
from is-daemon

get_config ➜ string
Full configuration for the individual daemon as defined in the TOML file. This includes defaults and shared settings not directly specified in the daemon-specific TOML table.
from is-daemon

get_config_filepath ➜ string
String representing the absolute filepath of the configuration file on the host machine.
from is-daemon

get_destination ➜ double
Get current daemon destination.
from has-position

get_limits ➜ {'items': 'double', 'type': 'array'}
Get daemon limits.Limits will be the intersection of config limits and driver limits (when appliciable).
from has-limits

get_position ➜ double
Get current daemon position.
from has-position

get_state ➜ string
Get version of the running daemon
from is-daemon

get_turret ➜ ['null', 'string']
Get current turret identifier.
from has-turret

get_turret_options ➜ {'items': ['null', 'string'], 'type': 'array'}
Get current turret identifier.
from has-turret

get_units ➜ ['null', 'string']
Get units of daemon. These units apply to the position and destination properties.
from has-position

home ➜ null
Initiates the homing procedure. The daemon will report as busy during the homing procedure. After the homing procedure is complete, the daemon will return to the current destination.
from is-homeable

id ➜ {'type': 'map', 'values': ['null', 'string']}
JSON object with information to identify the daemon, including name, kind, make, model, serial.
from is-daemon

in_limits ➜ boolean
Check if a given position is within daemon limits.
from has-limits
parameters:

position (double)

set_position ➜ null
Give the daemon a new destination, and begin motion towards that destination.
from has-position
parameters:

position (double)

set_relative ➜ double
Give the daemon a new destination relative to its current position. Daemon will immediately begin motion towards new destination. Returns new destination.
from has-position
parameters:

distance (double)

set_turret ➜ null
Set the turret to a given identifier.
from has-turret
parameters:

turret (string)

shutdown ➜ null
Cleanly shutdown (or restart) daemon.
from is-daemon
parameters:

restart (boolean) default: False

types ¶

The horiba-micro-hr daemon uses the following avro types:

horiba_grating (record)
fields:

index (int) default: 0

lines_per_mm (float) default: 1200.0