2024-06-03 09:14:10 +00:00
|
|
|
# API Reference
|
|
|
|
|
|
|
|
## Discover
|
|
|
|
|
2024-06-03 18:06:54 +00:00
|
|
|
|
|
|
|
```{module} kasa.discover
|
|
|
|
```
|
|
|
|
|
2024-06-03 09:14:10 +00:00
|
|
|
```{eval-rst}
|
|
|
|
.. autoclass:: kasa.Discover
|
|
|
|
:members:
|
|
|
|
```
|
|
|
|
|
|
|
|
## Device
|
|
|
|
|
2024-06-03 18:06:54 +00:00
|
|
|
```{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:
|
|
|
|
```
|
|
|
|
|
2024-06-03 09:14:10 +00:00
|
|
|
```{eval-rst}
|
2024-06-03 18:06:54 +00:00
|
|
|
.. autoclass:: kasa.DeviceEncryption
|
2024-06-03 09:14:10 +00:00
|
|
|
: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:
|