Skip to content

Create Entity Feature

Jump to bottom
partach edited this page Jan 13, 2026 · 3 revisions

Overview

The Protocol Wizard frontend card now includes functionality to create entities directly after successfully reading a Modbus register or SNMP OID. This streamlines the workflow of exploring devices and adding entities without needing to navigate through the configuration UI.

Features Added

1. Create Entity Button

  • Appears automatically after a successful read operation
  • Only visible when read was successful and contains valid data
  • Shows a clear "Create Entity from this Read" button

2. Entity Creation Form

  • Pre-fills entity name based on protocol and address
  • Shows a summary of the configuration that will be used
  • Displays the last read value for verification
  • Allows customization of the entity name before creation

3. Automatic Configuration

The entity is created with appropriate settings based on the read operation:

For Modbus:

  • Address
  • Register type (holding, input, coil, discrete)
  • Data type (uint16, int32, float32, etc.)
  • Size (number of registers)
  • Byte order
  • Word order
  • Read/write mode (defaults to read-only for safety)
  • Scale and offset (defaults to 1.0 and 0.0)
  • Options (See Value Mapping Guide)
  • Format (See Value Mapping Guide)

For SNMP:

  • OID address
  • Data type (string, integer, counter, etc.)
  • Read mode (defaults to "get")
  • Scale and offset (defaults to 1.0 and 0.0)

User Workflow

Step 1: Read a Register/OID

  1. Configure the read parameters (address, data type, etc.)
  2. Click the "Read" button (important: register type 'auto' helps read registers but if succesfull is not necessarily the correct register type for the entity!)
  3. Verify the returned value

Step 2: Create Entity

  1. After a successful read, click "Create Entity from this Read"
  2. Review the pre-filled entity name and configuration
  3. Modify the entity name if desired
  4. Click "Create Entity" to add it to the integration

Step 3: Confirmation

  • Success message appears: "Entity created successfully!"
  • Entity is immediately available in Home Assistant
  • Form automatically closes after 3 seconds

Clone this wiki locally