labjack-sensor

external links ¶

bugtracker
example-configs
source

installation ¶

The labjack-sensor daemon can be installed using the following package managers:

PyPI

traits ¶

The labjack-sensor daemon is composed of the following traits:

has-measure-trigger
is-daemon
is-sensor

hardware ¶

The labjack-sensor daemon has been tested with the following hardware:

labjack/t7-pro

configuration ¶

Example configuration files.

address (string) default: 192.168.1.207

channels (map) default: {}

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

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

loop_at_startup (boolean) default: False
If set to true, the daemon will begin to loop measure as soon as it starts.
from has-measure-trigger

make (['null', 'string']) default: None
from is-daemon

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

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

read_device_temperature (boolean) default: True
If true, an additional channel device_temperature with units kelvin will be added.

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

settings (array) default: []
All settings will be written roughly once per minute.

messages ¶

The labjack-sensor daemon will expose the following public messages:

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

get_channel_names ➜ {'items': 'string', 'type': 'array'}
Get current channel names.
from is-sensor

get_channel_shapes ➜ {'type': 'map', 'values': {'items': 'int', 'type': 'array'}}
Get current channel shapes. If list is empty, channel is scalar.
from is-sensor

get_channel_units ➜ {'type': 'map', 'values': ['null', 'string']}
Get current channel units.
from is-sensor

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_measured ➜ {'type': 'map', 'values': ['int', 'double', 'ndarray']}
Returns map of channel_name to measured_value. Always returns additional key measurement_id.
from is-sensor

get_measurement_id ➜ {'type': 'int'}
Get current measurement_id. Clients are encouraged to watch for this to be updated before calling get_measured to get entire measurement.
from is-sensor

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

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

measure ➜ int
Initiate a measurement. Returns integer, measurement ID.
from has-measure-trigger
parameters:

loop (boolean) default: False

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

restart (boolean) default: False

stop_looping ➜ null
Stop looping measurement.
from has-measure-trigger

types ¶

The labjack-sensor daemon uses the following avro types:

modbus_type (enum)
symbols: ['float32', 'uint16', 'uint32', 'int32']

channel (record)
fields:

modbus_address (int)

modbus_type (modbus_type)

units (['string', 'null']) default: None

enabled (boolean) default: True

setting (record)
fields:

modbus_address (int)

modbus_type (modbus_type)

value (['double', 'long'])

comment (string)
comment for human consumption

enabled (boolean) default: True