Plugin and fixture test improvements (#913)

* Refactor Millumin plugin: Build new fixture JSON
* QLC+: Create either global *or* mode physical
* QLC+: Get pan/tiltMax also from fixture channels
* QLC+: Fix category order
* Fix wrong category order in fixture
* Fixture test: Add mutually exclusive categories

Author: fxedel

fixtures/eurolite/led-pix-144.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/master/schemas/fixture.json",
   "name": "LED PIX-144",
-  "categories": ["Color Changer", "Pixel Bar"],
+  "categories": ["Pixel Bar", "Color Changer"],
   "meta": {
     "authors": ["Paolo Zanchi"],
     "createDate": "2019-02-06",

plugins/millumin/export.js

@@ -16,58 +16,48 @@ module.exports.supportedOflVersion = `7.3.0`;
 module.exports.export = function exportMillumin(fixtures, options) {
   // one JSON file for each fixture
   const outFiles = fixtures.map(fixture => {
-    let jsonData = JSON.parse(JSON.stringify(fixture.jsonObject));
-    jsonData.$schema = `https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/schema-${module.exports.supportedOflVersion}/schemas/fixture.json`;
-
-    jsonData.fixtureKey = fixture.key;
-    jsonData.manufacturerKey = fixture.manufacturer.key;
-    jsonData.oflURL = `https://open-fixture-library.org/${fixture.manufacturer.key}/${fixture.key}`;
-
-    jsonData.categories = getDowngradedCategories(jsonData.categories);
-
-    if (jsonData.links) {
-      if (jsonData.links.manual) {
-        // replace links with manual URL in keys array
-        const jsonKeys = Object.keys(jsonData);
-        jsonKeys[jsonKeys.indexOf(`links`)] = `manualURL`;
-        jsonData.manualURL = fixture.getLinksOfType(`manual`)[0];
-
-        // reorder JSON properties in jsonKeys order
-        const reorderedJsonData = {};
-        jsonKeys.forEach(key => {
-          reorderedJsonData[key] = jsonData[key];
-        });
-        jsonData = reorderedJsonData;
-      }
-      else {
-        delete jsonData.links;
-      }
+    const oflJson = JSON.parse(JSON.stringify(fixture.jsonObject));
+    const milluminJson = {};
+
+    milluminJson.$schema = `https://raw.githubusercontent.com/OpenLightingProject/open-fixture-library/schema-${module.exports.supportedOflVersion}/schemas/fixture.json`;
+    milluminJson.name = oflJson.name;
+    addIfValidData(milluminJson, `shortName`, oflJson.shortName);
+    milluminJson.categories = getDowngradedCategories(oflJson.categories);
+    milluminJson.meta = oflJson.meta;
+    addIfValidData(milluminJson, `comment`, oflJson.comment);
+
+    if (oflJson.links && oflJson.links.manual) {
+      milluminJson.manualURL = fixture.getLinksOfType(`manual`)[0];
     }
 
-    delete jsonData.wheels;
+    addIfValidData(milluminJson, `helpWanted`, oflJson.helpWanted);
+    addIfValidData(milluminJson, `rdm`, oflJson.rdm);
+    addIfValidData(milluminJson, `physical`, oflJson.physical);
+    addIfValidData(milluminJson, `matrix`, getDowngradedMatrix(oflJson.matrix, fixture));
 
-    // resolve all pixel key constraints
-    if (jsonData.matrix && jsonData.matrix.pixelGroups) {
-      Object.keys(jsonData.matrix.pixelGroups).forEach(groupKey => {
-        jsonData.matrix.pixelGroups[groupKey] = fixture.matrix.pixelGroups[groupKey];
+    if (oflJson.availableChannels) {
+      milluminJson.availableChannels = {};
+      Object.entries(oflJson.availableChannels).forEach(([chKey, jsonChannel]) => {
+        milluminJson.availableChannels[chKey] = getDowngradedChannel(chKey, jsonChannel, fixture);
       });
     }
 
-    if (jsonData.availableChannels) {
-      Object.keys(jsonData.availableChannels).forEach(
-        chKey => downgradeChannel(jsonData.availableChannels, chKey, fixture)
-      );
+    if (oflJson.templateChannels) {
+      milluminJson.templateChannels = {};
+      Object.entries(oflJson.templateChannels).forEach(([chKey, jsonChannel]) => {
+        milluminJson.templateChannels[chKey] = getDowngradedChannel(chKey, jsonChannel, fixture);
+      });
     }
 
-    if (jsonData.templateChannels) {
-      Object.keys(jsonData.templateChannels).forEach(
-        chKey => downgradeChannel(jsonData.templateChannels, chKey, fixture)
-      );
-    }
+    milluminJson.modes = oflJson.modes;
+
+    milluminJson.fixtureKey = fixture.key;
+    milluminJson.manufacturerKey = fixture.manufacturer.key;
+    milluminJson.oflURL = `https://open-fixture-library.org/${fixture.manufacturer.key}/${fixture.key}`;
 
     return {
       name: `${fixture.manufacturer.key}/${fixture.key}.json`,
-      content: fixtureJsonStringify(jsonData),
+      content: fixtureJsonStringify(milluminJson),
       mimetype: `application/ofl-fixture`,
       fixtures: [fixture]
     };
@@ -78,7 +68,7 @@ module.exports.export = function exportMillumin(fixtures, options) {
 
 /**
  * Replaces the fixture's categories array with one that only includes categories
- * from OFL schema version 7.3.0.
+ * from the supported OFL schema version.
  * @param {array.<string>} categories The fixture's categories array.
  * @returns {array.<string>} A filtered categories array.
  */
@@ -97,13 +87,27 @@ function getDowngradedCategories(categories) {
 }
 
 /**
- * Replaces the specified channel in the specified channels object with a downgraded version for schema 7.1.0.
- * @param {object} channelObject Either availableChannels or templateChannels.
+ * @param {object|undefined} jsonMatrix The matrix JSON data (if present) that should be downgraded.
+ * @param {Fixture} fixture The fixture the matrix belongs to.
+ * @returns {object} A downgraded version of the specified matrix object.
+ */
+function getDowngradedMatrix(jsonMatrix, fixture) {
+  if (jsonMatrix && jsonMatrix.pixelGroups) {
+    Object.keys(jsonMatrix.pixelGroups).forEach(groupKey => {
+      jsonMatrix.pixelGroups[groupKey] = fixture.matrix.pixelGroups[groupKey];
+    });
+  }
+
+  return jsonMatrix;
+}
+
+/**
  * @param {string} channelKey A key that exists in given channelObject and specifies the channel that should be downgraded.
+ * @param {object} jsonChannel The channel JSON data that should be downgraded.
  * @param {Fixture} fixture The fixture the channel belongs to.
+ * @returns {object} A downgraded version of the specified channel object.
  */
-function downgradeChannel(channelObject, channelKey, fixture) {
-  const jsonChannel = channelObject[channelKey];
+function getDowngradedChannel(channelKey, jsonChannel, fixture) {
   const channel = new CoarseChannel(channelKey, jsonChannel, fixture);
 
   const downgradedChannel = {};
@@ -119,8 +123,6 @@ function downgradeChannel(channelObject, channelKey, fixture) {
   addIfValidData(downgradedChannel, `crossfade`, channel.canCrossfade);
   addIfValidData(downgradedChannel, `precedence`, jsonChannel.precedence);
 
-  channelObject[channelKey] = downgradedChannel;
-
   if (capabilitiesNeeded()) {
     downgradedChannel.capabilities = [];
 
@@ -145,6 +147,8 @@ function downgradeChannel(channelObject, channelKey, fixture) {
     });
   }
 
+  return downgradedChannel;
+
   /**
    * @returns {boolean} Whether or not it is needed to include capabilities in a downgraded version of this channel
    */

plugins/qlcplus_4.12.1/export.js

@@ -65,13 +65,14 @@ module.exports.export = function exportQlcPlus(fixtures, options) {
       addChannel(xml, channel, fixture);
     }
 
+    const useGlobalPhysical = fixture.modes.every(mode => mode.physicalOverride === null);
+
     for (const mode of fixture.modes) {
-      addMode(xml, mode);
+      addMode(xml, mode, !useGlobalPhysical);
     }
 
-    const allModesHavePhysical = fixture.modes.every(mode => mode.physicalOverride !== null);
-    if (fixture.physical !== null && !allModesHavePhysical) {
-      addPhysical(xml, fixture.physical, fixture);
+    if (useGlobalPhysical) {
+      addPhysical(xml, fixture.physical || new Physical({}), fixture);
     }
 
     xml.dtd(``);
@@ -604,8 +605,9 @@ function getCapabilityPreset(capability) {
 /**
  * @param {object} xml The xmlbuilder <FixtureDefinition> object.
  * @param {Mode} mode The OFL mode object.
+ * @param {boolean} createPhysical Whether to add a Physical XML element to the mode.
  */
-function addMode(xml, mode) {
+function addMode(xml, mode, createPhysical) {
   const xmlMode = xml.element({
     Mode: {
       '@Name': mode.name
@@ -617,8 +619,8 @@ function addMode(xml, mode) {
     mode.physical.focusTiltMax === Number.POSITIVE_INFINITY
   );
 
-  if (mode.physicalOverride !== null || hasPanTiltInfinite) {
-    addPhysical(xmlMode, mode.physical, mode.fixture, hasPanTiltInfinite ? mode : null);
+  if (createPhysical) {
+    addPhysical(xmlMode, mode.physical || new Physical({}), mode.fixture, hasPanTiltInfinite ? mode : null);
   }
 
   mode.channels.forEach((channel, index) => {
@@ -686,7 +688,8 @@ function addPhysical(xmlParentNode, physical, fixture, mode) {
 
           if (panTiltMax === Number.POSITIVE_INFINITY) {
             try {
-              const panTiltChannel = mode.channels.find(
+              const channels = mode ? mode.channels : fixture.coarseChannels;
+              const panTiltChannel = channels.find(
                 ch => `capabilities` in ch && ch.capabilities.length === 1 &&
                   ch.capabilities[0].type === panOrTilt && ch.capabilities[0].angle[0].unit === `deg`
               );
@@ -798,13 +801,18 @@ function addHeads(xmlMode, mode) {
  * @returns {string} The first of the fixture's categories that is supported by QLC+, defaults to 'Other'.
  */
 function getFixtureType(fixture) {
-  // see https://github.com/OpenLightingProject/open-fixture-library/issues/581
-  if (fixture.categories.includes(`Pixel Bar`)) {
-    return isBeamBar() ? `LED Bar (Beams)` : `LED Bar (Pixels)`;
-  }
+  const replaceCats = {
+    // see https://github.com/OpenLightingProject/open-fixture-library/issues/581
+    'Pixel Bar': isBeamBar() ? `LED Bar (Beams)` : `LED Bar (Pixels)`
+  };
 
   const ignoredCats = [`Blinder`, `Matrix`, `Stand`];
-  return fixture.categories.find(cat => !ignoredCats.includes(cat)) || `Other`;
+
+  return fixture.categories.map(
+    cat => (cat in replaceCats ? replaceCats[cat] : cat)
+  ).find(
+    cat => !ignoredCats.includes(cat)
+  ) || `Other`;
 
 
   /**

tests/fixture-valid.js

@@ -1038,6 +1038,12 @@ function checkFixture(manKey, fixKey, fixtureJson, uniqueValues = null) {
    * Checks if the used channels fits to the fixture's categories and raise warnings suggesting to add/remove a category.
    */
   function checkCategories() {
+    const mutuallyExclusiveGroups = [
+      [`Moving Head`, `Scanner`],
+      [`Pixel Bar`, `Flower`],
+      [`Pixel Bar`, `Stand`]
+    ];
+
     const categories = {
       'Color Changer': {
         isSuggested: isColorChanger(),
@@ -1078,21 +1084,36 @@ function checkFixture(manKey, fixKey, fixtureJson, uniqueValues = null) {
       }
     };
 
-    for (const categoryName of Object.keys(categories)) {
-      const categoryUsed = fixture.categories.includes(categoryName);
-      const category = categories[categoryName];
+    Object.entries(categories).forEach(([categoryName, category]) => {
+      const isCategoryUsed = fixture.categories.includes(categoryName);
 
-      if (!(`isInvalid` in category)) {
-        category.isInvalid = !category.isSuggested;
-      }
+      if (!isCategoryUsed && category.isSuggested) {
+        // don't suggest this category if another mutually exclusive category is used
+        const exclusiveGroups = mutuallyExclusiveGroups.filter(
+          group => group.includes(categoryName)
+        );
+        const isForbiddenByGroup = exclusiveGroups.some(
+          group => group.some(
+            cat => fixture.categories.includes(cat)
+          )
+        );
 
-      if (!categoryUsed && category.isSuggested) {
-        result.warnings.push(`Category '${categoryName}' suggested since ${category.suggestedPhrase}.`);
+        if (!isForbiddenByGroup) {
+          result.warnings.push(`Category '${categoryName}' suggested since ${category.suggestedPhrase}.`);
+        }
       }
-      else if (categoryUsed && category.isInvalid) {
+      else if (isCategoryUsed && category.isInvalid) {
         result.errors.push(`Category '${categoryName}' invalid since ${category.invalidPhrase}.`);
       }
-    }
+    });
+
+    mutuallyExclusiveGroups.forEach(group => {
+      const usedCategories = group.filter(cat => fixture.categories.includes(cat));
+
+      if (usedCategories.length >= 2) {
+        result.errors.push(`Categories '${usedCategories.join(`', '`)}' can't be used together.`);
+      }
+    });
 
     /**
      * @returns {boolean} Whether the 'Color Changer' category is suggested.
@@ -1184,12 +1205,7 @@ function checkFixture(manKey, fixKey, fixtureJson, uniqueValues = null) {
      * @returns {boolean} True if a matrix with only one axis, which has more than 4 pixels, is defined.
      */
     function isPixelBar() {
-      const mutualExclusiveCategories = [`Flower`, `Stand`];
-      const hasMutualExclusiveCategory = fixture.categories.some(
-        cat => mutualExclusiveCategories.includes(cat)
-      );
-
-      if (hasMutualExclusiveCategory || fixture.matrix === null) {
+      if (fixture.matrix === null) {
         return false;
       }