Class Valve

Represents a valve in Home Assistant. A valve can be opened, closed, and optionally set to a position.

Hierarchy (View Summary)

Subscriber<ValveInfo, StateTopicMap, CommandTopicMap>
- Valve

Index

Constructors

Constructors

constructor

new Valve(
    settings: ComponentSettings<ValveInfo>,
    stateTopicNames: (keyof StateTopicMap)[],
    onStateChange: StateChangedHandler<StateTopicMap>,
    commandTopicNames: (keyof CommandTopicMap)[],
    onCommand: CommandCallback<CommandTopicMap>,
): Valve
Creates a new valve instance
Parameters
- settings: ComponentSettings<ValveInfo>
  Configuration settings for the valve
- stateTopicNames: (keyof StateTopicMap)[]
  Array of state topic names to expose
- onStateChange: StateChangedHandler<StateTopicMap>
  Callback function to handle state changes
- commandTopicNames: (keyof CommandTopicMap)[]
  Array of command topic names to subscribe to
- onCommand: CommandCallback<CommandTopicMap>
  Callback function to handle command messages
Returns Valve
Overrides Subscriber.constructor
- Defined in components/valve.ts:123

Properties

`Protected`attributesTopic

attributesTopic: string

MQTT topic for entity attributes

`Protected`availabilityTopic

availabilityTopic: string

MQTT topic for entity availability status

`Protected`baseTopicName

baseTopicName: string

Base MQTT topic name for this entity

`Protected`commandTopics

commandTopics: CommandTopicConfiguration[] = []

List of MQTT topics for entity commands.

`Protected`component

component: ValveInfo

The component configuration containing entity-specific settings

`Protected`configTopic

configTopic: string

MQTT topic for entity configuration

`Protected`identifier

identifier: string

Unique identifier for this entity

`Protected`logger

logger: Logger

Logger instance for debugging and error reporting

`Protected`mqttClient

mqttClient: MqttClient

The MQTT client instance used for communication

`Protected`settings

settings: ComponentSettings<ValveInfo>

The component settings including MQTT configuration

`Protected`stateChangedHandler

stateChangedHandler: StateChangedHandler<StateTopicMap>

Callback function to handle state changes

`Protected`stateTopics

stateTopics: StateTopicConfiguration[]

List of MQTT topics for entity state

`Protected`wroteConfiguration

wroteConfiguration: boolean = false

Flag indicating whether configuration has been written to MQTT

Accessors

currentState

get currentState(): ValveState | undefined
Returns ValveState | undefined
The current valve state. Setting it publishes the configured payload for that state on the state_topic.
- Defined in components/valve.ts:82
set currentState(state: ValveState | undefined): void
Parameters
- state: ValveState | undefined
Returns void
- Defined in components/valve.ts:86

position

get position(): number | undefined
Returns number | undefined
The current valve position (typically 0-100), used when reports_position is enabled. Setting a defined value publishes it on the position_topic.
- Defined in components/valve.ts:103
set position(position: number | undefined): void
Parameters
- position: number | undefined
Returns void
- Defined in components/valve.ts:107

Methods

`Protected`getConfig

getConfig(): ResolvedComponentConfiguration
Gets the complete configuration for this entity including command topic

Returns ResolvedComponentConfiguration
The resolved component configuration with all required MQTT topics
Inherited from Subscriber.getConfig
- Defined in api/subscriber.ts:69

removeConfig

removeConfig(): 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>
Inherited from Subscriber.removeConfig
- Defined in api/discoverable.ts:233

setAttributes

setAttributes(attributes: Record<string, unknown>): Promise<void>
Sets additional attributes for the entity
Parameters
- attributes: Record<string, unknown>
  Key-value pairs of attributes to set
Returns Promise<void>
Inherited from Subscriber.setAttributes
- Defined in api/discoverable.ts:244

setAvailability

setAvailability(availability: boolean): Promise<void>
Sets the availability state of the entity
Parameters
- availability: boolean
  True if the entity is available, false otherwise
Returns Promise<void>
Inherited from Subscriber.setAvailability
- Defined in api/discoverable.ts:254

setState

setState<K extends keyof StateTopicMap>(
topicName: K,
state: StateTopicMap[K],
): Promise<void>
Sets the state of the entity
Type Parameters
- K extends keyof StateTopicMap
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>
Inherited from Subscriber.setState
- Defined in api/discoverable.ts:306

setStateSync

setStateSync<K extends keyof StateTopicMap>(
topicName: K,
state: StateTopicMap[K],
): void
Sets the state of the entity
Type Parameters
- K extends keyof StateTopicMap
Parameters
- topicName: K
  The name of the MQTT topic to publish the state to
- state: StateTopicMap[K]
  The new state to set
Returns void
Inherited from Subscriber.setStateSync
- Defined in api/discoverable.ts:271

writeConfig

writeConfig(): Promise<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>
Inherited from Subscriber.writeConfig
- Defined in api/discoverable.ts:217

Class Valve

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Valve

Properties

ProtectedattributesTopic

ProtectedavailabilityTopic

ProtectedbaseTopicName

ProtectedcommandTopics

Protectedcomponent

ProtectedconfigTopic

Protectedidentifier

Protectedlogger

ProtectedmqttClient

Protectedsettings

ProtectedstateChangedHandler

ProtectedstateTopics

ProtectedwroteConfiguration

Accessors

currentState

Returns ValveState | undefined

Parameters

Returns void

position

Returns number | undefined

Parameters

Returns void

Methods

ProtectedgetConfig

Returns ResolvedComponentConfiguration

removeConfig

Returns Promise<void>

setAttributes

Parameters

Returns Promise<void>

setAvailability

Parameters

Returns Promise<void>

setState

Type Parameters

Parameters

Returns Promise<void>

setStateSync

Type Parameters

Parameters

Returns void

writeConfig

Returns Promise<void>

Settings

On This Page

`Protected`attributesTopic

`Protected`availabilityTopic

`Protected`baseTopicName

`Protected`commandTopics

`Protected`component

`Protected`configTopic

`Protected`identifier

`Protected`logger

`Protected`mqttClient

`Protected`settings

`Protected`stateChangedHandler

`Protected`stateTopics

`Protected`wroteConfiguration

`Protected`getConfig