Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-23 11:43:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
8d1a4a4229
python-kasa/docs/source/reference.md
Steven B 0d84d8785e
Update docs with more howto examples (#968) 
Co-authored-by: Teemu R. <tpr@iki.fi>
2024-06-19 09:53:40 +01:00

2.5 KiB
Raw Blame History

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.protocol.BaseProtocol
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.iotprotocol.IotProtocol
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.smartprotocol.SmartProtocol
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.protocol.BaseTransport
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.xortransport.XorTransport
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.klaptransport.KlapTransport
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.klaptransport.KlapTransportV2
    :members:
    :inherited-members:
    :undoc-members:

.. autoclass:: kasa.aestransport.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: