Skip to content

Commit

Permalink
adjuste "long press" ambiguity
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed Sep 3, 2024
1 parent 0c16d97 commit 8f05e6d
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 20 deletions.
10 changes: 5 additions & 5 deletions docs/Button/Button Activation.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,22 +140,22 @@ PushEvent. Please note that PushEvent consists of 2 distinct events, a pressed e

Auto-repeat will start 3 second after the button was pressed, the command will auto-repeat every 0.5 seconds, twice per second. (`dot` option also set for other purpose.)

# Longpress
# BeginEndPress

`type: longpress`
`type: begin-end-command`

Push button that will carry the command as long as the button will remain pressed.

Long press command should not be confused with auto-repeat commands. A Longpress command in one command that is executed once as long as the button remain pressed. An auto-repeat command is the same command that is executed several times at regular interval (typically once every 0.2 seconds, 5 times per second) as long as the button is pressed.
Long press command should not be confused with auto-repeat commands. A BeginEndPress command in one command that is executed once as long as the button remain pressed. An auto-repeat command is the same command that is executed several times at regular interval (typically once every 0.2 seconds, 5 times per second) as long as the button is pressed.

> [!NOTE]
> The Longpress command requires installation of a XPPYthon3 plugin in X-Plane to circumvent a few X-Plane UDP limitations.
> The BeginEndPress command requires installation of a XPPYthon3 plugin in X-Plane to circumvent a few X-Plane UDP limitations.
## Events

PushEvent

Only PushEvent can be used to trigger Longpress Activation since both press and release events are necessary to estimate the timing between both events.
Only PushEvent can be used to trigger BeginEndPress Activation since both press and release events are necessary to estimate the timing between both events.

## Attributes

Expand Down
6 changes: 3 additions & 3 deletions docs/Extending/Adding New Deck Models.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ Depending on the button's action that is triggered, the deck will programmatical

`swipe`: will produce a complex swipe Event, with the position of the start of the swipe, the end of the swipe and some timing information (timestamps of start and end of swipe).

Technically speaking, the deck will start a thread to listen to incoming events. Events will be decoded (which key was pressed, when, how, etc.) and presented to Cockpitdecks for handling.
Technically speaking, the deck will start a thread to listen to incoming events. Interaction will be decoded (which key was pressed, when, how, etc.) and presented to Cockpitdecks for handling as a typed Event.

Depending on the device driver's hardware access, events will either be presented directly to Cockpitdecks, or through a FIFO queue: Driver enqueues events, Cockpitdecks dequeues events.
Depending on the device driver's hardware access, events will either be presented directly to Cockpitdecks, or through a FIFO queue: Driver just enqueues events, Cockpitdecks dequeues events and does the work.

## Computer to Deck Interaction

Expand All @@ -91,4 +91,4 @@ 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 `lcd` view for instance.
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.
25 changes: 13 additions & 12 deletions docs/Extending/Internals/Deck Internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,19 @@ A deck is presented to Cockpitdecks through a deck definition file called a Deck
On startup, Cockpitdecks will report which deck types are available:

```
INFO: loaded 15 deck types (
Virtual Streamdeck Mini, Virtual Streamdeck MK.2, Streamdeck +,
Virtual LoupedeckLive, Stream Deck XL, Stream Deck Neo,
Virtual Streamdeck XL, LoupedeckLive, Streamdeck, Virtual X-Touch Mini,
Stream Deck Original, Stream Deck Mini, X-Touch Mini, Stream Deck +,
Virtual XKeys 80), 6 are virtual deck types
INFO: drivers installed for streamdeck 0.9.5, xtouchmini 1.3.6; scanning..
INFO: found 0 streamdeck
INFO: found 0 xtouchmini
...
INFO: found 1 web deck(s)
INFO: added virtual deck LoupedeckLive, serial None)
Cockpitdecks 11.20.1 © 2022-2024 Pierre M <pierre@devleaks.be>
Elgato Stream Decks, LoupedeckLive, Berhinger X-Touch, and web decks to X-Plane 12
INFO MainThread start.py:<module>:100: Initializing Cockpitdecks..
INFO MainThread xplane.py:init:329: aircraft dataref is sim/aircraft/view/acf_livery_path
WARNING MainThread xplane.py:add_datarefs_to_monitor:727: no connection
INFO MainThread xplane.py:add_datetime_datarefs:378: monitoring simulator date/time datarefs
INFO MainThread cockpit.py:load_deck_types:808: loaded 20 deck types (Virtual Deck for Development, virtual loupedeck.live.s, Virtual Streamdeck Mini, Virtual Streamdeck MK.2, Virtual Streamdeck +, Virtual LoupedeckLive, Stream Deck XL, Stream Deck Neo, Virtual Streamdeck XL, Virtual Stream Deck Neo, LoupedeckLive, Streamdeck, Virtual X-Touch Mini, Stream Deck Original, Stream Deck Mini, virtual loupedeck.ct, Virtual LoupedeckLive with Mosaic, X-Touch Mini, Stream Deck +, Virtual XKeys 80), 12 are virtual deck types
INFO MainThread cockpit.py:scan_devices:357: drivers installed for streamdeck 0.9.5, loupedeck 1.4.5, xtouchmini 1.3.6; scanning for decks and initializing them (this may take a few seconds)..
INFO MainThread cockpit.py:scan_devices:367: found 3 streamdeck
INFO MainThread cockpit.py:scan_devices:367: found 1 loupedeck
INFO MainThread cockpit.py:scan_devices:367: found 1 xtouchmini
INFO MainThread start.py:<module>:102: ..initialized
```

## Deck Definition
Expand Down

0 comments on commit 8f05e6d

Please sign in to comment.