aiobosest package¶
Subpackages¶
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
¶ helpers.key.Key
Class
-
nowplaying
¶
-
volume
¶ helpers.volume.Volume
Class
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
-
async
get
(uri)[source]¶ GET data using the REST API
- Parameters
uri – URI to get the data
- Returns
XML data string
- Raises
aiobosest.errors.CallError – malformed requests
aiobosest.errors.RequestError – request didn’t receive HTTP 200
aiobosest.errors.RestConnectionError – other errors
-
async
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
aiobosest.errors.CallError – malformed requests
aiobosest.errors.RequestError – request didn’t receive HTTP 200
aiobosest.errors.RestConnectionError – other errors
aiobosest.errors module¶
-
exception
aiobosest.errors.
BoseSoundTouchError
[source]¶ Bases:
Exception
Base exception class for BoseSoundTouch exceptions.
-
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.
-
exception
aiobosest.errors.
RESTConnectionError
[source]¶ Bases:
aiobosest.errors.BoseSoundTouchError
Raised if didn’t connect to REST API Endpoint.
-
exception
aiobosest.errors.
RequestError
[source]¶ Bases:
aiobosest.errors.BoseSoundTouchError
Raised if a request didn’t receive HTTP 200.
-
exception
aiobosest.errors.
WSConnectionError
[source]¶ Bases:
aiobosest.errors.BoseSoundTouchError
Raised if didn’t connect to WebSocket.