python-kasa · sdb9696 · Jun 3, 2024 · May 23, 2024 · May 23, 2024 · May 23, 2024
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-<h2 align="center">python-kasa</h2>
+# python-kasa
 
 [![PyPI version](https://badge.fury.io/py/python-kasa.svg)](https://badge.fury.io/py/python-kasa)
 [![Build Status](https://github.com/python-kasa/python-kasa/actions/workflows/ci.yml/badge.svg)](https://github.com/python-kasa/python-kasa/actions/workflows/ci.yml)

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -37,6 +37,10 @@
     "myst_parser",
 ]
 
+myst_enable_extensions = [
+    "colon_fence",
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/docs/source/deprecated.md b/docs/source/deprecated.md
@@ -0,0 +1,24 @@
+# Deprecated API
+
+```{currentmodule} kasa
+```
+The page contains the documentation for the deprecated library API that only works with the older kasa devices.
+
+If you want to continue to use the old API for older devices,
+you can use the classes in the `iot` module to avoid deprecation warnings.
+
+```py
+from kasa.iot import IotDevice, IotBulb, IotPlug, IotDimmer, IotStrip, IotLightStrip
+```
+
+
+```{toctree}
+:maxdepth: 2
+
+smartdevice
+smartbulb
+smartplug
+smartdimmer
+smartstrip
+smartlightstrip
+```
diff --git a/docs/source/discover.rst b/docs/source/discover.rst
diff --git a/docs/source/guides.md b/docs/source/guides.md
@@ -0,0 +1,42 @@
+# How-to Guides
+
+This page contains guides of how to perform common actions using the library.
+
+## Discover devices
+
+```{eval-rst}
+.. automodule:: kasa.discover
+```
+
+## Connect without discovery
+
+```{eval-rst}
+.. automodule:: kasa.deviceconfig
+```
+
+## Get Energy Consumption and Usage Statistics
+
+:::{note}
+In order to use the helper methods to calculate the statistics correctly, your devices need to have correct time set.
+The devices use NTP and public servers from [NTP Pool Project](https://www.ntppool.org/) to synchronize their time.
+:::
+
+### Energy Consumption
+
+The availability of energy consumption sensors depend on the device.
+While most of the bulbs support it, only specific switches (e.g., HS110) or strips (e.g., HS300) support it.
+You can use {attr}`~Device.has_emeter` to check for the availability.
+
+
+### Usage statistics
+
+You can use {attr}`~Device.on_since` to query for the time the device has been turned on.
+Some devices also support reporting the usage statistics on daily or monthly basis.
+You can access this information using through the usage module ({class}`kasa.modules.Usage`):
+
+```py
+dev = SmartPlug("127.0.0.1")
+usage = dev.modules["usage"]
+print(f"Minutes on this month: {usage.usage_this_month}")
+print(f"Minutes on today: {usage.usage_today}")
+```
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,12 @@
+```{include} ../../README.md
+```
+
+```{toctree}
+:maxdepth: 2
+
+Home <self>
+cli
+library
+contribute
+SUPPORTED
+```
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/library.md b/docs/source/library.md
@@ -0,0 +1,15 @@
+# Library usage
+
+```{currentmodule} kasa
+```
+The page contains all information about the library usage:
+
+```{toctree}
+:maxdepth: 2
+
+tutorial
+guides
+topics
+reference
+deprecated
+```
diff --git a/docs/source/reference.md b/docs/source/reference.md
@@ -0,0 +1,134 @@
+# 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: