Skip to content

Category descriptions #2577

Open
Open
@kengruven

Description

@kengruven

One of the issues I'm seeing with using OFL data is that the categories are not consistently applied, and I think that stems from there being no description of exactly what the categories mean.

For example, wearing my lighting technician hat, I would say a "Dimmer" is a device which takes DMX input, and provides PWM-dimmed power (probably over Edison, Socapex, or stage pin), i.e., PWM. But most of the fixtures in OFL which include category "Dimmer" aren't this type of dimmer at all. I think some people assumed it means "any fixture which has an Intensity channel" (which is a little silly since that's probably every DMX fixture ever made).

I think that, in almost every case, a device with category "Dimmer" should not have any other category (see #914).

I started to make a big PR which removed "Dimmer" from dozens of fixtures, and I realized there's a more general issue: I don't know what some of the other categories mean, either. (What's a "Flower"? Is "Strobe" simply anything that has a Strobe channel? What's the difference between "Smoke" and "Hazer"? Or "Scanner" and "Barrel Scanner"? I rarely work with those kinds of fixtures myself.)

So it would be great to have clarification on what the categories are intended to mean, and then I'll help clean up the data so they're accurate. Ideally, the descriptions would be in the docs (schemas?), and also visible in the web editor. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    component-schemaAffects the fixture JSON schema.documentationImproves the Markdown docs, or in-code JSDoc comments, or user documentation on the website.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions