actions

Send Report > Battery Level Report

The "Send Report > Battery Level Report" action will send a complete battery level report (for Z-Wave devices only) to the specified email address. You can send the report to multiple addresses (separate each address with a comma) and the "Email Address" field supports Indigo substitutions. For example, if you have the target email address in an Indigo variable, the substitution string would be %%v:12345678%% (replace the number with your variable's ID.)

Modify Numeric Variable

The "Modify Numeric Variable" action item is used to change the value of an Indigo variable based on a mathematical formula. The variable value must be a real number and the formula must use one or more of the following arithmetic operations:

• Addition (+)
• Subtraction (-)
• Multiplication (*)
• Division (/)
• Exponents (**)

Example 1:

Value = 13 Formula = * 2 + 1 Result = 27

Example 2:

Value = 16 Formula = **2 Result = 256

The Formula field also supports Indigo substitutions. Therefore, constructions like the following are also possible:

Example 3:

Value = 1 Formula = + %%v:12345678%% (where the value of the referenced variable is 5). Result = 6

Example 4:

Value = 1 Formula = + %%d:12345678:slider_value%% (where the value of the referenced device state is 75). Result = 76

The "Modify Numeric Variable" action item was added with v1.0.26 of the plugin.

Modify Time Variable

The "Modify Time Variable" action item is used to change the value of Indigo variables that hold a timestamp. The plugin is expecting the value of the variable to match this exact format: 2019-11-20 13:14:15.123456 (YYYY-MM-DD HH:MM:SS.ffffff). Any other time or date format will not be accepted.

You can indicate whether you would like the modifiers to be added to or subtracted from the variable value. The default modifier is addition.

You can indicate the days, hours, minutes, and seconds that you want to use to modify the initial variable value. For example, selecting an 'Add' modifier and entering an hours value of 1, will increase the variable value by 1 hour.

Example 1:

[Add] Days = 0 Hours = 1 Minutes = 0 Seconds = 0

Initial Value: 2019-05-26 02:57:24.974913 Result: 2019-05-26 03:57:24.974913

Example 2:

[Subtract] Days = 1 Hours = -1 Minutes = 0 Seconds = 0

Initial Value: 2019-05-26 02:57:24.974913 Result: 2019-05-25 03:57:24.974913

The "Modify Time Variable" action item was added with v1.0.26 of the plugin.

Network Quality Report

The "Network Quality Report" action item executes the Network Quality Report plugin menu item. This action is provided as a convenience in instances where you want to run the menu item report based on a schedule or other event. The results of the test are output to the Indigo Events log, and are not retained.

Update Network Quality Device

The Update Network Quality Device action item is required in order to cause any configured Network Quality Devices to update their states.

Backup Indigo Database

The "Backup Indigo Database" action creates a verified backup of the live Indigo database. It duplicates the current database to a temporary location, confirms the duplicate is stable by reading it twice, saves the verified copy to the folder you specify under a dated filename (for example, myDatabase backup 2026 09 16 plus your database's file extension), and confirms the saved file matches the duplicate before finishing. If a backup with that name already exists (for example, if you run more than one backup on the same day), a sequence number is appended, e.g. myDatabase backup 2026 09 16 (01).

The "Backup Folder" field is the destination folder for backup files. It is created automatically if it doesn't already exist, and it supports Indigo substitutions (for example, if the destination path is stored in an Indigo variable, use %%v:12345678%%). Only surrounding whitespace is stripped from this value — don't wrap the path in quotes or backticks, as they'll be treated as part of the folder name.

The "Backups to Retain" field is the number of backup files to keep for this database (a whole number greater than zero; the default is 5). Older backups beyond that count are deleted automatically after a successful backup.

The original database file is only ever read, never modified, by this action.

The "Backup Indigo Database" action item was added with v2025.2.9 of the plugin.

Test Action Return

The "Test Action Return" action is an action that can be used to test a call to a plugin action and test reply values to that call (the "Test Action Return" action is hidden in Indigo's UI, so it won't appear in Action menus). It is intended for testing code and is not useful in a day-to-day environment.

The action expects a return_value parameter which designates the type of return you want to receive: None, int, float, str, tuple, dict, or list.

A note about collections: by definition, any collections returned as a result of an indigo.executeAction call will either be an indigo.Dict or indigo.List. As a result, a call for a tuple return value will return an indigo.List object.

Important

"Test Action Return" only works when called in-process via indigo.executeAction(), as shown below. It is not wired up to handle calls made through the Indigo Web Server's HTTP API (/message/PLUGINID/ACTIONID/) — IWS doesn't inject a return_value prop for that path, so an HTTP call to this action will fail.

Call Using indigo.executeAction:

Calling the "Test Action Return" action from code is straightforward:

plugin_id = "com.fogbert.indigoplugin.multitool"
plugin = indigo.server.getPlugin(plugin_id)
reply = plugin.executeAction("test_action_return", props={'return_value': 'dict'})
indigo.server.log(f"{reply}")

See the Indigo documentation for more information on using the indigo.executeAction command.