Skip to content

Commit

Permalink
more migration to tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@devleaks
devleaks committed Jul 9, 2024
1 parent ef48900 commit 2918571
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 116 deletions.
6 changes: 6 additions & 0 deletions docs/Button/Button Representations/Drawn Buttons (continued).md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ In each case, we will detail its intended use and the limits of the icon provide

Also, these special icons exhibit particular design techniques that can be extended by Cockpitdecks Representation developers.


> [!WARNING] Work In Progress
> These icons are currently basic but do provide their function.
> They have limited customization, but these can be added over time later if necessary or requested.

# Display Tape

A Tape is a type of display that appears like a tape being slid under the screen. Here are famous display tapes on an Airbus Primary Flight Display:
Expand Down
4 changes: 4 additions & 0 deletions docs/Button/Button Representations/Drawn Buttons – Switches.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,7 @@ Later.
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.
# See Also
[[Switch Drawing Parameters]]
29 changes: 14 additions & 15 deletions docs/Cockpit.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ It starts up the entire Cockpitdecks application. It establishes connection to t

# Aircraft Configuration

Decks are particular to one aircraft. Cockpitdecks will look for a folder named `deckconfig` in the X-Plane folder of that aircraft.
Decks are particular to one aircraft. All files necessary to Cockpitdecks are located in a single folder named `deckconfig` that is found in the X-Plane aircraft folder currently being used.

If a `deckconfig` folder is found in the folder of the aircraft currently used, Cockpidecks will first look for a file named `config.yaml`. In that file, Cockpitdecks will find all decks connected to the system and available to it. It will also find a set of global parameters.
Cockpitdecks will look for a folder named `deckconfig` in the X-Plane folder of that aircraft.

If a `deckconfig` folder is found in the folder of the aircraft currently used, Cockpidecks will first look for a file named `config.yaml`. In that file, Cockpitdecks will discover all decks connected to the system and available to it. It will also find a set of global parameters.

If no `deckconfig` folder is found in the folder of the aicradft, Cockpitdecks will load a default page, with defaults actions on each deck available to it.

Cockpidecks will also look for a file named `secret.yaml` in the `deckconfig` folder. In that file, Cockpitdecks will find information such as the serial numbers of the deck devices used. Serial numbers are needed to distinguish all decks of a similar type.
Cockpidecks will also look for a file named `secret.yaml` in the `deckconfig` folder. In that file, Cockpitdecks will find information such as the serial numbers of the deck devices used. Serial numbers are necessary to distinguish all decks of a similar type.

All configuration files for decks are all Yaml-formatted files. Yaml file contains a structured list of (name, value) pairs. The name is referred to as an *attribute*. The *value* can be almost anything: A number, a string, a list of things, or a list of other attributes.
All configuration files for Cockpitdecks are *Yaml-formatted files*. Yaml file contains a structured list of (name, value) pairs. The name is referred to as an *attribute*. The *value* can be almost anything: A number, a string, a list of things, or a list of other attributes.

# deckconfig Folder

Expand Down Expand Up @@ -57,7 +59,6 @@ The `deckconfig` folder contains the following files and sub-folders:
| resources | Resource files used by this configuration. Resources are icons, fonts, images, etc. |
| layout | A Layout is a folder that contains what is displayed on a deck. There can be as many Layout Folder as necessary for this aircraft |
| docs | Documentation relative to this aircraft and configuration |
| | |

# config.yaml File

Expand Down Expand Up @@ -85,14 +86,14 @@ cockpit-color: lightblue
The parameters apply to all decks for the given aircraft. Each individual deck will have the possibility to redefine these values if necessary.
| Attribute | Definition |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| aircraft | Optional information. The name of the aircraft for this set of deck. |
| cockpit-color | Color for the cockpit. This color is used as the default background color for icons. |
| cockpit-texture | Name of a image file (JPEG or PNG) that will be used as the (default) background of icons.<br><br>The `cockpit-texture` file will be searched at different places depending on where it is specified.<br><br>The `cockpit-texture` file can be specified at the Cockpit, Deck, Page, or Button level.<br><br>Cockpit-level default textures will be seached in the following folders (in that order):<br><br>- `resources`<br>- `resources/icons`<br><br>If the AIRCRAFT is specified, Cockpit-level textures and all other levels textures will be searched in the following folders:<br><br>- `AIRCRAFT/resource`<br>- `AIRCRAFT/icons`<br><br>If no texture is found, a uniform `cockpit-color` icon is used. |
| ### default-wallpaper-logo | Name of image file, located in the `resource` folder, to be loaded when the deck is not used. |
| default-* | Name of default values of several parameters, defined at the aircraft-level. These values will be used for all missing values. They can be raffined at Layout and Page level if necessary.<br><br>If no aircraft-level global parameter values are not provided, Cockpitdecks will use its own internal default values. |
| **decks** | A list of deck structure, one per [[Deck|deck]].<br><br>Yaml allow for other attributes in the file. They are ignored by Cockpitdecks. You may include other attributes like aircraft name, ICAO code, descriptions, notes, even change log of your file. |
| Attribute | Definition | |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `aircraft` | Optional information. The name of the aircraft for this set of deck. | |
| `cockpit-color` | Color for the cockpit. This color is used as the default background color for icons. | |
| `cockpit-texture` | Name of a image file (JPEG or PNG) that will be used as the (default) background of icons.<br><br>The `cockpit-texture` file will be searched at different places depending on where it is specified.<br><br>The `cockpit-texture` file can be specified at the Cockpit, Deck, Page, or Button level.<br><br>Cockpit-level default textures will be seached in the following folders (in that order):<br><br>- `resources`<br>- `resources/icons`<br><br>If the AIRCRAFT is specified, Cockpit-level textures and all other levels textures will be searched in the following folders:<br><br>- `AIRCRAFT/resource`<br>- `AIRCRAFT/icons`<br><br>If no texture is found, a uniform `cockpit-color` icon is used. | |
| `default-wallpaper-logo` | Name of image file, located in the `resource` folder, to be loaded when the deck is not used. | |
| `default-*` | Name of default values of several parameters, defined at the aircraft-level. These values will be used for all missing values. They can be raffined at Layout and Page level if necessary.<br><br>If no aircraft-level global parameter values are not provided, Cockpitdecks will use its own internal default values. | |
| **decks** | A list of deck structure, one per [[Deck | deck]].<br><br>Yaml allow for other attributes in the file. They are ignored by Cockpitdecks. You may include other attributes like aircraft name, ICAO code, descriptions, notes, even change log of your file. |

# secret.yaml File

Expand All @@ -119,8 +120,6 @@ Resources are fonts, icons, other images, wallpapers, documentation, and texts u
| docs | Docs folder may contain documentation files, like explanatory images, and descriptive texts. Simpler text or markdown files are preferred. |
| decks | Cockpitdecks allow experienced users to add their own [[Web Decks|web decks]], specific to an aircraft. |

All other folders are *Layout* folders.

# Layout Folders

Next to the the above *resources* folder, there will be one folder per Layout for a deck.
Expand Down
Loading

0 comments on commit 2918571

Please sign in to comment.