MacroDroid Wiki - User contributions [en-gb]

Actions

2024-12-05T05:05:54Z

Dm114: /* Synchronous vs asynchronous */

<pre style="background-color: #FFFF99; color: #112A46; border-radius: 10px; padding: 10px;">
An action is something your device can do when a macro runs.
A macro must have at least one action to be valid.
</pre>

=== Synchronous vs asynchronous ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
MacroDroid actions typically execute quickly, but certain actions like HTTP requests or shell scripts may take longer. To ensure that subsequent actions wait for these longer actions to complete before continuing, enable the 'Block next action until complete' option in the action's configuration GUI. Otherwise, the action will run asynchronously while other actions continue.

In traditional programming languages, you could pass a callback function to execute after the asynchronous action is complete. This allows you to perform additional actions or work with the data returned by the asynchronous action. However, MacroDroid's inner workings are arbitrary, so there is no systematic option for this. Instead, you must rely on different workarounds.
</pre>

== Control flow ==

[[Control flow: If clause|If clause]]

[[Control flow: If confirmed then|If confirmed then]]

[[Control flow: Repeat actions|Repeat actions]]

[[Control flow: Iterate Dictionary/Array| Iterate Dictionary/Array]]

[[Control flow: Break from loop|Break from loop]]

[[Control flow: Continue loop|Continue loop]]

== List of Actions ==

[[Action: Accessibility Service|Accessibility Service]]

[[Action: Action Block|Action Block]]

[[Action: Airplane Mode On/Off|Airplane Mode On/Off]]

[[Action: Alarm Clock|Alarm Clock]]

[[Action: Ambient Display|Ambient Display]]

[[Action: Animation Overlay|Animation Overlay]]

[[Action: Android Shortcut|Android Shortcut]]

[[Action: Android Wear|Android Wear]]

[[Action: Answer Call|Answer Call]]

[[Action: App Enable/Disable|App Enable/Disable]]

[[Action: Authenticate User|Authenticate User]]

[[Action: Array Manipulation|Array Manipulation]]

[[Action: Autosync On/Off|Autosync On/Off]]

[[Action: Battery Saver|Battery Saver]]

[[Action: Block Screen Touch|Screen Block Touch]]

[[Action: Bluetooth Configure|Bluetooth Configure]]

[[Action: Brightness|Brightness]]

[[Action: Calendar - Add Event|Calendar - Add Event]]

[[Action: Call Reject|Call Reject]]

[[Action: Camera Enable/Disable|Camera Enable/Disable]]

[[Action: Cancel Macro Actions|Cancel Macro Actions]]

[[Action: Car Mode|Car Mode]]

[[Action: Check Pixel Colour|Check pixel colour]]

[[Action: Check Text In Screenshot|Check Text In Screenshot]]

[[Action: Check Text On Screen|Check Text On Screen]]

[[Action: Clear App Data|Clear App Data]]

[[Action: Clear Call Log|Clear Call Log]]

[[Action: Clear Dictionary/Array Entry|Clear Dictionary/Array Entry]]

[[Action: Clear MacroDroid Dialog|Clear MacroDroid Dialog]]

[[Action: Clear Log|Clear Log]]

[[Action: Clear Notifications|Clear Notifications]]

[[Action: Clear Variables|Clear Variables]]

[[Action: Clipboard Refresh|Clipboard Refresh]]

[[Action: Configure App Notifications|Configure App Notifications]]

[[Action: Configure Quick Tile|Configure Quick Tile]]

[[Action: Confirm Next|Confirm Next]]

[[Action: Connectivity Check|Connectivity Check]]

[[Action: Contact Via App|Contact Via App]]

[[Action: Control Media|Control Media]]

[[Action: Dark Theme|Dark Theme]]

[[Action: Daydream/Screensaver On|Daydream/Screensaver On]]

[[Action: Delete Macro|Delete Macro]]

[[Action: Delete Variable|Delete Variable]]

[[Action: Demo Mode|Demo Mode]]

[[Action: Dim Screen|Dim Screen]]

[[Action: Disable MacroDroid|Disable MacroDroid]]

[[Action: Display Bubble Notification|Display Bubble Notification]]

[[Action: Display Dialog|Display Dialog]]

[[Action: Display Notification|Display Notification]]

[[Action: Empty Action|Empty Action]]

[[Action: Enable/Disable Category|Enable/Disable Category]]

[[Action: Enable/Disable Macro|Enable/Disable Macro]]

[[Action: Enable/Disable Trigger|Enable/Disable Trigger]]

[[Action: Exit Action Block|Exit Action Block]]

[[Action: Expand/Collapse Status Bar|Expand/Collapse Status Bar]]

[[Action: Export Log|Export Log]]

[[Action: Export Macros|Export Macros]]

[[Action: File Operation| File Operation]]

[[Action: Fill Clipboard|Fill Clipboard]]

[[Action: Floating Button Configure|Floating Button Configure]]

[[Action: Floating text|Floating text]]

[[Action: Font Scale|Font Scale]]

[[Action: Force Location Update|Force Location Update]]

[[Action: Force Screen Rotation|Force Screen Rotation]]

[[Action: Get Light Level|Get Light Level]]

[[Action: Get Text From View Id|Get Text From View Id]]

[[Action: GPS Enable/Disable|GPS Enable/Disable]]

[[Action: Heads-up Enable/Disable|Heads-up Enable/Disable]]

[[Action: HotSpot On/Off|HotSpot On/Off]]

[[Action: HTTP Request|HTTP Request]]

[[Action: HTTP Server|HTTP Server]]

[[Action: Immersive Mode|Immersive Mode]]

[[Action: JavaScript Code|JavaScript Code]]

[[Action: Invert Colours|Invert Colours]]

[[Action: JSON Parse|JSON Parse]]

[[Action: Keep Device Awake|Keep Device Awake]]

[[Action: Keyboard - Set Default|Keyboard - Set Default]]

[[Action: Keyboard Prompt|Keyboard Prompt]]

[[Action: Kill Application|Kill Application]]

[[Action: Kill Background Processes|Kill Background Processes]]

[[Action: Launch and Press|Launch and Press]]

[[Action: Launch Application|Launch Application]]

[[Action: Launch Home Screen|Launch Home Screen]]

[[Action: Launch Shortcut|Launch Shortcut]]

[[Action: Locale/Tasker Plugin|Locale/Tasker Plugin]]

[[Action: Location Mode|Location Mode]]

[[Action: Log Event|Log Event]]

[[Action: MacroDroid Drawer|MacroDroid Drawer]]

[[Action: MacroDroid Settings|MacroDroid Settings]]

[[Action: Macro run|Macro run]]

[[Action: Make Call|Make Call]]

[[Action: Mobile Data On/Off|Mobile Data On/Off]]

[[Action: NFC Enable/Disable|NFC Enable/Disable]]

[[Action: Notification Interaction|Notification Interaction]]

[[Action: Notification LED Enable/Disable|Notification LED Enable/Disable]]

[[Action: Notification Reply|Notification Reply]]

[[Action: Open Call Log|Open Call Log]]

[[Action: Open File|Open File]]

[[Action: Open Last Photo|Open Last Photo]]

[[Action: Open MacroDroid Log|Open MacroDroid Log]]

[[Action: Open Website / HTTP GET|Open Website / HTTP GET]]

[[Action: Option Dialog|Option Dialog]]

[[Action: Play/Stop Sound|Play/Stop Sound]]

[[Action: Popup Message|Popup Message]]

[[Action: Press Back Button|Press Back Button]]

[[Action: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]

[[Action: Read Screen Contents|Read Screen Contents]]

[[Action: Read Screenshot Contents|Read Screenshot Contents]]

[[Action: Reboot/Power Off|Reboot/Power Off]]

[[Action: Record Microphone|Record Microphone]]

[[Action: Restore Hidden Notifications|Restore Hidden Notifications]]

[[Action: Ringtone Configure|Ringtone Configure]]

[[Action: Say Current Time|Say Current Time]]

[[Action: Screen On/Off|Screen On/Off]]

[[Action: Secure Settings|Secure Settings]]

[[Action: Selection Dialog|Selection Dialog]]

[[Action: Send Email|Send Email]]

[[Action: Send Intent|Send Intent]]

[[Action: Send SMS|Send SMS]]

[[Action: Set Button Bar Image|Set Button Bar Image]]

[[Action: Set Location Update Rate|Set Location Update Rate]]

[[Action: Set Digital Assistant|Set Digital Assistant]]

[[Action: Set MacroDroid Icon|Set MacroDroid Icon]]

[[Action: Set MacroDroid Mode|Set MacroDroid Mode]]

[[Action: Set MacroDroid Notification Text|Set MacroDroid Notification Text]]

[[Action: Set Notification Sound|Set Notification Sound]]

[[Action: Set Screen Lock|Set Screen Lock]]

[[Action: Set Screen Timeout|Set Screen Timeout]]

[[Action: Set Variable|Set Variable]]

[[Action: Set Wallpaper|Set Wallpaper]]

[[Action: Share Last Photo|Share Last Photo]]

[[Action: Share Text|Share Text]]

[[Action: Share Location|Share Location]]

[[Action: Shell Script|Shell Script]]

[[Action: Silent - Vibrate Off|Silent - Vibrate Off]]

[[Action: Silent - Show Volume Popup|Show Volume Popup]]

[[Action: Speak Text|Speak Text]]

[[Action: Speakerphone On/Off|Speakerphone On/Off]]

[[Action: Stopwatch|Stopwatch]]

[[Action: Sync Account|Sync Account]]

[[Action: System Setting|System Setting]]

[[Action: Take Picture|Take Picture]]

[[Action: Take Screenshot|Take Screenshot]]

[[Action: Text_from_Image_(OCR)|Text from Image (OCR)]]

[[Action: Text Manipulation|Text Manipulation]]

[[Action: Torch On/Off|Torch On/Off]]

[[Action: Translate Text|Translate Text]]

[[Action: Touch Screen|Touch Screen]]

[[Action: UDP Command|UDP Command]]

[[Action: UI Interaction|UI Interaction]]

[[Action: USB Tethering|USB Tethering]]

[[Action: Vibrate|Vibrate]]

[[Action: Vibrate Enable/Disable|Vibrate Enable/Disable]]

[[Action: Voice Input|Voice Input]]

[[Action: Voice Search|Voice Search]]

[[Action: Volume Change|Volume Change]]

[[Action: Volume Up/Down|Volume Up/Down]]

[[Action: Wait Before Next Action|Wait Before Next Action]]

[[Action: Wait Until Trigger|Wait Until Trigger]]

[[Action: WhatsApp Send|WhatsApp Send]]

[[Action: Widget Button Modify|Widget Button Modify]]

[[Action: Wifi Configure|Wifi Configure]]

[[Action: Write to File|Write to File]]

Action: Set Variable

2024-05-25T12:43:23Z

Dm114: Orthographic correction (a letter missing)

This action allows you to set the value of a specific MacroDroid variable.

As explained in the [[Variables]] section, variables are divided into '''2 categories''' and '''4 types'''. Whatever category or type, their value/content is never reset and remains, even after device reboot. They are identified by a '''name''' given at creation time ''(see below)''

'''Naming:'''

Every variable is identified by its name. This name can be made of any set of character. To facilitate maintainability, the name should relate the content or purpose of the named variable.

'''Category:'''

Every variable can be either '''local''' or '''global'''.
* A '''local variable''' belongs to the macro it has been created into. It can only be used inside this macro. Its name must be unique inside the macro it belongs to.
* A '''global variable''' can be accessed and used from any macro. Its name must be unique among all the 'global' variables

'''Type:'''

A variable belongs to 1 of the 4 following types: '''Boolean, Integer, Decimal''' or '''String'''.
*'''Boolean''' type allows 2 states: True or False
*'''Integer''' type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison
*'''Decimal''' type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison. Sientific notation may be used: 0.0012 or 1.2E-3
*'''String''' type contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). ''HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.''

'''"Set variable" action''' allows to store a specific value to a given variable. This variable has to be selected among all the available variables or created by selecting the first item of the list called ''[New Variable]''. In this case, you'll be asked what category, name and type have to be assigned to this new variable ''(see above)''.

According to its type ''(see above)'', you can choose a value or method to be assigned to among a list of methods:

'''For Boolean variables:'''
* False or True value
* invert current value
* prompt at execution time
* another boolean variable value

'''For Numeric variables (Integer or Decimal):'''
* fixed value (including any available [[Magic text]])
* random value
* prompt at execution time
* mathematical expression that can include any existing numeric or boolean variable as well as any available numeric [[Magic text]] and some mathematical functions (list and syntax included)

* in addition, Integer type variables have 2 other kinds of settings: adding or subtracting 1 to current value (same as mathematical expression 'my_integer_variable +/- 1' but more convenient when incrementing/decrementing an index by step of 1)

In expressions, booleans have value 1 if true, 0 if false.
Beyond the mathematical operations listed in the dropdown menu usual arithmetic operators (+ - * /) can be use and
:- % for modulo
:- ^ for power
:- logical operators (&& for "and", || for "or") where the operands can be booleans or numbers (0 is false, any non-zero is true) and the boolean result is converted to number (there is no "not" operator but there is a not() function shown in the list of available functions)
:- comparisons between numbers (< = != >) where again the boolean result is converted to number

'''For String variables:'''
* fixed value (including concatenated string variables contents as well as any available [[Magic text]] or empty string to clear the variable content)
* prompt at execution time

Variables

2024-02-05T14:53:54Z

Dm114: /* Boolean */

== Introduction ==
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Variables can be used to store values (numbers, text strings and true/false conditions). These values can be set in the Set Variable Action. Variables can be used throughout the app as Triggers and Conditions, and can be used for controlling specific Macrodroid and system settings.
</pre>
''''' An introduction video is available here '''''
https://www.youtube.com/watch?v=0V_EcyhxrpA&t=1s
 

==Global / Local Variables ==

=== Local ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Local variables are specific to an individual macro. You should use a local variable when the value is only required in that individual macro. Local variables are accessed via the edit macro screen.
</pre> 

=== Global ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Global variables are available throughout the application from any Macro. You should use global variables when you need to store a value between more than a single macro. The list of global variables can be accessed via the Variables tile on the home screen. From this screen you can add, delete and change the value of a global variable.
</pre> 

==Standard Variable Types==

=== Boolean ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
allows 2 states: True or False
</pre> 

=== Integer ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison.
</pre> 

=== Decimal ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison. Sientific notation as 1.3E-2 may be used.
</pre> 

=== String ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.

</pre> 

==Data Structure Variable Types==

=== Array ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of values with associated index variables. For example if you wanted to store a count for each day of the month you could create an array called dayOfMonthCount and have a series of entries such as dayOfWeekCount[1] = 5, dayOfWeekCount[2] = 2 etc.
</pre> 

=== Dictionary ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of key value pairs. For example if you wanted to store a count for each day of the week you could create a dictionary called dayOfWeekCount and have a series of entries such as dayOfWeekCount [monday] = 1, dayOfWeekCount [tuesday] = 3 etc.
</pre>

Variables

2024-02-05T14:53:36Z

Dm114: /* Integer */

== Introduction ==
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Variables can be used to store values (numbers, text strings and true/false conditions). These values can be set in the Set Variable Action. Variables can be used throughout the app as Triggers and Conditions, and can be used for controlling specific Macrodroid and system settings.
</pre>
''''' An introduction video is available here '''''
https://www.youtube.com/watch?v=0V_EcyhxrpA&t=1s
 

==Global / Local Variables ==

=== Local ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Local variables are specific to an individual macro. You should use a local variable when the value is only required in that individual macro. Local variables are accessed via the edit macro screen.
</pre> 

=== Global ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Global variables are available throughout the application from any Macro. You should use global variables when you need to store a value between more than a single macro. The list of global variables can be accessed via the Variables tile on the home screen. From this screen you can add, delete and change the value of a global variable.
</pre> 

==Standard Variable Types==

=== Boolean ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type allows 2 states: True or False
</pre> 

=== Integer ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison.
</pre> 

=== Decimal ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison. Sientific notation as 1.3E-2 may be used.
</pre> 

=== String ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.

</pre> 

==Data Structure Variable Types==

=== Array ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of values with associated index variables. For example if you wanted to store a count for each day of the month you could create an array called dayOfMonthCount and have a series of entries such as dayOfWeekCount[1] = 5, dayOfWeekCount[2] = 2 etc.
</pre> 

=== Dictionary ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of key value pairs. For example if you wanted to store a count for each day of the week you could create a dictionary called dayOfWeekCount and have a series of entries such as dayOfWeekCount [monday] = 1, dayOfWeekCount [tuesday] = 3 etc.
</pre>

Variables

2024-02-05T14:53:20Z

Dm114: /* Decimal */

== Introduction ==
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Variables can be used to store values (numbers, text strings and true/false conditions). These values can be set in the Set Variable Action. Variables can be used throughout the app as Triggers and Conditions, and can be used for controlling specific Macrodroid and system settings.
</pre>
''''' An introduction video is available here '''''
https://www.youtube.com/watch?v=0V_EcyhxrpA&t=1s
 

==Global / Local Variables ==

=== Local ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Local variables are specific to an individual macro. You should use a local variable when the value is only required in that individual macro. Local variables are accessed via the edit macro screen.
</pre> 

=== Global ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Global variables are available throughout the application from any Macro. You should use global variables when you need to store a value between more than a single macro. The list of global variables can be accessed via the Variables tile on the home screen. From this screen you can add, delete and change the value of a global variable.
</pre> 

==Standard Variable Types==

=== Boolean ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type allows 2 states: True or False
</pre> 

=== Integer ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison.
</pre> 

=== Decimal ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison. Sientific notation as 1.3E-2 may be used.
</pre> 

=== String ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.

</pre> 

==Data Structure Variable Types==

=== Array ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of values with associated index variables. For example if you wanted to store a count for each day of the month you could create an array called dayOfMonthCount and have a series of entries such as dayOfWeekCount[1] = 5, dayOfWeekCount[2] = 2 etc.
</pre> 

=== Dictionary ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of key value pairs. For example if you wanted to store a count for each day of the week you could create a dictionary called dayOfWeekCount and have a series of entries such as dayOfWeekCount [monday] = 1, dayOfWeekCount [tuesday] = 3 etc.
</pre>

Variables

2024-02-05T14:52:59Z

Dm114: /* String */

== Introduction ==
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Variables can be used to store values (numbers, text strings and true/false conditions). These values can be set in the Set Variable Action. Variables can be used throughout the app as Triggers and Conditions, and can be used for controlling specific Macrodroid and system settings.
</pre>
''''' An introduction video is available here '''''
https://www.youtube.com/watch?v=0V_EcyhxrpA&t=1s
 

==Global / Local Variables ==

=== Local ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Local variables are specific to an individual macro. You should use a local variable when the value is only required in that individual macro. Local variables are accessed via the edit macro screen.
</pre> 

=== Global ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
Global variables are available throughout the application from any Macro. You should use global variables when you need to store a value between more than a single macro. The list of global variables can be accessed via the Variables tile on the home screen. From this screen you can add, delete and change the value of a global variable.
</pre> 

==Standard Variable Types==

=== Boolean ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type allows 2 states: True or False
</pre> 

=== Integer ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison.
</pre> 

=== Decimal ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison. Sientific notation as 1.3E-2 may be used.
</pre> 

=== String ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.

</pre> 

==Data Structure Variable Types==

=== Array ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of values with associated index variables. For example if you wanted to store a count for each day of the month you could create an array called dayOfMonthCount and have a series of entries such as dayOfWeekCount[1] = 5, dayOfWeekCount[2] = 2 etc.
</pre> 

=== Dictionary ===
<pre style="background-color: #ACC8E5; color: #112A46; border-radius: 10px; padding: 10px;">
stores a series of key value pairs. For example if you wanted to store a count for each day of the week you could create a dictionary called dayOfWeekCount and have a series of entries such as dayOfWeekCount [monday] = 1, dayOfWeekCount [tuesday] = 3 etc.
</pre>

Magic text:Wifi/cell signal strength

2023-11-01T16:33:15Z

Dm114: Clarified some minor points

<pre style="background-color: #EEEEEE; color: Black; border-radius: 10px; padding: 10px;">The Wifi/Cell tower signal strength (written as [wifi_strength] and [cell_signal_strength]) can be used for example to determine the strength of the signal between your device and the router/tower (this can vary depending on the thickness of walls, the distance to the router/tower and several other various factors).
The scale of these values can be confusing : they range from -127 to 0 which might not be obvious on how to use.
The better the strength, the
closer you will be to 0 the weaker the strength the closer you will be to -127: if you are standing next to the source, you'd typically be around -35. If you have a weak connection to a cell tower, you'd get around -110 to -115.
-127 means you are not connected to the source you are trying to measure. 2147483647 means the magic text broke for some reason..</pre>
 
'''Example Usage''' 

<pre style="background-color: #AC2424; color: white; border-radius: 10px; padding: 10px;">
Triggers
Regular interval (Interval: 00:00:30)

</pre> 
Actions
IF (compare values([wifi_strength] < -80))
Connect to network (wifi1)
Wifi connected (wifi2)
Connect to network (wifi2)
Wifi connected (wifi1)
End if
 
<pre style="background-color: green; color: white; border-radius: 10px; padding: 10px;">
Constraints
Geofence (Inside area : home)

</pre> 
<pre style="background-color: teal; color: white; border-radius: 10px; padding: 10px;">
Local variables
No variables

</pre>

Constraint: AND / OR / XOR / NOT

2023-05-17T11:19:19Z

Dm114:

This constraint may be used to perform logical operators on any child constraints that are added to this constraint.

To add child constraint(s) tap the constraint in the edit macro screen and select the 'add constraint' option. All child constraints will appear indented directly under this constraint.

When several constraints are used, they are linked by an implicit AND i.e. ALL the constraint conditions have to be TRUE for the [[Actions|action]] to execute.

If you need a more sophisticated logic, you can link the constraints with logical operators:
* '''AND''' (by default)
ALL constraint conditions below this operator have to be TRUE. If no other logical operators are needed, this one is not necessary
* '''OR'''
AT LEAST ONE of the constraint conditions below this operator has to be TRUE
* '''XOR''' (XOR = eXclusive OR)
ONE AND ONLY ONE of the constraint conditions below this operator has to be TRUE
* '''NOT'''
NEGATION of the constraint condition attached i.e. the constraint has NOT to be TRUE for the action to execute.

All these constraints and operators can be nested to get even more sophisticated conditions.

Action: Set Variable

2023-04-04T10:46:48Z

Dm114:

This action allows you to set the value of a specific MacroDroid variable.

As explained in the [[Variables]] section, variables are divided into '''2 categories''' and '''4 types'''. Whatever category or type, their value/content is never reset and remains, even after device reboot. They are identified by a '''name''' given at creation time ''(see below)''

'''Naming:'''

Every variable is identified by its name. This name can be made of any set of character. To facilitate maintainability, the name should relate the content or purpose of the named variable.

'''Category:'''

Every variable can be either '''local''' or '''global'''.
* A '''local variable''' belongs to the macro it has been created into. It can only be used inside this macro. Its name must be unique inside the macro it belongs to
* A '''global variable''' can be accessed and used from any macro. Its name must be unique among all the 'global' variables

'''Type:'''

A variable belongs to 1 of the 4 following types: '''Boolean, Integer, Decimal''' or '''String'''.
*'''Boolean''' type allows 2 states: True or False
*'''Integer''' type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison
*'''Decimal''' type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison
*'''String''' type contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). ''HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.''

'''"Set variable" action''' allows to store a specific value to a given variable. This variable has to be selected among all the available variables or created by selecting the first item of the list called ''[New Variable]''. In this case, you'll be asked what category, name and type have to be assigned to this new variable ''(see above)''.

According to its type ''(see above)'', you can choose a value or method to be assigned to among a list of methods:

'''For Boolean variables:'''
* False or True value
* invert current value
* prompt at execution time
* another boolean variable value

'''For Numeric variables (Integer or Decimal):'''
* fixed value (including any available [[Magic text]])
* random value
* prompt at execution time
* mathematical expression that can include any existing numeric or boolean variable as well as any available numeric [[Magic text]] and some mathematical functions (list and syntax included)

* in addition, Integer type variables have 2 other kinds of settings: adding or subtracting 1 to current value (same as mathematical expression 'my_integer_variable +/- 1' but more convenient when incrementing/decrementing an index by step of 1)

In expressions, booleans have value 1 if true, 0 if false
and beyond usual arithmetic operators (+ - * /) you can use
:- % for modulo
:- ^ for power
:- logical operators (&& for "and", || for "or") where the operands can be booleans or numbers (0 is false, any non-zero is true) and the boolean result is converted to number (there is no "not" operator but there is a not() function shown in the list of available functions)
:- comparisons between numbers (< = != >) where again the boolean result is converted to number

'''For String variables:'''
* fixed value (including concatenated string variables contents as well as any available [[Magic text]] or empty string to clear the variable content)
* prompt at execution time

Action: Set Variable

2023-03-30T02:28:51Z

Dm114:

This action allows you to set the value of a specific MacroDroid variable.

As explained in the [[Variables]] section, variables are divided into '''2 categories''' and '''4 types'''. Whatever category or type, their value/content is never reset and remains, even after device reboot. They are identified by a '''name''' given at creation time ''(see below)''

'''Naming:'''

Every variable is identified by its name. This name can be made of any set of character. To facilitate maintainability, the name should relate the content or purpose of the named variable.

'''Category:'''

Every variable can be either '''local''' or '''global'''.
* A '''local variable''' belongs to the macro it has been created into. It can only be used inside this macro. Its name must be unique inside the macro it belongs to
* A '''global variable''' can be accessed and used from any macro. Its name must be unique among all the 'global' variables

'''Type:'''

A variable belongs to 1 of the 4 following types: '''Boolean, Integer, Decimal''' or '''String'''.
*'''Boolean''' type allows 2 states: True or False
*'''Integer''' type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison
*'''Decimal''' type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison
*'''String''' type contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). ''HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.''

'''"Set variable" action''' allows to store a specific value to a given variable. This variable has to be selected among all the available variables or created by selecting the first item of the list called ''[New Variable]''. In this case, you'll be asked what category, name and type have to be assigned to this new variable ''(see above)''.

According to its type ''(see above)'', you can choose a value or method to be assigned to among a list of methods:

'''For Boolean variables:'''
* False or True value
* invert current value
* prompt at execution time
* another boolean variable value

'''For Numeric variables (Integer or Decimal):'''
* fixed value
* random value
* prompt at execution time
* mathematical expression that can include any existing numeric or boolean variable as well as any available numeric [[Magic text]] and some mathematical functions (list and syntax included)

* in addition, Integer type variables have 2 other kinds of settings: adding or subtracting 1 to current value (same as mathematical expression 'my_integer_variable +/- 1' but more convenient when incrementing/decrementing an index by step of 1)

In expressions, booleans have value 1 if true, 0 if false
and beyond usual arithmetic operators (+ - * /) you can use
:- % for modulo
:- ^ for power
:- logical operators (&& for "and", || for "or") where the operands can be booleans or numbers (0 is false, any non-zero is true) and the boolean result is converted to number (there is no "not" operator but there is a not() function shown in the list of available functions)
:- comparisons between numbers (< = != >) where again the boolean result is converted to number

'''For String variables:'''
* fixed value (including concatenated string variables contents as well as any available [[Magic text]] or empty string to clear the variable content)
* prompt at execution time

Action: Set Variable

2023-03-30T02:26:49Z

Dm114:

This action allows you to set the value of a specific MacroDroid variable.

As explained in the [[Variables]] section, variables are divided into '''2 categories''' and '''4 types'''. Whatever category or type, their value/content is never reset and remains, even after device reboot. They are identified by a '''name''' given at creation time ''(see below)''

'''Naming:'''

