dirigera 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bdb01129652a3672f479d750453655d23d8ba1c30376dcd012cac432d60252f
-  data.tar.gz: 27d7c4fd79d539641b384f2f9e09b07186a7853699c03db73c8ee1f64d6b3c66
+  metadata.gz: 000c4ff5d39d54cdf523b1cb3d2177972061cac28144f791dd8053ddd1d28a5a
+  data.tar.gz: 0accf6d71a935486564c2bacb040625eedf6d81b1ae21b3fe5219d485c64f787
 SHA512:
-  metadata.gz: 24349d5707dfd6aaffa706403edeb6423d7ce00f75edca419b41fb99f3f4ed137fdc869a1f1f5d7820640eb460fb89613b45ccc3d2ffe1a6067c0b39e84e0887
-  data.tar.gz: 0af1066ceb05363f2012cfb1426b83ec8123aabc7fa98da55cdeba15b68e0533016378e664a321935be9e8b6039637b866d348dec9a51f8cccdfa8f2a1ff57f6
+  metadata.gz: 266253f0d4a5ca2f5c8f9637c34e75648450359474bc04d4e7b87a453cca13dbf6ed4df9aa8d0d72fb2af88c52d3b83150e3b15065de246093126ab5f3eab358
+  data.tar.gz: 914529e979786f6eeae4091046d880e0e41f53f67a058e6a4d501eda0e70464553f7f37caeb297c01db6c8003960c904d8765b29fcd18949612d016cccb0a191

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 phillipp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Dirigera Hub API client
+
+This gem implements an API client for the IKEA Dirigera hub.
+
+Add it to your Gemfile or install it with gem install
+
+# Quick start
+
+Install it via rubygems:
+
+```
+gem install example
+```
+
+First, you need to get a token. Run the setup.rb from this repository to get it.
+
+Then you can use the client:
+
+```
+require "dirigera"
+
+client = Dirigera::Client.new(
+  '192.168.x.x',
+  'YOURTOKEN'
+)
+
+light = client.lights.last
+
+light.name = 'Any light'
+
+light.on
+sleep 10
+light.off
+
+blinds = client.blinds.last
+
+blinds.up
+sleep 60
+blinds.down
+```
+
+# TODO
+
+- Yeah, I know, there is no specs...
+- Scenes
+- Link devices
+- Set power loss behaviour
+- Implement websocket to receive events

data/dirigera.gemspec

@@ -0,0 +1,16 @@
+require_relative 'lib/dirigera/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dirigera'
+  s.version     = Dirigera::VERSION
+  s.licenses    = ['MIT']
+  s.required_ruby_version = '>= 2.7.0'
+  s.summary     = "API client for the IKEA Dirigera hub using a local connection"
+  s.authors     = ["Phillipp Röll"]
+  s.email       = 'phillipp.roell@trafficplex.de'
+  s.files       = %w[dirigera.gemspec README.md LICENSE] + `git ls-files | grep -E '^lib'`.split("\n")
+  s.homepage    = 'https://rubygems.org/gems/dirigera'
+  s.metadata    = { "source_code_uri" => "https://github.com/phillipp/dirigera" }
+
+  s.add_dependency 'httparty'
+end

data/lib/dirigera/blinds.rb

@@ -0,0 +1,30 @@
+class Dirigera::Blinds < Dirigera::Device
+  def up
+    self.target_level = 0
+  end
+
+  def down
+    self.target_level = 100
+  end
+
+  def state
+    @data['attributes']['blindsState']
+  end
+
+  def current_level
+    @data['attributes']['blindsCurrentLevel']
+  end
+
+  def target_level
+    @data['attributes']['blindsTargetLevel']
+  end
+
+  def target_level=(level)
+    raise ArgumentError, 'level must be between 0 and 100' unless (0..100).include?(level)
+
+    response = @client.patch("/devices/#{id}", [{ attributes: { blindsTargetLevel: level } }])
+    raise 'Failed to update target level' unless response.code == 202
+
+    @data['attributes']['blindsTargetLevel'] = level
+  end
+end

