feat(schema): add controller display name (#175)

* feat(schema): add display name to controllers * feat: update static schema draft
aica-technology · Sep 13, 2024 · ab5c1c7 · ab5c1c7
1 parent c087053
commit ab5c1c7
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/docs/static/schemas/draft/2-0-0/application.d.ts b/docs/static/schemas/draft/2-0-0/application.d.ts
@@ -149,6 +149,10 @@ export type ManageSequenceObject = StartASequence | RestartASequence | AbortASeq
  * The log severity level for the component
  */
 export type LogLevel = "debug" | "info" | "warn" | "error" | "fatal";
+/**
+ * The human-readable name to display on the controller
+ */
+export type ControllerDisplayName = string;
 /**
  * The name of the controller plugin
  */
@@ -602,6 +606,7 @@ export interface Controllers {
  */
 export interface Controller {
     log_level?: LogLevel;
+    display_name?: ControllerDisplayName;
     plugin: ControllerPlugin;
     /**
      * The rate in Hz at which to run the controller. If undefined, the hardware rate is used instead.

diff --git a/docs/static/schemas/draft/2-0-0/application.schema.json b/docs/static/schemas/draft/2-0-0/application.schema.json
@@ -269,6 +269,11 @@
                     "log_level": {
                       "$ref": "#/$defs/log_level"
                     },
+                    "display_name": {
+                      "title": "Controller Display Name",
+                      "description": "The human-readable name to display on the controller",
+                      "type": "string"
+                    },
                     "plugin": {
                       "title": "Controller Plugin",
                       "description": "The name of the controller plugin",

diff --git a/schemas/applications/CHANGELOG.md b/schemas/applications/CHANGELOG.md
@@ -29,8 +29,9 @@ Release Versions:
 - Hardware control rate can be supplemented with a `rate_tolerance` to determine the allowable deviation from the
   intended control rate, and an optional `strict` flag that immediately shuts down the hardware in case of rate
   deviation or other error
-- Sequences support additional properties including display name, position on the graph and automatic looping
-- Sequences and conditions support display names
+- Graph positions can be expressed for all elements, including sequences, conditions and a stop application node
+- Sequences have a property to support automatic looping
+- Sequences, conditions and controllers now support display names
 - The event structures for lifecycle transitions, service calls and setting parameters now always require the target
   component to be specified, removing the previous "shorthand" for self-targeting events
 

diff --git a/schemas/applications/schema/hardware.schema.json b/schemas/applications/schema/hardware.schema.json
@@ -100,6 +100,11 @@
                 "log_level": {
                   "$ref": "common/log_level.schema.json"
                 },
+                "display_name": {
+                  "title": "Controller Display Name",
+                  "description": "The human-readable name to display on the controller",
+                  "type": "string"
+                },
                 "plugin": {
                   "title": "Controller Plugin",
                   "description": "The name of the controller plugin",