@ginden/ha-mqtt-discoverable
    Preparing search index...

    Class LightInfo

    Light specific information

    Hierarchy (View Summary)

    Index

    Properties

    brightness? colorMode? component device? deviceClass? effect? effectList? enabledByDefault? entityCategory? expireAfter? forceUpdate? icon? name objectId? optimistic? payloadOff payloadOn qos? retain? stateSchema stateTopic? supportedColorModes? uniqueId?

    Methods

    modelDump propertyMap create wholeValidation

    Properties

    brightness?: boolean

    Flag that defines if the light supports setting the brightness BUG: This seems to be ignored by Home Assistant

    colorMode?: boolean

    Flag that defines if the light supports color mode

    component: "light" = 'light'

    One of the supported MQTT components, for instance binary_sensor

    device?: DeviceInfo

    Information about the device this sensor belongs to

    deviceClass?: string

    Sets the class of the device, changing the device state and icon that is displayed on the frontend.

    effect?: boolean

    Flag that defines if the light supports effects

    effectList?: string[]

    List of supported effects. Required if effect is set

    enabledByDefault?: boolean

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

    entityCategory?: string

    Classification of a non-primary entity.

    expireAfter?: 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.

    forceUpdate?: boolean

    Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history.

    icon?: string

    Icon of the entity

    name: string

    Name of the sensor inside Home Assistant

    objectId?: string

    Set this to generate the entity_id in HA instead of using name

    optimistic?: boolean

    Flag that defines if light works in optimistic mode. Default: true if no state_topic defined, else false.

    payloadOff: string = 'OFF'

    The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic

    payloadOn: string = 'ON'

    The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic.

    qos?: number

    The maximum QoS level to be used when receiving messages.

    retain?: boolean

    If the published message should have the retain flag on or not

    stateSchema: string = 'json'

    Sets the schema of the state topic, ie the 'schema' field in the configuration

    stateTopic?: string

    The MQTT topic subscribed to receive state updates.

    supportedColorModes?: ColorMode[]

    List of supported color modes. See https://www.home-assistant.io/integrations/light.mqtt/#supported_color_modes for current list of supported modes. Required if color_mode is set

    uniqueId?: string

    Set this to enable editing sensor from the HA ui and to integrate with a device

    Methods

    • Generates a JSON object that can be used as an MQTT payload.

      Returns Record<string, unknown>

    • Mapping of class properties to MQTT payload keys.

      Returns {
          brightness: "brightness";
          colorMode: "color_mode";
          component: "component";
          device: "device";
          deviceClass: "device_class";
          effect: "effect";
          effectList: "effect_list";
          enabledByDefault: "enabled_by_default";
          entityCategory: "entity_category";
          expireAfter: "expire_after";
          forceUpdate: "force_update";
          icon: "icon";
          name: "name";
          objectId: "object_id";
          optimistic: "optimistic";
          payloadOff: "payload_off";
          payloadOn: "payload_on";
          qos: "qos";
          retain: "retain";
          stateSchema: "schema";
          stateTopic: "state_topic";
          supportedColorModes: "supported_color_modes";
          uniqueId: "unique_id";
      }

    Settings

    Member Visibility

    On This Page

    Properties
    Methods