mqtt2ha
    Preparing search index...

    Interface ImageInfo

    Configuration interface for an image component

    interface ImageInfo {
        availability?: AvailabilityConfiguration;
        component: "image";
        content_type?: string;
        device?: DeviceConfiguration;
        device_class?: string;
        enabled_by_default?: boolean;
        entity_category?: "config" | "diagnostic" | "system";
        expire_after?: number;
        force_update?: boolean;
        icon?: string;
        image_encoding?: "b64";
        json_attributes_template?: string;
        name?: string;
        object_id?: string;
        origin?: OriginConfiguration;
        qos?: number;
        unique_id?: string;
        url_template?: string;
        value_template?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Additional properties to serialize as part of the configuration payload. Typically used for command and state topics.

    Index
    availability? component content_type? device? device_class? enabled_by_default? entity_category? expire_after? force_update? icon? image_encoding? json_attributes_template? name? object_id? origin? qos? unique_id? url_template? value_template?
    availability?: AvailabilityConfiguration

    Configures the availability settings of the entity.

    component: "image"

    The type of component, constrained to valid component types

    Optionalcontent_type

    content_type?: string

    The content type of the image, e.g. image/jpeg or image/png. Only used with an image topic. Default: image/jpeg.

    device?: DeviceConfiguration

    Information about the device this component is a part of to tie it into the device registry. Only works when unique_id is set. At least one of identifiers or connections must be present to identify the device.

    device_class?: string

    Sets the class of the device, changing the device state and icon that is displayed on the frontend. The device_class can be null. Different components have different valid device classes.

    enabled_by_default?: boolean

    Flag which defines if the entity should be enabled when first added. Default is true.

    entity_category?: "config" | "diagnostic" | "system"

    The category of the entity

    • "config": For configuration related entities.
    • "diagnostic": For read-only diagnostic entities.
    • "system": For system related entities.
    expire_after?: number

    If set, it defines the number of seconds after the sensor’s state expires, if it’s not updated. After expiry, the sensor’s state becomes unavailable. Default the sensors state never expires.

    force_update?: boolean

    Sends update events (which results in update of state object’s last_changed) even if the sensor’s state hasn’t changed. Useful if you want to have meaningful value graphs in history or want to create an automation that triggers on every incoming state message (not only when the sensor’s new state is different to the current one).

    icon?: string

    Icon to use for the entity in the frontend. Should be a Material Design Icon (format: mdi:icon-name).

    image_encoding?: "b64"

    The encoding of the image payload received on the image topic. Use "b64" to publish base64-encoded images. Defaults to publishing raw binary image data.

    json_attributes_template?: string

    Template to extract the JSON dictionary from the json_attributes_topic.

    name?: string

    The name of the entity. This will be used for the entity name in the Home Assistant UI. Can be set to null if only the device name is relevant.

    object_id?: string

    Used instead of name for automatic generation of entity_id.

    origin?: OriginConfiguration

    Information about the application that is the origin of the component.

    qos?: number

    The maximum QoS level to be used when receiving and publishing messages. Default is 0.

    unique_id?: string

    An ID that uniquely identifies this entity. If two entities have the same unique ID, Home Assistant will raise an exception. Required when used with device-based discovery.

    url_template?: string

    Defines a template to extract the image URL from a message received on the url topic.

    value_template?: string

    Defines a template to extract the value from the payload. Useful when the payload isn't a simple value.

    Settings
    Member Visibility

    On This Page
    Properties