Templates

Device Templates

Templates let you import pre-defined entities for popular devices with one click — no manual entry needed. This can be done during install of the device or via configuration later. Also there is a possibility to export your setup into a template so you can share with others

A new feature is added to store self created templates locally. In this way the integration won't delete them by update. When exporting select that you want to store it locally. In this way you don't loose it.

How to Use During Install.

See Modbus‐Setup or SNMP Setup or MQTT Guide

How to Use Template Import During Configuration.

1. Go to your Protocol Wizard device → Configure (gear icon)
2. Select Load Template
3. Choose your device (SDM630, Waveshare relay, etc.)
4. Click Load → new entities appear instantly

How to Use Template Export During Configuration.

1. Go to your Protocol Wizard device → Configure (gear icon)
2. Select Export Template
3. Choose the name of the file (.json automatically added)
4. Chose location (recommend user space)
5. Click Save → Entities are transformed into a template.

Other Options with templates

Delete a self created template. This can be done from the same menu as explained above

Experimenting with Your Own

Templates are simple JSON files placed in /config/custom_components/protocol_wizard/templates/modbus/ (for modbus, use specific protocol sub dir)

Example structure:

[
  {
    "name": "Phase 1 Voltage",
    "address": 0,
    "data_type": "float32",
    "register_type": "input",
    "rw": "read",
    "unit": "V",
    "scale": 1.0,
    "offset": 0.0,
    "byte_order": "big",
    "word_order": "big",
    "allow_bits": false
  }
]

For SNMP /config/custom_components/protocol_wizard/templates/snmp/ :

[
  {
    "name": "System Description",
    "address": "1.3.6.1.2.1.1.1.0",
    "data_type": "string",
    "read_mode": "get"
  }
]

Send your templates to me (@partach) — I can include them in future releases! See existing template example: SDM630