Every variable is identified by its name. This name can be made of any set of character. To facilitate maintainability, the name should relate the content or purpose of the named variable.

'''Category:'''

Every variable can be either '''local''' or '''global'''.
* A '''local variable''' belongs to the macro it has been created into. It can only be used inside this macro. Its name must be unique inside the macro it belongs to
* A '''global variable''' can be accessed and used from any macro. Its name must be unique among all the 'global' variables

'''Type:'''

A variable belongs to 1 of the 4 following types: '''Boolean, Integer, Decimal''' or '''String'''.
*'''Boolean''' type allows 2 states: True or False
*'''Integer''' type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison
*'''Decimal''' type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison
*'''String''' type contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). ''HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.''

'''"Set variable" action''' allows to store a specific value to a given variable. This variable has to be selected among all the available variables or created by selecting the first item of the list called ''[New Variable]''. In this case, you'll be asked what category, name and type have to be assigned to this new variable ''(see above)''.

According to its type ''(see above)'', you can choose a value or method to be assigned to among a list of methods:

'''For Boolean variables:'''
* False or True value
* invert current value
* prompt at execution time
* another boolean variable value

'''For Numeric variables (Integer or Decimal):'''
* fixed value
* random value
* prompt at execution time
* mathematical expression that can include any existing numeric or boolean variable as well as any available numeric [[Magic text]] and some mathematical functions (list and syntax included)

* in addition, Integer type variables have 2 other kinds of settings: adding or subtracting 1 to current value (same as mathematical expression 'my_integer_variable +/- 1' but more convenient when incrementing/decrementing an index by step of 1)

In expressions, booleans have value 1 if true, 0 if false
and beyond usual arithmetic operators (+ - * /) you can use
:- % for modulo
:- ^ for power
:- logical operators (&& for "and", || for "or") where the operands can be booleans or numbers (0 is false, any non-zero is true) and the boolean result is converted to number (there is no "not" operator but there is a not() function shown in the list of available functions)
:- comparisons between numbers (<= < == != > >=) where again the boolean result is converted to number

'''For String variables:'''
* fixed value (including concatenated string variables contents as well as any available [[Magic text]] or empty string to clear the variable content)
* prompt at execution time

Action Blocks

2023-03-29T20:23:56Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.
{|border="1" cellpadding="2"
|+Schematic way variables interact between Macros and Action blocks
!width="10"|Step #
!width="150"|Where from
!width="150"|Kind of variable
!width="400"|When
|-
|1
|Macro
|rowspan="2"|Local Input
|rowspan="2"|Call configuration time
|-
|rowspan="3"|2
|rowspan="3"|Action block
|-
|Input Working Output
|Action block process
|-
|rowspan="2"|Output Local
|rowspan="2"|Call configuration time
|-
|3
|Macro
|}

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|No
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T19:10:28Z

Dm114: /* Kinds of variables used */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.
{|border="1" cellpadding="2"
|+Schematic way variables interact between Macros and Action blocks
!width="10"|Step #
!width="150"|Where from
!width="150"|Kind of variable
!width="400"|When
|-
|1
|Macro
|rowspan="2"|Local Input
|rowspan="2"|Call configuration time
|-
|rowspan="3"|2
|rowspan="3"|Action block
|-
|Input Working Output
|Action block process
|-
|rowspan="2"|Output Local
|rowspan="2"|Call configuration time
|-
|3
|Macro
|}

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T19:00:41Z

Dm114: /* Kinds of variables used */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

Schematic way variables interact between Macros and Action blocks:
{|border="1" cellpadding="2"
!width="10"|Step #
!width="100"|Where from
!width="100"|Kind of variable
!width="300"|When
|-
|1
|Macro
|Local
|rowspan="2"|Call configuration time
|-
|rowspan="3"|2
|rowspan="3"|Action block
|Input
|-
|Input Working Output
|Action block process
|-
|Output
|rowspan="2"|Call configuration time
|-
|3
|Macro
|Local
|}

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T18:53:37Z

Dm114: /* Kinds of variables used */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

{|border="1" cellpadding="2"
|+Schematic way variables interact between Macros and Action blocks
!width="10"|Step #
!width="100"|Where from
!width="100"|Kind of variable
!width="300"|When
|-
|1
|Macro
|Local
|rowspan="2"|Call configuration time
|-
|rowspan="3"|2
|rowspan="3"|Action block
|Input
|-
|Input Working Output
|Action block process
|-
|Output
|rowspan="2"|Call configuration time
|-
|3
|Macro
|Local
|}

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T13:15:26Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T13:14:51Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action Blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can create, read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T13:07:44Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="500"|Capabilities
!width="80"|Macros
!width="80"|Action Blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:39:32Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="300"|Capabilities
!width="80"|Macros
!width="80"|Action Blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component
|Yes
|No
|-
|Triggers can be constrained individually
|Yes
|N/A
|-
|Has an action set component
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"
|Yes
|Yes
|-
|Actions can be grouped into condition sets
|Yes
|Yes
|-
|Actions can be constrained individually
|Yes
|Yes
|-
|Has a constraint set component applied to all actions
|Yes
|No
|-
|Can create, read & update global variables
|Yes
|Yes
|-
|Can read & update calling macro's local variables
|N/A
|No
|-
|Can include Input variables
|No
|Yes
|-
|Can include Working variables
|No
|Yes
|-
|Can include Output variables
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:37:22Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, Action blocks are functions.
Below is a table that better describes the main differences.