data/lib/dirigera/client.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+
+class Dirigera::Client
+  def initialize(ip, bearer_token)
+    @ip = ip
+    @bearer_token = bearer_token
+  end
+
+  def blinds
+    devices.select { |data| data['type'] == 'blinds' }.map { |data| make_device(data) }
+  end
+
+  def outlets
+    devices.select { |data| data['type'] == 'outlet' }.map { |data| make_device(data) }
+  end
+
+  def lights
+    devices.select { |data| data['type'] == 'light' }.map { |data| make_device(data) }
+  end
+
+  def devices
+    get("/devices")
+  end
+
+  def get(path, params = {})
+    HTTParty.get(
+      "#{base_url}#{path}",
+      query: params,
+      headers: headers,
+      verify: false
+    )
+  end
+
+  def patch(path, data)
+    HTTParty.patch(
+      "#{base_url}#{path}",
+      body: data.to_json,
+      headers: headers,
+      verify: false
+    )
+  end
+
+  private
+
+  def make_device(data)
+    Object.const_get("Dirigera::#{data['deviceType'].capitalize}").new(data, self)
+  rescue NameError
+    Dirigera::Device.new(data, self)
+  end
+
+  def headers
+    {
+      'Authorization': "Bearer #{@bearer_token}",
+      "Content-Type": 'application/json'
+    }
+  end
+
+  def base_url
+    "https://#{@ip}:8443/v1"
+  end
+end

data/lib/dirigera/device.rb

@@ -0,0 +1,51 @@
+class Dirigera::Device
+  def initialize(data, client)
+    @data = data
+    @client = client
+  end
+
+  attr_reader :client
+
+  def id
+    @data['id']
+  end
+
+  def type
+    @data['type']
+  end
+
+  def name
+    @data['attributes']['customName']
+  end
+
+  def created_at
+    Time.parse(@data['createdAt'])
+  end
+
+  def last_seen_at
+    Time.parse(@data['lastSeen'])
+  end
+
+  def battery_level
+    @data['attributes']['batteryPercentage']
+  end
+
+  def reachable?
+    @data['isReachable']
+  end
+
+  def room
+    @data['room']
+  end
+
+  def name=(new_name)
+    response = @client.patch("/devices/#{id}", [{ attributes: { customName: new_name } }])
+    raise "Failed to update name" unless response.code == 202
+
+    @data['attributes']['customName'] = new_name
+  end
+
+  def reload
+    @data = @client.get("/devices/#{id}")
+  end
+end

data/lib/dirigera/light.rb

@@ -0,0 +1,5 @@
+require 'dirigera/on_off_behaviour'
+
+class Dirigera::Light < Dirigera::Device
+  include Dirigera::OnOffBehaviour
+end

data/lib/dirigera/on_off_behaviour.rb

@@ -0,0 +1,23 @@
+module Dirigera::OnOffBehaviour
+  def on?
+    @data['attributes']['isOn']
+  end
+
+  def off?
+    !on?
+  end
+
+  def on
+    response = @client.patch("/devices/#{id}", [{ attributes: { isOn: true } }])
+    raise "Failed to update attribute isOn" unless response.code == 202
+
+    @data['attributes']['isOn'] = true
+  end
+
+  def off
+    response = @client.patch("/devices/#{id}", [{ attributes: { isOn: false } }])
+    raise "Failed to update attribute isOn" unless response.code == 202
+
+    @data['attributes']['isOn'] = false
+  end
+end

data/lib/dirigera/outlet.rb

@@ -0,0 +1,5 @@
+require 'dirigera/on_off_behaviour'
+
+class Dirigera::Outlet < Dirigera::Device
+  include Dirigera::OnOffBehaviour
+end

data/lib/dirigera/version.rb

@@ -0,0 +1,3 @@
+module Dirigera
+  VERSION = '0.1.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dirigera
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Phillipp Röll
@@ -30,7 +30,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- dirigera.gemspec
 - lib/dirigera.rb
+- lib/dirigera/blinds.rb
+- lib/dirigera/client.rb
+- lib/dirigera/device.rb
+- lib/dirigera/light.rb
+- lib/dirigera/on_off_behaviour.rb
+- lib/dirigera/outlet.rb
+- lib/dirigera/version.rb
 homepage: https://rubygems.org/gems/dirigera
 licenses:
 - MIT