Skip to content
Permalink
Browse files

added readme descriptions of modules; added comments

  • Loading branch information...
Peter Sand
Peter Sand committed Jul 19, 2014
1 parent 151b652 commit 0d4777c7820485edca47b041b7c4434b2a95c743
@@ -1,7 +1,8 @@
// Manylabs BLEShieldStream Arduino Library 0.1.0
// a stream wrapper for the Red Bear Lab BLEShield library
// copyright Manylabs 2014
// MIT license
// copyright Manylabs 2014; MIT license
// --------
// This library provides a serial-like interface to the BLE Shield from Red Bear Lab.
// It depends on the BLE library provided by Red Bear Lab.
#ifndef _BLE_SHIELD_STREAM_H_
#define _BLE_SHIELD_STREAM_H_
#if ARDUINO >= 100
@@ -1,6 +1,8 @@
// Manylabs DisplayStream Arduino Library 0.4.0
// copyright Manylabs 2014
// MIT license
// copyright Manylabs 2014; MIT license
// --------
// This library allows file-like input/output using the flash memory device found
// on the SODAQ board. It depends on the dataflash library from the SODAQ developers.
#ifndef _MANYLABS_DATA_FLASH_STREAM_H_
#define _MANYLABS_DATA_FLASH_STREAM_H_
#if ARDUINO >= 100
@@ -1,12 +1,17 @@
// Manylabs DisplayStream Arduino Library 0.4.0
// copyright Manylabs 2014
// MIT license
// copyright Manylabs 2014; MIT license
// --------
// This library allows you to use an OLED display as a serial-like stream object for
// displaying data. It is intended for diagnostic purposes in cases where a serial
// connection isn't useable. It depends on the Seeed OLED library.
#ifndef _MANYLABS_DISPLAY_STREAM_H_
#define _MANYLABS_DISPLAY_STREAM_H_
#include <Wire.h>
#include <SeeedOLED.h>


// you can define the number of rows and columns to use in your own sketch; if you don't
// the library will use defaults provided here
#ifndef STREAM_DISPLAY_ROWS
#define STREAM_DISPLAY_ROWS 8
#endif
@@ -15,6 +20,7 @@
#endif


// a stream wrapper for the a Seeed OLED display; allows serial-like printing on an OLED
class DisplayStream : public Stream {
public:

@@ -1,4 +1,40 @@
manylabs-arduino
================

Arduino libraries made by Manylabs
This is a collection of libraries for the Arduino. To use these libraries copy
them into the libraries folder in your Arduino IDE directory.

Some of the code is based on code written by others. We have tried to provide
references for uses of outside code; let us know if you see anything that needs
additional references.

If you have questions about the code, email <support@manylabs.org>.

## WireGarden

This library provides a uniform interface for a variety of sensors and other
hardware. It includes a command processing module and other communication tools.
It depends on a variety of third-party libraries (for different hardware devices).
This library intended to be a general purpose system used by a variety of Manylabs
sketches.

## WifiSender

This library provides a simple interface for sending data to a server via WiFi.
It depends on the WiFly library from Seeed Studio.

## DataFlashStream

This library allows file-like input/output using the flash memory device found
on the SODAQ board. It depends on the dataflash library from the SODAQ developers.

## DisplayStream

This library allows you to use an OLED display as a serial-like stream object for
displaying data. It is intended for diagnostic purposes in cases where a serial
connection isn't useable. It depends on the Seeed OLED library.

## BLEShieldStream

This library provides a serial-like interface to the BLE Shield from Red Bear Lab.
It depends on the BLE library provided by Red Bear Lab.
@@ -1,6 +1,8 @@
// Manylabs WifiSender Library 0.4.0
// copyright Manylabs 2014
// MIT license
// copyright Manylabs 2014; MIT license
// --------
// This library provides a simple interface for sending data to a server via WiFi.
// It depends on the WiFly library from Seeed Studio.
#ifndef _MANYLABS_WIFI_SENDER_H_
#define _MANYLABS_WIFI_SENDER_H_
#if ARDUINO >= 100
@@ -5,6 +5,12 @@
// (1) MIT license (without external GPL'd libraries)
// (2) GPL license (with external GPL'd libraries)

// This library provides a uniform interface for a variety of sensors and other
// hardware. It includes a command processing module and other communication tools.
// It depends on a variety of third-party libraries (for different hardware devices).
// This library intended to be a general purpose system used by a variety of Manylabs
// sketches.

// the library is implemented in the following header files
// (we use header file implementations in order to allow better customization from within a sketch)
#include "library/wgErrorCodes.h"

0 comments on commit 0d4777c

Please sign in to comment.
You can’t perform that action at this time.