.. _ref-software:

========
Software
========

Downloading the Firmware
=========================

DataGoo's firmware is open-source and can be downloaded from GitHub:
https://github.com/yesimon/datagoo. Feel free to send a pull request
if you want to contribute changes either to the source code or the
documentation.

For write access to the repository, please contact Simon at
sye737+github@gmail.com.

Building with Arduino IDE
=========================

Download the required external libraries (see :ref:`libraries-label`)
and place them in the Arduino ``libraries/`` directory. Open
``datagoo.ino``, compile and upload using the GUI.

.. _libraries-label:

Software Libraries
==================

External Libraries
------------------

EmonLib
^^^^^^^^

A significant portion of our code is based on the OpenEnergyMonitor
project, which is building an open source energy monitoring solution
targeted at homes in the UK/Europe (and to a lesser extent the US).
Their library does much of the heavy lifting for us in converting the
raw voltage and current inputs coming into the DataGoo device into
power measurements.

We forked their code base primarily because we needed to output our
readings over GSM and to an SD logger, rather than over a custom
(low-power) RF system which OpenEMon uses to transmit their data.

| `Open Energy Monitor website <http://openenergymonitor.org/emon/>`_
| `GitHub (up-to-date code) for the library <https://github.com/openenergymonitor/EmonLib/>`_

Cell Phone Communication
-------------------------

There isn't exactly a library for communicating with the GSM module;
instead, it presents itself as a Serial device which can read and
write messages.

| `GSM Module Documentation <http://www.sparkfun.com/products/9533>`_
| In particular, see the `AT command set <http://www.sparkfun.com/datasheets/Cellular%20Modules/CEL-09533-AT%20Command_V1%5B1%5D.0.0-1.pdf>`_.

Also, see `this tutorial
<http://tronixstuff.wordpress.com/2011/01/19/tutorial-arduino-and-gsm-cellular-part-one/>`_
for some example code using the GSM module.

Standard Arduino Libraries
---------------------------

SD Library
^^^^^^^^^^^^

The library to write text to SD cards is part of the Arduino standard
library. It lets us write to the SD card just by creating a file and
then calling file.print().

`SD Library <http://arduino.cc/en/Reference/SD/>`_

SoftwareSerial Library
^^^^^^^^^^^^^^^^^^^^^^^

This library is also part of the Arduino standard library and emulates
a Serial port over software, which is especially critical for
interfacing with the GSM module (which takes input and provides output
over Serial).

`SoftwareSerial Library <http://arduino.cc/en/Reference/SoftwareSerial/>`_