ewelink 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6cbd50164b2f25247423b0cece7baee8ec1e6bbc49faa2545ad4c7450feaf3d
+  data.tar.gz: cf1e6148a4cebdb5efd52acfb66feacaa096d51ca2f1cd0b06e7c45b002c6fa1
+SHA512:
+  metadata.gz: e42fdd3244a0a9bb3a176c4ab760ba6100b8a8e9146c68b135044610075a4963d7e2d03df4cec6ae97febdcff21966d638ba9f4b6dd8e774c436acdf75174e0b
+  data.tar.gz: 204e83b06e6b788095352b97f5553291ec20bca0e4191695abc30f72cf898be9194bc04b3518fd61220f45250a90dac6054cfc184bdc10400639c8dca70efbaa

data/README.mdown

@@ -0,0 +1,84 @@
+# Ewelink
+
+Ruby API to manage eWeLink smart home devices.
+
+## Installation
+
+Just add this into your `Gemfile`:
+
+```ruby
+gem 'ewelink'
+```
+
+Then, just run `bundle install`.
+
+## Examples
+
+### Displaying all switches
+
+```ruby
+require 'ewelink'
+
+api = Ewelink::Api.new(email: 'john@example.com', password: 'secr$t')
+api.switches.each do |switch|
+  puts switch[:name]
+  puts switch[:uuid]
+end
+```
+
+`email` or `phone_number` must be specified for authentication.
+
+### Displaying all RF bridge buttons
+
+```ruby
+require 'ewelink'
+
+api = Ewelink::Api.new(email: 'john@example.com', password: 'secr$t')
+api.rf_bridge_buttons.each do |button|
+  puts button[:name]
+  puts button[:uuid]
+end
+```
+
+### Set switch on or off
+
+```ruby
+require 'ewelink'
+
+api = Ewelink::Api.new(phone_number: '+687 414243', password: 'secr$t')
+api.switch_on!(switch[:uuid])
+api.switch_off!(switch[:uuid])
+```
+
+### Check if switch is on or off
+
+```ruby
+require 'ewelink'
+
+api = Ewelink::Api.new(phone_number: '+687 414243', password: 'secr$t')
+puts api.switch_on?(switch[:uuid])
+puts api.switch_off?(switch[:uuid])
+```
+
+### Press RF bridge button
+
+```ruby
+require 'ewelink'
+
+api = Ewelink::Api.new(email: 'john@example.com', password: 'secr$t')
+api.press_rf_bridge_button!(button[:uuid])
+```
+
+### Configuring logger
+
+In order to have some debug informations about what kagu does, you could
+configure its logger:
+
+```ruby
+Ewelink.logger = Logger.new(STDERR)
+```
+
+### Executable
+
+This gem also provides a `ewelink` executable, just run it with
+`--help` option to get all available options.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/ewelink

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/ewelink'
+
+Ewelink.logger = Logger.new(STDOUT, formatter: -> (severity, time, progname, message) {
+  text = ''
+  text << "[#{progname}] " if progname.present?
+  text << message.to_s << "\n"
+})
+Ewelink.logger.level = :warn
+
+begin
+  Ewelink::Runner.new.run
+rescue => e
+  Ewelink.logger.fatal(Ewelink::Runner.name) { e }
+  exit(1)
+end

data/ewelink.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'ewelink'
+  s.version = File.read("#{File.dirname(__FILE__)}/VERSION").strip
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Alexis Toulotte'
+  s.email = 'al@alweb.org'
+  s.homepage = 'https://github.com/alexistoulotte/ewelink'
+  s.summary = 'Manage eWeLink devices'
+  s.description = 'Manage eWeLink smart home devices'
+  s.license = 'MIT'
+
+  s.files = `git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)'`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_dependency 'activesupport', '>= 6.0.0', '< 7.0.0'
+  s.add_dependency 'httparty', '>= 0.18.0', '< 0.19.0'
+
+  s.add_development_dependency 'byebug', '>= 11.0.0', '< 12.0.0'
+  s.add_development_dependency 'rake', '>= 12.0.0', '< 13.0.0'
+end

data/lib/ewelink/api.rb

