yaq-yeps/303


has-limits

YEP:303
Title:has-limits
Authors:Blaise Thompson
Status:accepted
Tags:trait
Post-History:2020-04-22, 2020-07-14

Abstract

This YEP defines the has-limits trait.

This trait has been accepted. See built documentation at at yaq.fyi.

Table of Contents

Motivation

A subset of positional hardware has exactly two limits. This trait standardies the interface to such hardware.

This trait requires has-position, see YEP-301.

Proposal

config: limits

type: array

default: [-inf, inf]

Configuration limits are strictly optional.

config: out_of_limits

type: enum

default: closest

Control behavior of daemon when set_position is given a value outside of limits.

state: hw_limits

type: array

message: get_limits

response: {'type': 'array', 'items': 'float'}

Get daemon limits.Limits will be the intersection of config limits and driver limits (when applicable).

messages: in_limits

parameters: position: float

response: boolean

Check if a given position is within daemon limits.

Copyright

This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive.


built 2022-08-09 20:27:49                                      CC0: no copyright