hass-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 424e5b5945d9b3664fcd367db46bf2afe2f8473e4fa225cd0ee6824e7c2f0e76
-  data.tar.gz: 8b3191a2e3aaf64f253c0f957a01003a8258ac83bcae04320d31d58887d51d6c
+  metadata.gz: 37eb66063f66121647a2b626e3d05fd3eb2510e366b567b0efe0cd090229294f
+  data.tar.gz: b4527ad41c79ebc1772eb0d4f3daa434d0e44a4e23d91b607e6ed0e586fee7cc
 SHA512:
-  metadata.gz: 8d8480e5f51bdc57622714871afca209e35943305e32015f7411b1d6305191ac3e1579065f534fda3c484142bc577d71ef6d5b6b4b505f86f778808514d74808
-  data.tar.gz: 8ea81f919350830449e0d4b6b4e71188cef3dde701f3a17730df3c777abcb2410123db9100917298b22faef273b8c8f8a928666c39d3a60dc399bf244c3dc09f
+  metadata.gz: f7cb29f7185d7f362c5fec706d5bc4c3d6d7912ede1998e99ee25596201ae774c1451525de2686161a458899f0283bedab7fbe8725e63afd1ef6ba73d0a58800
+  data.tar.gz: b89ed9be9b25dfdf5914d69a1277913f7af5b56b69c8498cfc0f607023308a05de76da364cf72419ebc681a28ddf92e1b392e90d34ead038f08fc518a66a0721

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,19 +1,21 @@
-# hass, Ruby client for HomeAssistant
+# hass-client, Ruby client for HomeAssistant
 
-hass is a simple Ruby client for the HomeAssistant API.
+hass-client is a simple Ruby client for the HomeAssistant API.
+
+The idea was to have a client which has actual classes for the available devices. This way, you can inspect objects and see your possible actions. It works for the available services but not yet for all states.
 
 ## Installation
 
 Install the gem via 
 
 ```bash
-gem install hass
+gem install hass-client
 ```
 
 or put it in your Gemfile
 
 ```ruby
-gem 'hass'
+gem 'hass-client'
 ```
 
 ## Usage
@@ -60,3 +62,29 @@ client = Hass::Client.new('localhost', 8123, 'api_token')
 light = client.light('light.living_room')
 light.toggle
 ```
+
+You can get a list of your available device types (domains) via
+
+```ruby
+pp(client.domains.map { |domain| domain['domain'] })
+```
+
+You can also get a list of your available entity ids via
+
+```ruby
+pp(client.states.map {|state| state['entity_id']} )
+```
+
+After initializing the client, you can instantiate the available classes directly. You need to provide the client object to be able to use them:
+
+```ruby
+client = Hass::Client.new('localhost', 8123, 'api_token')
+mediaplayer = Hass::MediaPlayer.new('media_player.yamaha_receiver')
+mediaplayer.client = client
+pp mediaplayer.attributes
+mediaplayer.select_source(source: 'HDMI1')
+```
+
+## Caveats
+
+To make multiple calls to client.domains faster, the result is cached. If you have a longer running application, you will have to set @domains to nil to re-request the data. Other requests are not cached at all and this might significantly slow down access to multiple devices.

data/hass-ruby.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'hass-client'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['Gerrit Visscher']
   spec.email         = ['gerrit@visscher.de']
   spec.summary       = 'A small library to access Home Assistant.'

data/lib/hass/client.rb

@@ -66,6 +66,10 @@ module Hass
       @domains ||= get('/services')
     end
 
+    def states
+      get('/states')
+    end
+
     def snake_to_camel(text)
       text.split('_').collect(&:capitalize).join
     end

data/lib/hass/domain.rb

@@ -40,6 +40,18 @@ module Hass
       check_params(service, params)
     end
 
+    def state_data
+      @client.get("/states/#{@entity_id}")
+    end
+
+    def attributes
+      state_data['attributes']
+    end
+
+    def state
+      state_data['state']
+    end
+
     def data
       self.class.const_get('DATA')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hass-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerrit Visscher
@@ -33,6 +33,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - README.md
 - bin/hass-send