mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 03:33:35 +00:00
6616d68d42
Starts structuring the documentation library usage into Tutorials, Guides, Explanations and Reference. Continues migrating new docs from rst to markdown. Extends the test framework discovery mocks to allow easy writing and testing of code examples.
135 lines
2.1 KiB
Markdown
135 lines
2.1 KiB
Markdown
# API Reference
|
|
|
|
```{currentmodule} kasa
|
|
```
|
|
|
|
## Discover
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.Discover
|
|
:members:
|
|
```
|
|
|
|
## Device
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: kasa.Device
|
|
: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:
|