Commit 6833588f authored by Kyle Sunden's avatar Kyle Sunden

Merge branch '302' into 'master'

YEP-302: is-sensor

See merge request !39
parents 733af1c5 ae432763
Pipeline #166579743 canceled with stage
......@@ -5,6 +5,63 @@ author: Blaise Thompson
status: draft
tags: trait
post-history: 2020-04-22
2020-07-14
---
This YEP is a stub.
# Abstract
This YEP defines the is-sensor trait.
Daemons implementing this trait make measurements.
# Table of Contents
[TOC]
# Motivation
Sensors are a core component of the instrumentation ecosystem.
The is-sensor trait enforces a consistent interface across all measurement devices.
# Proposal
## message: measure
response: int
Initiate a measurement. Returns integer, measurement ID.
## message: get_measured
response: {type: map, values: [float, ndarray]}
Get most recent measured value. Additional key of measurement ID.
## message: stop_looping
Stop looping measurement.
## message: get_channel_names
response: {'type': 'array', 'items': 'string'}
Get map of channel names.
## message: get_channel_shapes
response: {'type': 'map', 'values': {'type': 'array', 'items': 'int'}}
Get map of current channel shapes. Scalar represented by empty list.
## message: get_channel_units
response: {'type': 'map', 'values': ['null', 'string']}
Get current channel units.
# Discussion
Discussion can be found on the [gitlab issue](https://gitlab.com/yaq/yeps/-/issues/15) for this YEP.
# Copyright
This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment