Add API docs
parent
b384c2cec6
commit
d44a318e70
|
@ -1 +1,2 @@
|
||||||
*.pyc
|
*.pyc
|
||||||
|
docs/_build
|
||||||
|
|
|
@ -0,0 +1,20 @@
|
||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS = -a -E
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
SPHINXPROJ = SpejsIoT
|
||||||
|
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)
|
|
@ -0,0 +1,157 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# SpejsIoT documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Sat Jan 21 15:20:14 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', 'sphinxcontrib.autohttp.flask']
|
||||||
|
|
||||||
|
# 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 = 'SpejsIoT'
|
||||||
|
copyright = '2017, informatic'
|
||||||
|
author = 'informatic'
|
||||||
|
|
||||||
|
# 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 = '1.0'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '1.0.0'
|
||||||
|
|
||||||
|
# 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 = 'SpejsIoTdoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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, 'SpejsIoT.tex', 'SpejsIoT Documentation',
|
||||||
|
'informatic', '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, 'spejsiot', 'SpejsIoT 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, 'SpejsIoT', 'SpejsIoT Documentation',
|
||||||
|
author, 'SpejsIoT', 'One line description of project.',
|
||||||
|
'Miscellaneous'),
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,31 @@
|
||||||
|
SpejsIoT REST API documentation
|
||||||
|
===============================
|
||||||
|
|
||||||
|
Resources
|
||||||
|
---------
|
||||||
|
|
||||||
|
.. autoflask:: main:app
|
||||||
|
:undoc-static:
|
||||||
|
|
||||||
|
|
||||||
|
Example usage
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. sourcecode:: python
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
API = 'http://spejsiot.waw.hackerspace.pl'
|
||||||
|
|
||||||
|
# Get current device status
|
||||||
|
info = requests.get(API + '/api/1/devices/exhaust/').json()
|
||||||
|
print(info)
|
||||||
|
|
||||||
|
# Set negated relay state
|
||||||
|
requests.put(
|
||||||
|
API + '/api/1/devices/exhaust/relay/on',
|
||||||
|
json={'value': not info['relay']['on']})
|
||||||
|
|
||||||
|
# Show modified device status
|
||||||
|
print(requests.get(API + '/api/1/devices/exhaust/').json())
|
||||||
|
|
40
main.py
40
main.py
|
@ -26,16 +26,34 @@ def utility_processor():
|
||||||
@app.route('/')
|
@app.route('/')
|
||||||
def index():
|
def index():
|
||||||
if app.config.get('DISABLE_GUI'):
|
if app.config.get('DISABLE_GUI'):
|
||||||
flask.abort(404)
|
return flask.redirect(flask.url_for(
|
||||||
|
'static', filename='apidocs/index.html'))
|
||||||
|
|
||||||
return flask.render_template('index.html', devices=manager.devices)
|
return flask.render_template('index.html', devices=manager.devices)
|
||||||
|
|
||||||
@app.route('/api/1/devices/')
|
@app.route('/api/1/devices/')
|
||||||
def api_devices():
|
def api_devices():
|
||||||
|
"""Lists all known devices.
|
||||||
|
|
||||||
|
:status 200: list of all devices
|
||||||
|
:>json object [device_id]: listed device info object
|
||||||
|
"""
|
||||||
|
|
||||||
return flask.jsonify({k: v.dictify() for k, v in manager.devices.items()})
|
return flask.jsonify({k: v.dictify() for k, v in manager.devices.items()})
|
||||||
|
|
||||||
@app.route('/api/1/devices/<node_id>/')
|
@app.route('/api/1/devices/<node_id>/')
|
||||||
def api_device_info(node_id):
|
def api_device_info(node_id):
|
||||||
|
"""Returns specified device info object.
|
||||||
|
|
||||||
|
:param node_id: device ID or device name
|
||||||
|
:status 200: device found
|
||||||
|
:status 404: no device found
|
||||||
|
|
||||||
|
:>json string $name: human-readable device name
|
||||||
|
:>json boolean $online: device is currently online
|
||||||
|
:>json object [endpoint_name]: endpoint object
|
||||||
|
:>json [endpoint_name].[prop_name]: last endpoint property value
|
||||||
|
"""
|
||||||
node = manager.find_node(node_id)
|
node = manager.find_node(node_id)
|
||||||
|
|
||||||
if not node:
|
if not node:
|
||||||
|
@ -43,15 +61,33 @@ def api_device_info(node_id):
|
||||||
|
|
||||||
return flask.jsonify(node.dictify())
|
return flask.jsonify(node.dictify())
|
||||||
|
|
||||||
@app.route('/api/1/device/<node_id>/<endpoint>/<prop>/<value>')
|
# @app.route('/api/1/device/<node_id>/<endpoint>/<prop>/<value>')
|
||||||
@app.route('/api/1/devices/<node_id>/<endpoint>/<prop>/<value>')
|
@app.route('/api/1/devices/<node_id>/<endpoint>/<prop>/<value>')
|
||||||
def device_write(node_id, endpoint, prop, value):
|
def device_write(node_id, endpoint, prop, value):
|
||||||
|
"""Sets specified value to device endpoint and prop.
|
||||||
|
|
||||||
|
:param node_id: device ID or device name
|
||||||
|
:param endpoint: endpoint name
|
||||||
|
:param prop: endpoint property name
|
||||||
|
:param value: value to set
|
||||||
|
:status 200: device found
|
||||||
|
:status 404: no device found
|
||||||
|
"""
|
||||||
return flask.jsonify({
|
return flask.jsonify({
|
||||||
"result": manager.handle_request(node_id, endpoint, prop, value)
|
"result": manager.handle_request(node_id, endpoint, prop, value)
|
||||||
})
|
})
|
||||||
|
|
||||||
@app.route('/api/1/devices/<node_id>/<endpoint>/<prop>', methods=['PUT'])
|
@app.route('/api/1/devices/<node_id>/<endpoint>/<prop>', methods=['PUT'])
|
||||||
def device_put(node_id, endpoint, prop):
|
def device_put(node_id, endpoint, prop):
|
||||||
|
"""Sets specified value to device endpoint and prop.
|
||||||
|
|
||||||
|
:param node_id: device ID or device name
|
||||||
|
:param endpoint: endpoint name
|
||||||
|
:param prop: endpoint property name
|
||||||
|
:<json value: value to set
|
||||||
|
:status 200: device found
|
||||||
|
:status 404: no device found
|
||||||
|
"""
|
||||||
return device_write(node_id, endpoint, prop, flask.request.json['value'])
|
return device_write(node_id, endpoint, prop, flask.request.json['value'])
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
alabaster==0.7.9
|
||||||
|
Babel==2.3.4
|
||||||
|
click==6.7
|
||||||
|
docutils==0.13.1
|
||||||
|
Flask==0.12
|
||||||
|
imagesize==0.7.1
|
||||||
|
itsdangerous==0.24
|
||||||
|
Jinja2==2.9.4
|
||||||
|
MarkupSafe==0.23
|
||||||
|
paho-mqtt==1.2
|
||||||
|
pkg-resources==0.0.0
|
||||||
|
Pygments==2.1.3
|
||||||
|
pytz==2016.10
|
||||||
|
requests==2.12.5
|
||||||
|
six==1.10.0
|
||||||
|
snowballstemmer==1.2.1
|
||||||
|
Sphinx==1.5.1
|
||||||
|
sphinxcontrib-httpdomain==1.5.0
|
||||||
|
Werkzeug==0.11.15
|
|
@ -83,4 +83,9 @@ class SpejsiotManager(mqtt.Client):
|
||||||
if not node:
|
if not node:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
if value == True:
|
||||||
|
value = 'true'
|
||||||
|
elif value == False:
|
||||||
|
value = 'false'
|
||||||
|
|
||||||
return node.set(endpoint, prop, value)
|
return node.set(endpoint, prop, value)
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
../docs/_build/html/
|
Loading…
Reference in New Issue