Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 11:13:34 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
master
python-kasa/docs/source/reference.md
Steven B. 59e5073509
Some checks are pending
CI / Perform linting checks (3.13) (push) Waiting to run
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, macos-latest, 3.11) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, macos-latest, 3.12) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, macos-latest, 3.13) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, ubuntu-latest, 3.11) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, ubuntu-latest, 3.12) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, ubuntu-latest, 3.13) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, windows-latest, 3.11) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, windows-latest, 3.12) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (false, windows-latest, 3.13) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (true, ubuntu-latest, 3.11) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (true, ubuntu-latest, 3.12) (push) Blocked by required conditions
Details
CI / Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (extras)", ""]')[matrix.extras == ''] }} (true, ubuntu-latest, 3.13) (push) Blocked by required conditions
Details
CodeQL checks / Analyze (python) (push) Waiting to run
Details
Update docs for new FeatureAttribute behaviour (#1365) 
Co-authored-by: Teemu R. <tpr@iki.fi>
2024-12-13 22:23:58 +01:00

1.8 KiB
Raw Permalink Blame History

API Reference

Discover

.. autoclass:: Discover
    :members:

Device

% N.B. Credentials clashes with autodoc

.. autoclass:: Device
    :members:
    :undoc-members:
    :exclude-members: Credentials

Device Config

.. autoclass:: Credentials
    :members:
    :undoc-members:

.. autoclass:: DeviceConfig
    :members:
    :undoc-members:

.. autoclass:: DeviceFamily
    :members:
    :undoc-members:

.. autoclass:: DeviceConnectionParameters
    :members:
    :undoc-members:

.. autoclass:: DeviceEncryptionType
    :members:
    :undoc-members:

Modules and Features

.. autoclass:: Module
    :members:

.. autoclass:: Feature
    :members:
    :inherited-members:
    :undoc-members:

.. automodule:: kasa.interfaces
    :members:
    :inherited-members:
    :undoc-members:

Protocols and transports

.. automodule:: kasa.protocols
    :members:
    :imported-members:
    :undoc-members:
    :exclude-members: SmartErrorCode
    :no-index:

.. automodule:: kasa.transports
    :members:
    :imported-members:
    :undoc-members:
    :no-index:

Errors and exceptions

.. autoclass:: kasa.exceptions.KasaException
    :members:
    :undoc-members:

.. autoclass:: kasa.exceptions.DeviceError
    :members:
    :undoc-members:

.. autoclass:: kasa.exceptions.AuthenticationError
    :members:
    :undoc-members:

.. autoclass:: kasa.exceptions.UnsupportedDeviceError
    :members:
    :undoc-members:

.. autoclass:: kasa.exceptions.TimeoutError
    :members:
    :undoc-members: