OpenLightingProject / open-fixture-library

A library and website for lighting technology's DMX fixture definition files.
https://open-fixture-library.org/
MIT License
194 stars 65 forks source link

Better DMX source information for fixtures: Add network protocols to DMXConnector #202

Open FloEdelmann opened 7 years ago

FloEdelmann commented 7 years ago

→ rename DMXConnector to something that describes both physical and network ports

FloEdelmann commented 4 years ago

Information we may want to include:

~Proposed syntax~ (see version 2 below)

{
  "$schema": "…/schemas/fixture.json",
  // …
  "protocols": {
    "DMX512-A": {
      "ports": [
        "3-pin XLR",
        "5-pin XLR", 
        "3-pin XLR (swapped +/-)",
        "3-pin XLR IP65",
        "5-pin XLR IP65",
        "3.5mm stereo jack",
        "WDMX adapter",
        "WDMX receiver (built-in)"
      ]
    },
    "RDM": {
      "modelId": 7491
    },
    "Art-Net": {
      "ports": [
        "Ethernet",
        "WiFi"
      ]
    },
    "sACN": {
      "ports": [
        "Ethernet",
        "WiFi"
      ]
    }
  },
  // …
}

Unfortunately, this is quite verbose for most fixtures that only have a single XLR connector for DMX and nothing else, given that a physical section likely already exists anyway:

  "protocols": {
    "DMX512-A": {
      "ports": ["3-pin XLR"]
    }
  },
  // instead of
  "physical": {
    "DMXconnector": "3-pin"
  }
FloEdelmann commented 4 years ago

Proposed Syntax (version 2)

{
  "$schema": "…/schemas/fixture.json",
  // …
  "dmxConnections": [
    "3-pin XLR",
    "5-pin XLR", 
    "3-pin XLR (swapped +/-)",
    "3-pin XLR IP65",
    "5-pin XLR IP65",
    "3.5mm stereo jack",
    "Art-Net (Ethernet)",
    "Art-Net (WiFi)",
    "sACN (Ethernet)",
    "sACN (WiFi)",
    "WDMX (USB adapter)",
    "WDMX (built-in receiver)",
  ],
  // no change here:
  "rdm": {
    "modelId": 7491
  },
  // …
}
peternewman commented 4 years ago

Some other chaos to throw in, fixtures doing RS485 based DMX on RJ45 connectors. Fixtures with more than one connector wired in parallel (e.g. XLR3 and 5).

There are at least two competing wireless DMX standards!

XLR4 (i.e. DMX + power) for scrollers or other devices.

There are lots more Ethernet protocols, although those are probably the most popular, but see also KiNet and PathPort for example: https://www.openlighting.org/ola/

I can't imagine a fixture with WiFi and Ethernet would support one protocol only on one media, so your original proposal might be less complicated.

Some devices can also act as a gateway, so sACN to RS485 DMX.

You might also want to start tracking E1.33/RDMNet too...