busybar-python-sdk

HTTP API for BUSY Bar web server

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import busybar_python_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import busybar_python_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Author