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

Add information about the physical switch type to the machine-readable documentation #1

Open
jboecker opened this issue Dec 6, 2014 · 0 comments

Comments

@jboecker
Copy link
Member

jboecker commented Dec 6, 2014

Consider a hypothetical glass cockpit software that uses DCS-BIOS.
Ideally, this software would display a list of available controls which the user could drag and drop onto a panel and which would work without further configuration.

It is already possible to get a list of available controls by reading the JSON files that are also used to generate the reference documentation.

However, right now these files do not contain enough information to support the above use case.
For example, when looking at the Signal Lamps Test button in the A-10C, our glass cockpit software would know it was looking at a control with two states, but it has no way of knowing whether that was a toggle switch or a push button.

Ideally, when dragging the Signal Lamps Test button onto a panel, our glass cockpit software would know it is a push button and offer the user a range of visual styles to choose from.

The following information should be available in a machine-readable format:

  • Physical type of control
    • toggle switch
    • rotary switch
    • potentiometer
    • rotary encoder
    • rocker switch
  • Information about momentary positions for toggle switches and rotary switches
  • Information about min and max angles for rotary knobs

Some of this information is already encoded in the control_type, api_variant and physical_variant attributes. However, this is only a very first draft, very much subject to change and should not be relied upon yet.

If you are interested in such a feature, please use this issue to contribute your thoughts about what information needs to be included and how it should be encoded as JSON attributes.

@jboecker jboecker modified the milestone: After Next Release Dec 26, 2014
jboecker pushed a commit that referenced this issue Oct 22, 2019
Pull Request to add F5-E and AV8BNA
jboecker pushed a commit that referenced this issue Oct 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant