Templates

Templates provide an easy way for you to create, modify and share configurations for various devices that have features supported in Tasmota.

To provide easy processing by Tasmota a template is written as a JSON string and looks like this:

{"NAME":"Example Template","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45}

How to Use~

Go to Configuration - Configure Template ...

... and you'll end up looking at this screen.

Time to create your template.

Creating Your Template~

1. Change the template name (also defines the name for the module).
2. Select a module to BASE your template on. If you're not sure, Module 18 is the best choice. In this example the device is based on Blitzwolf SHP (45) module.

3. Configure the components assigned to the GPIOs to match your device. If you do not know what pins your device uses, read about the new device configuration procedure to determine the correct pin assignments.

   • Any unused GPIO that has cannot have a peripheral connected should be set to None (0). In our example the device has no exposed GPIO's so the unused ones are set to 0 compared to the original BlitzWolf module.
   • GPIOs that can have peripherals connected to (exposed GPIOs) should be set to User (1). This allows future configuration through the Configure Module dialog without the need to create a new template.

   Example

   Sonoff TH has a jack connected to GPIO4 that allows a user to plug in a sensor. Assigning GPIO4 as User allows a Template to have correct GPIOs for this device even if nothing is plugged in. But, when a user decides to connect a sensor using the jack, GPIO4 can be set to the type of sensor through the Configure Module page.

4. Click on Save and you'll see this message
   

5. Finally, the device will reboot with the new template name
   

Exporting Your Template~

Now that you've set up your previously unsupported device in Tasmota it is time to share the knowledge:

1. Check that Module 0 is selected in the Configuration - Configure Module menu.
2. Open up Console and issue command Template which will output a string with the configuration of your currently active template. Our example gives the following:

MQT: stat/tasmota/RESULT = {"NAME":"Merged","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45}

Copy the string {"NAME":"Merged","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45} and share it on the Tasmota Supported Devices Repository.

Importing Templates~

Go to Configuration - Configure Other

When there:

1. Paste the template string into the Template field
2. Make sure you check Activate
3. Click on Save.

The device will reboot with a name reflecting your template name and Module 0 selected which has your new template stored.

Commands~

A user provided template can be stored in Tasmota using the Template command. It has the following parameters.

Template {"NAME":"Example Template","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45} stores a complete template based on the Generic module

Template {"NAME":"AnotherModuleName"} updates the name of a stored template

Template {"FLAG":0} changes FLAG value

Template {"BASE":18} updates the base of a stored template to Generic

Template {"CMND":"LedTable 1"} adds LedTable 1 command to the stored template

Merge Template with Module~

You can set up your device in module *Configuration -> Configure Module* and use command Template 255 to merge the settings of the Module with current template into a new Template named "Merged".

Anatomy of a Template~

Let's look again at our example template:

{"NAME":"Example Template","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45}

The four properties with UPPERCASE property names have the following functionality:

GPIO~

GPIO order~

GPIO# |00| 01|02| 03|04| 05| 09| 10| 12| 13| 14| 15| 16| 17 
CODE  [416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0] 

GPIO functionality~

The GPIO functionality numbers are the same as shown by command GPIOs. In addition code 1 is added to select a GPIO as user configurable via the GUI Configure Module menu.

Components~

See Components for a complete list or use command Gpios 255 in console.

FLAG~

Before Tasmota 9.1 used to configure the ADC type. In new templates this should be set to 0 and the analog pin should be configured on GPIO17

BASE~

BASE is the starting module setup for the custom template. Some modules include special programming. If your device is similar to an existing built-in module it is best to use that as a starting point. When you're not sure which BASE module is suitable for your device use the Generic (18) module. A list of hard-coded devices can be found in Modules.

CMND~

CMND is an optional field in the template JSON string. It is used to embed commands for configuring the device instead of needing to type them in console. Multiple commands are separated with |.

"CMND":"<any template related command>|<any template related command>|..."

Commands will only be executed if the template is enabled (device module is set to 0), either before the template is loaded, when the activate box in the UI is selected or if the module 0 command is included in the CMND string itself.

{"NAME":"Example","GPIO":[416,0,418,0,417,2720,0,0,2624,32,2656,224,0,0],"FLAG":0,"BASE":45,"CMND":"LedTable 1|ChannelRemap 36"}

Total size of the template string should not exceed 500 chars.