python-ring-doorbell · tchellomello · Oct 17, 2017 · May 18, 2017 · Jun 1, 2017 · Jun 2, 2017
diff --git a/README.rst b/README.rst
@@ -8,8 +8,8 @@ Python Ring Door Bell
 .. image:: https://travis-ci.org/tchellomello/python-ring-doorbell.svg?branch=master
     :target: https://travis-ci.org/tchellomello/python-ring-doorbell
 
-.. image:: https://coveralls.io/repos/github/tchellomello/python-ring-doorbell/badge.svg
-    :target: https://coveralls.io/github/tchellomello/python-ring-doorbell
+.. image:: https://coveralls.io/repos/github/tchellomello/python-ring-doorbell/badge.svg?branch=master
+    :target: https://coveralls.io/github/tchellomello/python-ring-doorbell?branch=master
 
 .. image:: https://img.shields.io/pypi/pyversions/ring-doorbell.svg
     :target: https://pypi.python.org/pypi/ring-doorbell
@@ -20,6 +20,8 @@ that exposes the Ring.com devices as Python objects.
 
 *Currently Ring.com does not provide an official API. The results of this project are merely from reverse engineering.*
 
+Documentation: `http://python-ring-doorbell.readthedocs.io/ <http://python-ring-doorbell.readthedocs.io/>`_
+
 
 Installation
 ------------
@@ -30,7 +32,7 @@ Installation
     $ pip install ring_doorbell
 
     # Installing latest development
-    $ pip3 install \
+    $ pip install \
         git+https://github.com/tchellomello/python-ring-doorbell@dev
 
 
@@ -63,11 +65,15 @@ Listing devices linked to your account
     myring.doorbells
     [<RingDoorBell: Front Door>]
 
-Playing with the attributes
----------------------------
+    # All stickup cams
+    myring.stickup_cams
+    [<RingStickUpCam: Driveway>]
+
+Playing with the attributes and functions
+-----------------------------------------
 .. code-block:: python
 
-    for dev in list(myring.chimes + myring.doorbells):
+    for dev in list(myring.stickup_cams + myring.chimes + myring.doorbells):
 
         # refresh data
         dev.update()
@@ -78,6 +84,8 @@ Playing with the attributes
         print('ID:         %s' % dev.id)
         print('Name:       %s' % dev.name)
         print('Timezone:   %s' % dev.timezone)
+        print('Wifi Name:  %s' % dev.wifi_name)
+        print('Wifi RSSI:  %s' % dev.wifi_signal_strength)
 
         # setting dev volume
         print('Volume:     %s' % dev.volume)
@@ -86,7 +94,8 @@ Playing with the attributes
 
         # play dev test shound
         if dev.family == 'chimes'
-            dev.test_sound
+            dev.test_sound(kind = 'ding')
+            dev.test_sound(kind = 'motion')
 
 
 Showing door bell events

