music_cast 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a9b5366976677f44438df2214399a404d369a065808d3450e75319401732374
-  data.tar.gz: 8fb3c8a44bf838277711d3377aa040e033f8052bae8faa6616be7e5d087a4ec4
+  metadata.gz: 9ba0fe27dacbc0c4db860fbb944900440148a7ae74f351f46672f4b3d6528bbb
+  data.tar.gz: 8f1f35ff25230e3cbbe1efe536c4ee371759077647ef4f389b46b57dcb2bec1a
 SHA512:
-  metadata.gz: c8a7d233f5ee0a9943137946192092b92b3b841a6741223f56781dc91cc174b42183c84671efdd9600522f43db7312125092e433eeb01cda13cf0b135117fa57
-  data.tar.gz: 124ec5ab118789b284bf2a33e374f3273ec93147cbc74f7eea3b2870192fafc927fbd0065cff2bceec468e83905d527207d4f255c59df4275585aabe8c2f706f
+  metadata.gz: 676ee2860bf7b9a3a1db5f3ed4a47af2e617009e2ad580f6607f89fb1f35ec73bb617cc9b2a96d4dcf2b9c1c4d9b61793c8a573dedff100fa21d35b41be5ebd3
+  data.tar.gz: d2671976f0d9e02abba31aaa82668b8ca87a27440a8d660ff85d2717f7b1d037cfece7a4950a5b84600ccf0448b70a1d437ead5c0cdfdf0cb5e924651e864f4e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    music_cast (0.3.0)
+    music_cast (0.3.1)
       faraday (~> 0.14.0)
 
 GEM
@@ -52,4 +52,4 @@ DEPENDENCIES
   webmock (~> 3.3)
 
 BUNDLED WITH
-   1.16.1
+   1.16.3

data/README.md

@@ -1,6 +1,6 @@
 # MusicCast
 
-Control System for Yamaha MusicCast written in Ruby
+Ruby Control System for Yamaha MusicCast speakers
 
 ## Installation
 
@@ -18,6 +18,12 @@ Or install it yourself as:
 
     $ gem install music_cast
 
+## Prerequisites
+
+For the HTTP API to function correctly in an integrated system, the MusicCast devices must be on a fixed or bound IP Address. To avoid network loops through the wireless “extend” functionality of MusicCast products you should set the device to wired or wireless only - through the web GUI on the MusicCast device:
+
+![screen shot 2018-03-25 at 22 22 48](https://user-images.githubusercontent.com/666397/37880091-294978fc-307b-11e8-8985-3ee4e3f11fc6.png)
+
 ## Configuration
 
 The configuration options can be set by using the `configure` helper
@@ -34,6 +40,54 @@ The following is the full list of available configuration options:
 ip_address # The static IP address of your speaker
 ```
 
+## Usage
+
+This gem is intended to be a thin wrapper around the existing `YamahaExtendedControl/v1` API. The class structures are influenced by the existing API structure. This is a list of all the functions that can currently be performed with this gem.
+
+### Status
+
+Get device status
+
+```ruby
+status = MusicCast::GetStatus.new
+status.to_json # Current status as JSON
+```
+
+### Power Functions
+
+Set power status and enable/disable auto-standby
+
+```ruby
+power = MusicCast::SetPower.new
+power.on                    # Power on
+power.standby               # Standby
+power.toggle                # Power Toggle
+power.enable_auto_standby   # Enable Auto Power Standby
+power.disable_auto_standby  # Disable Auto Power Standby
+```
+
+### Volume Commands
+
+Set sound volume level
+
+```ruby
+volume = MusicCast::SetVolume.new
+volume.to(11)         # Set volume to n valid range 0..100
+volume.increment      # Increment volume by 1 step
+volume.increment(10)  # Increment volume by n steps
+volume.decrement      # Decrement volume by 1 step
+volume.decrement(10)  # Decrement volume by n steps
+```
+
+### Mute
+
+Enable or disable sound
+
+```ruby
+mute = MusicCast::SetMute.new
+mute.on  # Set Mute on
+mute.off # Set Mute off
+```
 
 ## Development
 

data/lib/music_cast/api.rb

@@ -26,6 +26,7 @@ module MusicCast
   end
 end
 
+require_relative 'api/get_status'
 require_relative 'api/set_mute'
 require_relative 'api/set_power'
 require_relative 'api/set_volume'

data/lib/music_cast/api/get_status.rb

@@ -0,0 +1,11 @@
+module MusicCast
+  class GetStatus < API
+    def to_json
+      get.body
+    end
+
+    def get
+      make_request('main/getStatus')
+    end
+  end
+end

data/lib/music_cast/api/set_power.rb

@@ -8,6 +8,8 @@ module MusicCast
       make_request('main/setPower?power=standby')
     end
 
+    alias_method :off, :standby
+
     def toggle
       make_request('main/setPower?power=toggle')
     end

data/lib/music_cast/version.rb

@@ -1,3 +1,3 @@
 module MusicCast
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: music_cast
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Karl Entwistle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-25 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -132,6 +132,7 @@ files:
 - bin/setup
 - lib/music_cast.rb
 - lib/music_cast/api.rb
+- lib/music_cast/api/get_status.rb
 - lib/music_cast/api/set_mute.rb
 - lib/music_cast/api/set_power.rb
 - lib/music_cast/api/set_volume.rb
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Yamaha MusicCast Control System