@@ -0,0 +1,226 @@
+module Ewelink
+
+  class Api
+
+    APP_ID = 'oeVkj2lYFGnJu5XUtWisfW4utiN4u9Mq'
+    APP_SECRET = '6Nz4n0xA8s8qdxQf2GqurZj2Fs55FUvM'
+    DEFAULT_REGION = 'us'
+    RF_BRIDGE_DEVICE_UIID = 28
+    SWITCH_DEVICES_UIIDS = [1, 5, 6, 24]
+    TIMEOUT = 10
+    URL = 'https://#{region}-api.coolkit.cc:8080'
+    UUID_NAMESPACE = 'e25750fb-3710-41af-b831-23224f4dd609';
+    VERSION = 8
+
+    attr_reader :email, :password, :phone_number
+
+    def initialize(email: nil, password:, phone_number: nil)
+      @email = email.presence.try(:strip)
+      @mutexs = {}
+      @password = password.presence || raise(Error.new(":password must be specified"))
+      @phone_number = phone_number.presence.try(:strip)
+      raise(Error.new(":email or :phone_number must be specified")) if email.blank? && phone_number.blank?
+    end
+
+    def press_rf_bridge_button!(uuid)
+      button = find_rf_bridge_button!(uuid)
+      params = {
+        'appid' => APP_ID,
+        'deviceid' => button[:device_id],
+        'nonce' => nonce,
+        'params' => {
+          'cmd' => 'transmit',
+          'rfChl' => button[:channel],
+        },
+        'ts' => Time.now.to_i,
+        'version' => VERSION,
+      }
+      http_request(:post, '/api/user/device/status', body: JSON.generate(params), headers: authentication_headers)
+      true
+    end
+
+    def reload
+      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices & region cache)' }
+      [:@authentication_token, :@devices, :@rf_bridge_buttons, :@region, :@switches].each do |variable|
+        remove_instance_variable(variable) if instance_variable_defined?(variable)
+      end
+      self
+    end
+
+    def rf_bridge_buttons
+      @rf_bridge_buttons ||= [].tap do |buttons|
+        rf_bridge_devices = devices.select { |device| device['uiid'] == RF_BRIDGE_DEVICE_UIID }.tap do |devices|
+          Ewelink.logger.debug(self.class.name) { "Found #{devices.size} RF 433MHz Bridge device(s)" }
+        end
+        rf_bridge_devices.each do |device|
+          device_id = device['deviceid'].presence || next
+          device_name = device['name'].presence || next
+          buttons = device['params']['rfList'].each do |rf|
+            button = {
+              channel: rf['rfChl'],
+              device_id: device_id,
+              device_name: device_name,
+            }
+            remote_info = device['tags']['zyx_info'].find { |info| info['buttonName'].find { |data| data.key?(button[:channel].to_s) } }.presence || next
+            remote_name = remote_info['name'].try(:squish).presence || next
+            button_info = remote_info['buttonName'].find { |info| info.key?(button[:channel].to_s) }.presence || next
+            button_name = button_info.values.first.try(:squish).presence || next
+            button.merge!({
+              name: button_name,
+              remote_name: remote_name,
+              remote_type: remote_info['remote_type'],
+            })
+            button[:uuid] = Digest::UUID.uuid_v5(UUID_NAMESPACE, "#{button[:device_id]}/#{button[:channel]}")
+            buttons << button
+          end
+        end
+      end.tap { |buttons| Ewelink.logger.debug(self.class.name) { "Found #{buttons.size} RF 433MHz bridge button(s)" } }
+    end
+
+    def switch_off!(uuid)
+      update_switch_on!(uuid, false)
+    end
+
+    def switch_off?(uuid)
+      !switch_on?(uuid)
+    end
+
+    def switch_on!(uuid)
+      update_switch_on!(uuid, true)
+    end
+
+    def switch_on?(uuid)
+      switch = find_switch!(uuid)
+      params = {
+        'appid' => APP_ID,
+        'deviceid' => switch[:device_id],
+        'nonce' => nonce,
+        'ts' => Time.now.to_i,
+        'version' => VERSION,
+      }
+      response = http_request(:get, '/api/user/device/status', headers: authentication_headers, query: params)
+      response['params']['switch'] == 'on'
+    end
+
+    def switches
+      @switches ||= [].tap do |switches|
+        switch_devices = devices.select { |device| SWITCH_DEVICES_UIIDS.include?(device['uiid']) }.tap do |devices|
+          Ewelink.logger.debug(self.class.name) { "Found #{devices.size} switch device(s)" }
+        end
+        switch_devices.each do |device|
+          device_id = device['deviceid'].presence || next
+          name = device['name'].presence || next
+          switch = {
+            device_id: device_id,
+            name: name,
+          }
+          switch[:uuid] = Digest::UUID.uuid_v5(UUID_NAMESPACE, switch[:device_id])
+          switches << switch
+        end
+      end.tap { |switches| Ewelink.logger.debug(self.class.name) { "Found #{switches.size} switch(es)" } }
+    end
+
+    private
+
+    def authentication_headers
+      { 'Authorization' => "Bearer #{authentication_token}" }
+    end
+
+    def authentication_token
+      synchronize(:authentication_token) do
+        @authentication_token ||= begin
+          params = {
+            'appid' => APP_ID,
+            'imei' => SecureRandom.uuid.upcase,
+            'nonce' => nonce,
+            'password' => password,
+            'ts' => Time.now.to_i,
+            'version' => VERSION,
+          }
+          if email.present?
+            params['email'] = email
+          else
+            params['phoneNumber'] = phone_number
+          end
+          body = JSON.generate(params)
+          response = http_request(:post, '/api/user/login', { body: body, headers: { 'Authorization' => "Sign #{Base64.encode64(OpenSSL::HMAC.digest('SHA256', APP_SECRET, body))}" } })
+          raise(Error.new('Authentication token not found')) if response['at'].blank?
+          response['at'].tap { Ewelink.logger.debug(self.class.name) { 'Authentication token found' } }
+        end
+      end
+    end
+
+    def devices
+      synchronize(:devices) do
+        @devices ||= begin
+          params = {
+            'appid' => APP_ID,
+            'getTags' => 1,
+            'nonce' => nonce,
+            'ts' => Time.now.to_i,
+            'version' => VERSION,
+          }
+          response = http_request(:get, '/api/user/device', headers: authentication_headers, query: params)
+          response['devicelist'].tap { |devices| Ewelink.logger.debug(self.class.name) { "Found #{devices.size} device(s)" } }
+        end
+      end
+    end
+
+    def find_rf_bridge_button!(uuid)
+      rf_bridge_buttons.find { |button| button[:uuid] == uuid } || raise(Error.new("No such RF bridge button with UUID: #{uuid.inspect}"))
+    end
+
+    def find_switch!(uuid)
+      switches.find { |switch| switch[:uuid] == uuid } || raise(Error.new("No such switch with UUID: #{uuid.inspect}"))
+    end
+
+    def nonce
+      SecureRandom.hex[0, 8]
+    end
+
+    def region
+      @region ||= DEFAULT_REGION
+    end
+
+    def http_request(method, path, options = {})
+      url = "#{URL.gsub('#{region}', region)}#{path}"
+      method = method.to_s.upcase
+      headers = (options[:headers] || {}).reverse_merge('Content-Type' => 'application/json')
+      Ewelink.logger.debug(self.class.name) { "#{method} #{url}" }
+      response = synchronize(:http_request) { HTTParty.send(method.downcase, url, options.merge(headers: headers).reverse_merge(timeout: TIMEOUT)) }
+      raise(Error.new("#{method} #{url}: #{response.code}")) unless response.success?
+      if response['error'] == 301 && response['region'].present?
+        @region = response['region']
+        Ewelink.logger.debug(self.class.name) { "Switched to region #{region.inspect}" }
+        return http_request(method, path, options)
+      end
+      remove_instance_variable(:@authentication_token) if instance_variable_defined?(:@authentication_token) && [401, 403].include?(response['error'])
+      raise(Error.new("#{method} #{url}: #{response['error']} #{response['msg']}".strip)) if response['error'].present? && response['error'] != 0
+      response
+    rescue Errno::ECONNREFUSED, OpenSSL::OpenSSLError, SocketError, Timeout::Error => e
+      raise Error.new(e)
+    end
+
+    def synchronize(name, &block)
+      (@mutexs[name] ||= Mutex.new).synchronize(&block)
+    end
+
+    def update_switch_on!(uuid, on)
+      switch = find_switch!(uuid)
+      params = {
+        'appid' => APP_ID,
+        'deviceid' => switch[:device_id],
+        'nonce' => nonce,
+        'params' => {
+          'switch' => on ? 'on' : 'off',
+        },
+        'ts' => Time.now.to_i,
+        'version' => VERSION,
+      }
+      http_request(:post, '/api/user/device/status', body: JSON.generate(params), headers: authentication_headers)
+      true
+    end
+
+  end
+
+end

