Skip to content

Commit

Permalink
adjusted deck internals
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed Sep 3, 2024
1 parent 8f05e6d commit dd8a1e5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 19 deletions.
4 changes: 4 additions & 0 deletions docs/Extending/Adding New Deck Models.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,7 @@ This is performed directly through the deck's device driver, by calling the appr
When creating an Activation, the activation will specify which **action** it requires. For example, an activation that requires an encoder dial to work will require the `encoder` or `encoder-push` capability.

Similarly, a Representation will specify which **view** it requires. A representation that displays an image (icon, drawing, animation...) will require a `image` view for instance.

# See Also

[[Deck Internals]]
39 changes: 20 additions & 19 deletions docs/Extending/Internals/Deck Internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,33 +27,34 @@ In the overall software organisation of Cockpitdecks, everything related to deck

The `decks` folder is organized as follow: (between parenthesis, the content of the folder or file.)

```
``` hl_lines="1 5"
deckconfig
⊢ resources
⊢ decks
decks
⊢ resources (accessory files)
⊢ templates (Jinja2 templates)
cockpitdecks/decks
⊢ resources << accessory files
⊢ templates << Jinja2 templates
⊢ index.j2
⊢ deck.j2
⊢ assets (Web Deck assets)
⊢ decks (Web Deck specific assets)
⊢ images (Web Deck background images)
⊢ images (Web Applicatioin images and icons)
⊢ js (Interaction and display software in JavaScript)
decktype.py (Deck Type class)
...
deckdefinition.yaml (Deck types, one file per type)
...
webdeckdefinition.yaml (Deck types, one file per type)
⊢ assets << Web Deck assets
⊢ decks << Web Deck specific assets
⊢ images << Web Deck background images
⊢ images << Web Applicatioin images and icons
⊢ js << Interaction and display software in JavaScript
⊢ types << Web Deck types
deckdefinition.yaml << Deck types, one file per deck type
...
webdeckdefinition.yaml << Web Deck types, one file per web deck type
decktype.py << Deck Type class
...
virtualdeck.py (Virtual Deck implementation class)
virtualdeckmanager.py (Virtual Deck Manager implementation class)
virtualdeck.py << Virtual Deck implementation class
virtualdeckmanager.py << Virtual Deck Manager implementation class
...
loupedeck.py (main drivers for each type of deck)
loupedeck.py << main drivers for each type of deck
...
virtualdeck.py (main drivers for all virtual decks)
xtouchmini.py (main drivers for each type of deck)
virtualdeck.py << main drivers for all virtual decks
xtouchmini.py << main drivers for each type of deck
```

# Deck Type
Expand Down

0 comments on commit dd8a1e5

Please sign in to comment.