0.0
Low commit activity in last 3 years
No release in over a year
Gem provides Ruby Samsung WAM API wrapper
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.14
~> 5.0
>= 0
~> 10.0
~> 4.0
~> 3.2

Runtime

 Project Readme

SamsungWamApi

This gem provides wrapper around Samsung wireless audio multiroom control API. For more information about what commands your Samsung device support, see this repo

Installation

Add this line to your application's Gemfile:

gem 'samsung_wam_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install samsung_wam_api

Usage

require 'samsung_wam_api'
living_room_soundbar = SamsungWamApi::Device.new(ip: '192.168.0.1')
living_room_soundbar.off? # => true
living_room_soundbar.on!
living_room_soundbar.volume # => 15
living_room_soundbar.increase_volume
living_room_soundbar.decrease_volume(5) # decrease by 5 instead of default 1
living_room_soundbar.set_volume(20)
living_room_soundbar.muted? # => false
living_room_soundbar.mute!
living_room_soundbar.unmute!
living_room_soundbar.toggle_mute!
living_room_soundbar.input
living_room_soundbar.set_input!('aux')
living_room_soundbar.cloud_provider_info
living_room_soundbar.play_info
living_room_soundbar.audio_info
living_room_soundbar.cloud_username

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ares/samsung_wam_api.

License

The gem is available as open source under the terms of the MIT License.