python-kasa/docs/source/reference.md

2.5 KiB

API Reference

Discover

.. autoclass:: Discover
    :members:

Device

.. autoclass:: Device
    :members:
    :undoc-members:

Device Config

.. autoclass:: Credentials
    :members:
    :undoc-members:
    :noindex:
.. 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
    :noindex:
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: Feature
    :noindex:
    :members:
    :inherited-members:
    :undoc-members:
.. automodule:: kasa.interfaces
    :noindex:
    :members:
    :inherited-members:
    :undoc-members:

Protocols and transports

.. autoclass:: kasa.protocols.BaseProtocol
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.protocols.IotProtocol
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.protocols.SmartProtocol
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.transports.BaseTransport
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.transports.XorTransport
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.transports.KlapTransport
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.transports.KlapTransportV2
    :members:
    :inherited-members:
    :undoc-members:
.. autoclass:: kasa.transports.AesTransport
    :members:
    :inherited-members:
    :undoc-members:

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: