-
Notifications
You must be signed in to change notification settings - Fork 0
Squeezebox Binding
Documentation of the Squeezebox binding Bundle
Slim Devices was established in 2000, and was first known for its SlimServer used for streaming music, but launched a hardware player named SliMP3 able to play these streams in 2001. Although the first player was fairly simple only supporting wired Ethernet and MP3 natively, it was followed two years later by a slightly more advanced player which was renamed to Squeezebox. Other versions followed, gradually adding native support for additional file formats, Wi-Fi-support, gradually adding larger and more advanced displays as well as a version targeting audiophile users. Support for playing music from external streaming platforms such as Pandora, Napster, Last.fm and Sirius were also added. The devices in general have two operating modes; either standalone where the device connects to an internet streaming service directly, or to a local computer running the Logitech Media Server or a network-attached storage device. Both the server software and large parts of the firmware on the most recent players are released under open source licenses.
In 2006, Slim Devices was acquired by Logitech for $20 million USD. Logitech continued the development of the player until they announced in August 2012 that it would be discontinued. Given the cross-platform nature of the server and software client, some users have ensured the continued use of the platform by utilizing the Raspberry Pi as dedicated Squeezebox device (both client and server).
Taken from: Wiki
For installation of the binding, please see Wiki page Bindings.
Please note there are two parts to the Squeezebox binding. You need to install both org.openhab.io.squeezeserver
and org.openhab.binding.squeezebox
. The io.squeezeserver
bundle is a common library used by both this binding and the Squeezebox action and handles all connections and messaging between openHAB and the Squeeze Server. This ensures you only need to specify one set of configuration in openhab.cfg (see below), which can be used by both the binding and the action.
First you need to let openHAB know where to find your Squeeze Server and each of your Squeezebox devices. This configuration is entered in your openhab.cfg configuration file and is used by both the Squeezebox binding and the Squeezebox Action:
# Squeeze server
squeeze:server.host=A.B.C.D
[squeeze:server.cliport=9090]
[squeeze:server.webport=9000]
The openhab.cfg reads squeeze:<serverId>.host=
and suggests that the part is customisable.
This is incorrect and it should be server
for example 'squeeze:server.host=192.168.1.13' (not serverId
, or your custom server name)
See example config and rules here SqueezeboxExample
# Squeezebox players/devices
squeeze:<player-id>.id=<mac-address-of-player A:B:C:D:E:F>
# Language used by squeezeboxSpeak as used by google ttl (en, de, fr,...)
squeeze:language=<xx>
NOTE: the player-id
will be used in both the binding item configs and the action calls to defined which of your Squeezebox devices to communicate with.
NOTE2: the mac-address of players is case-sensitive. Use small letters (a-f) if the address contains them.
The syntax of an item configuration is shown in the following line in general:
squeeze="<player-id>:<command>[:<extra>]"
Where player-id
matches one of the ids defined in your openhab.cfg file.
Command | Purpose |
---|---|
power | Power on/off your device |
mute | Mute/unmute your device |
volume | Change volume by 5% |
play | Play the current title |
pause | Pause the current title |
stop | Stop the current title |
http:stream | Play the given http stream (obsolete as there is now a new squeezeboxPlayUrl() action for handling this inside rules directly) |
file:file | Play the given file on your server (obsolete as there is now a new squeezeboxPlayUrl() action for handling this inside rules directly) |
sync:player-id2 | Add player-id2 to your device for synced playback |
Variable | Purpose |
title | Title of the current song |
album | Album name of the current song |
artist | Artist name of the current song |
year | Release year of the current song |
genre | Genre name of the current song |
coverart | Address to cover art of the current song |
remotetitle | Title of radio station currently playing |
ircode | String of the catched IR code |
Here are some examples of valid binding configuration strings:
squeeze="player1:volume"
squeeze="player1:title"
squeeze="player1:play"
As a result, your lines in the items file might look like the following:
Dimmer sq_test_volume "Volume [%.1f %%]" { squeeze="player1:volume" }
String sq_test_title "Title [%s]" { squeeze="player1:title" }
Switch sq_test_play "Play" { squeeze="player1:play" }
String sq_test_ircode "IR-Code [%s]" { squeeze="player1:ircode" }
NOTE: when binding the 'play' command to a switch item you will trigger 'play' when the item receives the ON command. It will also trigger 'stop' when the item receives the OFF command. The same applies for 'stop' and 'pause' except ON=>stop/pause and OFF=>play. This is so you can setup a single item for controlling play/stop by defining mappings in your sitemap:
Switch item=sq_test_play mappings=[ON="Play", OFF="Stop"]
And whenever the player state is changed from outside of openHAB these items will be updated accordingly, since there is now no longer a separate item for 'play' and 'isPlaying'.
v1.4.0: Squeezebox binding can store the latest IR code (form the infrared remote) in a variable, which can be used to do some actions. Look at this rule:
rule "IR Code catched"
when
Item sq_test_ircode received update
then
if (sq_test_ircode.state=="00ff32cd") {
sendCommand(Licht_Schlafzimmer, ON)
logInfo("IR Code rules", "schalte Schlafzimmerlicht ein")
} else if (sq_test_ircode.state=="00ff708f") {
sendCommand(Licht_Schlafzimmer, OFF)
logInfo("IR Code rules", "schalte Schlafzimmerlicht aus")
}
end
##Additional Control of Logitech Media Server
Another method to gain some extra control of the LMS not provided by the binding is via HTTP GET requests. Using rules, a switch/number etc can be linked to the required HTTP GET request.
All available GET requests can be found on the LMS.
In any browser enter <IP Address of LMS>:9000
Help button on the bottom left → Technical information → Logitech Media Server Web Interface For the multiple player variable either the IP address or the MAC address can be used.
##Example for adding playlists
Item file:
Number Squeezebox_PlayList "Playlists”
Rule file:
rule "Squeezebox_PlayList"
when
Item Squeezebox_PlayList received command
then
switch(receivedCommand) {
case 0 : sendHttpGetRequest("http://<IP Address of LMS>:9000/?p0=playlist&p1=play&p2=<Name of Playlist>&player=<MAC Address of Player>")
case 1 : sendHttpGetRequest("http://<IP Address of LMS>:9000/?p0=playlist&p1=play&p2=<Name of Next Playlist >&player=<MAC Address of Player>")
}
end
Sitemap file:
Selection item=Squeezebox_PlayList label="Start Playlist" mappings=[0="<Name of Playlist>", 1="<Name of Next Playlist >"]
##Example for displaying text
Rule file:
rule "SqueezeboxDisplay"
when
<any event>
then
var String text= "Das ist ein Text mit variablem Inhalt: " + Item1.state.toString +
" und " + Item2.state.toString
var String url = "http://192.168.2.5:9000/status?p0=display&p1=&p2=" + text.encode("UTF-8") + "&p3=300&player=00:04:20:06:21:6d"
sendHttpGetRequest(url)
end
The is UTF-8 encoded. The URL calls the squeezebox server at port 9000 with this parameters: p1=upper display line, p2=lower display line, p3=duration of display, player= MAC address of player
###Linux / OS X
###Windows
- Cosm Persistence
- db4o Persistence
- Exec Persistence
- InfluxDB Persistence
- JDBC Persistence
- JPA Persistence
- Logging Persistence
- mapdb Persistence
- MongoDB Persistence
- MQTT Persistence
- my.openHAB Persistence
- MySQL Persistence
- rrd4j Persistence
- Sen.Se Persistence
- SiteWhere Persistence
- AlarmDecoder Binding
- Anel Binding
- Arduino SmartHome Souliss Binding
- Asterisk Binding
- Astro Binding
- Autelis Pool Control Binding
- BenQ Projector Binding
- Bluetooth Binding
- Bticino Binding
- CalDAV Binding
- Comfo Air Binding
- Config Admin Binding
- CUL Binding
- CUL Intertechno Binding
- CUPS Binding
- DAIKIN Binding
- Davis Binding
- Denon Binding
- digitalSTROM Binding
- DMX512 Binding
- DSC Alarm Binding
- DSMR Binding
- eBUS Binding
- Ecobee Binding
- EDS OWSever Binding
- eKey Binding
- Energenie Binding
- EnOcean Binding
- Enphase Energy Binding
- Epson Projector Binding
- Exec Binding
- Freebox Binding
- Freeswitch Binding
- Frontier Silicon Radio Binding
- Fritz AHA Binding
- Fritz!Box Binding
- FS20 Binding
- Global Cache IR Binding
- GPIO Binding
- HAI/Leviton OmniLink Binding
- HDAnywhere Binding
- Heatmiser Binding
- Homematic / Homegear Binding
- HTTP Binding
- IEC 62056-21 Binding
- IHC / ELKO Binding
- ImperiHome Binding
- Insteon Hub Binding
- Insteon PLM Binding
- IPX800 Binding
- IRtrans Binding
- jointSPACE-Binding
- KNX Binding
- Koubachi Binding
- LCN Binding
- LightwaveRF Binding
- Leviton/HAI Omnilink Binding
- Lg TV Binding
- Logitech Harmony Hub
- MailControl Binding
- MAX!Cube-Binding
- MAX! CUL Binding
- MiLight Binding
- MiOS Binding
- Modbus TCP Binding
- MPD Binding
- MQTT Binding
- MQTTitude binding
- Neohub Binding
- Nest Binding
- Netatmo Binding
- Network Health Binding
- Network UPS Tools Binding
- Nibe Heatpump Binding
- Nikobus Binding
- Novelan/Luxtronic Heatpump Binding
- NTP Binding
- One-Wire Binding
- Onkyo AV Receiver Binding
- Open Energy Monitor Binding
- OpenPaths presence detection binding
- OpenSprinkler Binding
- OSGi Configuration Admin Binding
- Panasonic TV Bindung
- panStamp Binding
- Philips Hue Binding
- Piface Binding
- pilight Binding
- Pioneer-AVR-Binding
- Plex Binding
- Plugwise Binding
- PLCBus Binding
- Primare Binding
- Pulseaudio Binding
- RFXCOM Binding
- RWE Smarthome Binding
- Sager WeatherCaster Binding
- Samsung AC Binding
- Samsung TV Binding
- Serial Binding
- Sallegra Binding
- Satel Alarm Binding
- Sinthesi Sapp Binding
- Snmp Binding
- Somfy URTSI II Binding
- Sonos Binding
- Squeezebox Binding
- Swegon ventilation Binding
- System Info Binding
- TA CMI Binding
- TCP/UDP Binding
- Tellstick Binding
- TinkerForge Binding
- Tivo Binding
- VDR Binding
- Velleman-K8055-Binding
- Wago Binding
- Wake-on-LAN Binding
- Waterkotte EcoTouch Heatpump Binding
- Weather Binding
- Wemo Binding
- Withings Binding
- XBMC Binding
- xPL Binding
- Yamahareceiver Binding
- Zibase Binding
- Z-Wave Binding
- Asterisk
- Google Calendar
- Linux Media Players
- ROS Robot Operating System
- Telldus Tellstick
- Zoneminder
- Wink Hub (rooted)
- Wink Monitoring
- Transformations
- XSLT
- JSON
- REST-API
- Security
- Service Discovery
- Voice Control
- BritishGasHive-Using-Ruby
- Dropbox Bundle
A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.
Please update the wiki if you do come across any out of date information.
- Comfo Air Binding
- Ecobee Examples
- Nest Examples
- Rollershutter Bindings
- Squeezebox
- WAC Binding
- WebSolarLog
- Alarm Clock
- Convert Farenheit to Celcius
- The mother of all lighting rules
- Reusable Rules via Functions
- Combining different Items
- Items, Rules and more Examples of a SmartHome
- Google Map
- Controlling openHAB with Android
- Usecase examples
- B-Control Manager
- Spell checking for foreign languages
- Flic via Tasker
- Chromecast via castnow