Skip to content

Commit

Permalink
rewrite intro in more commercial way
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed Nov 5, 2024
1 parent 6f9c6b7 commit 0c49cf7
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/Cockpit.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Cockpitdecks is an application that connect decks to the X-Plane flight simulator. On one side, the application scans for connected decks and prepare them for use with X-Plane. On the other side, Cockpitdecks connects to X-Plane to issue instructions and listen to changes and reflect those changes on the deck device if it allows it.
Cockpitdecks is an application that connect decks to the X-Plane flight simulator. On one side, the application scans for decks connected to the computer and prepare them for use with X-Plane. On the other side, Cockpitdecks connects to X-Plane through the network to issue instructions to the simulator and listen to changes to reflect those changes on the deck device if it allows it.

To determine what to display on decks, which commands to issue to the simulator, etc. Cockpitdecks reads a set of configuration files on startup.
To determine what to display on decks, which commands to issue to the simulator, etc. Cockpitdecks reads a set of *configuration files* on startup.

Configuration files are specific to an aircraft. Commands are different on a Cesna and on an Airbus. Things to display are different as well. That’s why configuration files are located in the folder of the aircraft being used. Numerous other software like X-Camera proceed in a similar way, locating their aircraft specific configuration there as well.
Configuration files are specific to an aircraft. Commands are different on a Cessna and on an Airbus. Things to display on the deck are different as well. That’s why configuration files are located in the folder of the aircraft being used because they are specific to it. Numerous other software like X-Camera proceed in a similar way, locating their aircraft specific configuration there as well.

The Cockpit is the *Maestro* component of the Cockpitdecks application.

It starts up the entire Cockpitdecks application. It establishes connection to the simulator, scans for existing decks connected to the computer, and load the aircraft configuration files. It listen to interactions that occur on the decks and listen to simulator changes to reflect deck statuses. It also monitors which aircraft is currently loaded in the simulator, and if the user changes aircraft, it loads the new configuration if any.

The following pages describe the necessary configuration files, their location and organisation, and their content. Configuration files are organised in structured folders, and this structure is explained as well.
The following pages describe the necessary configuration files, their location and organisation, and their content. Configuration files are organized in structured folders, and this structure is explained as well.

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.

Expand Down
1 change: 1 addition & 0 deletions docs/Concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The following page describe the components of Cockpitdecks and its vocabulary.
Binary file added docs/images/web-deck-intro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

Cockpitdecks is an application to use *decks* connected to a computer with X-Plane flight simulator.

The following make and models have been tested and work with Cockpitdecks:
The following make and models have been tested and are known to work with Cockpitdecks:

- [Elgato Stream Deck](https://www.elgato.com/us/en/s/welcome-to-stream-deck) small, Mk.2, XL, Plus, and Neo,
- [Loupedeck LoupedeckLive](https://loupedeck.com/products/loupedeck-live/)
- [Elgato Stream Deck](https://www.elgato.com/us/en/s/welcome-to-stream-deck) (all models work: Small, Mk.2, XL, Plus, and Neo)
- [Loupedeck Loupedeck Live](https://loupedeck.com/products/loupedeck-live/) (Loupedeck Live S, Loupedeck+, Loupedeck CT should also work but have not been tested)
- [Berhinger X-Touch Mini](https://www.behringer.com/product.html?modelCode=0808-AAF)

There also are Web Decks, an emulator of the above decks in a web page, in the context of this application. Yes, you read it, you can now have any of the above deck, for free, on a tablet, to use with X-Plane flight simulator.
There also are *Web Decks*, an emulator of the above decks in a web page, in the context of this application. Yes, you read it, you can now have any of the above deck, reproduced on a tablet, to use with X-Plane flight simulator. For free.

![[web-deck-intro.png|600]]

Cockpitdecks can run on the same computer as X-Plane, or a remote computer, network-connected to X-Plane.

Expand Down

0 comments on commit 0c49cf7

Please sign in to comment.