2024-06-03 09:14:10 +00:00
|
|
|
# API Reference
|
|
|
|
|
|
|
|
## Discover
|
|
|
|
|
2024-06-03 18:06:54 +00:00
|
|
|
|
2024-06-19 08:53:40 +00:00
|
|
|
```{module} kasa
|
2024-06-03 18:06:54 +00:00
|
|
|
```
|
|
|
|
|
2024-06-03 09:14:10 +00:00
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: Discover
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
```
|
|
|
|
|
|
|
|
## Device
|
|
|
|
|
2024-06-03 18:06:54 +00:00
|
|
|
|
|
|
|
```{eval-rst}
|
|
|
|
.. autoclass:: Device
|
|
|
|
:members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## Device Config
|
|
|
|
|
|
|
|
|
|
|
|
```{eval-rst}
|
|
|
|
.. autoclass:: Credentials
|
|
|
|
:members:
|
|
|
|
:undoc-members:
|
2024-06-19 08:53:40 +00:00
|
|
|
:noindex:
|
2024-06-03 18:06:54 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
```{eval-rst}
|
|
|
|
.. autoclass:: DeviceConfig
|
|
|
|
:members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: DeviceFamily
|
2024-06-03 18:06:54 +00:00
|
|
|
:members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: DeviceConnectionParameters
|
2024-06-03 18:06:54 +00:00
|
|
|
:members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
2024-06-03 09:14:10 +00:00
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: DeviceEncryptionType
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
## Modules and Features
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: Module
|
2024-06-03 09:14:10 +00:00
|
|
|
:noindex:
|
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. autoclass:: Feature
|
2024-06-03 09:14:10 +00:00
|
|
|
:noindex:
|
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-06-19 08:53:40 +00:00
|
|
|
.. automodule:: kasa.interfaces
|
2024-06-03 09:14:10 +00:00
|
|
|
:noindex:
|
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
## Protocols and transports
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-13 17:50:21 +00:00
|
|
|
.. autoclass:: kasa.protocols.BaseProtocol
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-13 17:50:21 +00:00
|
|
|
.. autoclass:: kasa.protocols.IotProtocol
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-13 17:50:21 +00:00
|
|
|
.. autoclass:: kasa.protocols.SmartProtocol
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-12 13:40:44 +00:00
|
|
|
.. autoclass:: kasa.transports.BaseTransport
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-12 13:40:44 +00:00
|
|
|
.. autoclass:: kasa.transports.XorTransport
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-12 13:40:44 +00:00
|
|
|
.. autoclass:: kasa.transports.KlapTransport
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-12 13:40:44 +00:00
|
|
|
.. autoclass:: kasa.transports.KlapTransportV2
|
2024-06-03 09:14:10 +00:00
|
|
|
:members:
|
|
|
|
:inherited-members:
|
|
|
|
:undoc-members:
|
|
|
|
```
|
|
|
|
|
|
|
|
```{eval-rst}
|
2024-11-12 13:40:44 +00:00
|
|
|
.. autoclass:: kasa.transports.AesTransport
|
2024-06-03 09:14:10 +00:00
|
|
|
: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:
|