add libraries
This commit is contained in:
parent
e3a3562177
commit
7d4a3b6e57
|
|
@ -0,0 +1,257 @@
|
|||
#include "LiquidCrystal_I2C.h"
|
||||
#include <inttypes.h>
|
||||
#include <Arduino.h>
|
||||
#include <Wire.h>
|
||||
|
||||
// When the display powers up, it is configured as follows:
|
||||
//
|
||||
// 1. Display clear
|
||||
// 2. Function set:
|
||||
// DL = 1; 8-bit interface data
|
||||
// N = 0; 1-line display
|
||||
// F = 0; 5x8 dot character font
|
||||
// 3. Display on/off control:
|
||||
// D = 0; Display off
|
||||
// C = 0; Cursor off
|
||||
// B = 0; Blinking off
|
||||
// 4. Entry mode set:
|
||||
// I/D = 1; Increment by 1
|
||||
// S = 0; No shift
|
||||
//
|
||||
// Note, however, that resetting the Arduino doesn't reset the LCD, so we
|
||||
// can't assume that its in that state when a sketch starts (and the
|
||||
// LiquidCrystal constructor is called).
|
||||
|
||||
LiquidCrystal_I2C::LiquidCrystal_I2C(uint8_t lcd_addr, uint8_t lcd_cols, uint8_t lcd_rows, uint8_t charsize)
|
||||
{
|
||||
_addr = lcd_addr;
|
||||
_cols = lcd_cols;
|
||||
_rows = lcd_rows;
|
||||
_charsize = charsize;
|
||||
_backlightval = LCD_BACKLIGHT;
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::begin() {
|
||||
Wire.begin();
|
||||
_displayfunction = LCD_4BITMODE | LCD_1LINE | LCD_5x8DOTS;
|
||||
|
||||
if (_rows > 1) {
|
||||
_displayfunction |= LCD_2LINE;
|
||||
}
|
||||
|
||||
// for some 1 line displays you can select a 10 pixel high font
|
||||
if ((_charsize != 0) && (_rows == 1)) {
|
||||
_displayfunction |= LCD_5x10DOTS;
|
||||
}
|
||||
|
||||
// SEE PAGE 45/46 FOR INITIALIZATION SPECIFICATION!
|
||||
// according to datasheet, we need at least 40ms after power rises above 2.7V
|
||||
// before sending commands. Arduino can turn on way befer 4.5V so we'll wait 50
|
||||
delay(50);
|
||||
|
||||
// Now we pull both RS and R/W low to begin commands
|
||||
expanderWrite(_backlightval); // reset expanderand turn backlight off (Bit 8 =1)
|
||||
delay(1000);
|
||||
|
||||
//put the LCD into 4 bit mode
|
||||
// this is according to the hitachi HD44780 datasheet
|
||||
// figure 24, pg 46
|
||||
|
||||
// we start in 8bit mode, try to set 4 bit mode
|
||||
write4bits(0x03 << 4);
|
||||
delayMicroseconds(4500); // wait min 4.1ms
|
||||
|
||||
// second try
|
||||
write4bits(0x03 << 4);
|
||||
delayMicroseconds(4500); // wait min 4.1ms
|
||||
|
||||
// third go!
|
||||
write4bits(0x03 << 4);
|
||||
delayMicroseconds(150);
|
||||
|
||||
// finally, set to 4-bit interface
|
||||
write4bits(0x02 << 4);
|
||||
|
||||
// set # lines, font size, etc.
|
||||
command(LCD_FUNCTIONSET | _displayfunction);
|
||||
|
||||
// turn the display on with no cursor or blinking default
|
||||
_displaycontrol = LCD_DISPLAYON | LCD_CURSOROFF | LCD_BLINKOFF;
|
||||
display();
|
||||
|
||||
// clear it off
|
||||
clear();
|
||||
|
||||
// Initialize to default text direction (for roman languages)
|
||||
_displaymode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDECREMENT;
|
||||
|
||||
// set the entry mode
|
||||
command(LCD_ENTRYMODESET | _displaymode);
|
||||
|
||||
home();
|
||||
}
|
||||
|
||||
/********** high level commands, for the user! */
|
||||
void LiquidCrystal_I2C::clear(){
|
||||
command(LCD_CLEARDISPLAY);// clear display, set cursor position to zero
|
||||
delayMicroseconds(2000); // this command takes a long time!
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::home(){
|
||||
command(LCD_RETURNHOME); // set cursor position to zero
|
||||
delayMicroseconds(2000); // this command takes a long time!
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::setCursor(uint8_t col, uint8_t row){
|
||||
int row_offsets[] = { 0x00, 0x40, 0x14, 0x54 };
|
||||
if (row > _rows) {
|
||||
row = _rows-1; // we count rows starting w/0
|
||||
}
|
||||
command(LCD_SETDDRAMADDR | (col + row_offsets[row]));
|
||||
}
|
||||
|
||||
// Turn the display on/off (quickly)
|
||||
void LiquidCrystal_I2C::noDisplay() {
|
||||
_displaycontrol &= ~LCD_DISPLAYON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
void LiquidCrystal_I2C::display() {
|
||||
_displaycontrol |= LCD_DISPLAYON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
|
||||
// Turns the underline cursor on/off
|
||||
void LiquidCrystal_I2C::noCursor() {
|
||||
_displaycontrol &= ~LCD_CURSORON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
void LiquidCrystal_I2C::cursor() {
|
||||
_displaycontrol |= LCD_CURSORON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
|
||||
// Turn on and off the blinking cursor
|
||||
void LiquidCrystal_I2C::noBlink() {
|
||||
_displaycontrol &= ~LCD_BLINKON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
void LiquidCrystal_I2C::blink() {
|
||||
_displaycontrol |= LCD_BLINKON;
|
||||
command(LCD_DISPLAYCONTROL | _displaycontrol);
|
||||
}
|
||||
|
||||
// These commands scroll the display without changing the RAM
|
||||
void LiquidCrystal_I2C::scrollDisplayLeft(void) {
|
||||
command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVELEFT);
|
||||
}
|
||||
void LiquidCrystal_I2C::scrollDisplayRight(void) {
|
||||
command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT);
|
||||
}
|
||||
|
||||
// This is for text that flows Left to Right
|
||||
void LiquidCrystal_I2C::leftToRight(void) {
|
||||
_displaymode |= LCD_ENTRYLEFT;
|
||||
command(LCD_ENTRYMODESET | _displaymode);
|
||||
}
|
||||
|
||||
// This is for text that flows Right to Left
|
||||
void LiquidCrystal_I2C::rightToLeft(void) {
|
||||
_displaymode &= ~LCD_ENTRYLEFT;
|
||||
command(LCD_ENTRYMODESET | _displaymode);
|
||||
}
|
||||
|
||||
// This will 'right justify' text from the cursor
|
||||
void LiquidCrystal_I2C::autoscroll(void) {
|
||||
_displaymode |= LCD_ENTRYSHIFTINCREMENT;
|
||||
command(LCD_ENTRYMODESET | _displaymode);
|
||||
}
|
||||
|
||||
// This will 'left justify' text from the cursor
|
||||
void LiquidCrystal_I2C::noAutoscroll(void) {
|
||||
_displaymode &= ~LCD_ENTRYSHIFTINCREMENT;
|
||||
command(LCD_ENTRYMODESET | _displaymode);
|
||||
}
|
||||
|
||||
// Allows us to fill the first 8 CGRAM locations
|
||||
// with custom characters
|
||||
void LiquidCrystal_I2C::createChar(uint8_t location, uint8_t charmap[]) {
|
||||
location &= 0x7; // we only have 8 locations 0-7
|
||||
command(LCD_SETCGRAMADDR | (location << 3));
|
||||
for (int i=0; i<8; i++) {
|
||||
write(charmap[i]);
|
||||
}
|
||||
}
|
||||
|
||||
// Turn the (optional) backlight off/on
|
||||
void LiquidCrystal_I2C::noBacklight(void) {
|
||||
_backlightval=LCD_NOBACKLIGHT;
|
||||
expanderWrite(0);
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::backlight(void) {
|
||||
_backlightval=LCD_BACKLIGHT;
|
||||
expanderWrite(0);
|
||||
}
|
||||
bool LiquidCrystal_I2C::getBacklight() {
|
||||
return _backlightval == LCD_BACKLIGHT;
|
||||
}
|
||||
|
||||
|
||||
/*********** mid level commands, for sending data/cmds */
|
||||
|
||||
inline void LiquidCrystal_I2C::command(uint8_t value) {
|
||||
send(value, 0);
|
||||
}
|
||||
|
||||
inline size_t LiquidCrystal_I2C::write(uint8_t value) {
|
||||
send(value, Rs);
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
||||
/************ low level data pushing commands **********/
|
||||
|
||||
// write either command or data
|
||||
void LiquidCrystal_I2C::send(uint8_t value, uint8_t mode) {
|
||||
uint8_t highnib=value&0xf0;
|
||||
uint8_t lownib=(value<<4)&0xf0;
|
||||
write4bits((highnib)|mode);
|
||||
write4bits((lownib)|mode);
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::write4bits(uint8_t value) {
|
||||
expanderWrite(value);
|
||||
pulseEnable(value);
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::expanderWrite(uint8_t _data){
|
||||
Wire.beginTransmission(_addr);
|
||||
Wire.write((int)(_data) | _backlightval);
|
||||
Wire.endTransmission();
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::pulseEnable(uint8_t _data){
|
||||
expanderWrite(_data | En); // En high
|
||||
delayMicroseconds(1); // enable pulse must be >450ns
|
||||
|
||||
expanderWrite(_data & ~En); // En low
|
||||
delayMicroseconds(50); // commands need > 37us to settle
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::load_custom_character(uint8_t char_num, uint8_t *rows){
|
||||
createChar(char_num, rows);
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::setBacklight(uint8_t new_val){
|
||||
if (new_val) {
|
||||
backlight(); // turn backlight on
|
||||
} else {
|
||||
noBacklight(); // turn backlight off
|
||||
}
|
||||
}
|
||||
|
||||
void LiquidCrystal_I2C::printstr(const char c[]){
|
||||
//This function is not identical to the function used for "real" I2C displays
|
||||
//it's here so the user sketch doesn't have to be changed
|
||||
print(c);
|
||||
}
|
||||
|
|
@ -0,0 +1,165 @@
|
|||
#ifndef FDB_LIQUID_CRYSTAL_I2C_H
|
||||
#define FDB_LIQUID_CRYSTAL_I2C_H
|
||||
|
||||
#include <inttypes.h>
|
||||
#include <Print.h>
|
||||
|
||||
// commands
|
||||
#define LCD_CLEARDISPLAY 0x01
|
||||
#define LCD_RETURNHOME 0x02
|
||||
#define LCD_ENTRYMODESET 0x04
|
||||
#define LCD_DISPLAYCONTROL 0x08
|
||||
#define LCD_CURSORSHIFT 0x10
|
||||
#define LCD_FUNCTIONSET 0x20
|
||||
#define LCD_SETCGRAMADDR 0x40
|
||||
#define LCD_SETDDRAMADDR 0x80
|
||||
|
||||
// flags for display entry mode
|
||||
#define LCD_ENTRYRIGHT 0x00
|
||||
#define LCD_ENTRYLEFT 0x02
|
||||
#define LCD_ENTRYSHIFTINCREMENT 0x01
|
||||
#define LCD_ENTRYSHIFTDECREMENT 0x00
|
||||
|
||||
// flags for display on/off control
|
||||
#define LCD_DISPLAYON 0x04
|
||||
#define LCD_DISPLAYOFF 0x00
|
||||
#define LCD_CURSORON 0x02
|
||||
#define LCD_CURSOROFF 0x00
|
||||
#define LCD_BLINKON 0x01
|
||||
#define LCD_BLINKOFF 0x00
|
||||
|
||||
// flags for display/cursor shift
|
||||
#define LCD_DISPLAYMOVE 0x08
|
||||
#define LCD_CURSORMOVE 0x00
|
||||
#define LCD_MOVERIGHT 0x04
|
||||
#define LCD_MOVELEFT 0x00
|
||||
|
||||
// flags for function set
|
||||
#define LCD_8BITMODE 0x10
|
||||
#define LCD_4BITMODE 0x00
|
||||
#define LCD_2LINE 0x08
|
||||
#define LCD_1LINE 0x00
|
||||
#define LCD_5x10DOTS 0x04
|
||||
#define LCD_5x8DOTS 0x00
|
||||
|
||||
// flags for backlight control
|
||||
#define LCD_BACKLIGHT 0x08
|
||||
#define LCD_NOBACKLIGHT 0x00
|
||||
|
||||
#define En B00000100 // Enable bit
|
||||
#define Rw B00000010 // Read/Write bit
|
||||
#define Rs B00000001 // Register select bit
|
||||
|
||||
/**
|
||||
* This is the driver for the Liquid Crystal LCD displays that use the I2C bus.
|
||||
*
|
||||
* After creating an instance of this class, first call begin() before anything else.
|
||||
* The backlight is on by default, since that is the most likely operating mode in
|
||||
* most cases.
|
||||
*/
|
||||
class LiquidCrystal_I2C : public Print {
|
||||
public:
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param lcd_addr I2C slave address of the LCD display. Most likely printed on the
|
||||
* LCD circuit board, or look in the supplied LCD documentation.
|
||||
* @param lcd_cols Number of columns your LCD display has.
|
||||
* @param lcd_rows Number of rows your LCD display has.
|
||||
* @param charsize The size in dots that the display has, use LCD_5x10DOTS or LCD_5x8DOTS.
|
||||
*/
|
||||
LiquidCrystal_I2C(uint8_t lcd_addr, uint8_t lcd_cols, uint8_t lcd_rows, uint8_t charsize = LCD_5x8DOTS);
|
||||
|
||||
/**
|
||||
* Set the LCD display in the correct begin state, must be called before anything else is done.
|
||||
*/
|
||||
void begin();
|
||||
|
||||
/**
|
||||
* Remove all the characters currently shown. Next print/write operation will start
|
||||
* from the first position on LCD display.
|
||||
*/
|
||||
void clear();
|
||||
|
||||
/**
|
||||
* Next print/write operation will will start from the first position on the LCD display.
|
||||
*/
|
||||
void home();
|
||||
|
||||
/**
|
||||
* Do not show any characters on the LCD display. Backlight state will remain unchanged.
|
||||
* Also all characters written on the display will return, when the display in enabled again.
|
||||
*/
|
||||
void noDisplay();
|
||||
|
||||
/**
|
||||
* Show the characters on the LCD display, this is the normal behaviour. This method should
|
||||
* only be used after noDisplay() has been used.
|
||||
*/
|
||||
void display();
|
||||
|
||||
/**
|
||||
* Do not blink the cursor indicator.
|
||||
*/
|
||||
void noBlink();
|
||||
|
||||
/**
|
||||
* Start blinking the cursor indicator.
|
||||
*/
|
||||
void blink();
|
||||
|
||||
/**
|
||||
* Do not show a cursor indicator.
|
||||
*/
|
||||
void noCursor();
|
||||
|
||||
/**
|
||||
* Show a cursor indicator, cursor can blink on not blink. Use the
|
||||
* methods blink() and noBlink() for changing cursor blink.
|
||||
*/
|
||||
void cursor();
|
||||
|
||||
void scrollDisplayLeft();
|
||||
void scrollDisplayRight();
|
||||
void printLeft();
|
||||
void printRight();
|
||||
void leftToRight();
|
||||
void rightToLeft();
|
||||
void shiftIncrement();
|
||||
void shiftDecrement();
|
||||
void noBacklight();
|
||||
void backlight();
|
||||
bool getBacklight();
|
||||
void autoscroll();
|
||||
void noAutoscroll();
|
||||
void createChar(uint8_t, uint8_t[]);
|
||||
void setCursor(uint8_t, uint8_t);
|
||||
virtual size_t write(uint8_t);
|
||||
void command(uint8_t);
|
||||
|
||||
inline void blink_on() { blink(); }
|
||||
inline void blink_off() { noBlink(); }
|
||||
inline void cursor_on() { cursor(); }
|
||||
inline void cursor_off() { noCursor(); }
|
||||
|
||||
// Compatibility API function aliases
|
||||
void setBacklight(uint8_t new_val); // alias for backlight() and nobacklight()
|
||||
void load_custom_character(uint8_t char_num, uint8_t *rows); // alias for createChar()
|
||||
void printstr(const char[]);
|
||||
|
||||
private:
|
||||
void send(uint8_t, uint8_t);
|
||||
void write4bits(uint8_t);
|
||||
void expanderWrite(uint8_t);
|
||||
void pulseEnable(uint8_t);
|
||||
uint8_t _addr;
|
||||
uint8_t _displayfunction;
|
||||
uint8_t _displaycontrol;
|
||||
uint8_t _displaymode;
|
||||
uint8_t _cols;
|
||||
uint8_t _rows;
|
||||
uint8_t _charsize;
|
||||
uint8_t _backlightval;
|
||||
};
|
||||
|
||||
#endif // FDB_LIQUID_CRYSTAL_I2C_H
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# Installation #
|
||||
Create a new folder called "LiquidCrystal_I2C" under the folder named "libraries" in your Arduino sketchbook folder.
|
||||
Create the folder "libraries" in case it does not exist yet. Place all the files in the "LiquidCrystal_I2C" folder.
|
||||
|
||||
# Usage #
|
||||
To use the library in your own sketch, select it from *Sketch > Import Library*.
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
This library is based on work done by DFROBOT (www.dfrobot.com).
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
#include <Wire.h>
|
||||
#include <LiquidCrystal_I2C.h>
|
||||
|
||||
// Set the LCD address to 0x27 for a 16 chars and 2 line display
|
||||
LiquidCrystal_I2C lcd(0x27, 16, 2);
|
||||
|
||||
void setup()
|
||||
{
|
||||
// initialize the LCD
|
||||
lcd.begin();
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
bool blinking = true;
|
||||
lcd.cursor();
|
||||
|
||||
while (1) {
|
||||
if (blinking) {
|
||||
lcd.clear();
|
||||
lcd.print("No cursor blink");
|
||||
lcd.noBlink();
|
||||
blinking = false;
|
||||
} else {
|
||||
lcd.clear();
|
||||
lcd.print("Cursor blink");
|
||||
lcd.blink();
|
||||
blinking = true;
|
||||
}
|
||||
delay(4000);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
#include <Wire.h>
|
||||
#include <LiquidCrystal_I2C.h>
|
||||
|
||||
uint8_t bell[8] = {0x4, 0xe, 0xe, 0xe, 0x1f, 0x0, 0x4};
|
||||
uint8_t note[8] = {0x2, 0x3, 0x2, 0xe, 0x1e, 0xc, 0x0};
|
||||
uint8_t clock[8] = {0x0, 0xe, 0x15, 0x17, 0x11, 0xe, 0x0};
|
||||
uint8_t heart[8] = {0x0, 0xa, 0x1f, 0x1f, 0xe, 0x4, 0x0};
|
||||
uint8_t duck[8] = {0x0, 0xc, 0x1d, 0xf, 0xf, 0x6, 0x0};
|
||||
uint8_t check[8] = {0x0, 0x1 ,0x3, 0x16, 0x1c, 0x8, 0x0};
|
||||
uint8_t cross[8] = {0x0, 0x1b, 0xe, 0x4, 0xe, 0x1b, 0x0};
|
||||
uint8_t retarrow[8] = { 0x1, 0x1, 0x5, 0x9, 0x1f, 0x8, 0x4};
|
||||
|
||||
// Set the LCD address to 0x27 for a 16 chars and 2 line display
|
||||
LiquidCrystal_I2C lcd(0x27, 16, 2);
|
||||
|
||||
void setup()
|
||||
{
|
||||
lcd.begin();
|
||||
lcd.backlight();
|
||||
|
||||
lcd.createChar(0, bell);
|
||||
lcd.createChar(1, note);
|
||||
lcd.createChar(2, clock);
|
||||
lcd.createChar(3, heart);
|
||||
lcd.createChar(4, duck);
|
||||
lcd.createChar(5, check);
|
||||
lcd.createChar(6, cross);
|
||||
lcd.createChar(7, retarrow);
|
||||
lcd.home();
|
||||
|
||||
lcd.print("Hello world...");
|
||||
lcd.setCursor(0, 1);
|
||||
lcd.print(" i ");
|
||||
lcd.write(3);
|
||||
lcd.print(" arduinos!");
|
||||
delay(5000);
|
||||
displayKeyCodes();
|
||||
}
|
||||
|
||||
// display all keycodes
|
||||
void displayKeyCodes(void) {
|
||||
uint8_t i = 0;
|
||||
|
||||
while (1) {
|
||||
lcd.clear();
|
||||
lcd.print("Codes 0x");
|
||||
lcd.print(i, HEX);
|
||||
lcd.print("-0x");
|
||||
lcd.print(i + 16, HEX);
|
||||
lcd.setCursor(0, 1);
|
||||
|
||||
for (int j = 0; j < 16; j++) {
|
||||
lcd.write(i + j);
|
||||
}
|
||||
i += 16;
|
||||
|
||||
delay(4000);
|
||||
}
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
// Do nothing here...
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
#include <Wire.h>
|
||||
#include <LiquidCrystal_I2C.h>
|
||||
|
||||
// Set the LCD address to 0x27 for a 16 chars and 2 line display
|
||||
LiquidCrystal_I2C lcd(0x27, 16, 2);
|
||||
|
||||
void setup()
|
||||
{
|
||||
// initialize the LCD
|
||||
lcd.begin();
|
||||
|
||||
// Turn on the blacklight and print a message.
|
||||
lcd.backlight();
|
||||
lcd.print("Hello, world!");
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
// Do nothing here...
|
||||
}
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
/**
|
||||
* Displays text sent over the serial port (e.g. from the Serial Monitor) on
|
||||
* an attached LCD.
|
||||
*/
|
||||
#include <Wire.h>
|
||||
#include <LiquidCrystal_I2C.h>
|
||||
|
||||
// Set the LCD address to 0x27 for a 16 chars and 2 line display
|
||||
LiquidCrystal_I2C lcd(0x27, 16, 2);
|
||||
|
||||
void setup()
|
||||
{
|
||||
lcd.begin();
|
||||
lcd.backlight();
|
||||
|
||||
// Initialize the serial port at a speed of 9600 baud
|
||||
Serial.begin(9600);
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
// If characters arrived over the serial port...
|
||||
if (Serial.available()) {
|
||||
// Wait a bit for the entire message to arrive
|
||||
delay(100);
|
||||
// Clear the screen
|
||||
lcd.clear();
|
||||
|
||||
// Write all characters received with the serial port to the LCD.
|
||||
while (Serial.available() > 0) {
|
||||
lcd.write(Serial.read());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
###########################################
|
||||
# Syntax Coloring Map For LiquidCrystal_I2C
|
||||
###########################################
|
||||
|
||||
###########################################
|
||||
# Datatypes (KEYWORD1)
|
||||
###########################################
|
||||
|
||||
LiquidCrystal_I2C KEYWORD1
|
||||
|
||||
###########################################
|
||||
# Methods and Functions (KEYWORD2)
|
||||
###########################################
|
||||
init KEYWORD2
|
||||
begin KEYWORD2
|
||||
clear KEYWORD2
|
||||
home KEYWORD2
|
||||
noDisplay KEYWORD2
|
||||
display KEYWORD2
|
||||
noBlink KEYWORD2
|
||||
blink KEYWORD2
|
||||
noCursor KEYWORD2
|
||||
cursor KEYWORD2
|
||||
scrollDisplayLeft KEYWORD2
|
||||
scrollDisplayRight KEYWORD2
|
||||
leftToRight KEYWORD2
|
||||
rightToLeft KEYWORD2
|
||||
shiftIncrement KEYWORD2
|
||||
shiftDecrement KEYWORD2
|
||||
noBacklight KEYWORD2
|
||||
backlight KEYWORD2
|
||||
autoscroll KEYWORD2
|
||||
noAutoscroll KEYWORD2
|
||||
createChar KEYWORD2
|
||||
setCursor KEYWORD2
|
||||
print KEYWORD2
|
||||
blink_on KEYWORD2
|
||||
blink_off KEYWORD2
|
||||
cursor_on KEYWORD2
|
||||
cursor_off KEYWORD2
|
||||
setBacklight KEYWORD2
|
||||
load_custom_character KEYWORD2
|
||||
printstr KEYWORD2
|
||||
###########################################
|
||||
# Constants (LITERAL1)
|
||||
###########################################
|
||||
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,135 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 1 (10C8 or later firmware) or Series 2 XBee radios
|
||||
Sends a few AT command queries to the radio and checks the status response for success
|
||||
|
||||
This example uses the NewSoftSerial library to view the XBee communication. I am using a
|
||||
Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
|
||||
with the Arduino Serial Monitor.
|
||||
You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
|
||||
*/
|
||||
|
||||
// Define NewSoftSerial TX/RX pins
|
||||
// Connect Arduino pin 9 to TX of usb-serial device
|
||||
uint8_t ssRX = 9;
|
||||
// Connect Arduino pin 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
// Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
XBee xbee = XBee();
|
||||
|
||||
// serial high
|
||||
uint8_t shCmd[] = {'S','H'};
|
||||
// serial low
|
||||
uint8_t slCmd[] = {'S','L'};
|
||||
// association status
|
||||
uint8_t assocCmd[] = {'A','I'};
|
||||
|
||||
AtCommandRequest atRequest = AtCommandRequest(shCmd);
|
||||
|
||||
AtCommandResponse atResponse = AtCommandResponse();
|
||||
|
||||
void setup() {
|
||||
xbee.begin(9600);
|
||||
// start soft serial
|
||||
nss.begin(9600);
|
||||
|
||||
// Startup delay to wait for XBee radio to initialize.
|
||||
// you may need to increase this value if you are not getting a response
|
||||
delay(5000);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
// get SH
|
||||
sendAtCommand();
|
||||
|
||||
// set command to SL
|
||||
atRequest.setCommand(slCmd);
|
||||
sendAtCommand();
|
||||
|
||||
// set command to AI
|
||||
atRequest.setCommand(assocCmd);
|
||||
sendAtCommand();
|
||||
|
||||
// we're done. Hit the Arduino reset button to start the sketch over
|
||||
while (1) {};
|
||||
}
|
||||
|
||||
void sendAtCommand() {
|
||||
nss.println("Sending command to the XBee");
|
||||
|
||||
// send the command
|
||||
xbee.send(atRequest);
|
||||
|
||||
// wait up to 5 seconds for the status response
|
||||
if (xbee.readPacket(5000)) {
|
||||
// got a response!
|
||||
|
||||
// should be an AT command response
|
||||
if (xbee.getResponse().getApiId() == AT_COMMAND_RESPONSE) {
|
||||
xbee.getResponse().getAtCommandResponse(atResponse);
|
||||
|
||||
if (atResponse.isOk()) {
|
||||
nss.print("Command [");
|
||||
nss.print(atResponse.getCommand()[0]);
|
||||
nss.print(atResponse.getCommand()[1]);
|
||||
nss.println("] was successful!");
|
||||
|
||||
if (atResponse.getValueLength() > 0) {
|
||||
nss.print("Command value length is ");
|
||||
nss.println(atResponse.getValueLength(), DEC);
|
||||
|
||||
nss.print("Command value: ");
|
||||
|
||||
for (int i = 0; i < atResponse.getValueLength(); i++) {
|
||||
nss.print(atResponse.getValue()[i], HEX);
|
||||
nss.print(" ");
|
||||
}
|
||||
|
||||
nss.println("");
|
||||
}
|
||||
}
|
||||
else {
|
||||
nss.print("Command return error code: ");
|
||||
nss.println(atResponse.getStatus(), HEX);
|
||||
}
|
||||
} else {
|
||||
nss.print("Expected AT response but got ");
|
||||
nss.print(xbee.getResponse().getApiId(), HEX);
|
||||
}
|
||||
} else {
|
||||
// at command failed
|
||||
if (xbee.getResponse().isError()) {
|
||||
nss.print("Error reading packet. Error code: ");
|
||||
nss.println(xbee.getResponse().getErrorCode());
|
||||
}
|
||||
else {
|
||||
nss.print("No response from radio");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,143 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 1 (10C8 or later firmware) or Series 2 XBee
|
||||
Sends two Remote AT commands to configure the remote radio for I/O line monitoring
|
||||
|
||||
This example uses the NewSoftSerial library to view the XBee communication. I am using a
|
||||
Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
|
||||
with the Arduino Serial Monitor.
|
||||
You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
|
||||
*/
|
||||
|
||||
// Define NewSoftSerial TX/RX pins
|
||||
// Connect Arduino pin 9 to TX of usb-serial device
|
||||
uint8_t ssRX = 9;
|
||||
// Connect Arduino pin 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
// Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
XBee xbee = XBee();
|
||||
|
||||
// Turn on I/O sampling
|
||||
uint8_t irCmd[] = {'I','R'};
|
||||
// Set sample rate to 65 seconds (0xffff/1000)
|
||||
uint8_t irValue[] = { 0xff, 0xff };
|
||||
|
||||
// Set DIO0 (pin 20) to Analog Input
|
||||
uint8_t d0Cmd[] = { 'D', '0' };
|
||||
uint8_t d0Value[] = { 0x2 };
|
||||
|
||||
// SH + SL of your remote radio
|
||||
XBeeAddress64 remoteAddress = XBeeAddress64(0x0013a200, 0x400a3e02);
|
||||
// Create a remote AT request with the IR command
|
||||
RemoteAtCommandRequest remoteAtRequest = RemoteAtCommandRequest(remoteAddress, irCmd, irValue, sizeof(irValue));
|
||||
|
||||
// Create a Remote AT response object
|
||||
RemoteAtCommandResponse remoteAtResponse = RemoteAtCommandResponse();
|
||||
|
||||
void setup() {
|
||||
xbee.begin(9600);
|
||||
// start soft serial
|
||||
nss.begin(9600);
|
||||
|
||||
// When powered on, XBee radios require a few seconds to start up
|
||||
// and join the network.
|
||||
// During this time, any packets sent to the radio are ignored.
|
||||
// Series 2 radios send a modem status packet on startup.
|
||||
|
||||
// it took about 4 seconds for mine to return modem status.
|
||||
// In my experience, series 1 radios take a bit longer to associate.
|
||||
// Of course if the radio has been powered on for some time before the sketch runs,
|
||||
// you can safely remove this delay.
|
||||
// Or if you both commands are not successful, try increasing the delay.
|
||||
|
||||
delay(5000);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
sendRemoteAtCommand();
|
||||
|
||||
// now reuse same object for DIO0 command
|
||||
remoteAtRequest.setCommand(d0Cmd);
|
||||
remoteAtRequest.setCommandValue(d0Value);
|
||||
remoteAtRequest.setCommandValueLength(sizeof(d0Value));
|
||||
|
||||
sendRemoteAtCommand();
|
||||
|
||||
// it's a good idea to clear the set value so that the object can be reused for a query
|
||||
remoteAtRequest.clearCommandValue();
|
||||
|
||||
// we're done
|
||||
while (1) {};
|
||||
}
|
||||
|
||||
void sendRemoteAtCommand() {
|
||||
nss.println("Sending command to the XBee");
|
||||
|
||||
// send the command
|
||||
xbee.send(remoteAtRequest);
|
||||
|
||||
// wait up to 5 seconds for the status response
|
||||
if (xbee.readPacket(5000)) {
|
||||
// got a response!
|
||||
|
||||
// should be an AT command response
|
||||
if (xbee.getResponse().getApiId() == REMOTE_AT_COMMAND_RESPONSE) {
|
||||
xbee.getResponse().getRemoteAtCommandResponse(remoteAtResponse);
|
||||
|
||||
if (remoteAtResponse.isOk()) {
|
||||
nss.print("Command [");
|
||||
nss.print(remoteAtResponse.getCommand()[0]);
|
||||
nss.print(remoteAtResponse.getCommand()[1]);
|
||||
nss.println("] was successful!");
|
||||
|
||||
if (remoteAtResponse.getValueLength() > 0) {
|
||||
nss.print("Command value length is ");
|
||||
nss.println(remoteAtResponse.getValueLength(), DEC);
|
||||
|
||||
nss.print("Command value: ");
|
||||
|
||||
for (int i = 0; i < remoteAtResponse.getValueLength(); i++) {
|
||||
nss.print(remoteAtResponse.getValue()[i], HEX);
|
||||
nss.print(" ");
|
||||
}
|
||||
|
||||
nss.println("");
|
||||
}
|
||||
} else {
|
||||
nss.print("Command returned error code: ");
|
||||
nss.println(remoteAtResponse.getStatus(), HEX);
|
||||
}
|
||||
} else {
|
||||
nss.print("Expected Remote AT response but got ");
|
||||
nss.print(xbee.getResponse().getApiId(), HEX);
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
nss.print("Error reading packet. Error code: ");
|
||||
nss.println(xbee.getResponse().getErrorCode());
|
||||
} else {
|
||||
nss.print("No response from radio");
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 1 XBee Radios only
|
||||
Receives I/O samples from a remote radio with 16-bit addressing.
|
||||
The remote radio must have IR > 0, at least one digital or analog input enabled
|
||||
and DL set to the 16-bit address of the receiving XBee (the one connected to the Arduino).
|
||||
|
||||
This example uses the NewSoftSerial library to view the XBee communication. I am using a
|
||||
Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
|
||||
with the Arduino Serial Monitor.
|
||||
You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
|
||||
*/
|
||||
|
||||
// Define NewSoftSerial TX/RX pins
|
||||
// Connect Arduino pin 9 to TX of usb-serial device
|
||||
uint8_t ssRX = 9;
|
||||
// Connect Arduino pin 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
// Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
XBee xbee = XBee();
|
||||
|
||||
Rx16IoSampleResponse ioSample = Rx16IoSampleResponse();
|
||||
// 64-bit response is same except api id equals RX_64_IO_RESPONSE and returns a 64-bit address
|
||||
//Rx64IoSampleResponse ioSample = Rx64IoSampleResponse();
|
||||
|
||||
void setup() {
|
||||
xbee.begin(9600);
|
||||
// start soft serial
|
||||
nss.begin(9600);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
//attempt to read a packet
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something
|
||||
|
||||
if (xbee.getResponse().getApiId() == RX_16_IO_RESPONSE) {
|
||||
xbee.getResponse().getRx16IoSampleResponse(ioSample);
|
||||
|
||||
nss.print("Received I/O Sample from: ");
|
||||
nss.println(ioSample.getRemoteAddress16(), HEX);
|
||||
|
||||
nss.print("Sample size is ");
|
||||
nss.println(ioSample.getSampleSize(), DEC);
|
||||
|
||||
if (ioSample.containsAnalog()) {
|
||||
nss.println("Sample contains analog data");
|
||||
}
|
||||
|
||||
if (ioSample.containsDigital()) {
|
||||
nss.println("Sample contains digtal data");
|
||||
}
|
||||
|
||||
for (int k = 0; k < ioSample.getSampleSize(); k++) {
|
||||
nss.print("Sample ");
|
||||
nss.print(k + 1, DEC);
|
||||
nss.println(":");
|
||||
|
||||
for (int i = 0; i <= 5; i++) {
|
||||
if (ioSample.isAnalogEnabled(i)) {
|
||||
nss.print("Analog (AI");
|
||||
nss.print(i, DEC);
|
||||
nss.print(") is ");
|
||||
nss.println(ioSample.getAnalog(i, k));
|
||||
}
|
||||
}
|
||||
|
||||
for (int i = 0; i <= 8; i++) {
|
||||
if (ioSample.isDigitalEnabled(i)) {
|
||||
nss.print("Digtal (DI");
|
||||
nss.print(i, DEC);
|
||||
nss.print(") is ");
|
||||
nss.println(ioSample.isDigitalOn(i, k));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
else {
|
||||
nss.print("Expected I/O Sample, but got ");
|
||||
nss.print(xbee.getResponse().getApiId(), HEX);
|
||||
}
|
||||
}
|
||||
else if (xbee.getResponse().isError()) {
|
||||
nss.print("Error reading packet. Error code: ");
|
||||
nss.println(xbee.getResponse().getErrorCode());
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 1 XBee (802.15.4)
|
||||
Receives either a RX16 or RX64 packet and sets a PWM value based on packet data.
|
||||
Error led is flashed if an unexpected packet is received
|
||||
*/
|
||||
|
||||
XBee xbee = XBee();
|
||||
XBeeResponse response = XBeeResponse();
|
||||
// create reusable response objects for responses we expect to handle
|
||||
Rx16Response rx16 = Rx16Response();
|
||||
Rx64Response rx64 = Rx64Response();
|
||||
|
||||
int statusLed = 11;
|
||||
int errorLed = 12;
|
||||
int dataLed = 10;
|
||||
|
||||
uint8_t option = 0;
|
||||
uint8_t data = 0;
|
||||
|
||||
void flashLed(int pin, int times, int wait) {
|
||||
|
||||
for (int i = 0; i < times; i++) {
|
||||
digitalWrite(pin, HIGH);
|
||||
delay(wait);
|
||||
digitalWrite(pin, LOW);
|
||||
|
||||
if (i + 1 < times) {
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void setup() {
|
||||
pinMode(statusLed, OUTPUT);
|
||||
pinMode(errorLed, OUTPUT);
|
||||
pinMode(dataLed, OUTPUT);
|
||||
|
||||
// start serial
|
||||
xbee.begin(9600);
|
||||
|
||||
flashLed(statusLed, 3, 50);
|
||||
}
|
||||
|
||||
// continuously reads packets, looking for RX16 or RX64
|
||||
void loop() {
|
||||
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something
|
||||
|
||||
if (xbee.getResponse().getApiId() == RX_16_RESPONSE || xbee.getResponse().getApiId() == RX_64_RESPONSE) {
|
||||
// got a rx packet
|
||||
|
||||
if (xbee.getResponse().getApiId() == RX_16_RESPONSE) {
|
||||
xbee.getResponse().getRx16Response(rx16);
|
||||
option = rx16.getOption();
|
||||
data = rx16.getData(0);
|
||||
} else {
|
||||
xbee.getResponse().getRx64Response(rx64);
|
||||
option = rx64.getOption();
|
||||
data = rx64.getData(0);
|
||||
}
|
||||
|
||||
// TODO check option, rssi bytes
|
||||
flashLed(statusLed, 1, 10);
|
||||
|
||||
// set dataLed PWM to value of the first byte in the data
|
||||
analogWrite(dataLed, data);
|
||||
} else {
|
||||
// not something we were expecting
|
||||
flashLed(errorLed, 1, 25);
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
//nss.print("Error reading packet. Error code: ");
|
||||
//nss.println(xbee.getResponse().getErrorCode());
|
||||
// or flash error led
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,116 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 1 XBee
|
||||
Sends a TX16 or TX64 request with the value of analogRead(pin5) and checks the status response for success
|
||||
Note: In my testing it took about 15 seconds for the XBee to start reporting success, so I've added a startup delay
|
||||
*/
|
||||
|
||||
XBee xbee = XBee();
|
||||
|
||||
unsigned long start = millis();
|
||||
|
||||
// allocate two bytes for to hold a 10-bit analog reading
|
||||
uint8_t payload[] = { 0, 0 };
|
||||
|
||||
// with Series 1 you can use either 16-bit or 64-bit addressing
|
||||
|
||||
// 16-bit addressing: Enter address of remote XBee, typically the coordinator
|
||||
Tx16Request tx = Tx16Request(0x1874, payload, sizeof(payload));
|
||||
|
||||
// 64-bit addressing: This is the SH + SL address of remote XBee
|
||||
//XBeeAddress64 addr64 = XBeeAddress64(0x0013a200, 0x4008b490);
|
||||
// unless you have MY on the receiving radio set to FFFF, this will be received as a RX16 packet
|
||||
//Tx64Request tx = Tx64Request(addr64, payload, sizeof(payload));
|
||||
|
||||
TxStatusResponse txStatus = TxStatusResponse();
|
||||
|
||||
int pin5 = 0;
|
||||
|
||||
int statusLed = 11;
|
||||
int errorLed = 12;
|
||||
|
||||
void flashLed(int pin, int times, int wait) {
|
||||
|
||||
for (int i = 0; i < times; i++) {
|
||||
digitalWrite(pin, HIGH);
|
||||
delay(wait);
|
||||
digitalWrite(pin, LOW);
|
||||
|
||||
if (i + 1 < times) {
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void setup() {
|
||||
pinMode(statusLed, OUTPUT);
|
||||
pinMode(errorLed, OUTPUT);
|
||||
|
||||
xbee.begin(9600);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
// start transmitting after a startup delay. Note: this will rollover to 0 eventually so not best way to handle
|
||||
if (millis() - start > 15000) {
|
||||
// break down 10-bit reading into two bytes and place in payload
|
||||
pin5 = analogRead(5);
|
||||
payload[0] = pin5 >> 8 & 0xff;
|
||||
payload[1] = pin5 & 0xff;
|
||||
|
||||
xbee.send(tx);
|
||||
|
||||
// flash TX indicator
|
||||
flashLed(statusLed, 1, 100);
|
||||
}
|
||||
|
||||
// after sending a tx request, we expect a status response
|
||||
// wait up to 5 seconds for the status response
|
||||
if (xbee.readPacket(5000)) {
|
||||
// got a response!
|
||||
|
||||
// should be a znet tx status
|
||||
if (xbee.getResponse().getApiId() == TX_STATUS_RESPONSE) {
|
||||
xbee.getResponse().getZBTxStatusResponse(txStatus);
|
||||
|
||||
// get the delivery status, the fifth byte
|
||||
if (txStatus.getStatus() == SUCCESS) {
|
||||
// success. time to celebrate
|
||||
flashLed(statusLed, 5, 50);
|
||||
} else {
|
||||
// the remote XBee did not receive our packet. is it powered on?
|
||||
flashLed(errorLed, 3, 500);
|
||||
}
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
//nss.print("Error reading packet. Error code: ");
|
||||
//nss.println(xbee.getResponse().getErrorCode());
|
||||
// or flash error led
|
||||
} else {
|
||||
// local XBee did not provide a timely TX Status Response. Radio is not configured properly or connected
|
||||
flashLed(errorLed, 2, 50);
|
||||
}
|
||||
|
||||
delay(1000);
|
||||
}
|
||||
|
|
@ -0,0 +1,115 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 2 (ZigBee) XBee Radios only
|
||||
Receives I/O samples from a remote radio.
|
||||
The remote radio must have IR > 0 and at least one digital or analog input enabled.
|
||||
The XBee coordinator should be connected to the Arduino.
|
||||
|
||||
This example uses the NewSoftSerial library to view the XBee communication. I am using a
|
||||
Modern Device USB BUB board (http://moderndevice.com/connect) and viewing the output
|
||||
with the Arduino Serial Monitor.
|
||||
You can obtain the NewSoftSerial library here http://arduiniana.org/libraries/NewSoftSerial/
|
||||
*/
|
||||
|
||||
// Define NewSoftSerial TX/RX pins
|
||||
// Connect Arduino pin 9 to TX of usb-serial device
|
||||
uint8_t ssRX = 9;
|
||||
// Connect Arduino pin 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
// Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
XBee xbee = XBee();
|
||||
|
||||
ZBRxIoSampleResponse ioSample = ZBRxIoSampleResponse();
|
||||
|
||||
XBeeAddress64 test = XBeeAddress64();
|
||||
|
||||
void setup() {
|
||||
xbee.begin(9600);
|
||||
// start soft serial
|
||||
nss.begin(9600);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
//attempt to read a packet
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something
|
||||
|
||||
if (xbee.getResponse().getApiId() == ZB_IO_SAMPLE_RESPONSE) {
|
||||
xbee.getResponse().getZBRxIoSampleResponse(ioSample);
|
||||
|
||||
nss.print("Received I/O Sample from: ");
|
||||
|
||||
nss.print(ioSample.getRemoteAddress64().getMsb(), HEX);
|
||||
nss.print(ioSample.getRemoteAddress64().getLsb(), HEX);
|
||||
nss.println("");
|
||||
|
||||
if (ioSample.containsAnalog()) {
|
||||
nss.println("Sample contains analog data");
|
||||
}
|
||||
|
||||
if (ioSample.containsDigital()) {
|
||||
nss.println("Sample contains digtal data");
|
||||
}
|
||||
|
||||
// read analog inputs
|
||||
for (int i = 0; i <= 4; i++) {
|
||||
if (ioSample.isAnalogEnabled(i)) {
|
||||
nss.print("Analog (AI");
|
||||
nss.print(i, DEC);
|
||||
nss.print(") is ");
|
||||
nss.println(ioSample.getAnalog(i), DEC);
|
||||
}
|
||||
}
|
||||
|
||||
// check digital inputs
|
||||
for (int i = 0; i <= 12; i++) {
|
||||
if (ioSample.isDigitalEnabled(i)) {
|
||||
nss.print("Digital (DI");
|
||||
nss.print(i, DEC);
|
||||
nss.print(") is ");
|
||||
nss.println(ioSample.isDigitalOn(i), DEC);
|
||||
}
|
||||
}
|
||||
|
||||
// method for printing the entire frame data
|
||||
//for (int i = 0; i < xbee.getResponse().getFrameDataLength(); i++) {
|
||||
// nss.print("byte [");
|
||||
// nss.print(i, DEC);
|
||||
// nss.print("] is ");
|
||||
// nss.println(xbee.getResponse().getFrameData()[i], HEX);
|
||||
//}
|
||||
}
|
||||
else {
|
||||
nss.print("Expected I/O Sample, but got ");
|
||||
nss.print(xbee.getResponse().getApiId(), HEX);
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
nss.print("Error reading packet. Error code: ");
|
||||
nss.println(xbee.getResponse().getErrorCode());
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 2 XBee
|
||||
Receives a ZB RX packet and sets a PWM value based on packet data.
|
||||
Error led is flashed if an unexpected packet is received
|
||||
*/
|
||||
|
||||
XBee xbee = XBee();
|
||||
XBeeResponse response = XBeeResponse();
|
||||
// create reusable response objects for responses we expect to handle
|
||||
ZBRxResponse rx = ZBRxResponse();
|
||||
ModemStatusResponse msr = ModemStatusResponse();
|
||||
|
||||
int statusLed = 13;
|
||||
int errorLed = 13;
|
||||
int dataLed = 13;
|
||||
|
||||
void flashLed(int pin, int times, int wait) {
|
||||
|
||||
for (int i = 0; i < times; i++) {
|
||||
digitalWrite(pin, HIGH);
|
||||
delay(wait);
|
||||
digitalWrite(pin, LOW);
|
||||
|
||||
if (i + 1 < times) {
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void setup() {
|
||||
pinMode(statusLed, OUTPUT);
|
||||
pinMode(errorLed, OUTPUT);
|
||||
pinMode(dataLed, OUTPUT);
|
||||
|
||||
// start serial
|
||||
xbee.begin(9600);
|
||||
|
||||
flashLed(statusLed, 3, 50);
|
||||
}
|
||||
|
||||
// continuously reads packets, looking for ZB Receive or Modem Status
|
||||
void loop() {
|
||||
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something
|
||||
|
||||
if (xbee.getResponse().getApiId() == ZB_RX_RESPONSE) {
|
||||
// got a zb rx packet
|
||||
|
||||
// now fill our zb rx class
|
||||
xbee.getResponse().getZBRxResponse(rx);
|
||||
|
||||
if (rx.getOption() == ZB_PACKET_ACKNOWLEDGED) {
|
||||
// the sender got an ACK
|
||||
flashLed(statusLed, 10, 10);
|
||||
} else {
|
||||
// we got it (obviously) but sender didn't get an ACK
|
||||
flashLed(errorLed, 2, 20);
|
||||
}
|
||||
// set dataLed PWM to value of the first byte in the data
|
||||
analogWrite(dataLed, rx.getData(0));
|
||||
} else if (xbee.getResponse().getApiId() == MODEM_STATUS_RESPONSE) {
|
||||
xbee.getResponse().getModemStatusResponse(msr);
|
||||
// the local XBee sends this response on certain events, like association/dissociation
|
||||
|
||||
if (msr.getStatus() == ASSOCIATED) {
|
||||
// yay this is great. flash led
|
||||
flashLed(statusLed, 10, 10);
|
||||
} else if (msr.getStatus() == DISASSOCIATED) {
|
||||
// this is awful.. flash led to show our discontent
|
||||
flashLed(errorLed, 10, 10);
|
||||
} else {
|
||||
// another status
|
||||
flashLed(statusLed, 5, 10);
|
||||
}
|
||||
} else {
|
||||
// not something we were expecting
|
||||
flashLed(errorLed, 1, 25);
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
//nss.print("Error reading packet. Error code: ");
|
||||
//nss.println(xbee.getResponse().getErrorCode());
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 2 XBee
|
||||
Receives a ZB RX packet and sets a PWM value based on packet data.
|
||||
Error led is flashed if an unexpected packet is received
|
||||
*/
|
||||
|
||||
XBee xbee = XBee();
|
||||
XBeeResponse response = XBeeResponse();
|
||||
// create reusable response objects for responses we expect to handle
|
||||
ZBRxResponse rx = ZBRxResponse();
|
||||
ModemStatusResponse msr = ModemStatusResponse();
|
||||
|
||||
// Define NewSoftSerial TX/RX pins
|
||||
// Connect Arduino pin 9 to TX of usb-serial device
|
||||
uint8_t ssRX = 9;
|
||||
// Connect Arduino pin 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
// Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
|
||||
void setup() {
|
||||
// start serial
|
||||
xbee.begin(9600);
|
||||
nss.begin(9600);
|
||||
|
||||
nss.println("starting up yo!");
|
||||
}
|
||||
|
||||
// continuously reads packets, looking for ZB Receive or Modem Status
|
||||
void loop() {
|
||||
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something
|
||||
|
||||
if (xbee.getResponse().getApiId() == ZB_RX_RESPONSE) {
|
||||
// got a zb rx packet
|
||||
|
||||
// now fill our zb rx class
|
||||
xbee.getResponse().getZBRxResponse(rx);
|
||||
|
||||
nss.println("Got an rx packet!");
|
||||
|
||||
if (rx.getOption() == ZB_PACKET_ACKNOWLEDGED) {
|
||||
// the sender got an ACK
|
||||
nss.println("packet acknowledged");
|
||||
} else {
|
||||
nss.println("packet not acknowledged");
|
||||
}
|
||||
|
||||
nss.print("checksum is ");
|
||||
nss.println(rx.getChecksum(), HEX);
|
||||
|
||||
nss.print("packet length is ");
|
||||
nss.println(rx.getPacketLength(), DEC);
|
||||
|
||||
for (int i = 0; i < rx.getDataLength(); i++) {
|
||||
nss.print("payload [");
|
||||
nss.print(i, DEC);
|
||||
nss.print("] is ");
|
||||
nss.println(rx.getData()[i], HEX);
|
||||
}
|
||||
|
||||
for (int i = 0; i < xbee.getResponse().getFrameDataLength(); i++) {
|
||||
nss.print("frame data [");
|
||||
nss.print(i, DEC);
|
||||
nss.print("] is ");
|
||||
nss.println(xbee.getResponse().getFrameData()[i], HEX);
|
||||
}
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
nss.print("oh no!!! error code:");
|
||||
nss.println(xbee.getResponse().getErrorCode());
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,167 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 2 (ZigBee) XBee Radios only, though Series 1 also support sleep mode.
|
||||
This example demonstrates the XBee pin sleep setting, by allowing the Arduino
|
||||
to sleep/wake the XBee. In this example and end device is attached to the Arduino.
|
||||
|
||||
The end device sleep mode must be set to 1 (SM=1), to enable pin sleep.
|
||||
Set SP=AF0 (28 seconds) on the coordinator. This will instruct the coordinator to buffer any packets, for up to 28 seconds,
|
||||
while the end device is sleeping. When the end device wakes, it will poll the coordinator and receive the packet.
|
||||
|
||||
Note: I'm using the NewSoftSerial library to communicate with the Arduino since the Arduino's Serial is being used by the XBee
|
||||
|
||||
How it works:
|
||||
When you send a "1", the Arduino will sleep the XBee.
|
||||
Sending "2" wakes the XBee and "3" will send an arbitrary TX packet.
|
||||
Of course if the XBee is sleeping, the TX packet will not be delivered.
|
||||
Connect the Arduino Serial Monitor to the usb-serial device to send the commands.
|
||||
Connect an LED to the XBee Module Status (pin 13). This will turn on when the XBee is awake and off when it's sleeping
|
||||
Attach the coordinator to your computer and send a TX packet ever 28 seconds. You should be able to verify the
|
||||
end device receives the packet when it wakes from sleep.
|
||||
|
||||
Remember to connect all devices to a common Ground: XBee, Arduino and USB-Serial device
|
||||
*/
|
||||
|
||||
// TODO: monitor XBee current consumption while sleeping
|
||||
// TODO: send packets while sleeping
|
||||
|
||||
// create the XBee object
|
||||
XBee xbee = XBee();
|
||||
|
||||
// create an arbitrary payload -- what we're sending is not relevant
|
||||
uint8_t payload[] = { 0, 0 };
|
||||
|
||||
// SH + SL Address of a remote XBee
|
||||
XBeeAddress64 addr64 = XBeeAddress64(0x0013a200, 0x403e0f30);
|
||||
ZBTxRequest zbTx = ZBTxRequest(addr64, payload, sizeof(payload));
|
||||
ZBTxStatusResponse txStatus = ZBTxStatusResponse();
|
||||
ZBRxResponse rx = ZBRxResponse();
|
||||
|
||||
// note: xbee sleep pin doesn't need 3.3. to sleep -- open circuit also will sleep it, but of course needs 0V to wake!
|
||||
// connect Arduino digital 8 to XBee sleep pin (9) through a voltage divider. I'm using 10K resistors.
|
||||
uint8_t sleepPin = 8;
|
||||
|
||||
// SoftSerial RX: connect Arduino digitial 9 to the TX of of usb-serial device. note: I'm using Modern Device's USB BUB (set to 5V). You can use a 3.3V usb-serial with a voltage divider on RX (TX does not require since Arduino is 3.3V tolerant)
|
||||
uint8_t ssRX = 9;
|
||||
// SoftSerial TX: connect Arduino digital 10 to RX of usb-serial device
|
||||
uint8_t ssTX = 10;
|
||||
|
||||
NewSoftSerial nss(ssRX, ssTX);
|
||||
|
||||
void setup() {
|
||||
pinMode(sleepPin, OUTPUT);
|
||||
// set to LOW (wake)
|
||||
digitalWrite(sleepPin, LOW);
|
||||
|
||||
// start XBee communication
|
||||
xbee.begin(9600);
|
||||
// start soft serial
|
||||
nss.begin(9600);
|
||||
}
|
||||
|
||||
void sendPacket() {
|
||||
|
||||
nss.println("Sending a packet");
|
||||
|
||||
xbee.send(zbTx);
|
||||
|
||||
// after sending a tx request, we expect a status response
|
||||
// wait up to 5 seconds for the status response
|
||||
if (xbee.readPacket(5000)) {
|
||||
// got a response!
|
||||
|
||||
// should be a znet tx status
|
||||
if (xbee.getResponse().getApiId() == ZB_TX_STATUS_RESPONSE) {
|
||||
xbee.getResponse().getZBTxStatusResponse(txStatus);
|
||||
|
||||
// get the delivery status, the fifth byte
|
||||
if (txStatus.getDeliveryStatus() == SUCCESS) {
|
||||
// success. time to celebrate
|
||||
nss.println("packet was delivered");
|
||||
} else {
|
||||
// the remote XBee did not receive our packet. is it powered on?
|
||||
nss.println("packet delivery failed");
|
||||
}
|
||||
} else if (xbee.getResponse().getApiId() == ZB_RX_RESPONSE) {
|
||||
// we received a packet something!
|
||||
xbee.getResponse().getZBRxResponse(rx);
|
||||
// print the payload. lets assume it's text.
|
||||
for (uint8_t i = 0; i < rx.getDataLength(); i++) {
|
||||
nss.println(rx.getData(i));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// local xbee is sleeping
|
||||
nss.println("no response -- is local xbee sleeping?");
|
||||
}
|
||||
}
|
||||
|
||||
void loop() {
|
||||
if (nss.available()) {
|
||||
int cmd = nss.read();
|
||||
|
||||
// ascii 1 == 49
|
||||
if (cmd == 49) { // 1 (ASCII)
|
||||
// sleep XBee
|
||||
digitalWrite(sleepPin, HIGH);
|
||||
nss.println("sleeping xbee");
|
||||
} else if (cmd == 50) { // 2 (ASCII)
|
||||
digitalWrite(sleepPin, LOW);
|
||||
nss.println("waking xbee");
|
||||
} else if (cmd == 51) { // 3 (ASCII)
|
||||
// send packet
|
||||
sendPacket();
|
||||
} else {
|
||||
nss.println("I didn't understand");
|
||||
}
|
||||
}
|
||||
|
||||
readPacket();
|
||||
}
|
||||
|
||||
// when XBee powers up it sends a modem status 0 (hardware reset), followed by a 2 (Joined Network), assumming it's configured correctly
|
||||
// when XBee is woken up it sends a modem status 2 (Joined Network)
|
||||
|
||||
void readPacket() {
|
||||
xbee.readPacket();
|
||||
|
||||
if (xbee.getResponse().isAvailable()) {
|
||||
// got something.. print packet to nss
|
||||
nss.print("API=");
|
||||
nss.print(xbee.getResponse().getApiId(), HEX);
|
||||
nss.print(",frame=");
|
||||
|
||||
// print frame data
|
||||
for (int i = 0; i < xbee.getResponse().getFrameDataLength(); i++) {
|
||||
nss.print(xbee.getResponse().getFrameData()[i], HEX);
|
||||
nss.print(" ");
|
||||
}
|
||||
|
||||
nss.println("");
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
nss.print("XBee error. error code is");
|
||||
nss.println(xbee.getResponse().getErrorCode(), DEC);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,102 @@
|
|||
/**
|
||||
* Copyright (c) 2009 Andrew Rapp. All rights reserved.
|
||||
*
|
||||
* This file is part of XBee-Arduino.
|
||||
*
|
||||
* XBee-Arduino is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* XBee-Arduino is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with XBee-Arduino. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <XBee.h>
|
||||
#include <NewSoftSerial.h>
|
||||
|
||||
/*
|
||||
This example is for Series 2 XBee
|
||||
Sends a ZB TX request with the value of analogRead(pin5) and checks the status response for success
|
||||
*/
|
||||
|
||||
// create the XBee object
|
||||
XBee xbee = XBee();
|
||||
|
||||
uint8_t payload[] = { 0, 0 };
|
||||
|
||||
// SH + SL Address of receiving XBee
|
||||
XBeeAddress64 addr64 = XBeeAddress64(0x0013a200, 0x403e0f30);
|
||||
ZBTxRequest zbTx = ZBTxRequest(addr64, payload, sizeof(payload));
|
||||
ZBTxStatusResponse txStatus = ZBTxStatusResponse();
|
||||
|
||||
int pin5 = 0;
|
||||
|
||||
int statusLed = 13;
|
||||
int errorLed = 13;
|
||||
|
||||
void flashLed(int pin, int times, int wait) {
|
||||
|
||||
for (int i = 0; i < times; i++) {
|
||||
digitalWrite(pin, HIGH);
|
||||
delay(wait);
|
||||
digitalWrite(pin, LOW);
|
||||
|
||||
if (i + 1 < times) {
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void setup() {
|
||||
pinMode(statusLed, OUTPUT);
|
||||
pinMode(errorLed, OUTPUT);
|
||||
|
||||
xbee.begin(9600);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// break down 10-bit reading into two bytes and place in payload
|
||||
pin5 = analogRead(5);
|
||||
payload[0] = pin5 >> 8 & 0xff;
|
||||
payload[1] = pin5 & 0xff;
|
||||
|
||||
xbee.send(zbTx);
|
||||
|
||||
// flash TX indicator
|
||||
flashLed(statusLed, 1, 100);
|
||||
|
||||
// after sending a tx request, we expect a status response
|
||||
// wait up to half second for the status response
|
||||
if (xbee.readPacket(500)) {
|
||||
// got a response!
|
||||
|
||||
// should be a znet tx status
|
||||
if (xbee.getResponse().getApiId() == ZB_TX_STATUS_RESPONSE) {
|
||||
xbee.getResponse().getZBTxStatusResponse(txStatus);
|
||||
|
||||
// get the delivery status, the fifth byte
|
||||
if (txStatus.getDeliveryStatus() == SUCCESS) {
|
||||
// success. time to celebrate
|
||||
flashLed(statusLed, 5, 50);
|
||||
} else {
|
||||
// the remote XBee did not receive our packet. is it powered on?
|
||||
flashLed(errorLed, 3, 500);
|
||||
}
|
||||
}
|
||||
} else if (xbee.getResponse().isError()) {
|
||||
//nss.print("Error reading packet. Error code: ");
|
||||
//nss.println(xbee.getResponse().getErrorCode());
|
||||
} else {
|
||||
// local XBee did not provide a timely TX Status Response -- should not happen
|
||||
flashLed(errorLed, 2, 50);
|
||||
}
|
||||
|
||||
delay(1000);
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue