Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discussion: Should WheelSlotRotation's slotNumber be stepped? #3624

Open
Breina opened this issue Nov 13, 2023 · 2 comments · May be fixed by #3625
Open

Discussion: Should WheelSlotRotation's slotNumber be stepped? #3624

Breina opened this issue Nov 13, 2023 · 2 comments · May be fixed by #3625
Labels
component-schema Affects the fixture JSON schema. question Open questions to be resolved before implementation, insights wanted from anyone.

Comments

@Breina
Copy link
Contributor

Breina commented Nov 13, 2023

Currently on the capability types docs: https://github.com/OpenLightingProject/open-fixture-library/blob/master/docs/capability-types.md

image

Seems like it's either speed or angle that are being appended with Start and End. Semantically it doesn't make sense to have a range of slotNumber. The JSON schema does allow slotNumberStart and slotNumberEnd on WheelSlotRotation, however I confirmed that no current fixtures use these fields.

This leaves me confused. Should "🐾 must be stepped" be added to slotNumber?

@FloEdelmann
Copy link
Member

Hmm that does makes sense. However, I guess it's currently the way it is because is either stepped in all capability types or not stepped in all capability types:

const START_END_ENTITIES = [`speed`, `duration`, `time`, `brightness`, `slotNumber`, `angle`, `horizontalAngle`, `verticalAngle`, `colorTemperature`, `soundSensitivity`, `shakeAngle`, `shakeSpeed`, `distance`, `openPercent`, `frostIntensity`, `insertion`, `fogOutput`, `parameter`];

I figure we could change that, but I don't really think it's worth the effort. But a PR would be welcome 🙂

@FloEdelmann FloEdelmann added question Open questions to be resolved before implementation, insights wanted from anyone. component-schema Affects the fixture JSON schema. labels Nov 13, 2023
@Breina
Copy link
Contributor Author

Breina commented Nov 13, 2023

Ah I see. I'm not comfortable in adding an edge case to JS, so I'll update the docs to make this clearer. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component-schema Affects the fixture JSON schema. question Open questions to be resolved before implementation, insights wanted from anyone.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants