HomeAssistantApiClient.Types (HomeAssistantApiClient v0.1.0)
View SourceShared types used across HomeAssistantApiClient, such as entity types and states.
Summary
Types
This types are for the state of this entity types Binary sensor: Use boolean true = "on" and false = "off". Input boolean: Use boolean. Switch: boolean: Boolean too because it can either be true or false. Automation: The state is a boolean because it either has on or off. Light: Boolean because the state has either on or off. Remote state: Remote control who either has on or off, thats why its a boolean. Input number state: Integer number. Timer: The states it has are either idle, active or paused. Cover: Open, closed, opening, closed, unavailable or unknown.
Types
@type alarm_control_panel_state() :: atom()
@type alarm_password_services() ::
:alarm_disarm
| :alarm_arm_home
| :alarm_arm_away
| :alarm_arm_night
| :alarm_arm_custom_bypass
@type alarm_state() ::
:disarmed
| :arming
| :arming_home
| :arming_away
| :arming_night
| :arming_custom_bypass
| :armed_home
| :armed_away
| :armed_night
| :armed_vacation
| :armed_custom_bypass
| :triggered
| :pending
| :unknown
| :unavailable
@type automation_state() :: boolean()
@type basic_service() :: :turn_on | :turn_off | :toggle
@type binary_sensor_state() :: boolean()
@type cover() :: :opening | :closing | :unavaible | :unknown | :open | :closed
@type domain_with_extra_args() :: :weather | :mqtt | :input_text | :input_select
@type domain_without_extra_values() ::
:input_boolean
| :input_number
| :automation
| :scene
| :script
| :homeassistant
| :input_select
@type entity_id() :: String.t()
This types are for the state of this entity types Binary sensor: Use boolean true = "on" and false = "off". Input boolean: Use boolean. Switch: boolean: Boolean too because it can either be true or false. Automation: The state is a boolean because it either has on or off. Light: Boolean because the state has either on or off. Remote state: Remote control who either has on or off, thats why its a boolean. Input number state: Integer number. Timer: The states it has are either idle, active or paused. Cover: Open, closed, opening, closed, unavailable or unknown.
@type entity_type() ::
:conversation
| :event
| :sensor
| :binary_sensor
| :switch
| :light
| :tts
| :zone
| :person
| :input_number
| :input_select
| :input_boolean
| :alarm_control_panel
| :input_text
| :sun
| :todo
| :automation
| :weather
| :mqtt
| :remote
@type home_assistant_services() :: :restart | :stop
@type input_boolean_state() :: boolean()
@type input_number_services() :: :decrement | :increment | :reload | :set_value
@type input_select_services() ::
:select_option | :set_options | :select_first | :select_last | :reload
@type input_select_state() :: atom()
@type input_text_services() :: :set_value | :reload
@type light_services() :: :turn_on | :turn_off | :toggle
@type light_state() :: boolean()
@type mqtt_services() :: :dump | :publish | :reload
@type remote_state() :: boolean()
@type service() :: atom()
@type sun_state() :: atom()
@type switch_services() :: :turn_on | :turn_off | :toggle
@type switch_state() :: boolean()
@type timer() :: :idle | :active | :paused
@type todo_state() :: integer()
@type weather() :: String.t()
@type weather_services() :: :get_forecasts