aiobosest package

Submodules

aiobosest.aiobosest module

class aiobosest.aiobosest.BoseSoundTouch(address, is_updated=None, loop=None)[source]

Bases: object

Main Bose SoundTouch Class.

Parameters:
  • address – Bose SoundTouch IP address
  • is_updated – asyncio.Event() is set when an update happens
  • loop – asyncio loop if you want to provide one
key

Key Class

nowplaying

NowPlaying Class

volume

Volume Class

is_running()[source]

Wait for reader task running.

Returns:True when reader task is running
shutdown()[source]

Needs to be called before application quit.

aiobosest.connection module

class aiobosest.connection.Connection(address, loop=None)[source]

Bases: object

Connection class to connect on the system.

Also provides REST methods to get or post.

Parameters:
  • address – Bose SoundTouch IP address
  • loop – asyncio loop if you want to provide one
websocket

websocket connection

connect_websocket()[source]

Connect to the websocket.

get(uri)[source]

GET data using the REST API

Parameters:

uri – URI to get the data
Returns:

XML data string
Raises:
post(uri, message)[source]

POST data using the REST API

Parameters:
  • uri – URI to get the data
  • message – XML message to POST
Returns:

XML data string
Raises:
shutdown()[source]

Needs to be called before application quit. This is called by main the class

aiobosest.errors module

exception aiobosest.errors.BoseSoundTouchError[source]

Bases: Exception

Base exception class for BoseSoundTouch exceptions.

exception aiobosest.errors.RESTConnectionError[source]

Bases: aiobosest.errors.BoseSoundTouchError

Raised if didn’t connect to REST API Endpoint.

exception aiobosest.errors.WSConnectionError[source]

Bases: aiobosest.errors.BoseSoundTouchError

Raised if didn’t connect to WebSocket.

exception aiobosest.errors.RequestError[source]

Bases: aiobosest.errors.BoseSoundTouchError

Raised if a request didn’t receive HTTP 200.

exception aiobosest.errors.CallError[source]

Bases: aiobosest.errors.BoseSoundTouchError

Raised if a call produced errors or malformed requests.

exception aiobosest.errors.KeyNotFoundError[source]

Bases: aiobosest.errors.BoseSoundTouchError

Raised if a user try to set a key that doesn’t exists.

aiobosest.log module

aiobosest.utils module

aiobosest.utils.get_first_or_none(myList)[source]

To be used when parsing the XML Element

Parameters:myList – a list
Returns:First list item or a list with a None item

Module contents