Readonly
componentOne of the supported MQTT components, for instance binary_sensor
Optional
deviceInformation about the device this sensor belongs to
Optional
deviceSets the class of the device, changing the device state and icon that is displayed on the frontend.
Optional
enabledFlag which defines if the entity should be enabled when first added.
Optional
entityClassification of a non-primary entity.
Optional
expireIf 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.
Optional
forceSends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history.
Optional
iconIcon of the entity
Name of the sensor inside Home Assistant
Optional
objectSet this to generate the entity_id
in HA instead of using name
Optional
optimisticFlag that defines if light works in optimistic mode. Default: true if no state_topic defined, else false.
Readonly
payloadCommand payload to close the cover
Command payload to open the cover
Command payload to stop the cover
Number which represents the fully closed position
Number which represents the fully open position
Optional
qosThe maximum QoS level to be used when receiving messages.
Optional
retainIf the published message should have the retain flag on or not
Payload that represents a closed state
Payload that represents closing state
Payload that represents open state
Payload that represents opening state
Payload that represents stopped state
Optional
stateThe MQTT topic subscribed to receive state updates.
Optional
uniqueSet this to enable editing sensor from the HA ui and to integrate with a device
Generates a JSON object that can be used as an MQTT payload.
Protected
propertyMapping of class properties to MQTT payload keys.
Static
createStatic
wholeValidates that uniqueId
is set if device
is provided.
Cover specific information