yaq/daemons/lightcon-topas4-shutter


Daemon for the LightConversion WinTOPAS4 shutter.

external links

source
bugtracker
manufacturer

installation

The lightcon-topas4-shutter daemon can be installed using the following package managers:

PyPI

traits

The lightcon-topas4-shutter daemon is composed of the following traits:

has-position
is-daemon

hardware

The lightcon-topas4-shutter daemon has been tested with the following hardware:

topas-800
topas-c

configuration

base_url (String)
URL for the TOPAS4 server directly controlling the motor

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

serial (string) default: NULL
Serial number for the particular device represented by the daemon
from is-daemon

make (String) default: NULL
from is-daemon

model (String) default: NULL
from is-daemon

state

The lightcon-topas4-shutter daemon will provide the following state information:

position
type: number
from has-position

destination
type: number
from has-position

methods

Daemons with the lightcon-topas4-shutter trait expose the following public methods:

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

get_units ➜ string
Get units of daemon. These units apply to the position and destination fields.
from has-position

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

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

position, {'type': 'number'}

set_relative ➜ number
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
Arguments:

distance, {'type': 'number'}

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

id ➜ dictionary
JSON object with information to identify the daemon, including name, kind, make, model, serial.
from is-daemon

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

get_config ➜ dictionary
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_traits ➜ [string]
Get a full list of the daemon traits.
from is-daemon

get_state ➜ dictionary
Get daemon state, as saved in the state.toml file.
from is-daemon

set_state
Set daemon state. Accepts any subset of the state dictionary, dynamically.
from is-daemon

list_methods ➜ [string]
Get an array of all known public method names.
from is-daemon

shutdown
Cleanly shutdown (or restart) daemon.
from is-daemon
Arguments:

restart, {'type': 'boolean', 'default': False}

help ➜ string
If method not given, return a human-readable string with information about the daemon as a whole. If method is given, return a human-readable string with the signature of the method on the first line and a description of the method on subsequent lines. The signature is not specified to be in any particular language. It is intended for usage by humans ONLY.
from is-daemon
Arguments:

method, {'type': 'string'}


built 2020-05-24 18:31:17                                      CC0: no copyright