diff --git a/docs-src/index.rst b/docs-src/index.rst index 0e4ca63..0ed19d3 100644 --- a/docs-src/index.rst +++ b/docs-src/index.rst @@ -2,14 +2,14 @@ :hidden: self - wyze_sdk.api.devices - wyze_sdk.models.devices - wyze_sdk.models.events + wyze_sdk.api + wyze_sdk.models + wyze_sdk.errors wyze_sdk.signature + wyze_sdk.logging -============================================== -Wyze SDK -============================================== +Getting Started with Wyze SDK +***************************** A modern Python client for controlling Wyze devices. @@ -50,7 +50,7 @@ Whether you're building a custom app, or integrating into a third-party service **As this repository is entirely reverse-engineered, it may break at any time. If it does, I will fix it to the best of my ability.** Installation -************ +============ This package supports Python 3.8 and higher. I recommend using `PyPI `_ to install Wyze SDK @@ -88,7 +88,7 @@ You can run the code this way. python test.py Getting Help -************ +============ If you get stuck, I'm here to help. The following are the best ways to get assistance working through your issue: @@ -96,9 +96,10 @@ If you get stuck, I'm here to help. The following are the best ways to get assis .. include:: metadata.rst -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Indices and Tables + ------------------ + + * :ref:`genindex` + * :ref:`search` diff --git a/docs-src/metadata.rst b/docs-src/metadata.rst index 6fb3253..aaac18d 100644 --- a/docs-src/metadata.rst +++ b/docs-src/metadata.rst @@ -5,5 +5,5 @@ .. |github_username| replace:: shauntarves .. _Issue Tracker: http://github.com/shauntarves/wyze-sdk/issues -.. _pull request: http://github.com/shauntarves/wyze-sdk/pulls +.. _Pull Requests: http://github.com/shauntarves/wyze-sdk/pulls .. _License: https://github.com/shauntarves/wyze-sdk/blob/main/LICENSE \ No newline at end of file diff --git a/docs-src/modules.rst b/docs-src/modules.rst deleted file mode 100644 index 0cda973..0000000 --- a/docs-src/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -wyze_sdk -======== - -.. toctree:: - :maxdepth: 4 - - wyze_sdk diff --git a/docs-src/wyze_sdk.api.devices.rst b/docs-src/wyze_sdk.api.devices.rst deleted file mode 100644 index 856e4fe..0000000 --- a/docs-src/wyze_sdk.api.devices.rst +++ /dev/null @@ -1,78 +0,0 @@ -wyze\_sdk.api.devices package -============================= - -Submodules ----------- - -wyze\_sdk.api.devices.bulbs module ----------------------------------- - -.. automodule:: wyze_sdk.api.devices.bulbs - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.api.devices.cameras module ------------------------------------- - -.. automodule:: wyze_sdk.api.devices.cameras - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.locks module ----------------------------------- - -.. automodule:: wyze_sdk.api.devices.locks - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.plugs module ----------------------------------- - -.. automodule:: wyze_sdk.api.devices.plugs - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.scales module ------------------------------------ - -.. automodule:: wyze_sdk.api.devices.scales - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.sensors module ------------------------------------- - -.. automodule:: wyze_sdk.api.devices.sensors - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.thermostats module ----------------------------------------- - -.. automodule:: wyze_sdk.api.devices.thermostats - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.api.devices.vacuums module ------------------------------------- - -.. automodule:: wyze_sdk.api.devices.vacuums - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: wyze_sdk.api.devices - :members: - :undoc-members: - :show-inheritance: diff --git a/docs-src/wyze_sdk.api.rst b/docs-src/wyze_sdk.api.rst index 12f0ac0..8cbcb6f 100644 --- a/docs-src/wyze_sdk.api.rst +++ b/docs-src/wyze_sdk.api.rst @@ -1,45 +1,89 @@ -wyze\_sdk.api package -===================== +Web Client +********** -Subpackages ------------ +.. autoclass:: wyze_sdk.api.Client + :members: + :undoc-members: -.. toctree:: - :maxdepth: 4 +Bulbs +===== +.. autoclass:: wyze_sdk.api.devices.bulbs.BulbsClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: - wyze_sdk.api.devices +Cameras +======= +.. autoclass:: wyze_sdk.api.devices.cameras.CamerasClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: -Submodules ----------- +Locks +===== +.. autoclass:: wyze_sdk.api.devices.locks.LocksClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: -wyze\_sdk.api.base module -------------------------- +Plugs +===== +.. autoclass:: wyze_sdk.api.devices.plugs.PlugsClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: -.. automodule:: wyze_sdk.api.base +Scales +====== +.. autoclass:: wyze_sdk.api.devices.scales.ScalesClient :members: :undoc-members: + :inherited-members: :show-inheritance: -wyze\_sdk.api.client module ---------------------------- +Sensors +======= -.. automodule:: wyze_sdk.api.client +Contact Sensors +--------------- +.. autoclass:: wyze_sdk.api.devices.sensors.ContactSensorsClient :members: :undoc-members: + :inherited-members: :show-inheritance: -wyze\_sdk.api.events module ---------------------------- +Entry Sensors +------------- +.. autoclass:: wyze_sdk.api.devices.sensors.MotionSensorsClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: -.. automodule:: wyze_sdk.api.events +Thermostats +=========== +.. autoclass:: wyze_sdk.api.devices.thermostats.ThermostatsClient :members: :undoc-members: + :inherited-members: :show-inheritance: -Module contents ---------------- +Vacuums +======= +.. autoclass:: wyze_sdk.api.devices.vacuums.VacuumsClient + :members: + :undoc-members: + :inherited-members: + :show-inheritance: -.. automodule:: wyze_sdk.api +Events +====== +.. autoclass:: wyze_sdk.api.events.EventsClient :members: :undoc-members: + :inherited-members: :show-inheritance: diff --git a/docs-src/wyze_sdk.errors.rst b/docs-src/wyze_sdk.errors.rst index d50fa18..4bbcab0 100644 --- a/docs-src/wyze_sdk.errors.rst +++ b/docs-src/wyze_sdk.errors.rst @@ -1,8 +1,8 @@ -wyze\_sdk.errors package -======================== +Errors +****** -Module contents ---------------- +wyze\_sdk.errors +---------------- .. automodule:: wyze_sdk.errors :members: diff --git a/docs-src/wyze_sdk.logging.rst b/docs-src/wyze_sdk.logging.rst new file mode 100644 index 0000000..e0b6b41 --- /dev/null +++ b/docs-src/wyze_sdk.logging.rst @@ -0,0 +1,5 @@ +Logging +******* + +.. automodule:: wyze_sdk + :members: diff --git a/docs-src/wyze_sdk.models.devices.rst b/docs-src/wyze_sdk.models.devices.rst deleted file mode 100644 index 0fde010..0000000 --- a/docs-src/wyze_sdk.models.devices.rst +++ /dev/null @@ -1,93 +0,0 @@ -wyze\_sdk.models.devices package -================================ - -Submodules ----------- - -wyze\_sdk.models.devices.base module ------------------------------------- - -.. automodule:: wyze_sdk.models.devices.base - :members: - :undoc-members: - :show-inheritance: - -wyze\_sdk.models.devices.bulbs module -------------------------------------- - -.. automodule:: wyze_sdk.models.devices.bulbs - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.cameras module ---------------------------------------- - -.. automodule:: wyze_sdk.models.devices.cameras - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.locks module -------------------------------------- - -.. automodule:: wyze_sdk.models.devices.locks - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.plugs module -------------------------------------- - -.. automodule:: wyze_sdk.models.devices.plugs - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.scales module --------------------------------------- - -.. automodule:: wyze_sdk.models.devices.scales - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.sensors module ---------------------------------------- - -.. automodule:: wyze_sdk.models.devices.sensors - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.thermostats module -------------------------------------------- - -.. automodule:: wyze_sdk.models.devices.thermostats - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -wyze\_sdk.models.devices.vacuums module ---------------------------------------- - -.. automodule:: wyze_sdk.models.devices.vacuums - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: wyze_sdk.models.devices - :members: - :undoc-members: - :show-inheritance: diff --git a/docs-src/wyze_sdk.models.events.rst b/docs-src/wyze_sdk.models.events.rst deleted file mode 100644 index 0c9e737..0000000 --- a/docs-src/wyze_sdk.models.events.rst +++ /dev/null @@ -1,10 +0,0 @@ -wyze\_sdk.models.events package -=============================== - -Module contents ---------------- - -.. automodule:: wyze_sdk.models.events - :members: - :undoc-members: - :show-inheritance: diff --git a/docs-src/wyze_sdk.models.rst b/docs-src/wyze_sdk.models.rst index 8638e9f..6ccf645 100644 --- a/docs-src/wyze_sdk.models.rst +++ b/docs-src/wyze_sdk.models.rst @@ -1,19 +1,90 @@ -wyze\_sdk.models package -======================== +Data Models +*********** -Subpackages ------------ +Devices +======= -.. toctree:: - :maxdepth: 4 +wyze\_sdk.models.devices.base +----------------------------- - wyze_sdk.models.devices - wyze_sdk.models.events +.. autoclass:: wyze_sdk.models.devices.base.Device + :members: + :undoc-members: + :inherited-members: +.. autoclass:: wyze_sdk.models.devices.base.Product + :members: + :undoc-members: +.. autoclass:: wyze_sdk.models.devices.base.Timezone + :members: + :undoc-members: + +wyze\_sdk.models.devices.bulbs +------------------------------ + +.. automodule:: wyze_sdk.models.devices.bulbs + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.cameras +-------------------------------- + +.. automodule:: wyze_sdk.models.devices.cameras + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.locks +------------------------------ + +.. automodule:: wyze_sdk.models.devices.locks + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.plugs +------------------------------ -Module contents ---------------- +.. automodule:: wyze_sdk.models.devices.plugs + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.scales +------------------------------- + +.. automodule:: wyze_sdk.models.devices.scales + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.sensors +-------------------------------- + +.. automodule:: wyze_sdk.models.devices.sensors + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.thermostats +------------------------------------ + +.. automodule:: wyze_sdk.models.devices.thermostats + :members: + :undoc-members: + :inherited-members: + +wyze\_sdk.models.devices.vacuums +-------------------------------- + +.. automodule:: wyze_sdk.models.devices.vacuums + :members: + :undoc-members: + :inherited-members: -.. automodule:: wyze_sdk.models +Events +====== +.. automodule:: wyze_sdk.models.events :members: :undoc-members: - :show-inheritance: + :inherited-members: diff --git a/docs-src/wyze_sdk.rst b/docs-src/wyze_sdk.rst deleted file mode 100644 index b0ca345..0000000 --- a/docs-src/wyze_sdk.rst +++ /dev/null @@ -1,33 +0,0 @@ -wyze\_sdk package -================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - wyze_sdk.api - wyze_sdk.errors - wyze_sdk.models - wyze_sdk.service - wyze_sdk.signature - -Submodules ----------- - -wyze\_sdk.version module ------------------------- - -.. automodule:: wyze_sdk.version - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: wyze_sdk - :members: - :undoc-members: - :show-inheritance: diff --git a/docs-src/wyze_sdk.signature.rst b/docs-src/wyze_sdk.signature.rst index 584ac81..e006044 100644 --- a/docs-src/wyze_sdk.signature.rst +++ b/docs-src/wyze_sdk.signature.rst @@ -1,5 +1,5 @@ -wyze\_sdk.signature package -=========================== +Request Signature Verification +============================== Module contents --------------- diff --git a/docs/html/genindex.html b/docs/html/genindex.html index 7e922e9..d21fa01 100644 --- a/docs/html/genindex.html +++ b/docs/html/genindex.html @@ -68,21 +68,17 @@

Index

A

-
  • api_test() (wyze_sdk.api.client.Client method) -
    • -
  • api_type() (wyze_sdk.models.PropDef property) -
    • -
  • api_value() (wyze_sdk.models.devices.base.DeviceProp property) +
  • api_test() (wyze_sdk.api.Client method)
  • ApiServiceClient (class in wyze_sdk.service.api_service)
    • -
  • attributes (wyze_sdk.models.devices.base.Device attribute) +
  • attributes (wyze_sdk.models.devices.base.Device attribute)
    • -
  • attributes() (wyze_sdk.models.devices.base.AbstractNetworkedDevice property) +
  • attributes() (wyze_sdk.models.devices.bulbs.Bulb property)