mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
be5202ccb7
Adds username and password arguments to discovery to remove the need to import Credentials. Creates TypeAliases in Device for connection configuration classes and DeviceType. Using the API with these changes will only require importing either Discover or Device depending on whether using Discover.discover() or Device.connect() to initialize and interact with the API.
179 lines
2.6 KiB
Markdown
179 lines
2.6 KiB
Markdown
# API Reference
|
|
|
|
## Discover
|
|
|
|
|
|
```{module} kasa.discover
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.Discover
|
|
:members:
|
|
```
|
|
|
|
## Device
|
|
|
|
```{module} kasa.device
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: Device
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
|
|
## Device Config
|
|
|
|
```{module} kasa.credentials
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: Credentials
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{module} kasa.deviceconfig
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: DeviceConfig
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.DeviceFamily
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.DeviceConnection
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.DeviceEncryption
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
## Modules and Features
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.Module
|
|
:noindex:
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. automodule:: kasa.interfaces
|
|
:noindex:
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.Feature
|
|
:noindex:
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
## Protocols and transports
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.protocol.BaseProtocol
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.iotprotocol.IotProtocol
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.smartprotocol.SmartProtocol
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.protocol.BaseTransport
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.xortransport.XorTransport
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.klaptransport.KlapTransport
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.klaptransport.KlapTransportV2
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.aestransport.AesTransport
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
```
|
|
|
|
## Errors and exceptions
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.exceptions.KasaException
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.exceptions.DeviceError
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.exceptions.AuthenticationError
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.exceptions.UnsupportedDeviceError
|
|
:members:
|
|
:undoc-members:
|
|
```
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.exceptions.TimeoutError
|
|
:members:
|
|
:undoc-members:
|