Metadata-Version: 2.4
Name: busybar_python_sdk
Version: 0.0.1
Summary: BUSY Bar HTTP API
Home-page: https://github.com/nuxnik/busybar-python-sdk
Author: tbd
Author-email: tbd <team@openapitools.org>
Project-URL: Repository, https://github.com/nuxnik/busybar-python-sdk
Keywords: OpenAPI,OpenAPI-Generator,BUSY Bar HTTP API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# busybar-python-sdk
HTTP API for BUSY Bar web server

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 25.0.0
- Package version: 0.0.1
- Generator version: 7.25.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/nuxnik/busybar-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/nuxnik/busybar-python-sdk.git`)

Then import the package:
```python
import busybar_python_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import busybar_python_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import busybar_python_sdk
from busybar_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = busybar_python_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with busybar_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = busybar_python_sdk.AccountApi(api_client)

    try:
        # Get MQTT configuration
        api_response = api_instance.get_account_backend()
        print("The response of AccountApi->get_account_backend:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_account_backend: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**get_account_backend**](docs/AccountApi.md#get_account_backend) | **GET** /api/account/backend | Get MQTT configuration
*AccountApi* | [**get_account_info**](docs/AccountApi.md#get_account_info) | **GET** /api/account/info | Get linked account info
*AccountApi* | [**get_account_status**](docs/AccountApi.md#get_account_status) | **GET** /api/account/status | Get MQTT status info
*AccountApi* | [**link_account**](docs/AccountApi.md#link_account) | **POST** /api/account/link | Link device to account
*AccountApi* | [**set_account_backend**](docs/AccountApi.md#set_account_backend) | **PUT** /api/account/backend | Set MQTT configuration
*AccountApi* | [**unlink_account**](docs/AccountApi.md#unlink_account) | **DELETE** /api/account | Unlink device from account
*AssetsApi* | [**clear_display**](docs/AssetsApi.md#clear_display) | **DELETE** /api/display/draw | Clear display
*AssetsApi* | [**delete_app_assets**](docs/AssetsApi.md#delete_app_assets) | **DELETE** /api/assets/upload | Delete app assets
*AssetsApi* | [**draw_on_display**](docs/AssetsApi.md#draw_on_display) | **POST** /api/display/draw | Draw on display
*AssetsApi* | [**play_audio**](docs/AssetsApi.md#play_audio) | **POST** /api/audio/play | Play audio file
*AssetsApi* | [**stop_audio**](docs/AssetsApi.md#stop_audio) | **DELETE** /api/audio/play | Stop audio playback
*AssetsApi* | [**upload_asset_with_app_id**](docs/AssetsApi.md#upload_asset_with_app_id) | **POST** /api/assets/upload | Upload asset file with app ID
*BLEApi* | [**api_ble_disable_post**](docs/BLEApi.md#api_ble_disable_post) | **POST** /api/ble/disable | Disable BLE
*BLEApi* | [**api_ble_enable_post**](docs/BLEApi.md#api_ble_enable_post) | **POST** /api/ble/enable | Enable BLE
*BLEApi* | [**api_ble_pairing_delete**](docs/BLEApi.md#api_ble_pairing_delete) | **DELETE** /api/ble/pairing | Remove pairing
*BLEApi* | [**api_ble_status_get**](docs/BLEApi.md#api_ble_status_get) | **GET** /api/ble/status | 
*BusyApi* | [**get_busy_profile**](docs/BusyApi.md#get_busy_profile) | **GET** /api/busy/profiles/{slot} | Get BUSY timer profile
*BusyApi* | [**get_busy_snapshot**](docs/BusyApi.md#get_busy_snapshot) | **GET** /api/busy/snapshot | Get BUSY timer snapshot
*BusyApi* | [**set_busy_profile**](docs/BusyApi.md#set_busy_profile) | **PUT** /api/busy/profiles/{slot} | Set BUSY timer profile
*BusyApi* | [**set_busy_snapshot**](docs/BusyApi.md#set_busy_snapshot) | **PUT** /api/busy/snapshot | Set BUSY timer snapshot
*InputApi* | [**set_input_key**](docs/InputApi.md#set_input_key) | **POST** /api/input | Send input event
*SettingsApi* | [**api_name_get**](docs/SettingsApi.md#api_name_get) | **GET** /api/name | Get current device name
*SettingsApi* | [**api_name_post**](docs/SettingsApi.md#api_name_post) | **POST** /api/name | Set new device name
*SettingsApi* | [**get_audio_volume**](docs/SettingsApi.md#get_audio_volume) | **GET** /api/audio/volume | Get audio volume
*SettingsApi* | [**get_display_brightness**](docs/SettingsApi.md#get_display_brightness) | **GET** /api/display/brightness | Get display brightness
*SettingsApi* | [**get_http_access**](docs/SettingsApi.md#get_http_access) | **GET** /api/access | Get HTTP API access over Wi-Fi configuration
*SettingsApi* | [**set_audio_volume**](docs/SettingsApi.md#set_audio_volume) | **POST** /api/audio/volume | Set audio volume
*SettingsApi* | [**set_display_brightness**](docs/SettingsApi.md#set_display_brightness) | **POST** /api/display/brightness | Set display brightness
*SettingsApi* | [**set_http_access**](docs/SettingsApi.md#set_http_access) | **POST** /api/access | Set HTTP API access over Wi-Fi configuration
*SmartHomeApi* | [**api_smart_home_pairing_delete**](docs/SmartHomeApi.md#api_smart_home_pairing_delete) | **DELETE** /api/smart_home/pairing | Erase all smart home links
*SmartHomeApi* | [**api_smart_home_switch_get**](docs/SmartHomeApi.md#api_smart_home_switch_get) | **GET** /api/smart_home/switch | Get state of emulated smart home switch
*SmartHomeApi* | [**api_smart_home_switch_post**](docs/SmartHomeApi.md#api_smart_home_switch_post) | **POST** /api/smart_home/switch | Set state of emulated smart home switch
*SmartHomeApi* | [**get_smart_home_commissioning_status**](docs/SmartHomeApi.md#get_smart_home_commissioning_status) | **GET** /api/smart_home/pairing | Smart home commissioning status
*SmartHomeApi* | [**start_smart_home_pairing**](docs/SmartHomeApi.md#start_smart_home_pairing) | **POST** /api/smart_home/pairing | Link device to a smart home
*StorageApi* | [**create_storage_dir**](docs/StorageApi.md#create_storage_dir) | **POST** /api/storage/mkdir | Create a directory on internal storage
*StorageApi* | [**get_storage_status**](docs/StorageApi.md#get_storage_status) | **GET** /api/storage/status | Show storage usage
*StorageApi* | [**list_storage_files**](docs/StorageApi.md#list_storage_files) | **GET** /api/storage/list | List files on internal storage
*StorageApi* | [**read_storage_file**](docs/StorageApi.md#read_storage_file) | **GET** /api/storage/read | Download file from internal storage
*StorageApi* | [**remove_storage_file**](docs/StorageApi.md#remove_storage_file) | **DELETE** /api/storage/remove | Remove a file on internal storage
*StorageApi* | [**rename_storage_file**](docs/StorageApi.md#rename_storage_file) | **POST** /api/storage/rename | Rename/move a file
*StorageApi* | [**write_storage_file**](docs/StorageApi.md#write_storage_file) | **POST** /api/storage/write | Upload file to internal storage
*StreamingApi* | [**api_screen_get**](docs/StreamingApi.md#api_screen_get) | **GET** /api/screen | Get single frame for requested screen
*StreamingApi* | [**connect_web_socket**](docs/StreamingApi.md#connect_web_socket) | **GET** /api/status/ws | Device status streaming WebSocket endpoint
*SystemApi* | [**dump_log**](docs/SystemApi.md#dump_log) | **POST** /api/log_dump | Dump captured log
*SystemApi* | [**get_status**](docs/SystemApi.md#get_status) | **GET** /api/status | Get device status
*SystemApi* | [**get_status_device**](docs/SystemApi.md#get_status_device) | **GET** /api/status/device | Get device info
*SystemApi* | [**get_status_firmware**](docs/SystemApi.md#get_status_firmware) | **GET** /api/status/firmware | Get firmware info
*SystemApi* | [**get_status_power**](docs/SystemApi.md#get_status_power) | **GET** /api/status/power | Get power status
*SystemApi* | [**get_status_system**](docs/SystemApi.md#get_status_system) | **GET** /api/status/system | Get system status
*SystemApi* | [**get_transport**](docs/SystemApi.md#get_transport) | **GET** /api/transport | Get device network connection info
*SystemApi* | [**get_version**](docs/SystemApi.md#get_version) | **GET** /api/version | Get API version information
*TimeApi* | [**get_time**](docs/TimeApi.md#get_time) | **GET** /api/time | Get current timestamp with timezone
*TimeApi* | [**get_time_timezone**](docs/TimeApi.md#get_time_timezone) | **GET** /api/time/timezone | Get timezone
*TimeApi* | [**get_time_tzlist**](docs/TimeApi.md#get_time_tzlist) | **GET** /api/time/tzlist | Get list of supported time zones
*TimeApi* | [**set_time_timestamp**](docs/TimeApi.md#set_time_timestamp) | **POST** /api/time/timestamp | Set current timestamp
*TimeApi* | [**set_time_timezone**](docs/TimeApi.md#set_time_timezone) | **POST** /api/time/timezone | Set timezone
*UpdaterApi* | [**abort_firmware_download**](docs/UpdaterApi.md#abort_firmware_download) | **POST** /api/update/abort_download | Abort ongoing firmware download
*UpdaterApi* | [**check_firmware_update**](docs/UpdaterApi.md#check_firmware_update) | **POST** /api/update/check | Start firmware update check
*UpdaterApi* | [**get_autoupdate_settings**](docs/UpdaterApi.md#get_autoupdate_settings) | **GET** /api/update/autoupdate | Get autoupdate settings
*UpdaterApi* | [**get_firmware_update_status**](docs/UpdaterApi.md#get_firmware_update_status) | **GET** /api/update/status | Get firmware update status
*UpdaterApi* | [**get_update_changelog**](docs/UpdaterApi.md#get_update_changelog) | **GET** /api/update/changelog | Get update changelog
*UpdaterApi* | [**install_firmware_update**](docs/UpdaterApi.md#install_firmware_update) | **POST** /api/update/install | Install firmware update
*UpdaterApi* | [**set_autoupdate_settings**](docs/UpdaterApi.md#set_autoupdate_settings) | **POST** /api/update/autoupdate | Set autoupdate settings
*UpdaterApi* | [**update_firmware**](docs/UpdaterApi.md#update_firmware) | **POST** /api/update | Update firmware
*WiFiApi* | [**api_wifi_connect_post**](docs/WiFiApi.md#api_wifi_connect_post) | **POST** /api/wifi/connect | 
*WiFiApi* | [**api_wifi_disconnect_post**](docs/WiFiApi.md#api_wifi_disconnect_post) | **POST** /api/wifi/disconnect | 
*WiFiApi* | [**api_wifi_status_get**](docs/WiFiApi.md#api_wifi_status_get) | **GET** /api/wifi/status | 
*WiFiApi* | [**get_wifi_networks**](docs/WiFiApi.md#get_wifi_networks) | **GET** /api/wifi/networks | 


## Documentation For Models

 - [AccountBackend](docs/AccountBackend.md)
 - [AccountInfo](docs/AccountInfo.md)
 - [AccountLink](docs/AccountLink.md)
 - [AccountStatus](docs/AccountStatus.md)
 - [AnimationElement](docs/AnimationElement.md)
 - [AudioVolumeInfo](docs/AudioVolumeInfo.md)
 - [AutoupdateSettings](docs/AutoupdateSettings.md)
 - [BleStatusResponse](docs/BleStatusResponse.md)
 - [BusyBarSettings](docs/BusyBarSettings.md)
 - [BusyProfile](docs/BusyProfile.md)
 - [BusyProfileSlot](docs/BusyProfileSlot.md)
 - [BusyProfileTimerSettings](docs/BusyProfileTimerSettings.md)
 - [BusySnapshot](docs/BusySnapshot.md)
 - [BusySnapshotInfinite](docs/BusySnapshotInfinite.md)
 - [BusySnapshotInterval](docs/BusySnapshotInterval.md)
 - [BusySnapshotNotStarted](docs/BusySnapshotNotStarted.md)
 - [BusySnapshotSimple](docs/BusySnapshotSimple.md)
 - [BusySnapshotSnapshot](docs/BusySnapshotSnapshot.md)
 - [BusyTimerInfiniteSettings](docs/BusyTimerInfiniteSettings.md)
 - [BusyTimerIntervalSettings](docs/BusyTimerIntervalSettings.md)
 - [BusyTimerSimpleSettings](docs/BusyTimerSimpleSettings.md)
 - [ConnectRequestConfig](docs/ConnectRequestConfig.md)
 - [ConnectRequestConfigIpConfig](docs/ConnectRequestConfigIpConfig.md)
 - [CountdownElement](docs/CountdownElement.md)
 - [DisplayBrightnessInfo](docs/DisplayBrightnessInfo.md)
 - [DisplayElement](docs/DisplayElement.md)
 - [DisplayElements](docs/DisplayElements.md)
 - [DisplayElementsElementsInner](docs/DisplayElementsElementsInner.md)
 - [DumpLog200Response](docs/DumpLog200Response.md)
 - [Error](docs/Error.md)
 - [FileUpload](docs/FileUpload.md)
 - [GetUpdateChangelog200Response](docs/GetUpdateChangelog200Response.md)
 - [HttpAccessInfo](docs/HttpAccessInfo.md)
 - [ImageElement](docs/ImageElement.md)
 - [NameInfo](docs/NameInfo.md)
 - [Network](docs/Network.md)
 - [NetworkInterfaceInfo](docs/NetworkInterfaceInfo.md)
 - [NetworkResponse](docs/NetworkResponse.md)
 - [PlayAudio](docs/PlayAudio.md)
 - [RectangleElement](docs/RectangleElement.md)
 - [SmartHomePairingInfo](docs/SmartHomePairingInfo.md)
 - [SmartHomePairingInfoLatestPairingStatus](docs/SmartHomePairingInfoLatestPairingStatus.md)
 - [SmartHomePairingPayload](docs/SmartHomePairingPayload.md)
 - [SmartHomeSwitchState](docs/SmartHomeSwitchState.md)
 - [Status](docs/Status.md)
 - [StatusDevice](docs/StatusDevice.md)
 - [StatusFirmware](docs/StatusFirmware.md)
 - [StatusPower](docs/StatusPower.md)
 - [StatusResponse](docs/StatusResponse.md)
 - [StatusResponseIpConfig](docs/StatusResponseIpConfig.md)
 - [StatusSystem](docs/StatusSystem.md)
 - [StorageDirElement](docs/StorageDirElement.md)
 - [StorageFileElement](docs/StorageFileElement.md)
 - [StorageList](docs/StorageList.md)
 - [StorageListElement](docs/StorageListElement.md)
 - [StorageStatus](docs/StorageStatus.md)
 - [SuccessResponse](docs/SuccessResponse.md)
 - [TextElement](docs/TextElement.md)
 - [TimestampInfo](docs/TimestampInfo.md)
 - [TimezoneInfo](docs/TimezoneInfo.md)
 - [TimezoneListResponse](docs/TimezoneListResponse.md)
 - [UpdateStatus](docs/UpdateStatus.md)
 - [UpdateStatusCheck](docs/UpdateStatusCheck.md)
 - [UpdateStatusInstall](docs/UpdateStatusInstall.md)
 - [UpdateStatusInstallDownload](docs/UpdateStatusInstallDownload.md)
 - [VersionInfo](docs/VersionInfo.md)
 - [WifiIpMethod](docs/WifiIpMethod.md)
 - [WifiIpType](docs/WifiIpType.md)
 - [WifiSecurityMethod](docs/WifiSecurityMethod.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: X-API-Token
- **Location**: HTTP header


## Author




