Skip to content

Commit afe0c7e

Browse files
committed
content: usage: advanced: introduce custom Actions
1 parent 89def84 commit afe0c7e

5 files changed

+28
-0
lines changed
Loading
139 KB
Loading
Loading
Loading

content/usage/advanced/index.md

+28
Original file line numberDiff line numberDiff line change
@@ -582,6 +582,34 @@ If you want a similar feature for joystick button functions, consider assigning
582582
can be triggered.
583583
{% end %}
584584

585+
### Custom Actions
586+
587+
Cockpit's Action system provides a set of functionalities that can be triggered from any of Cockpit's
588+
supported input sources (e.g. joystick buttons, interface elements, other Actions, etc). There are
589+
some predefined ones, but it is also possible to define (and export or import) custom Actions with a
590+
few different approaches:
591+
592+
{{ easy_image(src="custom-actions-config", width=500) }}
593+
594+
- **MAVLink Message Actions** are the most confined, and allow sending arbitrary
595+
[MAVLink messages](https://mavlink.io/en/messages/common.html) and
596+
[commands](https://mavlink.io/en/messages/common.html#mav_commands) to the vehicle and any other
597+
components in your MAVLink system
598+
{{ easy_image(src="custom-mavlink-action", width=400) }}
599+
- **HTTP Request Actions** can send arbitrary HTTP requests, including custom URL parameters, headers,
600+
and a JSON body
601+
- These are best for basic communication with arbitrary APIs
602+
{{ easy_image(src="custom-http-action", width=400, center=true) }}
603+
- **JavaScript Actions** are a blank canvas, with all the possibilities (but also the complexities) of
604+
programming your own functionalities
605+
{{ easy_image(src="custom-javascript-action", width=500, center=true) }}
606+
607+
Existing custom Actions can be edited, run manually (to test them), exported, or deleted.
608+
609+
{% note() %}
610+
More detailed breakdowns and examples will be coming in future.
611+
{% end %}
612+
585613
## Status and Recordings
586614

587615
### Video Library

0 commit comments

Comments
 (0)