data/lib/ewelink/error.rb

@@ -0,0 +1,6 @@
+module Ewelink
+
+  class Error < StandardError
+  end
+
+end

data/lib/ewelink/runner.rb

@@ -0,0 +1,78 @@
+module Ewelink
+
+  class Runner
+
+    def run
+      api = Api.new(options.slice(:email, :password, :phone_number))
+      puts(JSON.pretty_generate(api.switches)) if options[:list_switches]
+      puts(JSON.pretty_generate(api.rf_bridge_buttons)) if options[:list_rf_bridge_buttons]
+      options[:switches_on_uuids].each { |uuid| api.switch_on!(uuid) }
+      options[:switches_off_uuids].each { |uuid| api.switch_off!(uuid) }
+      options[:press_rf_bridge_buttons_uuids].each { |uuid| api.press_rf_bridge_button!(uuid) }
+    end
+
+    private
+
+    def options
+      @options ||= begin
+        options = { press_rf_bridge_buttons_uuids: [], switches_off_uuids: [], switches_on_uuids: [] }
+        parser = OptionParser.new do |opts|
+          opts.banner = 'Manage eWeLink smart home devices'
+          opts.version = File.read(File.expand_path('../../VERSION', __dir__)).strip
+          opts.separator('')
+          opts.separator('Usage: ewelink [options]')
+          opts.separator('')
+          opts.on('-e', '--email EMAIL', "eWeLink account's email (mandatory if phone number is not specified)") do |email|
+            options[:email] = email
+          end
+          opts.on('-p', '--password PASSWORD', "eWeLink account's password (mandatory, prompted if not specified on command line)") do |password|
+            options[:password] = password
+          end
+          opts.on('-n', '--phone-number PHONE_NUMBER', "eWeLink account's phone number (mandatory if email is not specified)") do |phone_number|
+            options[:phone_number] = phone_number
+          end
+          opts.on('--list-switches', 'List all switches in JSON format') do
+            options[:list_switches] = true
+          end
+          opts.on('--list-rf-bridge-buttons', 'List all RF 433MHz bridge buttons in JSON format') do
+            options[:list_rf_bridge_buttons] = true
+          end
+          opts.on('--switch-on SWITCH_UUID', 'Set the switch with specified UUID on') do |uuid|
+            options[:switches_on_uuids] << uuid
+          end
+          opts.on('--switch-off SWITCH_UUID', 'Set the switch with specified UUID off') do |uuid|
+            options[:switches_off_uuids] << uuid
+          end
+          opts.on('--press-rf-bridge-button BUTTON_UUID', 'Press RF 433MHz bridge button with specified UUID') do |uuid|
+            options[:press_rf_bridge_buttons_uuids] << uuid
+          end
+          opts.on('-v', '--verbose', 'Verbose mode') do
+            Ewelink.logger.level = :debug
+          end
+        end
+        arguments = parser.parse!
+        if arguments.any?
+          STDERR.puts("Invalid option specified: #{arguments.first}")
+          STDERR.puts(parser.summarize)
+          exit(1)
+        end
+        if options[:email].blank? && options[:phone_number].blank?
+          STDERR.puts('Email or phone number must be specified')
+          STDERR.puts(parser.summarize)
+          exit(1)
+        end
+        if [:list_switches, :list_rf_bridge_buttons, :switches_on_uuids, :switches_off_uuids, :press_rf_bridge_buttons_uuids].map { |action| options[action] }.all?(&:blank?)
+          STDERR.puts('An action must be specified (listing switches, press RF bridge button, etc.)')
+          STDERR.puts(parser.summarize)
+          exit(1)
+        end
+        while options[:password].blank?
+          options[:password] = IO::console.getpass("Enter eWeLink account's password: ")
+        end
+        options
+      end
+    end
+
+  end
+
+end

data/lib/ewelink.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'byebug' if ENV['DEBUGGER']
+require 'httparty'
+require 'io/console'
+require 'json'
+require 'logger'
+require 'openssl'
+require 'optparse'
+
+module Ewelink
+
+  mattr_accessor :logger
+  self.logger = Logger.new(nil)
+
+end
+
+require_relative 'ewelink/api'
+require_relative 'ewelink/error'
+require_relative 'ewelink/runner'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: ewelink
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexis Toulotte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+description: Manage eWeLink smart home devices
+email: al@alweb.org
+executables:
+- ewelink
+extensions: []
+extra_rdoc_files: []
+files:
+- README.mdown
+- VERSION
+- bin/ewelink
+- ewelink.gemspec
+- lib/ewelink.rb
+- lib/ewelink/api.rb
+- lib/ewelink/error.rb
+- lib/ewelink/runner.rb
+homepage: https://github.com/alexistoulotte/ewelink
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Manage eWeLink devices
+test_files: []