yaq/traits/has-mapping


Mappings define additional context for the channel arrays defined by is-sensor.

requires

is-sensor

messages

Daemons with the has-mapping trait expose the following public messages:

get_channel_mappings ➜ {'type': 'map', 'values': {'items': 'string', 'type': 'array'}}
Defines which mapping keys apply to which channel keys. Each channel may have zero or many mappings. Mappings must broadcast into corresponding channels.

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_mapping_id ➜ int
Mapping ID. This integer increments every time the mapping is updated. Clients can safely check this id to verify that their cached mappings are correct, if desired.

get_mapping_units ➜ {'type': 'map', 'values': ['null', 'string']}
Must return units for every mapping. Units can be null.

get_mappings ➜ {'type': 'map', 'values': ['null', 'ndarray', 'double']}
Mappings themselves.

get_measured ➜ {'type': 'map', 'values': ['double', 'ndarray']}
Get most recent measured value.
from is-sensor

daemons

The following daemons implement the has-mapping trait:

fake-spectrometer
rgb-qmini
seabreeze
wright-ingaas


built 2021-09-25 05:03:33                                      CC0: no copyright