How to speed up device configuration with Setbox macros?

Create sequences of settings changes and apply them in one click when needed.

Setbox is an independent flespi tool dedicated to device configuration. The two major things it can do above the conventional Settings tab in the device card are bulk settings update and macros.

Here we will show how macros can simplify 

  • re-applying the same set of settings changes in the future or 

  • re-applying the same set of settings changes to other devices of the same device type.


Let’s go through the steps required to create a macro and execute it for a set of devices.

  • Open Setbox.
  • Select the device type you want to create a macro for:

flespi setbox select device type

  • Navigate to the Macros tab:

flespi setbox macros tab

  • Give a name to the new macro and click the ‘+’ button:

flespi setbox add new macro

  • Click the Add setting button to select a setting to include in the macro:

flespi setbox macros add setting

  • Make the necessary changes to the configuration of each setting:

flespi setbox configure macros

  • Add as many settings as would be convenient for you to change in one go later on.
  • When done, click Save.
  • Once the macro is created, switch back to the Settings tab and select the device(s) to apply the macro to.

flespi setbox apply macros to devices

Note that macro can apply only to the devices of the same device type.

Done! The sequence of settings will be sent to the settings queue of each selected device and will apply as soon as they go online.

Permission note

If you want to use Setbox macros with the ACL token, you need to add the following MQTT topic xflespifront/setbox/macros/{DEVICE_TYPE_ID}/{MACRO_NAME} into your ACL token configuration. Replace the placeholders in {} with the proper values or use "+" to allow access to all items of the given type.


See also
Article explains how to automatically store device command execution results in device messages
Explaining the different methods to change the device behavior in Flespi.