Commit b1a06efc authored by Nelso Jost's avatar Nelso Jost

FIX: refactored C code and docs

parent 48feba9b
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
# the i18n builder cannot share the environment and doctrees with the others
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
rm -rf $(BUILDDIR)/*
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
@echo "Build finished; now you can process the pickle files."
@echo "Build finished; now you can process the JSON files."
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/arduino-meteorolog.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/arduino-meteorolog.qhc"
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/arduino-meteorolog"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/arduino-meteorolog"
@echo "# devhelp"
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
@echo "Build finished. The text files are in $(BUILDDIR)/text."
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
@echo "The overview file is in $(BUILDDIR)/changes."
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# arduino-meteorolog documentation build configuration file, created by
# sphinx-quickstart on Sun Aug 16 21:11:13 2015.
# 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.
import sys
import os
import shlex
# 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.
#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 = [
# 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 encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'arduino-meteorolog'
copyright = '2015, Nelso G. Jost'
author = 'Nelso G. Jost'
# 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 = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# 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
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# 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 themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'arduino-meteorologdoc'
# -- 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, 'arduino-meteorolog.tex', 'arduino-meteorolog Documentation',
'Nelso G. Jost', 'manual'),
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- 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, 'arduino-meteorolog', 'arduino-meteorolog Documentation',
[author], 1)
# If true, show URL addresses after external links.
#man_show_urls = False
# -- 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, 'arduino-meteorolog', 'arduino-meteorolog Documentation',
author, 'arduino-meteorolog', 'One line description of project.',
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
.. arduino-meteorolog documentation master file, created by
sphinx-quickstart on Sun Aug 16 21:11:13 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to arduino-meteorolog's documentation!
.. toctree::
:maxdepth: 2
Let me tell you: this is a test.
Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
#include "boardcommands.h"
#include "mysensors.h"
#include "utils.h"
String _sensor_names[__SENSOR_COUNT] = __LIST_SENSOR_NAMES;
String _sensor_nicknames[__SENSOR_COUNT] = __LIST_SENSOR_NICKNAMES;
ReadSensorFP _fp_array_read_sensor[__SENSOR_COUNT] = __FP_ARRAY_SENSOR_READ;
String execute_command(String csv_line)
String command = csv_line.substring(0, csv_line.indexOf(CSV_SEP));
String csv_args = csv_line.substring(csv_line.indexOf(CSV_SEP) + 1);
if (command == "readSensors" && csv_args.length() > 0)
return read_sensors(csv_args);
else if (command == "setRTC" && csv_args.length() > 0)
return set_time_from_csv(csv_args);
else if (command == "listSensors")
return get_sensor_names();
else if (command == "help")
String s = "";
return s + String("readSensors,name1,name2,...,nameN\n"
return String("<invalid_command:'") + csv_line + String("'>");
String read_sensors(String csv_line)
int s=0, e=0; // start,end string indexes
String result_line="", name;
while (e != -1)
e = csv_line.indexOf(CSV_SEP, s);
name = (e != -1) ? csv_line.substring(s, e) : csv_line.substring(s);
s = e+1;
result_line += call_read_sensor(name);
if (e != -1) result_line += CSV_SEP;
return result_line;
String call_read_sensor(String name)
for (int i=0; i < __SENSOR_COUNT; i++)
if (name == _sensor_names[i] || name == _sensor_nicknames[i])
return _fp_array_read_sensor[i]();
return String("<invalid_sensor_name:") + name + String(">");
String get_sensor_names()
String s = "";
for (int i=0; i < __SENSOR_COUNT; i++)
s += _sensor_names[i];
s += ":";
s += _sensor_nicknames[i];
if (i < __SENSOR_COUNT - 1) s += ',';
return s;
* Author: Nelso G. Jost (
* License: GPLv2
* Purpose: Serial commands parsing and execution.
#if ARDUINO >= 100
#include "Arduino.h"
#include "WProgram.h"
/* Parse and execute the serial command on the given CSV string line expected
* to be on the format:
* commandName,arg1,arg2,...,argN
* Returns a new string with the command output or "<invalid_command:...>"
* if the command name or its arguments are invalid.
String execute_command(String csv_line);
/* Given a CSV string line with sensor names or nicknames, returns a new CSV
* string with the output values of the reading function for each sensor.
* For instance, given the CSV string
* where, hipotetically, "SENSOR_A" is a valid sensor name, "WRONG" is an
* invalid one and "sb" is a valid sensor nickname (mapped to "SENSOR_B").
* This function will iterate over each one by calling call_read_sensor()
* on them. All results are joined on a new CSV string:
* 81.1,<invalid_sensor_name:WRONG>,23
String read_sensors(String csv_line);
/* Given a sensor name/nickname, call its corresponding read_SENSOR_NAME()
* function defined at "mysensors.h" and returns its string response.
* This function tries to match the given name with the ones on the global
* vectors _sensor_names[] and _sensor_nicknames[]. If positive, the index
* is used to lookup at the function pointer vector _fp_array_sensor_read[],
* retrieve the correct function and call it.
String call_read_sensor(String name);
/* Returns a CSV string with all available sensor names and nicknames on the
* following format:
* name1:nick1,name2:nick2,...,nameN:nickN
String get_sensor_names();
/* Function pointer type to be used at the vector with all read_SENSOR_NAME()
* functions. Those functions must expect no arguments and always return a
* String (with a number from the reading, presumably).
typedef String (* ReadSensorFP)(void);
* Author: Nelso G. Jost (
* License: GPLv2
* Purpose: Root file for Arduino IDE projects.
* Purpose: Entry point for the Arduino Toolchain.
#include <Wire.h>
#include "mysensors.h"
#include "utils.h"
#include "boardcommands.h"
String stream_line;
void setup()
void loop()
if (Serial.available())
#include "mysensors.h"
#include "utils.h"
......@@ -50,7 +47,6 @@ String read_BMP085_PRESSURE()
return String("<bmp085_not_found>");
// ----------------------------------------------------------------
// === RTC_DS1307 SETUP ===========================================
......@@ -5,14 +6,14 @@
String read_LDR();
#include "DHT.h"
#include "libs/DHT.h"
String read_DHT22_TEMP();
String read_DHT22_AH();
#include "Adafruit_BMP085.h"
#include "libs/Adafruit_BMP085.h"
String read_BMP085_PRESSURE();
#include "RTClib.h"
#include "libs/RTClib.h"
String read_RTC_DS1307();
String get_datetime_str(DateTime dt);
String set_time_from_csv(String s);
......@@ -20,8 +21,19 @@ String set_time_from_csv(String s);
void mysensors_setup();
#define __SENSOR_COUNT 5
#define __LIST_SENSOR_SHORT_NICKS {"l", "p", "t", "ah", "dt"}
#define __FP_ARRAY_SENSOR_READ {&read_LDR, &read_BMP085_PRESSURE, &read_DHT22_TEMP, &read_DHT22_AH, &read_RTC_DS1307}
#define __LIST_SENSOR_NICKNAMES {"l", "p", "t", "ah", "dt"}
#define __LIST_SENSOR_NAMES {"LDR", \
"DHT22_TEMP", \
"DHT22_AH", \
#define __FP_ARRAY_SENSOR_READ {&read_LDR, \
&read_BMP085_PRESSURE, \
&read_DHT22_TEMP, \
&read_DHT22_AH, \
* Author: Nelso G. Jost (
* License: BEERWARE (
* Purpose: General utilities, for instance, not present on the Wiring lib.
#include "utils.h"
#include "mysensors.h"