esphome 0.6.0 → 1.1.0

data/lib/esphome/api.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require_relative "api/api_pb"
+require_relative "action"
+require_relative "entity"
+
+module ESPHome
+  module Api
+    ID_TO_MESSAGE = [nil,
+                     HelloRequest,
+                     HelloResponse,
+                     AuthenticationRequest,
+                     AuthenticationResponse,
+                     DisconnectRequest,
+                     DisconnectResponse,
+                     PingRequest,
+                     PingResponse,
+                     DeviceInfoRequest,
+                     DeviceInfoResponse,
+                     ListEntitiesRequest,
+                     ListEntitiesBinarySensorResponse,
+                     ListEntitiesCoverResponse,
+                     ListEntitiesFanResponse,
+                     ListEntitiesLightResponse,
+                     ListEntitiesSensorResponse,
+                     ListEntitiesSwitchResponse,
+                     ListEntitiesTextSensorResponse,
+                     ListEntitiesDoneResponse,
+                     SubscribeStatesRequest,
+                     BinarySensorStateResponse,
+                     CoverStateResponse,
+                     FanStateResponse,
+                     LightStateResponse,
+                     SensorStateResponse,
+                     SwitchStateResponse,
+                     TextSensorStateResponse,
+                     SubscribeLogsRequest,
+                     SubscribeLogsResponse,
+                     CoverCommandRequest,
+                     FanCommandRequest,
+                     LightCommandRequest,
+                     SwitchCommandRequest,
+                     SubscribeHomeassistantServicesRequest,
+                     HomeassistantActionRequest,
+                     GetTimeRequest,
+                     GetTimeResponse,
+                     SubscribeHomeAssistantStatesRequest,
+                     SubscribeHomeAssistantStateResponse,
+                     HomeAssistantStateResponse,
+                     ListEntitiesServicesResponse,
+                     ExecuteServiceRequest,
+                     ListEntitiesCameraResponse,
+                     CameraImageResponse,
+                     CameraImageRequest,
+                     ListEntitiesClimateResponse,
+                     ClimateStateResponse,
+                     ClimateCommandRequest,
+                     ListEntitiesNumberResponse,
+                     NumberStateResponse,
+                     NumberCommandRequest,
+                     ListEntitiesSelectResponse,
+                     SelectStateResponse,
+                     SelectCommandRequest,
+                     ListEntitiesSirenResponse,
+                     SirenStateResponse,
+                     SirenCommandRequest,
+                     ListEntitiesLockResponse,
+                     LockStateResponse,
+                     LockCommandRequest,
+                     ListEntitiesButtonResponse,
+                     ButtonCommandRequest,
+                     ListEntitiesMediaPlayerResponse,
+                     MediaPlayerStateResponse,
+                     MediaPlayerCommandRequest,
+                     SubscribeBluetoothLEAdvertisementsRequest,
+                     BluetoothLEAdvertisementResponse,
+                     BluetoothDeviceRequest,
+                     BluetoothDeviceConnectionResponse,
+                     BluetoothGATTGetServicesRequest,
+                     BluetoothGATTGetServicesResponse,
+                     BluetoothGATTGetServicesDoneResponse,
+                     BluetoothGATTReadRequest,
+                     BluetoothGATTReadResponse,
+                     BluetoothGATTWriteRequest,
+                     BluetoothGATTReadDescriptorRequest,
+                     BluetoothGATTWriteDescriptorRequest,
+                     BluetoothGATTNotifyRequest,
+                     BluetoothGATTNotifyDataResponse,
+                     SubscribeBluetoothConnectionsFreeRequest,
+                     BluetoothConnectionsFreeResponse,
+                     BluetoothGATTErrorResponse,
+                     BluetoothGATTWriteResponse,
+                     BluetoothGATTNotifyResponse,
+                     BluetoothDevicePairingResponse,
+                     BluetoothDeviceUnpairingResponse,
+                     UnsubscribeBluetoothLEAdvertisementsRequest,
+                     BluetoothDeviceClearCacheResponse,
+                     SubscribeVoiceAssistantRequest,
+                     VoiceAssistantRequest,
+                     VoiceAssistantResponse,
+                     VoiceAssistantEventResponse,
+                     BluetoothLERawAdvertisementsResponse,
+                     ListEntitiesAlarmControlPanelResponse,
+                     AlarmControlPanelStateResponse,
+                     AlarmControlPanelCommandRequest,
+                     ListEntitiesTextResponse,
+                     TextStateResponse,
+                     TextCommandRequest,
+                     ListEntitiesDateResponse,
+                     DateStateResponse,
+                     DateCommandRequest,
+                     ListEntitiesTimeResponse,
+                     TimeStateResponse,
+                     TimeCommandRequest,
+                     VoiceAssistantAudio,
+                     ListEntitiesEventResponse,
+                     EventResponse,
+                     ListEntitiesValveResponse,
+                     ValveStateResponse,
+                     ValveCommandRequest,
+                     ListEntitiesDateTimeResponse,
+                     DateTimeStateResponse,
+                     DateTimeCommandRequest,
+                     VoiceAssistantTimerEventResponse,
+                     ListEntitiesUpdateResponse,
+                     UpdateStateResponse,
+                     UpdateCommandRequest,
+                     VoiceAssistantAnnounceRequest,
+                     VoiceAssistantAnnounceFinished,
+                     VoiceAssistantConfigurationRequest,
+                     VoiceAssistantConfigurationResponse,
+                     VoiceAssistantSetConfiguration,
+                     NoiseEncryptionSetKeyRequest,
+                     NoiseEncryptionSetKeyResponse,
+                     BluetoothScannerStateResponse,
+                     BluetoothScannerSetModeRequest,
+                     ZWaveProxyFrame,
+                     ZWaveProxyRequest,
+                     HomeassistantActionResponse,
+                     ExecuteServiceResponse,
+                     ListEntitiesWaterHeaterResponse,
+                     WaterHeaterStateResponse,
+                     WaterHeaterCommandRequest,
+                     ListEntitiesInfraredResponse,
+                     InfraredRFTransmitRawTimingsRequest,
+                     InfraredRFReceiveEvent,
+                     SerialProxyConfigureRequest,
+                     SerialProxyDataReceived,
+                     SerialProxyWriteRequest,
+                     SerialProxySetModemPinsRequest,
+                     SerialProxyGetModemPinsRequest,
+                     SerialProxyGetModemPinsResponse,
+                     SerialProxyRequest,
+                     BluetoothSetConnectionParamsRequest,
+                     BluetoothSetConnectionParamsResponse,
+                     SerialProxyRequestResponse,
+                     ListEntitiesRadioFrequencyResponse].each_with_index.filter_map do |klass, index|
+      next unless klass
+
+      klass.descriptor.define_singleton_method(:id) { index }
+
+      [index, klass]
+    end.to_h.freeze
+
+    def ListEntitiesBinarySensorResponse.entity_class = Entities::BinarySensor
+    def ListEntitiesButtonResponse.entity_class = Entities::Button
+    def ListEntitiesClimateResponse.entity_class = Entities::Climate
+    def ListEntitiesCoverResponse.entity_class = Entities::Cover
+    def ListEntitiesDateResponse.entity_class = Entities::Date
+    def ListEntitiesDateTimeResponse.entity_class = Entities::DateTime
+    def ListEntitiesFanResponse.entity_class = Entities::Fan
+    def ListEntitiesLightResponse.entity_class = Entities::Light
+    def ListEntitiesLockResponse.entity_class = Entities::Lock
+    def ListEntitiesNumberResponse.entity_class = Entities::Number
+    def ListEntitiesSelectResponse.entity_class = Entities::Select
+    def ListEntitiesSensorResponse.entity_class = Entities::Sensor
+    def ListEntitiesSwitchResponse.entity_class = Entities::Switch
+    def ListEntitiesTextResponse.entity_class = Entities::Text
+    def ListEntitiesTextSensorResponse.entity_class = Entities::TextSensor
+    def ListEntitiesTimeResponse.entity_class = Entities::Time
+  end
+end

data/lib/esphome/cli/colors.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ESPHome
+  module Cli
+    module Colors
+      ANSI_COLOR_MAP = {
+        30 => Curses::COLOR_BLACK,
+        31 => Curses::COLOR_RED,
+        32 => Curses::COLOR_GREEN,
+        33 => Curses::COLOR_YELLOW,
+        34 => Curses::COLOR_BLUE,
+        35 => Curses::COLOR_MAGENTA,
+        36 => Curses::COLOR_CYAN,
+        37 => Curses::COLOR_WHITE
+      }.freeze
+
+      # Regex to match ANSI color codes (like \e[31m)
+      ANSI_ESCAPE_REGEX = /\e\[(\d+(?:;\d+)*)m/
+
+      private
+
+      def parse_sgr_codes(codes)
+        color = nil
+        attr = Curses::A_NORMAL
+
+        codes.each do |code|
+          code = code.to_i
+          if ANSI_COLOR_MAP.key?(code)
+            color = ANSI_COLOR_MAP[code]
+          elsif code == 1
+            attr |= Curses::A_BOLD
+          elsif code == 4
+            attr |= Curses::A_UNDERLINE
+          elsif code.zero?
+            attr = Curses::A_NORMAL
+            color = nil
+          end
+        end
+
+        [color, attr]
+      end
+    end
+  end
+end

data/lib/esphome/cli/completion.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require "uri"
+
+require "esphome/dashboard"
+
+module ESPHome
+  module Cli
+    module Completion
+      class << self
+        def run(prefix: ARGV[1].to_s,
+                comp_line: ENV["COMP_LINE"],
+                multi: false)
+          argv = Shellwords.split(comp_line || "")[1..]
+          dashboard_uri, argv = extract_dashboard_uri(argv)
+          return if argv.length > 1 && !multi
+
+          dashboard = ESPHome::Dashboard.new(dashboard_uri)
+          puts dashboard.devices
+                        .filter_map { |device| device["name"] }
+                        .select { |name| name.start_with?(prefix) }
+                        .sort
+        rescue HTTPX::Error, IOError, SocketError, SystemCallError, Timeout::Error
+          nil
+        end
+
+        private
+
+        def extract_dashboard_uri(argv)
+          argv ||= []
+          dashboard_uri = Dashboard::DEFAULT_URI
+          if argv[0]
+            uri = URI.parse(argv[0])
+            if uri.scheme
+              dashboard_uri = uri.to_s
+              argv = argv[1..]
+            end
+          end
+
+          [dashboard_uri, argv]
+        rescue URI::InvalidURIError
+          [dashboard_uri, argv]
+        end
+      end
+    end
+  end
+end

data/lib/esphome/cli/entities/button.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ESPHome
+  module Cli
+    module Entities
+      class Button < Entity
+        def formatted_state
+          "PRESS"
+        end
+
+        def activate
+          cli.info("Pressing #{object_id_}")
+          press
+        end
+      end
+    end
+  end
+end

data/lib/esphome/cli/entities/climate.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require_relative "form"
+require_relative "subfields"
+
+module ESPHome
+  module Cli
+    module Entities
+      class Climate < Subfields
+        include FormPrompt
+
+        private
+
+        def subfields
+          items = [:mode]
+          if two_point_target_temperature?
+            items << :target_temperature_low
+            items << :target_temperature_high
+          else
+            items << :target_temperature
+          end
+          items << :fan_mode unless supported_fan_modes.empty?
+          items << :swing_mode unless supported_swing_modes.empty?
+          items << :preset unless supported_presets.empty?
+          items << :target_humidity if target_humidity?
+          items
+        end
+
+        def subfield_segment_indexes
+          segment_index = 0
+          indexes = { mode: segment_index }
+
+          segment_index += 1 if action?
+          segment_index += 1 if current_temperature?
+
+          segment_index += 1
+          if two_point_target_temperature?
+            indexes[:target_temperature_low] = segment_index
+          else
+            indexes[:target_temperature] = segment_index
+          end
+          if two_point_target_temperature?
+            segment_index += 1 # literal "-"
+            segment_index += 1
+            indexes[:target_temperature_high] = segment_index
+          end
+
+          unless supported_fan_modes.empty?
+            segment_index += 1
+            indexes[:fan_mode] = segment_index
+          end
+
+          unless supported_swing_modes.empty?
+            segment_index += 1
+            indexes[:swing_mode] = segment_index
+          end
+
+          unless supported_presets.empty?
+            segment_index += 1
+            indexes[:preset] = segment_index
+          end
+
+          segment_index += 1 if current_humidity?
+          segment_index += 1 if current_humidity? && target_humidity?
+          indexes[:target_humidity] = segment_index + 1 if target_humidity?
+          indexes
+        end
+
+        def highlighted_segment_parts(idx, segment)
+          selected_subfield = active_subfield
+
+          if idx == highlighted_segment_index && selected_subfield == :fan_mode
+            value = (fan_mode || "-").to_s
+            [formatted_fan_segment.delete_suffix(value), value, ""]
+          elsif idx == highlighted_segment_index && selected_subfield == :swing_mode
+            value = (swing_mode || "-").to_s
+            [formatted_swing_segment.delete_suffix(value), value, ""]
+          else
+            ["", segment, ""]
+          end
+        end
+
+        def activate_mode
+          choice = prompt_menu("Mode", supported_modes.map(&:to_s), state&.to_s)
+          return unless choice
+
+          cli.info("Setting #{object_id_} mode to #{choice}")
+          change_mode(choice)
+        end
+
+        def activate_fan_mode
+          choice = prompt_menu("Fan Mode", supported_fan_modes.map(&:to_s), fan_mode&.to_s)
+          return unless choice
+
+          cli.info("Setting #{object_id_} fan mode to #{choice}")
+          change_fan_mode(choice)
+        end
+
+        def activate_swing_mode
+          choice = prompt_menu("Swing Mode", supported_swing_modes.map(&:to_s), swing_mode&.to_s)
+          return unless choice
+
+          cli.info("Setting #{object_id_} swing mode to #{choice}")
+          change_swing_mode(choice)
+        end
+
+        def activate_preset
+          options = supported_presets.map(&:to_s)
+          choice = prompt_menu("Preset", options, preset&.to_s)
+          return unless choice
+
+          cli.info("Setting #{object_id_} preset to #{choice}")
+          change_preset(choice)
+        end
+
+        def activate_target_temperature
+          value = prompt_number("Target Temperature",
+                                initial_value: target_temperature,
+                                suffix: unit_symbol)
+          return unless value
+
+          cli.info("Setting #{object_id_} target to #{format_temperature(value)}")
+          change_target_temperature(value)
+        end
+
+        def activate_target_temperature_low
+          value = prompt_number("Target Low",
+                                initial_value: target_temperature_low,
+                                suffix: unit_symbol)
+          return unless value
+
+          cli.info("Setting #{object_id_} target low to #{format_temperature(value)}")
+          change_target_temperature(low: value)
+        end
+
+        def activate_target_temperature_high
+          value = prompt_number("Target High",
+                                initial_value: target_temperature_high,
+                                suffix: unit_symbol)
+          return unless value
+
+          cli.info("Setting #{object_id_} target high to #{format_temperature(value)}")
+          change_target_temperature(high: value)
+        end
+
+        def activate_target_humidity
+          value = prompt_number("Target Humidity",
+                                initial_value: target_humidity,
+                                suffix: "%RH",
+                                decimals: 0,
+                                range: visual_humidity_range)
+          return unless value
+
+          cli.info("Setting #{object_id_} target humidity to #{format_humidity(value)}")
+          change_target_humidity(value)
+        end
+
+        def prompt_number(title, initial_value:, suffix:, decimals: nil, range: nil)
+          decimals ||= temperature_decimals
+          initial_value = format("%.#{decimals}f", initial_value) if initial_value
+          value = prompt_form(title,
+                              initial_value:,
+                              suffix:,
+                              field_width: number_field_width(range, decimals))
+          return unless value
+
+          normalize_number(value, range:, decimals:)
+        end
+
+        def normalize_number(value, range:, decimals:)
+          number = Float(value)
+          number = number.round(decimals)
+          return number unless range
+
+          number.clamp(range)
+        rescue ArgumentError
+          cli.error("Invalid number: #{value}")
+          nil
+        end
+
+        def number_field_width(range, decimals)
+          range ||= visual_temperature_range
+          [
+            number_display_width(range.begin, decimals),
+            number_display_width(range.end, decimals),
+            6
+          ].max
+        end
+
+        def number_display_width(number, decimals)
+          format("%.#{decimals}f", number).length
+        end
+      end
+    end
+  end
+end

data/lib/esphome/cli/entities/cover.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "form"
+require_relative "subfields"
+
+module ESPHome
+  module Cli
+    module Entities
+      class Cover < Subfields
+        include FormPrompt
+
+        VERBS = {
+          open: "Opening",
+          close: "Closing",
+          stop: "Stopping"
+        }.freeze
+        private_constant :VERBS
+
+        private
+
+        def subfields
+          items = []
+          items << :position if position?
+          items << :tilt if tilt?
+          items << :current_operation
+          items
+        end
+
+        def subfield_segment_indexes
+          segment_index = 0
+          indexes = {}
+          indexes[:position] = segment_index if position?
+          if tilt?
+            segment_index += 2
+            indexes[:tilt] = segment_index
+          end
+          segment_index += 1
+          indexes[:current_operation] = segment_index
+          indexes
+        end
+
+        def highlighted_segment_parts(idx, segment)
+          return ["", segment, ""] unless idx == highlighted_segment_index && active_subfield == :current_operation
+
+          value = (current_operation || "-").to_s
+          ["(", value, ")"]
+        end
+
+        def activate_position
+          value = prompt_percentage("Position", position)
+          return if value.nil?
+
+          cli.info("Setting #{object_id_} position to #{percentage_label(value)}")
+          command(position: value)
+        end
+
+        def activate_tilt
+          value = prompt_percentage("Tilt", tilt)
+          return if value.nil?
+
+          cli.info("Setting #{object_id_} tilt to #{percentage_label(value)}")
+          command(tilt: value)
+        end
+
+        def activate_current_operation
+          choice = prompt_menu("Operation", operation_options, current_operation_option)
+          return unless choice
+
+          choice = choice.to_sym
+          cli.info("#{VERBS[choice]} #{object_id_}")
+          __send__(choice)
+        end
+
+        def prompt_percentage(title, value)
+          initial_value = format("%d", (value * 100).round) if value.finite?
+          choice = prompt_form(title,
+                               initial_value:,
+                               suffix: "%",
+                               field_width: 3)
+          return unless choice
+
+          normalize_percentage(choice)
+        end
+
+        def percentage_label(value)
+          "#{(value * 100).round}%"
+        end
+
+        def normalize_percentage(value)
+          value = Float(value).round.clamp(0, 100)
+          value / 100.0
+        rescue ArgumentError
+          cli.error("Invalid percentage: #{value}")
+          nil
+        end
+
+        def operation_options
+          options = %w[open close]
+          options << "stop" if stop?
+          options
+        end
+
+        def current_operation_option
+          case current_operation
+          when :opening
+            "open"
+          when :closing
+            "close"
+          when :idle
+            "stop" if stop?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/esphome/cli/entities/date.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "form"
+
+module ESPHome
+  module Cli
+    module Entities
+      class Date < Form
+        def length_range
+          3..11
+        end
+
+        def command(value)
+          begin
+            value = Date.parse(value)
+          rescue ArgumentError
+            cli.error("Invalid date: #{value}")
+            return
+          end
+
+          cli.info("Setting #{object_id_} to #{value.iso8601}")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/esphome/cli/entities/date_time.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "time"
+
+require_relative "form"
+
+module ESPHome
+  module Cli
+    module Entities
+      class DateTime < Form
+        def length_range
+          25..25
+        end
+
+        def command(value)
+          begin
+            value = Time.parse(value)
+          rescue ArgumentError
+            cli.error("Invalid timestamp: #{value}")
+            return
+          end
+
+          cli.info("Setting #{object_id_} to #{value.iso8601}")
+          super
+        end
+      end
+    end
+  end
+end