yaq/daemons/mcp3428


bugtracker
manufacturer
source

traits

The mcp3428 daemon is composed of the following traits:

has-measure-trigger
is-sensor
is-daemon
uses-serial
uses-i2c

hardware

The mcp3428 daemon has been tested with the following hardware:

microchip/mcp3428

configuration

i2c_addr (int)
I2C bus address.
from uses-i2c

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

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

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

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

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

messages

Daemons with the mcp3428 trait expose the following public messages:

busy ➜ boolean
Returns true if daemon is currently busy.

direct_serial_write ➜ null
Expose direct access to the serial port to clients. This should not be encouraged for normal use, but may be very important for debugging. If a device is expected to return data, it should be logged at the INFO level, not returned to the client. This is done to allow long tasks to be run asynchronously, and to explicitly discourage use of this method except when debugging. Setting `busy` to true is encouraged, but individual daemon writers should consider their own use case.
parameters:

message (bytes)

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

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

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

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.

get_config_filepath ➜ string
String representing the absolute filepath of the configuration file on the host machine.

get_measured ➜ {'type': 'map', 'values': ['float', 'ndarray']}
Get most recent measured value.

get_state ➜ string
Get version of the running daemon

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

measure ➜ int
Initiate a measurement. Returns integer, measurement ID.
parameters:

loop (boolean) default: False

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

restart (boolean) default: False

stop_looping ➜ null
Stop looping measurement.


built 2020-08-18 17:11:11                                      CC0: no copyright