{| border="1" cellpadding="2"
!width="300"|Capabilities
!width="80"|Macros
!width="80"|Action Blocks
|-
|Has a disabling switch
|Yes
|No
|-
|Can be categorized
|Yes
|No
|-
|Has a trigger component?
|Yes
|No
|-
|Triggers can be constrained individually?
|Yes
|N/A
|-
|Has an action set component?
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"?
|Yes
|Yes
|-
|Actions can be grouped into condition sets?
|Yes
|Yes
|-
|Actions can be constrained individually?
|Yes
|Yes
|-
|Has a constraint set component to apply to all actions?
|Yes
|No
|-
|Can create, read & update global variables?
|Yes
|Yes
|-
|Can read & update calling macro's local variables?
|N/A
|No
|-
|Can include Input variables?
|No
|Yes
|-
|Can include Working variables?
|No
|Yes
|-
|Can include Output variables?
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:31:09Z

Dm114: /* Differences between an action block and a macro? */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, action blocks are functions.
But below is a table that better describes the differences.

{| border="1" cellpadding="2"
!width="200"|
!width="100"|A Macro
!width="150"|An Action Block
|-
|Has a disabling switch?
|Yes
|No
|-
|Can be categorized?
|Yes
|No
|-
|Has a trigger component?
|Yes
|No
|-
|Triggers can be constrained individually?
|Yes
|Triggers not available
|-
|Has an action set component?
|Yes
|Yes
|-
|Actions can include “Wait For Trigger"?
|Yes
|Yes
|-
|Actions can be grouped into condition sets?
|Yes
|Yes
|-
|Actions can be constrained individually?
|Yes
|Yes
|-
|Has a constraint set component to apply to all actions?
|Yes
|No
|-
|Can create, read & update global variables?
|Yes
|Yes
|-
|Can read & update calling macro's local variables?
|N/A
|No
|-
|Can include Input variables?
|No
|Yes
|-
|Can include Working variables?
|No
|Yes
|-
|Can include Output variables?
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:22:16Z

Dm114: /* Kinds of variables used */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Action blocks work with their own set of variables (plus Global ones if necessary) whose values can be passed from/to the calling macro.

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, action blocks are functions.
But below is a table that better describes the differences.

{| border="1" cellpadding="2"
!width="200"|
!width="100"|A Macro
!width="150"|An Action Block
|-
|Has a disabling switch?
|Yes
|No
|-
|Can be categorized?
|Yes
|No
|-
|Has a trigger component?
|Yes
|No
|-
|Triggers can be constrained individually?
|Yes
|Triggers not available
|-
|Has an action set component?
|Yes
|Yes
|-
|Actions can include “Wait For Trigger?”
|Yes
|Yes
|-
|Actions can be grouped into condition sets?
|Yes
|Yes
|-
|Actions can be constrained individually?
|Yes
|Yes
|-
|Has a constraint set component to apply to all actions?
|Yes
|No
|-
|Can read & edit global variables?
|Yes
|Yes
|-
|Can include local variables?
|Yes
|No
|-
|Can include input variables?
|No
|Yes
|-
|Can include those new “working variables?”
|No
|Yes
|-
|Can include output variables?
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:19:24Z

Dm114: /* Kinds of variables used */

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

Working variables are used to make all kinds of calculations/comparisons inside the action block, like any variable according to its type. The only difference with Input and Output ones is that they do not appear in the variables list when configuring the call, as they are not useful to the calling macro.

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, action blocks are functions.
But below is a table that better describes the differences.

{| border="1" cellpadding="2"
!width="200"|
!width="100"|A Macro
!width="150"|An Action Block
|-
|Has a disabling switch?
|Yes
|No
|-
|Can be categorized?
|Yes
|No
|-
|Has a trigger component?
|Yes
|No
|-
|Triggers can be constrained individually?
|Yes
|Triggers not available
|-
|Has an action set component?
|Yes
|Yes
|-
|Actions can include “Wait For Trigger?”
|Yes
|Yes
|-
|Actions can be grouped into condition sets?
|Yes
|Yes
|-
|Actions can be constrained individually?
|Yes
|Yes
|-
|Has a constraint set component to apply to all actions?
|Yes
|No
|-
|Can read & edit global variables?
|Yes
|Yes
|-
|Can include local variables?
|Yes
|No
|-
|Can include input variables?
|No
|Yes
|-
|Can include those new “working variables?”
|No
|Yes
|-
|Can include output variables?
|No
|Yes
|-
|}

Action Blocks

2023-03-06T12:11:20Z

Dm114: /* Kinds of variables used */Added content

== Introduction ==

Action blocks allow you to group related actions together that can then be called from elsewhere as a single action (the "Action Block" action).

The action blocks feature can be accessed from the "Action Blocks" home screen tile. Pressing this will take you to a list of currently defined action blocks (or an empty list if you haven't defined any yet). From this list you can press the + button to add a new action block.

Each action block must be given a unique name and contain at least one action. A description is optional and you can also specify input and/or output parameters if you desire.

== When to Use ==

The main reason to use action blocks is to minimize duplicated blocks of actions throughout your macros.

In some cases you may have common repeated functionality spread throughout multiple macros, for example you may set the brightness low and volume to zero at night time (using day/time trigger) in one macro. You may also wish to do the same elsewhere in another macro (for example using a location trigger when you are at the cinema). By grouping these actions into an action block you can call just a single action to invoke the action block. If you later decide to tweak these settings then you can just update the action block and avoid updating the settings in multiple places.

== Kinds of variables used ==

Three kinds of variables can be used inside an action block: Input, Output and Working ones. Each one can be of any type (boolean, integer, decimal, string, array/dictionary).

All these variables are implicitly local and their lifetime is limited to action block execution. Their default values (see below) will be restored at the end of the execution so it is not possible to retreive previous values from a previous run (except when using Global variables).

== Input and Output Parameters ==

For more advanced use cases, action blocks allow you the option to pass in input parameters and return output parameters. In this way an action block may be used in a similar way to a function in computer programming.

For example suppose you wanted to convert from Celsius to Fahrenheit from within multiple macros. You could create an action block to do this that will take in an input parameter in Celsius and return an output parameter in Fahrenheit. The input parameters are available as local variables anywhere it makes sense to read a value. For example you can access the local variable in a pop up message, or in an expression when setting another variable value. The output variables are available as local variables anywhere it makes sense to set the value. For example in the set variable action you can assign to any output parameter.

Each input parameter will specify a default value and this value will be set in the case where you run a local test or if you do not specify an input value when calling the action block from a macro. Likewise all output parameters define a default value. In the case that the action block doesn't set an explicit value on an output parameter, it's default value will be returned.

When calling the action block you can specify what values will be passed in as input parameters and assign variables (either local or global) to capture the returned output parameters. You can also ignore any or all return parameters if you desire.

== Differences between an action block and a macro?==
A quick explanation might be: Macros are programs, action blocks are functions.
But below is a table that better describes the differences.

{| border="1" cellpadding="2"
!width="200"|
!width="100"|A Macro
!width="150"|An Action Block
|-
|Has a disabling switch?
|Yes
|No
|-
|Can be categorized?
|Yes
|No
|-
|Has a trigger component?
|Yes
|No
|-
|Triggers can be constrained individually?
|Yes
|Triggers not available
|-
|Has an action set component?
|Yes
|Yes
|-
|Actions can include “Wait For Trigger?”
|Yes
|Yes
|-
|Actions can be grouped into condition sets?
|Yes
|Yes
|-
|Actions can be constrained individually?
|Yes
|Yes
|-
|Has a constraint set component to apply to all actions?
|Yes
|No
|-
|Can read & edit global variables?
|Yes
|Yes
|-
|Can include local variables?
|Yes
|No
|-
|Can include input variables?
|No
|Yes
|-
|Can include those new “working variables?”
|No
|Yes
|-
|Can include output variables?
|No
|Yes
|-
|}

Action: Text Manipulation

2022-04-05T12:43:21Z

Dm114:

This action can be used to perform basic string manipulation on a text string. 
 '''Note''' 
The replace text and extract text functions support the use of regex. 
 '''Substring''' 
Returns a sub-section of the text defined by the supplied start and end indexes. The first character starts at index 0 and the last index is excluded. (To get the first character use values 0 and 1.)
 '''Example Usage''' 
"hello i am using macrodroid app" 
To obtain the word Macrodroid we will use the initial position 17 and last position 27 and as a result we will have the value "Macrodroid". 
 '''Replace all''' 
Uses a regular expression to replace matching text with the supplied new text. 
'''Example Usage''' 
Source text = Hello, how are you?.
 
the text to replace is "hello". 
the new text is "hi" 
The end result will be, "hi, how are you?".

 '''Extract text''' 
Uses a regular expression to match and extract a section from the text.
 '''Example Usage''' 
My phone number is 1234567890 
Extract the expression "[0-9]".
This will give a final result of the extraction of the phone number.
 
 '''Upper case''' 
Converts the text to all upper case characters. 
'''Example Usage''' 
Source text 
"Macrodroid is my app to automate my device". 
Final result
"MACRODROID IS MY APP TO AUTOMATE MY DEVICE". 
 '''Lower case''' 
Converts the text to all lower case characters. 
'''Example Usage''' 
Source text 
"MACRODROID IS MY APP TO AUTOMATE MY DEVICE". 
Final result 
"macrodroid is my app to automate my device". 
 '''Trim whitespace''' 
Removes any leading/trailing whitespace from the text.

Constraint: MacroDroid Variable

2022-01-03T12:40:48Z

Dm114:

This constraint can be used to allow a trigger to fire only when a MacroDroid variable is set to a particular value.

The rules for such a constraint to be TRUE are the same as for 'If clause' [[Actions|action]].

Constraint: MacroDroid Variable

2022-01-03T12:39:26Z

Dm114:

This constraint can be used to allow a trigger to fire only when a MacroDroid variable is set to a particular value.

The rules for such a constraint to be TRUE are the same as for [[Actions|action]] If clause action.

Constraint: MacroDroid Variable

2022-01-03T12:12:31Z

Dm114:

Constraint: MacroDroid Variable

2022-01-03T12:05:33Z

Dm114: Added info about rules

This constraint can be used to allow a trigger to fire only when a MacroDroid variable is set to a particular value.

The rules for such a constraint to be TRUE are the same as for [url=https://macrodroidforum.com/wiki/index.php/Action:_If_clause] If clause[/url] action.

Action: Set Variable

2021-09-19T15:01:58Z

Dm114:

This action allows you to set the value of a specific MacroDroid variable.

As explained in the [[Variables]] section, variables are divided into '''2 categories''' and '''4 types'''. Whatever category or type, their value/content is never reset and remains, even after device reboot. They are identified by a '''name''' given at creation time ''(see below)''

'''Naming:'''

Every variable is identified by its name. This name can be made of any set of character. To facilitate maintainability, the name should relate the content or purpose of the named variable.

'''Category:'''

Every variable can be either '''local''' or '''global'''.
* A '''local variable''' belongs to the macro it has been created into. It can only be used inside this macro. Its name must be unique inside the macro it belongs to
* A '''global variable''' can be accessed and used from any macro. Its name must be unique among all the 'global' variables

'''Type:'''

A variable belongs to 1 of the 4 following types: '''Boolean, Integer, Decimal''' or '''String'''.
*'''Boolean''' type allows 2 states: True or False
*'''Integer''' type is to store positive or negative numbers without decimal part, in order to make any kind of mathematical calculations or comparison
*'''Decimal''' type is to store any positive or negative numeric value, with or without decimal digits, in order to make any kind of mathematical calculations or comparison
*'''String''' type contains any kind of character (alphanumeric ones or any special ones, such as line feed/carriage return/new line or emojis). ''HINT: an individual string variable can hold up to 500,000 characters, however it is advisable to avoid very long strings where possible. If you should use strings of great length it is recommended to clear them when finished with.''

'''"Set variable" action''' allows to store a specific value to a given variable. This variable has to be selected among all the available variables or created by selecting the first item of the list called ''[New Variable]''. In this case, you'll be asked what category, name and type have to be assigned to this new variable ''(see above)''.

According to its type ''(see above)'', you can choose a value or method to be assigned to among a list of methods:

'''For Boolean variables:'''
* False or True value
* invert current value
* prompt at execution time
* another boolean variable value

'''For Numeric variables (Integer or Decimal):'''
* fixed value
* random value
* prompt at execution time
* mathematical expression that can include any existing numeric or boolean variable as well as any available numeric [[Magic text]] and some mathematical functions (list and syntax included)
* in addition, Integer type variables have 2 other kinds of settings: adding or subtracting 1 to current value (same as mathematical expression 'my_integer_variable +/- 1' but more convenient when incrementing/decrementing an index by step of 1)

'''For String variables:'''
* fixed value (including concatenated string variables contents as well as any available [[Magic text]] or empty string to clear the variable content)
* prompt at execution time

Constraint: AND / OR / XOR / NOT

2021-07-30T11:03:05Z

Dm114:

This constraint may be used to perform logical operators on any child constraints that are added to this constraint.

To add child constraint(s) tap the constraint in the edit macro screen and select the 'add constraint' option. All child constraints will appear indented directly under this constraint.

When several constraints are used, they are linked by an implicit AND i.e. ALL the constraint conditions have to be TRUE for the [[Actions|action]] to execute.

If you need a more sophisticated logic, you can link the constraints with logical operators:
* '''AND''' (by default)
All constraint conditions below this operator have to be TRUE. If no other logical operators are needed, this one is not necessary
* '''OR'''
AT LEAST ONE of the constraint conditions below this operator has to be TRUE
* '''XOR''' (XOR = eXclusive OR)
ONE AND ONLY ONE of the constraint conditions below this operator has to be TRUE
* '''NOT'''
NEGATION of the constraint condition attached i.e. the constraint has NOT to be TRUE for the action to execute.

All these constraints and operators can be nested to get even more sophisticated conditions.

Constraint: AND / OR / XOR / NOT

2021-07-21T23:32:21Z

Dm114:

This constraint may be used to perform logical operators on any child constraints that are added to this constraint.

To add child constraint(s) tap the constraint in the edit macro screen and select the 'add constraint' option. All child constraints will appear indented directly under this constraint.

When several constraints are used, they are linked by an implicit AND i.e. ALL the constraint conditions have to be TRUE for the action to execute (see [[Actions]]).

If you need a more sophisticated logic, you can link the constraints with logical operators:
* '''AND''' (by default)
All constraint conditions below this operator have to be TRUE. If no other logical operators are needed, this one is not necessary
* '''OR'''
AT LEAST ONE of the constraint conditions below this operator has to be TRUE
* '''XOR''' (XOR = eXclusive OR)
ONE AND ONLY ONE of the constraint conditions below this operator has to be TRUE
* '''NOT'''
NEGATION of the constraint condition attached i.e. the constraint has NOT to be TRUE for the action to execute.

All these constraints and operators can be nested to get even more sophisticated conditions.

Constraint: AND / OR / XOR / NOT

2021-07-19T13:25:28Z

Dm114:

This constraint may be used to perform logical operators on any child constraints that are added to this constraint.

To add child constraint(s) tap the constraint in the edit macro screen and select the 'add constraint' option. All child constraints will appear indented directly under this constraint.

When several constraints are used, they are linked by an implicit AND i.e. ALL the constraint conditions have to be TRUE for the action to execute (see [[Actions]]).

If you need a more sophisticated logic, you can link the constraints with logical operators:
* '''AND''' (by default)
All constraint conditions below this operator have to be TRUE
* '''OR'''
AT LEAST ONE of the constraint conditions below this operator has to be TRUE
* '''XOR''' (XOR = eXclusive OR)
ONE AND ONLY ONE of the constraint conditions below this operator has to be TRUE
* '''NOT'''
NEGATION of the constraint condition attached i.e. the constraint has NOT to be TRUE for the action to execute.

All these constraints and operators can be nested to get even more sophisticated conditions.

Constraint: AND / OR / XOR / NOT

2021-07-19T13:05:52Z

Dm114:

Constraint: AND / OR / XOR / NOT

2021-07-19T12:53:17Z

Dm114:

Constraint: AND / OR / XOR / NOT

2021-07-19T12:47:47Z

Dm114:

Constraint: AND / OR / XOR / NOT

2021-07-19T12:38:50Z

Dm114: Created page with "This constraint may be used to perform logical operators on any child constraints that are added to this constraint. To add child constraint(s) tap the constraint in the edit..."

Constraints

2021-07-19T12:38:23Z

Dm114: /* List of Constraints */

Constraints are optional and can be used to allow or prevent a macro/action from running based on certain conditions.

Constraints can be placed on macros to allow or prevent the entire macro firing based on the set condition(s). You can also add constraints directly to individual triggers and actions from the 'Edit Macro' screen, by clicking on the trigger/action and selecting "Add constraint"

A constraint is evaluated at the point a trigger fires or action runs and a macro/action will only run if the constraint condition is true.

By default if adding more than one constraint to a macro they will be combined with an AND condition (e.g. all added constraints must be true). This can be changed in the dropdown in the constraints title to an OR condition. In this case only one of the added constraints needs to be true for the macro to run.

Nesting constraints

If you need more sophisticated logic applied to constraint there is a special AND/OR/XOR/NOT constraint that can be used. Any constraints nested under the logic constraint will have that logic operator applied. It's also possible to nest multiple logic constraints to create complex logic. For example:

AND
| - Constraint 1
| - OR
| - Constraint 2
| - Constraint 3

In the above example, Constraint 1 must always be true '''AND''' at least one of (Constraint 2 '''OR''' Constraint 3) must be true.

== List of Constraints ==

[[Constraint: Airplane Mode|Airplane Mode]]

[[Constraint: AND / OR / XOR / NOT|AND / OR / XOR / NOT]]

[[Constraint: Application Running|Application Running]]

[[Constraint: Auto Rotate|Auto Rotate]]

[[Constraint: Auto Sync|Auto Sync]]

[[Constraint: Battery Level|Battery Level]]

[[Constraint: Battery Saver State|Battery Saver State]]

[[Constraint: Battery Temperature|Battery Temperature]]

[[Constraint: Bluetooth State|Bluetooth State]]

[[Constraint: Brightness|Brightness]]

[[Constraint: Calendar Entry|Calendar Entry]]

[[Constraint: Call State|Call State]]

[[Constraint: Cell Towers|Cell Towers]]

[[Constraint: Dark Mode|Dark Mode]]

[[Constraint: Day of the Month|Day of the Month]]

[[Constraint: Day of the Week|Day of the Week]]

[[Constraint: Device Facing|Device Facing]]

[[Constraint: Device Locked/Unlocked|Device Locked/Unlocked]]

[[Constraint: Device Orientation|Device Orientation]]

[[Constraint: Geofence|Geofence (Location)]]

[[Constraint: GPS State|GPS State]]

[[Constraint: Headphone Connection|Headphone Connection]]

[[Constraint: Is Roaming|Is Roaming]]

[[Constraint: Light Sensor|Light Sensor]]

[[Constraint: Location Mode|Location Mode]]

[[Constraint: Macro(s) Enabled/Disabled|Macro(s) Enabled/Disabled]]

[[Constraint: Macro(s) Invoked/Not invoked Recently|Macro(s) Invoked/Not invoked Recently]]

[[Constraint: MacroDroid Mode|MacroDroid Mode]]

[[Constraint: MacroDroid Variable|MacroDroid Variable]]

[[Constraint: Mobile Data On/Off|Mobile Data On/Off]]

[[Constraint: Mobile Service Status|Mobile Service Status]]

[[Constraint: Month of the Year|Month of the Year]]

[[Constraint: Music Active|Music Active]]

[[Constraint: NFC State|NFC State]]

[[Constraint: Notification Present|Notification Present]]

[[Constraint: Notification Volume|Notification Volume]]

[[Constraint: Phone Ringing|Phone Ringing]]

[[Constraint: Power Connected|Power Connected]]

[[Constraint: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]

[[Constraint: Proximity Sensor|Proximity Sensor]]

[[Constraint: Ringer Volume|Ringer Volume]]

[[Constraint: Roaming Enabled|Roaming Enabled]]

[[Constraint: Rooted Device|Rooted Device]]

[[Constraint: Screen On/Off|Screen On/Off]]

[[Constraint: Speakerphone On/Off|Speakerphone On/Off]]

[[Constraint: Stopwatch|Stopwatch]]

[[Constraint: Sunrise/Sunset|Sunrise/Sunset]]

[[Constraint: Time of Day|Time of Day]]

[[Constraint: Time Since Boot|Time Since Boot]]

[[Constraint: Torch On/Off|Torch On/Off]]

[[Constraint: Trigger Fired|Trigger Fired]]

[[Constraint: Volume Level|Volume Level]]

[[Constraint: VPN State|VPN State]]

[[Constraint: Wifi HotSpot State|Wifi HotSpot State]]

[[Constraint: Wifi State|Wifi State]]

Constraint: AND / OR / NOT

2021-07-19T12:37:50Z

Dm114: Replaced by AND/OR/XOR/NOT page

Constraints

2021-07-19T11:09:49Z

Dm114: /* List of Constraints */

Constraints are optional and can be used to allow or prevent a macro/action from running based on certain conditions.

Constraints can be placed on macros to allow or prevent the entire macro firing based on the set condition(s). You can also add constraints directly to individual triggers and actions from the 'Edit Macro' screen, by clicking on the trigger/action and selecting "Add constraint"

A constraint is evaluated at the point a trigger fires or action runs and a macro/action will only run if the constraint condition is true.

By default if adding more than one constraint to a macro they will be combined with an AND condition (e.g. all added constraints must be true). This can be changed in the dropdown in the constraints title to an OR condition. In this case only one of the added constraints needs to be true for the macro to run.

Nesting constraints

If you need more sophisticated logic applied to constraint there is a special AND/OR/XOR/NOT constraint that can be used. Any constraints nested under the logic constraint will have that logic operator applied. It's also possible to nest multiple logic constraints to create complex logic. For example:

AND
| - Constraint 1
| - OR
| - Constraint 2
| - Constraint 3

In the above example, Constraint 1 must always be true '''AND''' at least one of (Constraint 2 '''OR''' Constraint 3) must be true.

== List of Constraints ==

[[Constraint: Airplane Mode|Airplane Mode]]

[[Constraint: AND / OR / NOT|AND / OR / XOR / NOT]]

[[Constraint: Application Running|Application Running]]

[[Constraint: Auto Rotate|Auto Rotate]]

[[Constraint: Auto Sync|Auto Sync]]

[[Constraint: Battery Level|Battery Level]]

[[Constraint: Battery Saver State|Battery Saver State]]

[[Constraint: Battery Temperature|Battery Temperature]]

[[Constraint: Bluetooth State|Bluetooth State]]

[[Constraint: Brightness|Brightness]]

[[Constraint: Calendar Entry|Calendar Entry]]

[[Constraint: Call State|Call State]]

[[Constraint: Cell Towers|Cell Towers]]

[[Constraint: Dark Mode|Dark Mode]]

[[Constraint: Day of the Month|Day of the Month]]

[[Constraint: Day of the Week|Day of the Week]]

[[Constraint: Device Facing|Device Facing]]

[[Constraint: Device Locked/Unlocked|Device Locked/Unlocked]]

[[Constraint: Device Orientation|Device Orientation]]

[[Constraint: Geofence|Geofence (Location)]]

[[Constraint: GPS State|GPS State]]

[[Constraint: Headphone Connection|Headphone Connection]]

[[Constraint: Is Roaming|Is Roaming]]

[[Constraint: Light Sensor|Light Sensor]]

[[Constraint: Location Mode|Location Mode]]

[[Constraint: Macro(s) Enabled/Disabled|Macro(s) Enabled/Disabled]]

[[Constraint: Macro(s) Invoked/Not invoked Recently|Macro(s) Invoked/Not invoked Recently]]

[[Constraint: MacroDroid Mode|MacroDroid Mode]]

[[Constraint: MacroDroid Variable|MacroDroid Variable]]

[[Constraint: Mobile Data On/Off|Mobile Data On/Off]]

[[Constraint: Mobile Service Status|Mobile Service Status]]

[[Constraint: Month of the Year|Month of the Year]]

[[Constraint: Music Active|Music Active]]

[[Constraint: NFC State|NFC State]]

[[Constraint: Notification Present|Notification Present]]

[[Constraint: Notification Volume|Notification Volume]]

[[Constraint: Phone Ringing|Phone Ringing]]

[[Constraint: Power Connected|Power Connected]]

[[Constraint: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]

[[Constraint: Proximity Sensor|Proximity Sensor]]

[[Constraint: Ringer Volume|Ringer Volume]]

[[Constraint: Roaming Enabled|Roaming Enabled]]

[[Constraint: Rooted Device|Rooted Device]]

[[Constraint: Screen On/Off|Screen On/Off]]

[[Constraint: Speakerphone On/Off|Speakerphone On/Off]]

[[Constraint: Stopwatch|Stopwatch]]

[[Constraint: Sunrise/Sunset|Sunrise/Sunset]]

[[Constraint: Time of Day|Time of Day]]

[[Constraint: Time Since Boot|Time Since Boot]]

[[Constraint: Torch On/Off|Torch On/Off]]

[[Constraint: Trigger Fired|Trigger Fired]]

[[Constraint: Volume Level|Volume Level]]

[[Constraint: VPN State|VPN State]]

[[Constraint: Wifi HotSpot State|Wifi HotSpot State]]

[[Constraint: Wifi State|Wifi State]]

Constraints

2021-07-19T11:08:41Z

Dm114: /* List of Constraints */Adding XOR constraint

Action: If clause

2021-06-28T15:20:37Z

Dm114:

This action allows to execute a set of subsequent actions according to specific condition(s).

The possible conditions are the same as constraints (see [[Constraints]]) and are tested in exactly the same way, with logical connectors 'AND' (default one) or 'OR' in case of multiple conditions.

When the condition depends on the content of string variable, there are 4 ways to test it:
* '''=''' (equal sign) means that the '''whole content''' of the string variable has to be equal to the whole set of typed characters
* '''!=''' means that the content of the string variable has to be unequal (i.e. different) to the set of typed characters
* '''Contains''' means that the content of the string variable has to contain the whole set of typed character. For instance, enter the word ''information'' to match with a string variable containing the text: ''Here are the '''information'''s you asked for...''
* '''Excludes''' means that the content of the string variable has not to contain the typed text

The wildcards '*' and '?' have the following meaning:
* '''*''' stands for any number of character (from 0 to any, same as '.*' in Regex)
* '''?''' is for 1 and only 1 mandatory character (same as '.{1}' in Regex).

Tick the box '''Enter regular expression matching''' if the typed text follows Regex syntax, far more powerful than plain text with or without wildcards (for advanced users).

Action: If clause

2021-06-28T14:43:20Z

Dm114: Created page with "This action allows to execute a set of subsequent actions according to specific condition(s). The possible conditions are the same as constraints (see Constraints: List of..."

This action allows to execute a set of subsequent actions according to specific condition(s).

The possible conditions are the same as constraints (see [[Constraints: List of Constraints|List of Constraints]]) and are tested in exactly the same way, with logical connectors 'AND' (default one) or 'OR' in case of multiple conditions.

When the condition depends on the content of string variable, there are 4 ways to test it:
* '''=''' (equal sign) means that the '''whole content''' of the string variable has to be equal to the whole set of typed characters
* '''!=''' means that the content of the string variable has to be unequal (i.e. different) to the set of typed characters
* '''Contains''' means that the content of the string variable has to contain the whole set of typed character. For instance, enter the word ''information'' to match with a string variable containing the text: ''Here are the '''information'''s you asked for...''
* '''Excludes''' means that the content of the string variable has not to contain the typed text

The wildcards '*' and '?' have the following meaning:
* '''*''' stands for any number of character (from 0 to any, same as '.*' in Regex)
* '''?''' is for 1 and only 1 mandatory character (same as '.{1}' in Regex).

Tick the box '''Enter regular expression matching''' if the typed text follows Regex syntax, far more powerful than plain text with or without wildcards (for advanced users).

Actions

2021-06-28T13:48:42Z

Dm114: /* List of Actions */Added 'if clause' action

An action is something your device can do when a macro runs. A macro must have at least one action to be valid.

== List of Actions ==

[[Action: Airplane Mode On/Off|Airplane Mode On/Off]]

[[Action: Alarm Clock|Alarm Clock]]

[[Action: Ambient Display|Ambient Display]]

[[Action: Android Shortcut|Android Shortcut]]

[[Action: Android Wear|Android Wear]]

[[Action: Answer Call|Answer Call]]

[[Action: Autosync On/Off|Autosync On/Off]]

[[Action: Battery Saver|Battery Saver]]

[[Action: Bluetooth Configure|Bluetooth Configure]]

[[Action: Bluetooth Tethering|Bluetooth Tethering]]

[[Action: Brightness|Brightness]]

[[Action: Calendar - Add Event|Calendar - Add Event]]

[[Action: Call Reject|Call Reject]]

[[Action: Camera Enable/Disable|Camera Enable/Disable]]

[[Action: Cancel Macro Actions|Cancel Macro Actions]]

[[Action: Car Mode|Car Mode]]

[[Action: Clear App Data|Clear App Data]]

[[Action: Clear Call Log|Clear Call Log]]

[[Action: Clear Log|Clear Log]]

[[Action: Clear Notifications|Clear Notifications]]

[[Action: Configure App Notifications|Configure App Notifications]]

[[Action: Confirm Next|Confirm Next]]

[[Action: Connectivity Check|Connectivity Check]]

[[Action: Contact Via App|Contact Via App]]

[[Action: Control Media|Control Media]]

[[Action: Dark Theme|Dark Theme]]

[[Action: Daydream/Screensaver On|Daydream/Screensaver On]]

[[Action: Delete Macro|Delete Macro]]

[[Action: Demo Mode|Demo Mode]]

[[Action: Dim Screen|Dim Screen]]

[[Action: Disable MacroDroid|Disable MacroDroid]]

[[Action: Display Dialog|Display Dialog]]

[[Action: Display Notification|Display Notification]]

[[Action: Empty Action|Empty Action]]

[[Action: Enable/Disable Category|Enable/Disable Category]]

[[Action: Enable/Disable Macro|Enable/Disable Macro]]

[[Action: Expand/Collapse Status Bar|Expand/Collapse Status Bar]]

[[Action: Export Macros|Export Macros]]

[[Action: File Operations V2|File Operations V2]]

[[Action: Fill Clipboard|Fill Clipboard]]

[[Action: Font Scale|Font Scale]]

[[Action: Force Location Update|Force Location Update]]

[[Action: Force Screen Rotation|Force Screen Rotation]]

[[Action: GPS Enable/Disable|GPS Enable/Disable]]

[[Action: Heads-up Enable/Disable|Heads-up Enable/Disable]]

[[Action: HotSpot On/Off|HotSpot On/Off]]

[[Action: If clause|If clause]]

[[Action: Immersive Mode|Immersive Mode]]

[[Action: Invert Colours|Invert Colours]]

[[Action: Keep Device Awake|Keep Device Awake]]

[[Action: Keyboard - Set Default|Keyboard - Set Default]]

[[Action: Keyboard Prompt|Keyboard Prompt]]

[[Action: Kill Application|Kill Application]]

[[Action: Kill Background Processes|Kill Background Processes]]

[[Action: Launch and Press|Launch and Press]]

[[Action: Launch Application|Launch Application]]

[[Action: Launch Home Screen|Launch Home Screen]]

[[Action: Launch Shortcut|Launch Shortcut]]

[[Action: Locale/Tasker Plugin|Locale/Tasker Plugin]]

[[Action: Location Mode|Location Mode]]

[[Action: Log Event|Log Event]]

[[Action: MacroDroid Drawer|MacroDroid Drawer]]

[[Action: MacroDroid Settings|MacroDroid Settings]]

[[Action: Macro run|Macro run]]

[[Action: Make Call|Make Call]]

[[Action: Mobile Data On/Off|Mobile Data On/Off]]

[[Action: NFC Enable/Disable|NFC Enable/Disable]]

[[Action: Notification Interaction|Notification Interaction]]

[[Action: Notification LED Enable/Disable|Notification LED Enable/Disable]]

[[Action: Open Call Log|Open Call Log]]

[[Action: Open File|Open File]]

[[Action: Open Last Photo|Open Last Photo]]

[[Action: Open MacroDroid Log|Open MacroDroid Log]]

[[Action: Open Website / HTTP GET|Open Website / HTTP GET]]

[[Action: Option Dialog|Option Dialog]]

[[Action: Play/Stop Sound|Play/Stop Sound]]

[[Action: Popup Message|Popup Message]]

[[Action: Press Back Button|Press Back Button]]

[[Action: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]

[[Action: Reboot/Power Off|Reboot/Power Off]]

[[Action: Record Microphone|Record Microphone]]

[[Action: Restore Hidden Notifications|Restore Hidden Notifications]]

[[Action: Ringtone Configure|Ringtone Configure]]

[[Action: Say Current Time|Say Current Time]]

[[Action: Screen On/Off|Screen On/Off]]

[[Action: Secure Settings|Secure Settings]]

[[Action: Send Email|Send Email]]

[[Action: Send Intent|Send Intent]]

[[Action: Send SMS|Send SMS]]

[[Action: Set Location Update Rate|Set Location Update Rate]]

[[Action: Set MacroDroid Icon|Set MacroDroid Icon]]

[[Action: Set MacroDroid Mode|Set MacroDroid Mode]]

[[Action: Set MacroDroid Notification Text|Set MacroDroid Notification Text]]

[[Action: Set Notification Sound|Set Notification Sound]]

[[Action: Set Quick Settings Tile State|Set Quick Settings Tile State]]

[[Action: Set Screen Lock|Set Screen Lock]]

[[Action: Set Screen Timeout|Set Screen Timeout]]

[[Action: Set Variable|Set Variable]]

[[Action: Set Wallpaper|Set Wallpaper]]

[[Action: Share Last Photo|Share Last Photo]]

[[Action: Share Location|Share Location]]

[[Action: Shell Script|Shell Script]]

[[Action: Silent - Vibrate Off|Silent - Vibrate Off]]

[[Action: Speak Text|Speak Text]]

[[Action: Speakerphone On/Off|Speakerphone On/Off]]

[[Action: Stopwatch|Stopwatch]]

[[Action: Sync Account|Sync Account]]

[[Action: System Setting|System Setting]]

[[Action: Take Picture|Take Picture]]

[[Action: Take Screenshot|Take Screenshot]]

[[Action: Text Manipulation|Text Manipulation]]

[[Action: Torch On/Off|Torch On/Off]]

[[Action: Touch Screen|Touch Screen]]

[[Action: Tweet|Tweet]]

[[Action: UDP Command|UDP Command]]

[[Action: UI Interaction|UI Interaction]]

[[Action: USB Tethering|USB Tethering]]

[[Action: Vibrate|Vibrate]]

[[Action: Vibrate Enable/Disable|Vibrate Enable/Disable]]

[[Action: Voice Search|Voice Search]]

[[Action: Volume Change|Volume Change]]

[[Action: Volume Up/Down|Volume Up/Down]]

[[Action: Wait Before Next Action|Wait Before Next Action]]

[[Action: Wait Until Trigger|Wait Until Trigger]]

[[Action: Widget Button Modify|Widget Button Modify]]

[[Action: Wifi Configure|Wifi Configure]]

[[Action: Write to File|Write to File]]

Trigger: Battery Level

2021-06-22T20:19:59Z

Dm114:

When the battery % increases or decreases, this trigger will fire. The trigger can be configured to trigger on any change or when the battery % increases or decreases to a certain level.

'''Example Usage''' 
Battery level = 15% ==> battery saving enabled. 
Battery level = 30% ==> battery saving disabled.

''HINT: Don't forget that a trigger fires once at the exact time the event occurs. So, in the above examples, it will only fire when battery level goes down from 16% to 15% or up from 14% to 15% (respectively from 31% to 30% or from 29% to 30%)''

Constraint: Application Running

2021-06-22T20:05:26Z

Dm114:

This constraint can be used to allow/prevent functionality from running, depending whether one or more apps are or are not currently running.

Constraint: AND / OR / NOT

2021-06-22T19:59:38Z

Dm114:

Constraints

2021-06-22T19:58:17Z

Dm114:

Constraints are optional and can be used to allow or prevent a macro/action from running based on certain conditions.

Constraints can be placed on macros to allow or prevent the entire macro firing based on the set condition(s). You can also add constraints directly to individual triggers and actions from the 'Edit Macro' screen, by clicking on the trigger/action and selecting "Add constraint"

A constraint is evaluated at the point a trigger fires or action runs and a macro/action will only run if the constraint condition is true.

By default if adding more than one constraint to a macro they will be combined with an AND condition (e.g. all added constraints must be true). This can be changed in the dropdown in the constraints title to an OR condition. In this case only one of the added constraints needs to be true for the macro to run.

Nesting constraints

If you need more sophisticated logic applied to constraint there is a special AND/OR/XOR/NOT constraint that can be used. Any constraints nested under the logic constraint will have that logic operator applied. It's also possible to nest multiple logic constraints to create complex logic. For example:

AND
| - Constraint 1
| - OR
| - Constraint 2
| - Constraint 3

In the above example, Constraint 1 must always be true '''AND''' at least one of (Constraint 2 '''OR''' Constraint 3) must be true.

== List of Constraints ==

[[Constraint: Airplane Mode|Airplane Mode]]

[[Constraint: AND / OR / NOT|AND / OR / NOT]]

[[Constraint: Application Running|Application Running]]

[[Constraint: Auto Rotate|Auto Rotate]]

[[Constraint: Auto Sync|Auto Sync]]

[[Constraint: Battery Level|Battery Level]]

[[Constraint: Battery Saver State|Battery Saver State]]

[[Constraint: Battery Temperature|Battery Temperature]]

[[Constraint: Bluetooth State|Bluetooth State]]

[[Constraint: Brightness|Brightness]]

[[Constraint: Calendar Entry|Calendar Entry]]

[[Constraint: Call State|Call State]]

[[Constraint: Cell Towers|Cell Towers]]

[[Constraint: Dark Mode|Dark Mode]]

[[Constraint: Day of the Month|Day of the Month]]

[[Constraint: Day of the Week|Day of the Week]]

[[Constraint: Device Facing|Device Facing]]

[[Constraint: Device Locked/Unlocked|Device Locked/Unlocked]]

[[Constraint: Device Orientation|Device Orientation]]

[[Constraint: Geofence|Geofence (Location)]]

[[Constraint: GPS State|GPS State]]

[[Constraint: Headphone Connection|Headphone Connection]]

[[Constraint: Is Roaming|Is Roaming]]

[[Constraint: Light Sensor|Light Sensor]]

[[Constraint: Location Mode|Location Mode]]

[[Constraint: Macro(s) Enabled/Disabled|Macro(s) Enabled/Disabled]]

[[Constraint: Macro(s) Invoked/Not invoked Recently|Macro(s) Invoked/Not invoked Recently]]

[[Constraint: MacroDroid Mode|MacroDroid Mode]]

[[Constraint: MacroDroid Variable|MacroDroid Variable]]

[[Constraint: Mobile Data On/Off|Mobile Data On/Off]]

[[Constraint: Mobile Service Status|Mobile Service Status]]

[[Constraint: Month of the Year|Month of the Year]]

[[Constraint: Music Active|Music Active]]

[[Constraint: NFC State|NFC State]]

[[Constraint: Notification Present|Notification Present]]

[[Constraint: Notification Volume|Notification Volume]]

[[Constraint: Phone Ringing|Phone Ringing]]

[[Constraint: Power Connected|Power Connected]]

[[Constraint: Priority Mode / Do Not Disturb|Priority Mode / Do Not Disturb]]

[[Constraint: Proximity Sensor|Proximity Sensor]]

[[Constraint: Ringer Volume|Ringer Volume]]

[[Constraint: Roaming Enabled|Roaming Enabled]]

[[Constraint: Rooted Device|Rooted Device]]

[[Constraint: Screen On/Off|Screen On/Off]]

[[Constraint: Speakerphone On/Off|Speakerphone On/Off]]

[[Constraint: Stopwatch|Stopwatch]]

[[Constraint: Sunrise/Sunset|Sunrise/Sunset]]

[[Constraint: Time of Day|Time of Day]]

[[Constraint: Time Since Boot|Time Since Boot]]

[[Constraint: Torch On/Off|Torch On/Off]]

[[Constraint: Trigger Fired|Trigger Fired]]

[[Constraint: Volume Level|Volume Level]]

[[Constraint: VPN State|VPN State]]

[[Constraint: Wifi HotSpot State|Wifi HotSpot State]]

[[Constraint: Wifi State|Wifi State]]

Trigger: Empty Trigger

2021-06-22T19:44:57Z

Dm114:

This trigger will never fire of its own accord. Its main use is for macros that are designed to be invoked from other macros using the [[Action: Macro run|Macro run]] action.

Trigger: Empty Trigger

2021-06-22T19:40:11Z

Dm114:

This trigger will never fire of its own accord. Its main use is for macros that are designed to be invoked from other macros using the [[Action:Macro run]] action.