Skip to main content
The control interface exposes actuator parameters in two complementary representations.

Simple control actions

Use a simple action when the client already knows the parameter name and type. The request sets one or more typed values directly. Appropriate for:
  • machine-to-machine control with a known interface version;
  • small, atomic changes;
  • low-latency operations.

Data-form control

Use a data form when a human or generic client needs to discover available parameters, labels, descriptions, grouping, options, types, and validation.
  1. Request the control form.
  2. Render or inspect the returned fields.
  3. Submit a form of type submit, or translate selected fields into simple actions.
  4. A partial form may update only the included parameters.

Safe control flow

Authorization tokens

Control requests can include device, service, or user tokens depending on provisioning policy. A token is evidence supplied to the receiver; the receiver still decides whether the sender, token, operation, and current rules permit control.

Design guidance

  • Use typed booleans/numbers/dates, not stringly typed values.
  • Include physical units and allowed ranges.
  • Make dangerous operations explicit commands rather than magic parameter values.
  • Separate “requested” from “observed” state.
  • Make retries idempotent or include an operation ID.
  • Require fresh authorization for safety-critical changes.
  • Return structured error conditions that distinguish validation, authorization, device, and transport failure.