Home Page

@hass-blocks/blocks

A declarative framework for building Home Assistant automations

Function

Name	Description
action	A generic block that represents some kind of action
assertion	An assertion is a block which can decide whether or not an automation should continue based on the result of a predicate
automation	An automation represents a sequence of actions that can either be executed in sequence or in parallel. When passed into
concurrently	When executed, this block will execute all the blocks passed in as the first argument concurrently. Once complete the outputs from all the blocks will be returned as an array
initialiseBlocks	Bootstrap the connection with Home Assistant and initialise Hass Blocks
sequence	Block that takes a series of blocks and executes them either in sequence or in parallel
serviceCall	A specialised action block that will call a service on your configured Home Assistant instance
trigger	Associate the automation with a Home Assistant trigger. For more details, see
when	Use in combination with an , block to implement branching logic in your automations. Supply two blocks and execute either one of them depending on the result of the assertion

Class

Name	Description
Block	The core Hass Blocks abstraction - all Blocks must extend from this class for the framework to be able to execute them

Enum

Name	Description
ExecutionMode	The execution mode for an automation

Interface

Name	Description
AutomationRegistered	An event that is emitted when an automation has been registered
BaseHassEvent	The base event for all events related to automations emitted by this framework
BlockFailed	An event that is emitted when a block fails for some reason
BlockFinished	An event that is emitted when a block finishes successfully
BlockPending	An event that is emitted when a block is queued for execution
BlockStarted	An event that is emitted when a block starts executing
ConditionResult	Output returned when a conditional block signals to continue
ContinueOutput	Output returned when a block signals to continue
GeneralFailure	An event that is emitted when there is some kind of error
IActionConfig	Configuration object for action blocks
IAssertionConfig	Configuration object for an assertion block
IAutomationConfig	Configuration object for automation blocks
IBaseBlockConfig	Configuration that is common for all blocks
IBlock	The abstract base class that all blocks inherit from
IBlocksConfig	Configuration object for Hass Blocks
IBlocksConnection	An initialied Hass Blocks connection
IBlocksPlugin	An object that implements this interface can be passed into the 'plugins' property of the , config object.
IBlocksRegistry	A blocks registery object - this is where you start registering automations
ICallServiceParams	Parameters for calling Home Assistant services
IEventBus	The Hass Blocks internal event bus
IfThenElseConditionConfig	Configuration object for a condition block
IFullBlocksClient	The full version of the blocks client - only available to plugins
IHass	An initialised Home Assistant connection that blocks can used to inspect state or make calls to services
IPluginArgs	This object will be passed into the load method once during Hass Blocks initialisation, plugins can use it to interact with home assistant and listen to hass blocks event
ITrigger	An object representing a Home Assistant trigger
ITriggerConfig	The configuration object for a trigger
LoadPluginFinished	An event that is emitted just after a specific plugin finishes loading
LoadPluginsFinished	An event that is emitted after all plugins have finished loading
LoadPluginsStart	An event that is emitted just before all plugins start loading
LoadPluginStart	An event that is emitted just before a specific plugin starts loading
LogEvent	An event emitted whenever you want to log information. Will be picked up by logging clients
SequenceAborted	An event that is emitted when a sequence is aborted for some reason
SerialisedBlock	A serialised version of a block - used for transmission purposes
StateChanged	An event that is emitted when the websocket client recieves a state change from Hass
StopOutput	Output returned when a block signals to stop

TypeAlias

Name	Description
BlockOutput	Results that can be returned by blocks
BlockRetainType	Rehydrate a sequence of blocks with its input and output types
GetSequenceInput	Given an array of blocks, get the input type from the first block
GetSequenceOutput	Given an array of blocks, get the output type from the last block
HassBlocksEvent	Events published by the framework on the event bus
HassContext	The Home Assistant context (See ,)
HassEntity	A Home Assistant entity
HassEntityAttributeBase	The core entity attributes shared by all Home Assistant entities
HassEntityBase	The core attributes shared by all Home Assistant entities
InputType	Given a block, extract the input type
OutputType	Given a block, extract the output type
OutputTypeKeepPromise	Block output type without undefined
ValidInputOutputSequence	Given an Input and Ouput type and an array of block types, this type validates that they are a compatible sequence of blocks.,So for input I, output O and blocks A and B, this type will produce compiler errors unless I is compatible with A,, A, is compatible with B, and B, is compatible with O