Skip to content

Commit

Permalink
Add set-stand-movement method
Browse files Browse the repository at this point in the history
Add updated Python API client
Add OpenAPI document
  • Loading branch information
mj23000 committed Mar 23, 2024
1 parent 17d9f9d commit da13156
Show file tree
Hide file tree
Showing 227 changed files with 39,364 additions and 17,405 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@
The Mozart API is an async REST API with WebSocket notification channel for immediate state information from Mozart devices. Currently the API is distributed as a [Python package](https://pypi.org/project/mozart-api) and as an OpenAPI document that can be found in the [Github releases](https://github.com/bang-olufsen/mozart-open-api/releases).

Supported by:
- [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core)
- [Beolab 8](https://www.bang-olufsen.com/en/dk/speakers/beolab-8)
- [Beolab 28](https://www.bang-olufsen.com/en/dk/speakers/beolab-28)
- [Beosound 2 3rd gen](https://www.bang-olufsen.com/en/dk/speakers/beosound-2)
- [Beosound A5](https://www.bang-olufsen.com/en/dk/speakers/beosound-a5)
- [Beosound A9 5th gen](https://www.bang-olufsen.com/en/dk/speakers/beosound-a9)
- [Beosound Balance](https://www.bang-olufsen.com/en/dk/speakers/beosound-balance)
- [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core)
- [Beosound Emerge](https://www.bang-olufsen.com/en/dk/speakers/beosound-emerge)
- [Beosound Level](https://www.bang-olufsen.com/en/dk/speakers/beosound-level)
- [Beosound Theatre](https://www.bang-olufsen.com/en/dk/soundbars/beosound-theatre)
Expand Down
68 changes: 63 additions & 5 deletions docs/mozart-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2500,6 +2500,24 @@ components:
connected:
type: boolean
type: object
StandMovement:
properties:
angle:
format: float
nullable: true
type: number
ignoreEndstop:
example: false
type: boolean
standMotion:
enum:
- continuousCCW
- stepCCW
- stop
- stepCW
- continuousCW
type: string
type: object
StandPosition:
properties:
angle:
Expand Down Expand Up @@ -3837,20 +3855,20 @@ info:
\ immediate state information from Mozart devices. Currently the API is distributed\
\ as a [Python package](https://pypi.org/project/mozart-api) and as an OpenAPI\
\ document that can be found in the [Github releases](https://github.com/bang-olufsen/mozart-open-api/releases).\n\
\n\nSupported by:\n- [Beolab 8](https://www.bang-olufsen.com/en/dk/speakers/beolab-8)\n\
- [Beolab 28](https://www.bang-olufsen.com/en/dk/speakers/beolab-28)\n- [Beosound\
\n\nSupported by:\n- [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core)\n\
- [Beolab 8](https://www.bang-olufsen.com/en/dk/speakers/beolab-8)\n- [Beolab\
\ 28](https://www.bang-olufsen.com/en/dk/speakers/beolab-28)\n- [Beosound\
\ 2 3rd gen](https://www.bang-olufsen.com/en/dk/speakers/beosound-2)\n- [Beosound\
\ A5](https://www.bang-olufsen.com/en/dk/speakers/beosound-a5)\n- [Beosound\
\ A9 5th gen](https://www.bang-olufsen.com/en/dk/speakers/beosound-a9)\n-\
\ [Beosound Balance](https://www.bang-olufsen.com/en/dk/speakers/beosound-balance)\n\
- [Beoconnect Core](https://www.bang-olufsen.com/en/dk/accessories/beoconnect-core)\n\
- [Beosound Emerge](https://www.bang-olufsen.com/en/dk/speakers/beosound-emerge)\n\
- [Beosound Level](https://www.bang-olufsen.com/en/dk/speakers/beosound-level)\n\
- [Beosound Theatre](https://www.bang-olufsen.com/en/dk/soundbars/beosound-theatre)\n\
\n\nThis API documentation has been generated for version 3.4.1.8 of the Mozart\
\ platform and API generation version 3.4.1.8.1.\n\n## Python API\n\nThe Python\
\ platform and API generation version 3.4.1.8.2.\n\n## Python API\n\nThe Python\
\ package has been generated using the [OpenAPI Generator](https:/openapi-generator.tech/)\
\ version 7.1.0. On top of the generated API, a helper file, mozart_client.py,\
\ version 7.4.0. On top of the generated API, a helper file, mozart_client.py,\
\ has been made that makes the API more pythonic. We recommend using this.\n\
\nAnother file, mozart_cli.py, has been made for using the Mozart API in a\
\ simple CLI program. This has been set as the \"entry point\" for the Python\
Expand Down Expand Up @@ -5869,6 +5887,46 @@ paths:
tags:
- Sound
- mozart
/api/v1/stand/move:
post:
description: |-
Use the `set-stand-movement` method in the Python package with one of:
```mozart_client
await mozart_client.set_stand_movement()
```
```mozart_api
await mozart_api.set_stand_movement()
```
```stand_api
await stand_api.set_stand_movement()
```
operationId: set-stand-movement
parameters:
- description: Use slow speed on continuous movement
in: query
name: slow-speed
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StandMovement'
description: Stand Movement
required: true
responses:
'204':
description: the movement were accepted
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Stand not connected ot stand capability is not available
summary: Set stand movement with either an angle or a movement type
tags:
- Stand
- mozart
/api/v1/state:
get:
description: |-
Expand Down
Loading

0 comments on commit da13156

Please sign in to comment.