diff --git a/docs/source/credits.rst b/docs/source/credits.rst
diff --git a/docs/source/how_to.rst b/docs/source/how_to.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,15 +10,162 @@ that exposes the Ring.com devices as Python objects.
     Ring.com does not provide an official API.
     The results of this project are merely from reverse engineering.
 
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   Installation <installation.rst>
-   How to Use it <how_to.rst>
-   Source Code <source_code.rst>
-   Credits & Thanks <credits.rst>
+Installation
+------------
+
+.. code-block:: bash
+
+    # Installing from PyPi
+    $ pip install ring_doorbell
+
+    # Installing latest development
+    $ pip install \
+        git+https://github.com/tchellomello/python-ring-doorbell@dev
+
+
+Initializing your Ring object
+-----------------------------
+
+.. code-block:: python
+
+    from ring_doorbell import Ring
+    myring = Ring('foo@bar', 'secret')
+
+    myring.is_connected
+    True
+
+Listing devices linked to your account
+--------------------------------------
+
+.. code-block:: python
+
+    # All devices
+    myring.devices
+    {'chimes': [<RingChime: Downstairs>],
+    'doorbells': [<RingDoorBell: Front Door>]}
+
+    # All chimes
+    myring.chimes
+    [<RingChime: Downstairs>]
+
+    # All door bells
+    myring.doorbells
+    [<RingDoorBell: Front Door>]
+
+    # All stickup cams
+    myring.stickup_cams
+    [<RingStickUpCam: Driveway>]
+
+
+Playing with the attributes
+---------------------------
+.. code-block:: python
+
+    for dev in list(myring.stickup_cams + myring.chimes + myring.doorbells):
+
+        # refresh data
+        dev.update()
+
+        print('Account ID: %s' % dev.account_id)
+        print('Address:    %s' % dev.address)
+        print('Family:     %s' % dev.family)
+        print('ID:         %s' % dev.id)
+        print('Name:       %s' % dev.name)
+        print('Timezone:   %s' % dev.timezone)
+        print('Wifi Name:  %s' % dev.wifi_name)
+        print('Wifi RSSI:  %s' % dev.wifi_signal_strength)
+
+        # setting dev volume
+        print('Volume:     %s' % dev.volume)
+        dev.volume = 5
+        print('Volume:     %s' % dev.volume)
+
+        # play dev test shound
+        if dev.family == 'chimes'
+            dev.test_sound
+
+
+Showing door bell events
+------------------------
+.. code-block:: python
+
+    for doorbell in myring.doorbells:
+
+        # listing the last 15 events of any kind
+        for event in doorbell.history(limit=15):
+            print('ID:       %s' % event['id'])
+            print('Kind:     %s' % event['kind'])
+            print('Answered: %s' % event['answered'])
+            print('When:     %s' % event['created_at'])
+            print('--' * 50)
+
+        # get a event list only the triggered by motion
+        events = doorbell.history(kind='motion')
+
+
+Downloading the last video triggered by ding
+--------------------------------------------
+.. code-block:: python
+
+    doorbell = myring.doorbells[0]
+    doorbell.recording_download(
+        doorbell.history(limit=100, kind='ding')[0]['id'],
+                         filename='/home/user/last_ding.mp4',
+                         override=True)
+
+
+Displaying the last video capture URL
+-------------------------------------
+.. code-block:: python
+
+    print(doorbell.recording_url(doorbell.last_recording_id))
+    'https://ring-transcoded-videos.s3.amazonaws.com/99999999.mp4?X-Amz-Expires=3600&X-Amz-Date=20170313T232537Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TOKEN_SECRET/us-east-1/s3/aws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=secret'
+
+
+Developing
+==========
+
+.. autoclass:: ring_doorbell.Ring
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: ring_doorbell.generic.RingGeneric
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: ring_doorbell.chime.RingChime
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. autoclass:: ring_doorbell.doorbot.RingDoorBell
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
+
+.. autoclass:: ring_doorbell.stickup_cam.RingStickUpCam
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :inherited-members:
+
+
+Credits && Thanks
+-----------------
+
+* This project was inspired and based on https://github.com/jeroenmoors/php-ring-api. Many thanks @jeroenmoors.
+* A guy named MadBagger at Prism19 for his initial research (http://www.prism19.com/doorbot/second-pass-and-comm-reversing/)
+* The creators of mitmproxy (https://mitmproxy.org/) great http and https traffic inspector
+* @mfussenegger for his post on mitmproxy and virtualbox https://zignar.net/2015/12/31/sniffing-vbox-traffic-mitmproxy/
+* To the project http://www.android-x86.org/ which allowed me to install Android on KVM.
+
 
 Indices and tables
 ==================

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
diff --git a/docs/source/source_code.rst b/docs/source/source_code.rst
diff --git a/requirements_tests.txt b/requirements_tests.txt
@@ -4,4 +4,5 @@ mock
 pylint
 pytest
 pytest-cov
+requests_mock
 tox
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ mock @@
     pylint
     pytest
     pytest-cov
+    requests_mock
     tox