Skip to content

Overview

The RENKEI Processor external API is a stateful TCP/JSON protocol for automation and control-system drivers.

The processor exposes an installation-level view of commissioned motors and groups. Driver clients connect to the processor, authenticate with an integration token, query a baseline state snapshot, subscribe to updates, and send motor or group commands.

External Scope

The external profile exposes:

  • motor records and motor_state events
  • group records and group_state events
  • registry updates for motors and externally visible group metadata
  • single-motor, stored-group, and stateless multi-motor command flows

The external profile does not expose group membership topology, processor settings, commissioning, access point inventory, discovered devices, diagnostics, OTA, internal web UI authentication, raw transport details, or motor raw diagnostic fields.

Design Rules For Drivers

  • Treat query_state as the baseline authority after every connection.
  • Treat events as deltas after subscription is acknowledged.
  • Use group_command when every member of a stored group shares one intent.
  • Use multi_motor_move when a scene assigns independent percentages to individual motors.
  • Omit request_id for the simplest one-request-at-a-time implementation.
  • Supply request_id when concurrent response correlation or retry-safe commands are needed.
  • Ignore unknown additive response/event fields for forward compatibility.