Skip to content

Commit

Permalink
adjusted nav and links
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed May 6, 2024
1 parent a4d3884 commit 0625321
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 54 deletions.
2 changes: 1 addition & 1 deletion docs/Button/Button Representations/Basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The `color` attribute can use a formula to determine the color (single hue value

# Deck Specific Displays

Some decks have particular LCD displays. Cockpitdecks [[Larger Displays|designed specific]] activations and representations for those.
Some decks have particular LCD displays. Cockpitdecks [[Deck Specific#Larger Displays|designed specific]] activations and representations for those.

# Other Representations

Expand Down
13 changes: 8 additions & 5 deletions docs/Button/Button Representations/Switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,11 @@ They can be used in replacement of multi-icons.
### Circular Switch Models
![[circular-switches.jpg]]
![[circular-switches.jpg|500]]
### Circular Switches as Drawn
![[rotating-selector-design.png]]
![[circular-switches.png]]
![[rotating-selector-design.png|400]]
# Push Button and Knob
- `button-size`
Expand All @@ -116,11 +116,14 @@ They can be used in replacement of multi-icons.
A PushButton is a simple button that can be used to trigger a command. It can be On or Off, and it's state can be reflected graphically by adjusting its color for instance.
### Push Button Models
Later…
Later.
### Push Buttons and Knob as Drawn
![[knobs-design.png]]
![[knobs-design.png|500]]
# Knob
Knobs are circular rotating buttons used to set values by rotating the button clockwise or counterclockwise. Although they can be drawn and « turn » according to dataref values, they cannot currently be used with activations to trigger their rotation. Real, physical rotation knobs must be used instead. (Mimicking a rotation knob with a push button is a difficult task that requires awkward manipulations such as long pushes. We may later offer a possibility to allow for rotation knows on icon button, because the surface of some icon button (LoupedeckLive) reacts to touch and swipes. It would therefore be possible to detect precisely where the button was touched (left, right, up, center…) and assign activations accordingly.)
So we shall just say that Knob icons can be used as simple push button, with an alternative representation.
2 changes: 1 addition & 1 deletion docs/Extending/Internals/Deck Internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The function, that we supply, is called each time an interaction occurs on the p

When Cockpitdecks is started, its scans for available devices, and check whether the interfacing software package is available. If it is, it installs its own callback function into the python package for that deck. From that moment on, each time something occurs on the deck device, Cockpitdecks' callback function gets called.

In that callback function, Cockpitdecks tries to spend a minimum time. From the data it receives, it creates an [[Event]] with all necessary data and enqueues it for later processing by Cockpitdecks.
In that callback function, Cockpitdecks tries to spend a minimum time. From the data it receives, it creates an [[Events|Event]] with all necessary data and enqueues it for later processing by Cockpitdecks.

The Event contains information about the deck, of course, but also the precise button, knob, encoder, slider, screen... that was used and what type of interaction occurred (pushed, turned, swiped...)

Expand Down
2 changes: 1 addition & 1 deletion docs/Extending/Internals/X-Plane Interaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ We experimentally observed that there is a performance limit of about ~100 datar

To request more datarefs, you can request them by batch of less than 100 datarefs and switch batches of requested datarefs at regular interval. It works very well.

Cockpitdecks created a dataref batch collector.
Cockpitdecks created a [[Dataref Sets|dataref batch collector]].
33 changes: 0 additions & 33 deletions docs/Extending/New Interactions.md

This file was deleted.

26 changes: 13 additions & 13 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,26 +63,26 @@ nav:
- Drawn Buttons: Button/Button Representations/Drawn Buttons.md
- Advanced:
- Deck Specific: Button/Button Representations/Deck Specific.md
- Toliss Airbus Specific Buttons: Button/Button Representations/Toliss Specific Buttons.md
- Toliss Airbus Specific Buttons: Button/Button Representations/Toliss Specific Representations.md
- Weather Representations: Button/Button Representations/Weather.md
- Resources: Resources.md
- Examples: Resources/Examples.md
- Examples: Extending/Examples.md
- Extending:
- Extending Cockpitdecks: Resources/Extending/Extending Cockpitdecks.md
- Activation for Developers: Resources/Button Activations for Developers.md
- Adding new deck models: Resources/Extending/New Deck.md
- New interactions: Resources/Extending/New Interactions.md
- Extending Cockpitdecks: Extending/Extending Cockpitdecks.md
- Adding rpresentations: Extending/Adding Representations.md
- Adding activations: Extending/Adding Activations.md
- Activation for developers: Extending/Button Activations for Developers.md
- Adding new deck models: Extending/Adding New Deck Models.md
- Cockpitdecks Internals:
- History: History.md
- Simulator:
- Simulator: Simulator.md
- X-Plane Interaction: Resources/X-Plane Interaction.md
- Cockpitdecks Internals: Resources/Internals/Cockpitdecks Internals.md
- Deck Internals: Resources/Internals/Deck Internals.md
- X-Plane UDP Interaction: Resources/About X-Plane UDP Interaction.md
- To do: Resources/To do.md
- Simulator: Extending/Simulator.md
- X-Plane Interaction: Extending/Internals/X-Plane Interaction.md
- Cockpitdecks Internals: Extending/Internals/Cockpitdecks Internals.md
- Deck Internals: Extending/Internals/Deck Internals.md
- To Do: Extending/Internals/To do.md
- Installation:
- Requirements: Installation.md#Installation Requirements
- Requirements: "Installation.md#Installation Requirements"
- Installation: Installation.md

# ###############################################
Expand Down

0 comments on commit 0625321

Please sign in to comment.