Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 4.78 KB

Automation Structure.md

File metadata and controls

61 lines (52 loc) · 4.78 KB

Detailed Inputs list

Inputs
Name Description Type Helper? Optional / Required
00 appliance_socket Appliance Smart Socket switch. True *REQUIRED
01 appliance_power_sensor Appliance Power Consumption sensor. True *REQUIRED
02 appliance_starting_power_threshold Starting power threshold number False *REQUIRED
03 delayed_job_ongoing_timer Delayed Job Ongoing timer timer. True OPTIONAL
04 delayed_job_ongoing_duration Delayed Job Ongoing duration number False OPTIONAL
05 appliance_finishing_power_threshold Finishing power threshold number False *REQUIRED
06 delayed_job_completion_timer Job Completion - Delayed Job Completion timer timer. True OPTIONAL
07 delayed_job_completion_duration Delayed Job Completion duration number False OPTIONAL
08 appliance_overload_state_enabled Appliance Overload State Enabled boolean False *REQUIRED
09 appliance_suspended_sensor Appliance Suspended Overload entity input_number. True OPTIONAL but *REQUIRED if appliance_overload_state_enabled: true
10 appliance_state_machine Appliance State Machine input_select. True *REQUIRED
11 appliance_job_cycle Appliance Job Cycle input_boolean. True *REQUIRED
12 job_completed_persistence_timer Job completed - State persistence Timer timer. True OPTIONAL
13 job_completed_persistence_duration Job completed - State Persistence Duration number True OPTIONAL

The current automation has:

  • 1 switch
  • 1 sensor
  • 3 timers: theoretically OPTIONAL (but this is untested)
  • 1 input_number
  • 1 input_boolean

That have to be provided to fully configure the automation. The rest are constants, stored in the automation itself.

Detailed Triggers list

Triggers
Name Description
00 automation_self_trigger Automation Self-triggering entity
01 power_event Event - A new power measurement is received
02 socket_state_change_event Event - The socket had changed its state (ON <-> OFF)
03 paused_after_overload_event Event - The state machine changed state. From detached_overload -> paused
04 paused_after_unplugged_event Event - The state machine changed state. From unplugged -> paused
05 resuming_after_paused_overload_event Event - The state machine changed state. From detached_overload -> job_ongoing
06 automation_self_triggered Event - The automation_self_trigger changed from false -> true
07 job_started_timer_finished Event - delayed_job_ongoing_timer has finished counting
08 job_completed_timer_finished Event - delayed_job_completion_timer has finished counting
09 job_completed_persistence_timer_finished Event - job_completed_persistence_timer has finished counting
10 home_assistant_started_event Event - Home Assistant has started
11 automation_reloaded_event Event - The automation have been reloaded

Detailed States list

States
Name Description
00 unplugged The appliance is no longer powered. The smart socket is off.
01 idle There is no pending job, the machine is powered but idling.
02 paused The appliance has a pending job (cycle still on) but the appliance is not performing it. The state also indicates that the Power absorption is lower than the finishing power threshold, but the previous state indicates that the appliance hasn't completed its job yet. The appliance has to be off (the user may have turned it off manually), or maybe the job needs some time to recover. The automation is now waiting for the appliance to resume.
03 detached_overload Entered when, during a cycle, the appliance used too much power and was therefore suspended. It is also technically unplugged. The state works only if Appliance Overload State is enabled appliance_overload_state_enabled: true and appliance_suspended_sensor: input_number.some_power_overload_sensor_is_present
04 job_ongoing Signals that a cycle has to be complete and a new or a previous job is ongoing
05 job_completed Entered when the current incomplete job cycle is finished. The appliance uses less power than the Finishing Power threshold ( appliance_finishing_power_threshold) (with the possibility of selecting for how long).