Skip to main content

Asynchronous library to control Logitech Media Server

Project description

pysqueezebox - Asynchronous control of squeezeboxes

This a library to control a Logitech Media Server asynchronously, intended for integration with Home Assistant.

Much of the code was adapted from the Home Assistant squeezebox integration. The current convention is for all API-specific code to be part of a third party library hosted on PyPi, so I created a separate library.

The function names track the terms used by the LMS API, so they do not all match the old Home Assistant squeezebox integration.

Thank you to the original author of the squeezebox integration. If it is you, please let me know so I can credit you here.

Usage

Install pysqueezebox from github, or using PyPi via pip.

$ pip3 install pysqueezebox

Imports

Import the Server() and Player() classes from this module. You will also need to create an aiohttp.ClientSession() that the module will use to communicate with the Logitech Media Server.

You can use Server.async_get_players() to retrieve a list of connected players, or get a specific player using Server.async_get_player(name="PlayerName"). Remember that any method starting with "async_" is a coroutine that must be preceded by an await to run.

For more information on using aiohttp.ClientSession(), see https://aiohttp.readthedocs.io/en/stable/client_reference.html.

from pysqueezebox import Server, Player
import aiohttp
import asyncio
SERVER = '192.168.1.2' # ip address of Logitech Media Server

async def main():
    async with aiohttp.ClientSession() as session:
        lms = Server(session, SERVER)
        player = await lms.async_get_player(name="Bedroom")
	await player.async_update()
	print(player.album)
	await player.async_play()

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

Player.async_update()

The Player object stores information about the current status of the player. This allows you to retrieve the player's properties without any I/O. Remember to call Player.async_update() prior to retrieving properties if you want the most up-to-date information.

Player() class

Most of the useful functions are in the Player class. More documentation to follow, but in the meantime, the docstrings should be instructive.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysqueezebox-0.2.3.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

pysqueezebox-0.2.3-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file pysqueezebox-0.2.3.tar.gz.

File metadata

  • Download URL: pysqueezebox-0.2.3.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for pysqueezebox-0.2.3.tar.gz
Algorithm Hash digest
SHA256 11c7e6461c94408040477cc41243fdd34b7098a85dfaa3455f93e284535b22bf
MD5 35e5a0b34fb6364ab16e8ac654dfded7
BLAKE2b-256 44815ba6cde3f63b11ea473f336955ed0877a73db0d03e7d93a7a298d9d73e1b

See more details on using hashes here.

File details

Details for the file pysqueezebox-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: pysqueezebox-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.3

File hashes

Hashes for pysqueezebox-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2bce09b8726958d6148bb7dd92ae8373d11e61838c3f8f3347244afe4f63efb1
MD5 9946692d762a4500173ee8aad7d67ec5
BLAKE2b-256 4213ae4c1904a458cba0b77855b02a24c3d3ae5ff23f0c8583c698866dfb81eb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page