The first version of the stonesThrow library is available for download!

Version A001 (zip archive) Released: July 12, 2009

This library is being actively developed and the included functions are in the early proof of concept stages. There is a lot of room for optimization and improvement. Suggestions are welcome.

Installing the Library

• Download and unpack the archive

• Place the StonesThrow folder inside the Arduino IDE Libraries folder. The path should resemble: Arduino-XXXX/hardware/libraries

• Restart the Arduino IDE if it is open.

• StonesThrow should now appear in the Sketch\Import Library menu

Include the Library

There are two ways to include the library in a sketch:

• At the top of your sketch, type
  

  #include <StonesThrow.h>

• using the menus, select: Sketch\Import Library\StonesThrow

Use the Library

Full function details and examples are available on the Reference page .

Reads the value (either HIGH or LOW) from a specified digital pin on a remote I/O board . This function automatically sets the pinMode() of the target pin to INPUT.

NOTE: the remoteRead functions in this library can be MUCH slower than remoteWrite functions.  This is because remoteRead requires a serial handshake, which is time consuming.  Where possible, call remoteRead functions no more than 1x per second, or conceive of a system where remote changes are written.  Also,  transitions (edges) are best detected locally and then written to a remote NODE.

Compare with Arduino analogWrite()

Syntax

int remoteDigitalRead(pin);

Parameters

pin: the target pin number, INTEGER

Returns

Integer: 1 (HIGH) or 0 (LOW)

Example:

All examples require two NODES to operate. For simplicity, one NODE should run the following while another NODE is running the listener example.

Attach an LED to digital PIN 11 of the listener NODE. Attach a button or other digital input circuit to PIN 3 of NODE running this code.

#include <StonesThrow.h>

StonesThrow st;

#define myID 2
#define pairWithID 1

void setup(){
 st.begin(myID, pairWithID);
 pinMode(11,OUTPUT);                             //  must set pinmode for LOCAL pins

}

void loop(){

   int digitalValue =  st.remoteDigitalRead(3);   // read digital PIN3 on REMOTE node 

   Serial.print("digitalValue: ");
   Serial.println(digitalValue);

   digitalWrite(11, digitalValue);     // write scaled reading to LOCAL pin
                                                    // REMEMBER set local pinModes!

   delay(100);  

}

[index]

Write an analog value to a PWM pin on a remote I/O board. The function automatically sets the pinMode() of the target pin to output. The analog write value expects a value between 0 – 255.

Compare with Arduino analogWrite()

Syntax

remoteAnalogWrite(pin, value);

Parameters

pin: the target pin number, INTEGER

value: 0 (off) – 255 (on), INTEGER

Returns

none

Example:

All examples require two NODES to operate. For simplicity, one NODE should run the following while another NODE is running the listener example.

Attach an LED to digital PIN 11 of the listener NODE.

#include <StonesThrow.h>

StonesThrow st;

#define myID 2
#define pairWithID 1

void setup(){
   st.begin(myID, pairWithID);
}

void loop(){

   int analogValue = analogRead(0);            // read a local analog pin

   analogValue = map(analogValue,0,1023,0,100);  // scale reading to single BYTE

   st.remoteAnalogWrite(11, analogValue);      // write scaled reading to remote NODE

   delay(250);  // can be smaller but if erratic results emerge -- increase again

}

[index]

Reads the value from the specified analog pin of a remote I/O board. Newer Arduino based i/o boards have six, 10-bit analog to digital converters. Input voltages are mapped from 0 to 1023. The function returns the full 10 bit (max 1023) value. YOU must SCALE it for ANALOG output through PWM (analogWrite).

NOTE: the remoteRead functions in this library can be MUCH slower than remoteWrite functions.  This is because remoteRead requires a serial handshake, which is time consuming.  Where possible, call remoteRead functions no more than 1x per second, or conceive of a system where remote changes are written.  Also,  transitions (edges) are best detected locally and then written to a remote NODE.

Compare with Arduino analogRead()

Syntax

remoteAnalogRead(pin);

Parameters

pin: the target pin number, INTEGER

Returns

Integer: Range 0 -1023

Example:

All examples require two NODES to operate. For simplicity, one NODE should run the following while another NODE is running the listener example.

Attach an LED to digital PIN 11 of the listener NODE. Attach a POT, photoCell or other analog input circuit to analog PIN 0 of the NODE running this code.

#include <StonesThrow.h>

StonesThrow st;

#define myID 2
#define pairWithID 1

void setup(){
   st.begin(myID, pairWithID);
   pinMode(11,OUTPUT);      //  must set pinmode for local PINs
}

void loop(){

   int analogValue = st.remoteAnalogRead(0);     // read a REMOTE analog pin

   analogValue = map(analogValue,0,1023,0,100);  // scale reading to single BYTE

   analogWrite(11, analogValue);                 // write scaled reading to LOCAL pin

   delay(100);  

}

[index]

Polls the hardware serial buffer for incoming StonesThrow messages, and executes function calls. It can be included on its own or in a sketch with I/O functions.

Syntax

update();

Parameters

none

Returns

none

Context / Example:

update() should be placed inside the loop() structure of an Arduino sketch.  It MUST be included in NODES that you wish to control remotely.

void loop(){
   st.update();
}

[index]

Write a HIGH or a LOW value to a digital pin on a remote I/O board. The function automatically sets the pinMode() of the target pin to output.

Compare with Arduino digitalWrite()

Syntax

remoteDigitalWrite(pin, value);

Parameters

pin: the target PIN number, INTEGER

value: HIGH or LOW

Returns

none

Example:

All examples require two NODES to operate. For simplicity, one NODE should run the following while another NODE is running the listener example.

Attach an LED to digital PIN 11 of the listener NODE.

#include 

StonesThrow st;

#define myID 2
#define pairWithID 1

void setup(){
  st.begin(myID, pairWithID);
}

void loop(){

  st.remoteDigitalWrite(11,HIGH);
  delay(1000);
  st.remoteDigitalWrite(11,LOW);
  delay(1000);

}

[index]