Version 0.0.5 (#25)

* Added Sphinx documentation (#23)

* Added Sphinx documentation

* Exclude flake8 from docs directory

* Added developer documentation link to README.rst

* Added support for getting the mode and also battery_level from device (#22)

* Added code to create an event stream and get notifications from arlo device. This can be used to get mode, battery level of camera and even all other properties of camera. Created properties to pull the base station properties, camera properties, schedule, rules etc. Also added property to get the battery level of cameras as well as filled the mode getter function to return the mode.

* Added code to create an event stream and get notifications from arlo device. This can be used to get mode, battery level of camera and even all other properties of camera. Created properties to pull the base station properties, camera properties, schedule, rules etc. Also added property to get the battery level of cameras as well as filled the mode getter function to return the mode.

* Updating the requirements.txt to add sseclient

* Updating the requirements.txt to add sseclient-py

* Updating the setup.py to add sseclient-py

* Addressing the review comments by @tchellomello

* Addressing the comments posted by CI bot

* Added code to get the per camera battery level. Added a new property called get_battery_level for camera. It will return the battery level of that camera alone.

* Fixing the review comment by CI bot. Also updated the README file with the commands to get properties, battery level, mode etc

* Added new properties for base station and camera. Added property in base station to fetch the schedule and a boolean property to find out if motion detection is enabled or not. Added properties in camera to get flip, mirror, power save mode, connection status, signal strength etc.

* Added property in camera to fetch the motion detection sensitivity

* Added property in camera to fetch the motion detection sensitivity : fixed the lint errors.

* Updated README with new properties

* Bump version 0.0.5

README.rst

@@ -16,6 +16,9 @@ Python Arlo
 
 Python Arlo  is a library written in Python 2.7/3x that exposes the Netgear Arlo cameras as Python objects.
 
+Developer Documentation: `http://python-arlo.readthedocs.io/ <http://python-arlo.readthedocs.io/>`_
+
+
 Installation
 ------------
 
@@ -41,24 +44,80 @@ Usage
     # listing base stations
     arlo.base_stations
 
+    # get base station handle
+    # assuming only 1 base station is available
+    base = arlo.base_stations[0]
+
     # listing Arlo modes
     base.available_modes
     ['armed', 'disarmed', 'schedule', 'custom']
 
-    # setting a mode
-    garage_cam.mode = 'armed'
-
     # listing all cameras
     arlo.cameras
 
     # showing camera preferences
     cam = arlo.cameras[0]
 
+    # check if camera is connected to base station
+    cam.is_camera_connected
+    True
+
+    # setting a mode
+    cam.mode = 'armed'
+
+    # getting the current active mode
+    cam.mode
+    'armed'
+
     # printing camera attributes
     cam.serial_number
     cam.model_id
     cam.unseen_videos
 
+    # get brightness value of camera
+    cam.get_brightness
+
+    # get signal strength of camera with base station
+    cam.get_signal_strength
+    
+    # get flip property from camera
+    cam.get_flip_state
+
+    # get mirror property from camera
+    cam.get_mirror_state
+
+    # get power save mode value from camera
+    cam.get_powersave_mode
+
+    # get current battery level of camera
+    cam.get_battery_level
+    92
+
+    # get boolean result if motion detection
+    # is enabled or not
+    cam.is_motion_detection_enabled
+    True
+
+    # get battery levels of all cameras
+    # prints serial number and battery level of each camera
+    base.get_camera_battery_level
+    {'4N71235T12345': 92, '4N71235T12345': 90}    
+
+    # get base station properties
+    base.get_basestation_properties
+
+    # get camera properties
+    base.get_camera_properties
+
+    # get camera rules
+    base.get_camera_rules
+
+    # get camera schedule
+    base.get_camera_schedule
+
+    # get camera motion detection sensitivity
+    cam.get_motion_detection_sensitivity
+
     # refreshing camera properties
     cam.update()
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = PyArlo
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,160 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# PyArlo documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 27 00:04:52 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'PyArlo'
+copyright = '2017, Marcelo Moreira de Mello <[email protected]>'
+author = 'Marcelo Moreira de Mello <[email protected]>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'PyArlodoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'PyArlo.tex', 'PyArlo Documentation',
+     'Marcelo Moreira de Mello \\textless{}[email protected]\\textgreater{}', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pyarlo', 'PyArlo Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'PyArlo', 'PyArlo Documentation',
+     author, 'PyArlo', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,63 @@
+.. PyArlo documentation master file, created by
+   sphinx-quickstart on Tue Jun 27 00:04:52 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyArlo's documentation!
+==================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Python Arlo  is a library written in Python 2.7/3x that exposes the Netgear Arlo cameras as Python objects.
+
+Documentation for developers.
+
+
+PyArlo
+------
+.. autoclass:: pyarlo.PyArlo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+ArloBaseStation
+---------------
+.. autoclass:: pyarlo.base_station.ArloBaseStation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ArloCamera
+----------
+.. autoclass:: pyarlo.camera.ArloCamera
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ArloMediaLibrary
+----------------
+.. autoclass:: pyarlo.media.ArloMediaLibrary
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ArloVideo
+---------
+.. autoclass:: pyarlo.media.ArloVideo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=PyArlo
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd