Get Started
Action Types in Detail
Appendix

Action Types in Detail

This appendix lists the commands, input fields, and output variables of all 33 action types, in the order of the type list in the add-action dialog. See Part 4 for adding and editing actions and for the shared notes on Wait for Completion and status variables, and Appendix D for the AI Analysis action.

Note Actions that use a resource select it in their first field from the resources (devices, timers, clients, and so on) registered in Settings (Part 6). Resources can also be added, edited, and deleted from the selection window. Value fields accept direct input, a variable value, or the block editor (Part 8), and file fields select a file uploaded to the project (Part 3). Output variable fields list only the variables created in Settings → Variable whose type matches. "Displayed only when" means the field appears only under that condition.

In this chapter

  1. I/O Device ControlControls I/O devices connected to the controller, such as LEDs, sensors, LCDs, and motors. See Part 7 for the device cat…
  2. Set VariableWrites a value to the selected variable. The write mode and the value field change with the variable type. Variable Sele…
  3. Shell CommandRuns a command in the default shell of the controller's operating system. Use it to run system commands or to launch ext…
  4. Read/Write FileReads text or binary data from a file, or writes data to a file. File editors are registered in Settings > File Editor .…
  5. File SystemCreates, copies, moves, and deletes local files and folders on the controller, or queries their information. Paths can b…
  6. DelayWaits for the set time and then continues to the next action. Mode Normal (default): Delay in milliseconds. Precision : …
  7. TimerMeasures the time elapsed from a base time. It can be set to count up or down, so it serves as a timer or a stopwatch. T…
  8. CollectionAdds, retrieves, and removes values in a collection. A collection is a store for many values and comes in two types, lis…
  9. DatabaseQueries, inserts, updates, and deletes data in a database. SQL databases (MySQL, PostgreSQL, SQLite, ODBC) and the Fireb…
  10. StatisticsCalculates statistics such as the minimum, maximum, and average of a number variable. For example, a statistic on a temp…
  11. Data LoggingRecords one sample to the specified data logging channel. One row of the channel's variable values is appended at the mo…
  12. Play MediaPlays audio and video. Most file formats such as mp3 and mp4 and web streaming are supported; see the VLC supported form…
  13. Display ImageDisplays an image on the display connected to the controller. Files uploaded to the project and web images can be shown,…
  14. SynthesizerPlays instrument sounds and sound effects, or plays MIDI files. The synthesizer is implemented in software and uses a So…
  15. CameraStarts or stops camera capture and streaming, and saves the current frame to a file. Cameras are registered in Settings …
  16. Audio AnalysisAnalyzes the level and frequency distribution of audio in real time using FFT (Fast Fourier Transform). Audio analyzers …
  17. Record AudioRecords sound from the microphone and saves it as a file. The mp3, ogg, flac, and wav formats are supported, and recorde…
  18. Transform AudioChanges the tempo, pitch, and playback speed of a source audio file, saves the result as a new file, and plays it if req…
  19. LLM AI QuerySends a query text and an optional attachment to an LLM (large language model) provider and stores the response in a var…
  20. Text-to-Speech (TTS)Converts text to speech and plays it. The service type (On Device, Google Cloud, OpenAI, or ElevenLabs) is set when the …
  21. Speech-to-Text (STT)Converts human speech to text in real time. VAD (voice activity detection) detects the speech segments automatically; th…
  22. Telegram MessageExchanges messages or files with users through a Telegram bot. Bots are registered in Settings > Telegram Bot ; see Appe…
  23. Send EmailSends an email through an SMTP client. The body can be text or HTML, files can be attached, and any mail server that sup…
  24. Push NotificationSends a push notification to the user's mobile app. The title and message are free text, and dynamic messages that inclu…
  25. Zigbee Device ControlReads sensor values from, or controls, a Zigbee device registered in Settings . Every property the device exposes can be…
  26. Home Assistant IntegrationIntegrates with the Home Assistant server registered in Settings . Home Assistant entities can be read or controlled, an…
  27. MQTT CommunicationPublishes messages to an MQTT broker, or subscribes to a topic and receives messages. MQTT is a lightweight messaging pr…
  28. Modbus CommunicationExchanges data with industrial equipment such as PLCs and sensors using the Modbus protocol. Modbus is an industrial pro…
  29. OPC UA CommunicationReads or writes nodes on an OPC UA server. OPC UA is an industrial standard protocol for exchanging data in a standardiz…
  30. HTTP CommunicationSends an HTTP request to a web server or REST API and receives the response. This action has no resource selection and n…
  31. User Defined CommunicationCommunicates with external devices using frames that you define yourself. Serial, TCP, UDP, WebSocket, Bluetooth, and sh…
  32. PID ControlCalculates PID feedback control. PID stands for Proportional, Integral, and Derivative; the three terms are combined to …
  33. Custom ActionWrites the action to run yourself with block coding. See Part 8 for using the block editor and the block categories, and…