# Bang & Olufsen BeoPlay devices Python integration module
Beoplay Python wrapper to integrate B&O speakers/TVs to Python that use the BeoPlay API. BeoPlay API is the 2nd generation B&O API, after [Masterlink Gateway](https://github.com/giachello/mlgw) and before [Mozart](https://github.com/bang-olufsen/mozart-open-api). It is supported by devices built from the early 2000s to the late 2010s, including several BeoVision TV, BeoLab speakers and the NL/ML Converter.
The API is wrapped in an object that can be used to read the state and control BeoPlay devices. It includes both methods for blocking calls, and async calls with callbacks using aiohttp.
Reference information [is on this page.](https://documenter.getpostman.com/view/1053298/T1LTe4Lt)
Some more information on the Notifications stream is in the [EVENTS.md](EVENTS.md) file.
Currently gets the following attributes:
- volume
- mute
- source
- source list
- primary experience
- state
- standby
- track image (if available)
- artist
- album
- song(name) (if available)
- description (if available)
- stand positions
The following commands are available:
- set volume
- set mute
- play
- pause
- stop
- next
- previous
- standby
- set source
- join experience
- leave experience
- play queue item
- set stand position
The following key presses are available:
```Cursor/Select, Cursor/Up, Cursor/Down, Cursor/Left, Cursor/Right, Cursor/Exit, Cursor/Back, Cursor/PageUp, Cursor/PageDown, Cursor/Clear, Stream/Play, Stream/Stop, Stream/Pause, Stream/Wind, Stream/Rewind, Stream/Forward, Stream/Backward, List/StepUp, List/StepDown, List/PreviousElement, List/Shuffle, List/Repeat, Menu/Root, Menu/Option, Menu/Setup, Menu/Contents, Menu/Favorites, Menu/ElectronicProgramGuide, Menu/VideoOnDemand, Menu/Text, Menu/HbbTV,Menu/HomeControl, Device/Information, Device/Eject, Device/TogglePower, Device/Languages, Device/Subtitles, Device/OneWayJoin, Device/Mots, Record/Record, Generic/Blue, Generic/Red, Generic/Green, Generic/Yellow,``` and the digits ```0-9```
Raw data
{
"_id": null,
"home_page": "https://github.com/giachello/pybeoplay",
"name": "pybeoplay",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "beoplay, pybeoplay, B&O, Bang & Olufsen",
"author": "Giovanni Iachello",
"author_email": "giovanni.iachello@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/49/70/60bfdeb1f5774ca4d223a015ea153d2455ca024b70af269bec06b9858bbe/pybeoplay-2.1.0.tar.gz",
"platform": "any",
"description": "# Bang & Olufsen BeoPlay devices Python integration module\r\n\r\nBeoplay Python wrapper to integrate B&O speakers/TVs to Python that use the BeoPlay API. BeoPlay API is the 2nd generation B&O API, after [Masterlink Gateway](https://github.com/giachello/mlgw) and before [Mozart](https://github.com/bang-olufsen/mozart-open-api). It is supported by devices built from the early 2000s to the late 2010s, including several BeoVision TV, BeoLab speakers and the NL/ML Converter.\r\n\r\nThe API is wrapped in an object that can be used to read the state and control BeoPlay devices. It includes both methods for blocking calls, and async calls with callbacks using aiohttp.\r\n\r\nReference information [is on this page.](https://documenter.getpostman.com/view/1053298/T1LTe4Lt)\r\n\r\nSome more information on the Notifications stream is in the [EVENTS.md](EVENTS.md) file.\r\n\r\nCurrently gets the following attributes:\r\n- volume\r\n- mute\r\n- source\r\n- source list\r\n- primary experience\r\n- state\r\n- standby\r\n- track image (if available)\r\n- artist \r\n- album\r\n- song(name) (if available)\r\n- description (if available)\r\n- stand positions\r\n\r\nThe following commands are available:\r\n- set volume\r\n- set mute\r\n- play\r\n- pause\r\n- stop\r\n- next\r\n- previous\r\n- standby\r\n- set source\r\n- join experience\r\n- leave experience\r\n- play queue item\r\n- set stand position\r\n\r\nThe following key presses are available:\r\n```Cursor/Select, Cursor/Up, Cursor/Down, Cursor/Left, Cursor/Right, Cursor/Exit, Cursor/Back, Cursor/PageUp, Cursor/PageDown, Cursor/Clear, Stream/Play, Stream/Stop, Stream/Pause, Stream/Wind, Stream/Rewind, Stream/Forward, Stream/Backward, List/StepUp, List/StepDown, List/PreviousElement, List/Shuffle, List/Repeat, Menu/Root, Menu/Option, Menu/Setup, Menu/Contents, Menu/Favorites, Menu/ElectronicProgramGuide, Menu/VideoOnDemand, Menu/Text, Menu/HbbTV,Menu/HomeControl, Device/Information, Device/Eject, Device/TogglePower, Device/Languages, Device/Subtitles, Device/OneWayJoin, Device/Mots, Record/Record, Generic/Blue, Generic/Red, Generic/Green, Generic/Yellow,``` and the digits ```0-9```\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "BeoPlay API for Python",
"version": "2.1.0",
"project_urls": {
"Download": "https://github.com/giachello/pybeoplay/tarball/2.1.0",
"Homepage": "https://github.com/giachello/pybeoplay"
},
"split_keywords": [
"beoplay",
" pybeoplay",
" b&o",
" bang & olufsen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "868471d9c373d0ebb6147ea6c440fddd00a48320af64ba22cdae97681206e167",
"md5": "60ae83edfabdc3570eb9c515c0cf13e8",
"sha256": "d30d9669efe31d7ce3816302955029efdcbe5f7043eb693a9609a880abaa175f"
},
"downloads": -1,
"filename": "pybeoplay-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60ae83edfabdc3570eb9c515c0cf13e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9941,
"upload_time": "2024-04-07T00:27:11",
"upload_time_iso_8601": "2024-04-07T00:27:11.065229Z",
"url": "https://files.pythonhosted.org/packages/86/84/71d9c373d0ebb6147ea6c440fddd00a48320af64ba22cdae97681206e167/pybeoplay-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "497060bfdeb1f5774ca4d223a015ea153d2455ca024b70af269bec06b9858bbe",
"md5": "349290559c5eae2da26221c2b016b740",
"sha256": "d837500023e01f6ec106983c823d8aba83339c43edc4bc0e26100aee02cb34dc"
},
"downloads": -1,
"filename": "pybeoplay-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "349290559c5eae2da26221c2b016b740",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10002,
"upload_time": "2024-04-07T00:27:13",
"upload_time_iso_8601": "2024-04-07T00:27:13.204842Z",
"url": "https://files.pythonhosted.org/packages/49/70/60bfdeb1f5774ca4d223a015ea153d2455ca024b70af269bec06b9858bbe/pybeoplay-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 00:27:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giachello",
"github_project": "pybeoplay",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pybeoplay"
}
JSON
