Capability type improvements (#748)

* Mark StrobeSpeed.speed/StrobeDuration.duration as required in docs * Make IrisEffect.speed/FrostEffect.speed optional in schema -> Bump schema version * Add capability type hints in editor to avoid common mistakes
OpenLightingProject · Jan 15, 2019 · a573e2e · a573e2e
1 parent cf9e6c6
commit a573e2e
Show file tree

Hide file tree

Showing 12 changed files with 14 additions and 16 deletions.
diff --git a/docs/capability-types.md b/docs/capability-types.md
@@ -94,13 +94,13 @@ To make common percentage values more readable, one can use specific keywords to
 </tr>
 <tr>
   <th valign="top" scope="row" id="strobespeed">StrobeSpeed</th>
-  <td valign="top">speed<br><sub>:grey_question: optional</sub></td>
+  <td valign="top">speed<br><sub>:star2: required</sub></td>
   <td valign="top">Entity <em>Speed</em></td>
   <td valign="top">global, doesn't activate strobe directly</td>
 </tr>
 <tr>
   <th valign="top" scope="row" id="strobeduration">StrobeDuration</th>
-  <td valign="top">duration<br><sub>:grey_question: optional</sub></td>
+  <td valign="top">duration<br><sub>:star2: required</sub></td>
   <td valign="top">Entity <em>Time</em></td>
   <td valign="top"></td>
 </tr>

diff --git a/schemas/capability.json b/schemas/capability.json
@@ -1010,10 +1010,7 @@
           "switchChannels": {}
         },
         "required": ["effectName"],
-        "oneOf": [
-          { "required": ["speed"] },
-          { "required": ["speedStart"] }
-        ],
+        "not": { "required": ["speed", "speedStart"] },
         "dependencies": {
           "speedStart": ["speedEnd"],
           "speedEnd": ["speedStart"]
@@ -1070,10 +1067,7 @@
           "switchChannels": {}
         },
         "required": ["effectName"],
-        "oneOf": [
-          { "required": ["speed"] },
-          { "required": ["speedStart"] }
-        ],
+        "not": { "required": ["speed", "speedStart"] },
         "dependencies": {
           "speedStart": ["speedEnd"],
           "speedEnd": ["speedStart"]

diff --git a/schemas/fixture-redirect.json b/schemas/fixture-redirect.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/master/schemas/fixture-redirect.json",
 
-  "version": "11.0.0",
+  "version": "11.0.1",
 
   "type": "object",
   "properties": {

diff --git a/schemas/fixture.json b/schemas/fixture.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/master/schemas/fixture.json",
 
-  "version": "11.0.0",
+  "version": "11.0.1",
 
   "type": "object",
   "properties": {

diff --git a/schemas/manufacturers.json b/schemas/manufacturers.json
@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/master/schemas/manufacturers.json",
 
-  "version": "11.0.0",
+  "version": "11.0.1",
 
   "type": "object",
   "propertyNames": {

diff --git a/ui/components/editor-capabilities/ColorPreset.vue b/ui/components/editor-capabilities/ColorPreset.vue
@@ -93,7 +93,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
-      hint: `This capability enables a static predefined color (mix). Use WheelSlot for color wheel filters.`,
+      hint: `This capability enables a static predefined RGB/CMY color. Use WheelSlot for color wheel filters.`,
       defaultData: {
         comment: ``,
         colors: null,

diff --git a/ui/components/editor-capabilities/FrostEffect.vue b/ui/components/editor-capabilities/FrostEffect.vue
@@ -64,6 +64,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
+      hint: `This capability enables a non-static frost effect, e.g. pulse. Use the Frost type instead if a static frost intensity can be chosen.`,
       defaultData: {
         effectName: ``,
         speed: ``,

diff --git a/ui/components/editor-capabilities/IrisEffect.vue b/ui/components/editor-capabilities/IrisEffect.vue
@@ -64,6 +64,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
+      hint: `This capability enables a non-static iris effect, e.g. pulse. Use the Iris type instead if a static degree of opening can be chosen.`,
       defaultData: {
         effectName: ``,
         speed: ``,

diff --git a/ui/components/editor-capabilities/Rotation.vue b/ui/components/editor-capabilities/Rotation.vue
@@ -73,6 +73,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
+      hint: `Only use this if no other type is applicable. Note that some types like WheelSlot and Prism also allow setting a rotation angle / speed value.`,
       defaultData: {
         speedOrAngle: `speed`,
         speed: ``,

diff --git a/ui/components/editor-capabilities/Speed.vue b/ui/components/editor-capabilities/Speed.vue
@@ -53,6 +53,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
+      hint: `Only use this if no other type is applicable. Note that some types like Effect, PanContinuous or Rotation also allow setting a speed value.`,
       defaultData: {
         speed: null,
         speedStart: `slow`,

diff --git a/ui/components/editor-capabilities/StrobeSpeed.vue b/ui/components/editor-capabilities/StrobeSpeed.vue
@@ -53,7 +53,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
-      hint: `Doesn't activate strobe, only controls the strobe speed.`,
+      hint: `Doesn't activate strobe, only controls the strobe frequency when another channel is set to a ShutterStrobe capability with shutter effect 'Strobe'.`,
       defaultData: {
         speed: null,
         speedStart: `Hz`,

diff --git a/ui/components/editor-capabilities/WheelRotation.vue b/ui/components/editor-capabilities/WheelRotation.vue
@@ -73,7 +73,7 @@ export default {
   data() {
     return {
       properties: schemaProperties,
-      hint: `Rotation of the whole wheel (i.e. over all wheel slots). Use WheelSlotRotation if only the slot itself (e.g. a Gobo) rotates in this capability.`,
+      hint: `Rotation of the whole wheel (i.e. over all wheel slots). Use WheelSlotRotation if only the slot itself (e.g. a Gobo) rotates in this capability. If the fixture doesn't have a physical color wheel, use Effect with ColorFade/ColorJump preset instead.`,
       defaultData: {
         speedOrAngle: `speed`,
         speed: null,