mqtt2ha
    Preparing search index...

    Class Camera

    Represents a camera in Home Assistant. A camera publishes still images, either as raw binary payloads or as base64-encoded strings when CameraInfo.image_encoding is "b64".

    Hierarchy (View Summary)

    Index
    constructor
    attributesTopic availabilityTopic baseTopicName component configTopic identifier logger mqttClient settings stateChangedHandler stateTopics wroteConfiguration
    getConfig publishImage removeConfig setAttributes setAvailability setState setStateSync writeConfig
    attributesTopic: string

    MQTT topic for entity attributes

    availabilityTopic: string

    MQTT topic for entity availability status

    baseTopicName: string

    Base MQTT topic name for this entity

    component: CameraInfo

    The component configuration containing entity-specific settings

    configTopic: string

    MQTT topic for entity configuration

    identifier: string

    Unique identifier for this entity

    logger: Logger

    Logger instance for debugging and error reporting

    mqttClient: MqttClient

    The MQTT client instance used for communication

    settings: ComponentSettings<CameraInfo>

    The component settings including MQTT configuration

    stateChangedHandler: StateChangedHandler<StateTopicMap>

    Callback function to handle state changes

    stateTopics: StateTopicConfiguration[]

    List of MQTT topics for entity state

    wroteConfiguration: boolean = false

    Flag indicating whether configuration has been written to MQTT

    • Publishes an image frame.

      Parameters

      • image: string | Buffer<ArrayBufferLike>

        The image data. A Buffer of raw image bytes, or a string (typically a base64-encoded image when CameraInfo.image_encoding is "b64").

      Returns Promise<void>

    • Clears the entity's retained discovery configuration, causing Home Assistant to remove the entity.

      Use this when an entity that may have been published by a previous run should no longer exist. Because writeConfig retains its payload, simply not calling it leaves the entity in place indefinitely.

      Returns Promise<void>

    • Sets additional attributes for the entity

      Parameters

      • attributes: Record<string, unknown>

        Key-value pairs of attributes to set

      Returns Promise<void>

    • Sets the availability state of the entity

      Parameters

      • availability: boolean

        True if the entity is available, false otherwise

      Returns Promise<void>

    • Sets the state of the entity

      Type Parameters

      • K extends "topic"

      Parameters

      • topicName: K

        The name of the MQTT topic to publish the state to

      • state: StateTopicMap[K]

        The new state to set

      Returns Promise<void>

    • Sets the state of the entity

      Type Parameters

      • K extends "topic"

      Parameters

      • topicName: K

        The name of the MQTT topic to publish the state to

      • state: StateTopicMap[K]

        The new state to set

      Returns void

    • Writes the entity's configuration to MQTT for Home Assistant discovery Also sets the entity's initial availability state if not manually managed

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods