RDM data (#291)

Add RDM data (#291)

Author: FloEdelmann

cli/fixture-features/rdm.js

@@ -0,0 +1,6 @@
+module.exports = [{
+  name: 'RDM',
+  description: 'Whether an RDM model ID is set',
+  order: 40,
+  hasFeature: fixture => fixture.rdm !== null
+}];

cli/generate-register.js

@@ -8,14 +8,18 @@ let register = {
   filesystem: {},
   manufacturers: {},
   categories: {},
-  contributors: {}
+  contributors: {},
+  rdm: {}
 };
 let categories = {};
 let contributors = {};
+let rdm = {};
 
 const fixturePath = path.join(__dirname, '..', 'fixtures');
 
 try {
+  const manufacturers = JSON.parse(fs.readFileSync(path.join(fixturePath, 'manufacturers.json'), 'utf8'));
+
   // add all fixture.json files to the register
   for (const manKey of fs.readdirSync(fixturePath).sort()) {
     const manDir = path.join(fixturePath, manKey);
@@ -24,6 +28,13 @@ try {
     if (fs.statSync(manDir).isDirectory()) {
       register.manufacturers[manKey] = [];
 
+      if ('rdmId' in manufacturers[manKey]) {
+        rdm[manufacturers[manKey].rdmId] = {
+          key: manKey,
+          models: {}
+        };
+      }
+
       for (const filename of fs.readdirSync(manDir).sort()) {
         const ext = path.extname(filename);
         if (ext === '.json') {
@@ -63,6 +74,11 @@ try {
             }
             contributors[contributor].push(manKey + '/' + fixKey);
           }
+
+          // add to rdm register
+          if ('rdm' in fixData) {
+            rdm[manufacturers[manKey].rdmId].models[fixData.rdm.modelId] = fixKey;
+          }
         }
       }
     }
@@ -97,6 +113,18 @@ register.lastUpdated = Object.keys(register.filesystem).sort((a, b) => {
   return dateDelta !== 0 ? dateDelta : keyDelta;
 });
 
+// copy sorted RDM data into register
+for (const manId of Object.keys(rdm).sort()) {
+  register.rdm[manId] = {
+    key: rdm[manId].key,
+    models: {}
+  };
+
+  for (const fixId of Object.keys(rdm[manId].models).sort()) {
+    register.rdm[manId].models[fixId] = rdm[manId].models[fixId];
+  }
+}
+
 const filename = path.join(fixturePath, (process.argv.length === 3 ? process.argv[2] : 'register.json'));
 
 fs.writeFile(filename, JSON.stringify(register, null, 2), 'utf8', error => {

fixtures/manufacturers.json

@@ -16,19 +16,22 @@
   },
   "coemar": {
     "name": "Coemar",
-    "website": "http://www.coemar.com/"
+    "website": "http://www.coemar.com/",
+    "rdmId": 17229
   },
   "chauvet-dj": {
     "name": "Chauvet DJ",
-    "website": "https://www.chauvetdj.com/"
+    "website": "https://www.chauvetdj.com/",
+    "rdmId": 8612
   },
   "dts": {
     "name": "DTS",
     "website": "https://dts-lighting.it/"
   },
   "elation": {
     "name": "Elation",
-    "website": "http://www.elationlighting.com/"
+    "website": "http://www.elationlighting.com/",
+    "rdmId": 8870
   },
   "eliminator": {
     "name": "Eliminator Lighting",
@@ -60,11 +63,13 @@
   },
   "martin": {
     "name": "Martin",
-    "website": "http://www.martin.com/"
+    "website": "http://www.martin.com/",
+    "rdmId": 19792
   },
   "mdg": {
     "name": "MDG",
-    "website": "http://www.mdgfog.com/en"
+    "website": "http://www.mdgfog.com/en",
+    "rdmId": 19780
   },
   "prolights": {
     "name": "Prolights",
@@ -76,10 +81,12 @@
   },
   "robe": {
     "name": "Robe",
-    "website": "https://www.robe.cz/"
+    "website": "https://www.robe.cz/",
+    "rdmId": 21075
   },
   "showtec": {
     "name": "Showtec",
-    "website": "http://www.highlite.nl/"
+    "website": "http://www.highlite.nl/",
+    "rdmId": 10676
   }
 }

fixtures/martin/mac-aura.json

@@ -9,6 +9,9 @@
   },
   "comment": "moving wash:\n- single-lens wash with fully premixed color \n- broad color palette, RGBW color mixing \n- eye-candy Aura EffectsTM",
   "manualURL": "http://www.martin.com/files/files/productdocuments/11_MANUALS/999/UM_MACAura_EN_B.pdf",
+  "rdm": {
+    "modelId": 4
+  },
   "physical": {
     "dimensions": [302, 360, 302],
     "weight": 5.6,

fixtures/martin/mac-viper-airfx.json

@@ -9,6 +9,10 @@
   },
   "comment": "Viper Air FX:\n- 35000 Lumens \n- 1:5 zoom - Continuous and fast zoom with auto-linked focus\n- 160 mm precision PC front lens for fat beam looks\n- The Martin Quadray Module is available as an accessory for the MAC Viper AirFX. It splits the MAC Viper AirFX beam into four individually controllable rays.",
   "manualURL": "http://www.martin.com/files/files/productdocuments/11_MANUALS/999/UM_MACViperAirFX_EN_B.pdf",
+  "rdm": {
+    "modelId": 44,
+    "softwareVersion": "1.2.0"
+  },
   "physical": {
     "dimensions": [473, 749, 566],
     "weight": 35.7,
@@ -1179,6 +1183,7 @@
     {
       "name": "Extended",
       "shortName": "ext",
+      "rdmPersonalityIndex": 1,
       "channels": [
         "Strobe / Shutter",
         "Dimmer fade",

fixtures/martin/mac-viper-performance.json

@@ -8,6 +8,10 @@
     "lastModifyDate": "2017-09-08"
   },
   "manualURL": "http://www.martin.com/files/files/productdocuments/11_MANUALS/999/35000275c%20UM_MACViperPerf_EN_C.pdf",
+  "rdm": {
+    "modelId": 65,
+    "softwareVersion": "1.0.0"
+  },
   "physical": {
     "dimensions": [472, 748, 566],
     "weight": 37.9,
@@ -1035,6 +1039,7 @@
     {
       "name": "Basic 16-bit",
       "shortName": "bas",
+      "rdmPersonalityIndex": 1,
       "channels": [
         "Strobe / Shutter",
         "Dimmer fade",
@@ -1073,6 +1078,7 @@
     {
       "name": "Extended 16-bit",
       "shortName": "ext",
+      "rdmPersonalityIndex": 2,
       "channels": [
         "Strobe / Shutter",
         "Dimmer fade",

fixtures/martin/mac-viper-wash.json

@@ -9,6 +9,10 @@
   },
   "comment": "This fixture definition covers both the MAC Viper Wash and the MAC Viper Wash DX. The Color Wheel, Iris and all Internal Barndoor channels are only available in the DX variant.\n\nNote: Focus and Zoom are 8-bit channels, the manual is wrong there.",
   "manualURL": "http://www.martin.com/files/files/productdocuments/11_MANUALS/999/UM_MACViperWash_EN_B.pdf",
+  "rdm": {
+    "modelId": 43,
+    "softwareVersion": "1.3.0"
+  },
   "physical": {
     "dimensions": [473, 749, 566],
     "weight": 33,
@@ -541,6 +545,7 @@
     {
       "name": "Basic",
       "shortName": "basic",
+      "rdmPersonalityIndex": 1,
       "channels": [
         "Strobe / Shutter",
         "Dimmer",
@@ -565,6 +570,7 @@
     {
       "name": "Extended",
       "shortName": "ext",
+      "rdmPersonalityIndex": 2,
       "channels": [
         "Strobe / Shutter",
         "Dimmer",

fixtures/register.json

@@ -599,6 +599,43 @@
       "prolights/diamond-19"
     ]
   },
+  "rdm": {
+    "8612": {
+      "key": "chauvet-dj",
+      "models": {}
+    },
+    "8870": {
+      "key": "elation",
+      "models": {}
+    },
+    "10676": {
+      "key": "showtec",
+      "models": {}
+    },
+    "17229": {
+      "key": "coemar",
+      "models": {}
+    },
+    "19780": {
+      "key": "mdg",
+      "models": {}
+    },
+    "19792": {
+      "key": "martin",
+      "models": {
+        "4": "mac-aura",
+        "43": "mac-viper-wash",
+        "44": "mac-viper-airfx",
+        "65": "mac-viper-performance"
+      }
+    },
+    "21075": {
+      "key": "robe",
+      "models": {
+        "7": "colorspot-2500e-at"
+      }
+    }
+  },
   "lastUpdated": [
     "eliminator/stealth-beam",
     "jb-systems/twin-effect-laser",

fixtures/robe/colorspot-2500e-at.json

@@ -8,6 +8,9 @@
     "lastModifyDate": "2017-09-07"
   },
   "manualURL": "https://www.robe.cz/index.php?type=10898&tx_odproducts_f%5baction%5d=downloadFile&tx_odproducts_f%5bfile%5d=robe/downloads/user_manuals/User_manual_ColorSpot_2500E_AT.pdf",
+  "rdm": {
+    "modelId": 7
+  },
   "physical": {
     "dimensions": [536, 638, 678],
     "weight": 42.5,

fixtures/schema.js

@@ -12,7 +12,7 @@ const schema = require('js-schema');
  * 
  * @type {string}
  */
-module.exports.VERSION = '2.0.0';
+module.exports.VERSION = '2.1.0';
 
 /**
  * see https://github.com/molnarg/js-schema
@@ -124,6 +124,7 @@ const Channel = schema({
 const Mode = schema({
   'name': NonEmptyString,
   '?shortName': NonEmptyString, // if not set: use name
+  '?rdmPersonalityIndex': Number.min(1).step(1),
   '?physical': Physical, // overrides fixture's Physical
   'channels': Array.of([null, ChannelKey, ChannelAliasKey]), // null for unused channels
   '*': Function
@@ -147,6 +148,11 @@ const Fixture = schema({
   }),
   '?comment': NonEmptyMultiLineString,
   '?manualURL': URL,
+  '?rdm': schema({
+    'modelId': Number.min(0).step(1),
+    '?softwareVersion': String,
+    '*': Function
+  }),
   '?physical': Physical,
   'availableChannels': schema({
     '*': Channel // '*' is the channel key
@@ -163,6 +169,7 @@ const Manufacturers = schema({
     'name': NonEmptyString,
     '?comment': NonEmptyMultiLineString,
     '?website': URL,
+    '?rdmId': Number.min(0).step(1),
     '*': Function
   })
 });

lib/add-fixtures.js

@@ -6,16 +6,15 @@ var properties = require('../fixtures/schema.js').properties;
  */
 module.exports = function addFixtures(request, response) {
   createPullRequest(getOutObjectFromEditorData(request.body.fixtures), (error, pullRequestUrl) => {
-    response
-      .status(201)
-      .type('application/json')
-      .send(Buffer.from(
-        JSON.stringify({
-          pullRequestUrl: pullRequestUrl,
-          error: error
-        })
-      ));
-    });
+    response.status(201)
+    .type('application/json')
+    .send(Buffer.from(
+      JSON.stringify({
+        pullRequestUrl: pullRequestUrl,
+        error: error
+      })
+    ));
+  });
 };
 
 
@@ -73,6 +72,14 @@ function addFixture(fixture) {
         addAvailableChannel(key, fixture.availableChannels, chId);
       }
     }
+    else if (prop === 'rdm' && propExistsIn('rdmModelId', fixture)) {
+      out.fixtures[key].rdm = {
+        modelId: fixture.rdmModelId
+      };
+      if (propExistsIn('rdmSoftwareVersion', fixture)) {
+        out.fixtures[key].rdm.softwareVersion = fixture.rdmSoftwareVersion;
+      }
+    }
     else if (prop === 'modes') {
       out.fixtures[key].modes = [];
       for (const mode of fixture.modes) {
@@ -105,6 +112,10 @@ function getManufacturerKey(fixture) {
     out.manufacturers[manKey].website = fixture.newManufacturerWebsite;
   }
 
+  if (propExistsIn('newManufacturerRdmId', fixture)) {
+    out.manufacturers[manKey].rdmId = fixture.newManufacturerRdmId;
+  }
+
   return manKey;
 }