python-kasa/docs/source/smartplug.rst

Plugs
=====

.. contents:: Contents
   :local:

.. note::

    Feel free to open a pull request to improve the documentation!


API documentation
*****************

.. autoclass:: kasa.SmartPlug
    :members:
    :inherited-members:
    :undoc-members:
Simplify API documentation by using doctests (#73) * Add doctests to SmartBulb * Add SmartDevice doctests, cleanup README.md * add doctests for smartplug and smartstrip * add discover doctests * Fix bulb mock * add smartdimmer doctests * add sphinx-generated docs, cleanup readme a bit * remove sphinx-click as it does not work with asyncclick * in preparation for rtd hooking, move doc deps to be separate from dev deps * pytestmark needs to be applied separately for each and every file, this fixes the tests * use pathlib for resolving relative paths * Skip discovery doctest on python3.7 The code is just fine, but some reason the mocking behaves differently between 3.7 and 3.8. The latter seems to accept a discrete object for asyncio.run where the former expects a coroutine.. 2020-06-30 00:29:52 +00:00			`Plugs`
			`=====`

Add ToCs for doc pages (#380) 2022-10-18 17:08:10 +00:00			`.. contents:: Contents`
			`:local:`

Improve cli documentation for bulbs and power strips (#123) 2020-12-09 09:13:14 +00:00			`.. note::`

			`Feel free to open a pull request to improve the documentation!`


			`API documentation`
			`*****************`

Simplify API documentation by using doctests (#73) * Add doctests to SmartBulb * Add SmartDevice doctests, cleanup README.md * add doctests for smartplug and smartstrip * add discover doctests * Fix bulb mock * add smartdimmer doctests * add sphinx-generated docs, cleanup readme a bit * remove sphinx-click as it does not work with asyncclick * in preparation for rtd hooking, move doc deps to be separate from dev deps * pytestmark needs to be applied separately for each and every file, this fixes the tests * use pathlib for resolving relative paths * Skip discovery doctest on python3.7 The code is just fine, but some reason the mocking behaves differently between 3.7 and 3.8. The latter seems to accept a discrete object for asyncio.run where the former expects a coroutine.. 2020-06-30 00:29:52 +00:00			`.. autoclass:: kasa.SmartPlug`
			`:members:`
Various documentation updates (#333) * Add a note about socket sharing * Show inherited members for apidocs * Remove outdated note of emeters not being supported on smartstrips * Describe emeter and usage modules, add note about NTP for time sync * Describe lib design and modules * Bump sphinx version, ignore d001 (line-length) for doc8 * demote energy & usage to 3rd level, promote api for 2nd 2022-04-05 23:13:27 +00:00			`:inherited-members:`
Simplify API documentation by using doctests (#73) * Add doctests to SmartBulb * Add SmartDevice doctests, cleanup README.md * add doctests for smartplug and smartstrip * add discover doctests * Fix bulb mock * add smartdimmer doctests * add sphinx-generated docs, cleanup readme a bit * remove sphinx-click as it does not work with asyncclick * in preparation for rtd hooking, move doc deps to be separate from dev deps * pytestmark needs to be applied separately for each and every file, this fixes the tests * use pathlib for resolving relative paths * Skip discovery doctest on python3.7 The code is just fine, but some reason the mocking behaves differently between 3.7 and 3.8. The latter seems to accept a discrete object for asyncio.run where the former expects a coroutine.. 2020-06-30 00:29:52 +00:00			`:undoc-members:`