Merge branch 'development' into dev-raspberrypi
This commit is contained in:
@@ -1,297 +0,0 @@
|
||||
/***************************************************
|
||||
This is a library for the Adafruit BMP085/BMP180 Barometric Pressure + Temp sensor
|
||||
|
||||
Designed specifically to work with the Adafruit BMP085 or BMP180 Breakout
|
||||
----> http://www.adafruit.com/products/391
|
||||
----> http://www.adafruit.com/products/1603
|
||||
|
||||
These displays use I2C to communicate, 2 pins are required to
|
||||
interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
#include "Adafruit_BMP085.h"
|
||||
|
||||
Adafruit_BMP085::Adafruit_BMP085() {
|
||||
}
|
||||
|
||||
|
||||
boolean Adafruit_BMP085::begin(uint8_t mode) {
|
||||
if (mode > BMP085_ULTRAHIGHRES)
|
||||
mode = BMP085_ULTRAHIGHRES;
|
||||
oversampling = mode;
|
||||
|
||||
Wire.begin();
|
||||
|
||||
if (read8(0xD0) != 0x55) return false;
|
||||
|
||||
/* read calibration data */
|
||||
ac1 = read16(BMP085_CAL_AC1);
|
||||
ac2 = read16(BMP085_CAL_AC2);
|
||||
ac3 = read16(BMP085_CAL_AC3);
|
||||
ac4 = read16(BMP085_CAL_AC4);
|
||||
ac5 = read16(BMP085_CAL_AC5);
|
||||
ac6 = read16(BMP085_CAL_AC6);
|
||||
|
||||
b1 = read16(BMP085_CAL_B1);
|
||||
b2 = read16(BMP085_CAL_B2);
|
||||
|
||||
mb = read16(BMP085_CAL_MB);
|
||||
mc = read16(BMP085_CAL_MC);
|
||||
md = read16(BMP085_CAL_MD);
|
||||
#if (BMP085_DEBUG == 1)
|
||||
Serial.print("ac1 = "); Serial.println(ac1, DEC);
|
||||
Serial.print("ac2 = "); Serial.println(ac2, DEC);
|
||||
Serial.print("ac3 = "); Serial.println(ac3, DEC);
|
||||
Serial.print("ac4 = "); Serial.println(ac4, DEC);
|
||||
Serial.print("ac5 = "); Serial.println(ac5, DEC);
|
||||
Serial.print("ac6 = "); Serial.println(ac6, DEC);
|
||||
|
||||
Serial.print("b1 = "); Serial.println(b1, DEC);
|
||||
Serial.print("b2 = "); Serial.println(b2, DEC);
|
||||
|
||||
Serial.print("mb = "); Serial.println(mb, DEC);
|
||||
Serial.print("mc = "); Serial.println(mc, DEC);
|
||||
Serial.print("md = "); Serial.println(md, DEC);
|
||||
#endif
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
int32_t Adafruit_BMP085::computeB5(int32_t UT) {
|
||||
int32_t X1 = (UT - (int32_t)ac6) * ((int32_t)ac5) >> 15;
|
||||
int32_t X2 = ((int32_t)mc << 11) / (X1+(int32_t)md);
|
||||
return X1 + X2;
|
||||
}
|
||||
|
||||
uint16_t Adafruit_BMP085::readRawTemperature(void) {
|
||||
write8(BMP085_CONTROL, BMP085_READTEMPCMD);
|
||||
delay(5);
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("Raw temp: "); Serial.println(read16(BMP085_TEMPDATA));
|
||||
#endif
|
||||
return read16(BMP085_TEMPDATA);
|
||||
}
|
||||
|
||||
uint32_t Adafruit_BMP085::readRawPressure(void) {
|
||||
uint32_t raw;
|
||||
|
||||
write8(BMP085_CONTROL, BMP085_READPRESSURECMD + (oversampling << 6));
|
||||
|
||||
if (oversampling == BMP085_ULTRALOWPOWER)
|
||||
delay(5);
|
||||
else if (oversampling == BMP085_STANDARD)
|
||||
delay(8);
|
||||
else if (oversampling == BMP085_HIGHRES)
|
||||
delay(14);
|
||||
else
|
||||
delay(26);
|
||||
|
||||
raw = read16(BMP085_PRESSUREDATA);
|
||||
|
||||
raw <<= 8;
|
||||
raw |= read8(BMP085_PRESSUREDATA+2);
|
||||
raw >>= (8 - oversampling);
|
||||
|
||||
/* this pull broke stuff, look at it later?
|
||||
if (oversampling==0) {
|
||||
raw <<= 8;
|
||||
raw |= read8(BMP085_PRESSUREDATA+2);
|
||||
raw >>= (8 - oversampling);
|
||||
}
|
||||
*/
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("Raw pressure: "); Serial.println(raw);
|
||||
#endif
|
||||
return raw;
|
||||
}
|
||||
|
||||
|
||||
int32_t Adafruit_BMP085::readPressure(void) {
|
||||
int32_t UT, UP, B3, B5, B6, X1, X2, X3, p;
|
||||
uint32_t B4, B7;
|
||||
|
||||
UT = readRawTemperature();
|
||||
UP = readRawPressure();
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
// use datasheet numbers!
|
||||
UT = 27898;
|
||||
UP = 23843;
|
||||
ac6 = 23153;
|
||||
ac5 = 32757;
|
||||
mc = -8711;
|
||||
md = 2868;
|
||||
b1 = 6190;
|
||||
b2 = 4;
|
||||
ac3 = -14383;
|
||||
ac2 = -72;
|
||||
ac1 = 408;
|
||||
ac4 = 32741;
|
||||
oversampling = 0;
|
||||
#endif
|
||||
|
||||
B5 = computeB5(UT);
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("X1 = "); Serial.println(X1);
|
||||
Serial.print("X2 = "); Serial.println(X2);
|
||||
Serial.print("B5 = "); Serial.println(B5);
|
||||
#endif
|
||||
|
||||
// do pressure calcs
|
||||
B6 = B5 - 4000;
|
||||
X1 = ((int32_t)b2 * ( (B6 * B6)>>12 )) >> 11;
|
||||
X2 = ((int32_t)ac2 * B6) >> 11;
|
||||
X3 = X1 + X2;
|
||||
B3 = ((((int32_t)ac1*4 + X3) << oversampling) + 2) / 4;
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("B6 = "); Serial.println(B6);
|
||||
Serial.print("X1 = "); Serial.println(X1);
|
||||
Serial.print("X2 = "); Serial.println(X2);
|
||||
Serial.print("B3 = "); Serial.println(B3);
|
||||
#endif
|
||||
|
||||
X1 = ((int32_t)ac3 * B6) >> 13;
|
||||
X2 = ((int32_t)b1 * ((B6 * B6) >> 12)) >> 16;
|
||||
X3 = ((X1 + X2) + 2) >> 2;
|
||||
B4 = ((uint32_t)ac4 * (uint32_t)(X3 + 32768)) >> 15;
|
||||
B7 = ((uint32_t)UP - B3) * (uint32_t)( 50000UL >> oversampling );
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("X1 = "); Serial.println(X1);
|
||||
Serial.print("X2 = "); Serial.println(X2);
|
||||
Serial.print("B4 = "); Serial.println(B4);
|
||||
Serial.print("B7 = "); Serial.println(B7);
|
||||
#endif
|
||||
|
||||
if (B7 < 0x80000000) {
|
||||
p = (B7 * 2) / B4;
|
||||
} else {
|
||||
p = (B7 / B4) * 2;
|
||||
}
|
||||
X1 = (p >> 8) * (p >> 8);
|
||||
X1 = (X1 * 3038) >> 16;
|
||||
X2 = (-7357 * p) >> 16;
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("p = "); Serial.println(p);
|
||||
Serial.print("X1 = "); Serial.println(X1);
|
||||
Serial.print("X2 = "); Serial.println(X2);
|
||||
#endif
|
||||
|
||||
p = p + ((X1 + X2 + (int32_t)3791)>>4);
|
||||
#if BMP085_DEBUG == 1
|
||||
Serial.print("p = "); Serial.println(p);
|
||||
#endif
|
||||
return p;
|
||||
}
|
||||
|
||||
int32_t Adafruit_BMP085::readSealevelPressure(float altitude_meters) {
|
||||
float pressure = readPressure();
|
||||
return (int32_t)(pressure / pow(1.0-altitude_meters/44330, 5.255));
|
||||
}
|
||||
|
||||
float Adafruit_BMP085::readTemperature(void) {
|
||||
int32_t UT, B5; // following ds convention
|
||||
float temp;
|
||||
|
||||
UT = readRawTemperature();
|
||||
|
||||
#if BMP085_DEBUG == 1
|
||||
// use datasheet numbers!
|
||||
UT = 27898;
|
||||
ac6 = 23153;
|
||||
ac5 = 32757;
|
||||
mc = -8711;
|
||||
md = 2868;
|
||||
#endif
|
||||
|
||||
B5 = computeB5(UT);
|
||||
temp = (B5+8) >> 4;
|
||||
temp /= 10;
|
||||
|
||||
return temp;
|
||||
}
|
||||
|
||||
float Adafruit_BMP085::readAltitude(float sealevelPressure) {
|
||||
float altitude;
|
||||
|
||||
float pressure = readPressure();
|
||||
|
||||
altitude = 44330 * (1.0 - pow(pressure /sealevelPressure,0.1903));
|
||||
|
||||
return altitude;
|
||||
}
|
||||
|
||||
|
||||
/*********************************************************************/
|
||||
|
||||
uint8_t Adafruit_BMP085::read8(uint8_t a) {
|
||||
uint8_t ret;
|
||||
|
||||
Wire.beginTransmission(BMP085_I2CADDR); // start transmission to device
|
||||
#if (ARDUINO >= 100)
|
||||
Wire.write(a); // sends register address to read from
|
||||
#else
|
||||
Wire.send(a); // sends register address to read from
|
||||
#endif
|
||||
Wire.endTransmission(); // end transmission
|
||||
|
||||
Wire.beginTransmission(BMP085_I2CADDR); // start transmission to device
|
||||
Wire.requestFrom(BMP085_I2CADDR, 1);// send data n-bytes read
|
||||
#if (ARDUINO >= 100)
|
||||
ret = Wire.read(); // receive DATA
|
||||
#else
|
||||
ret = Wire.receive(); // receive DATA
|
||||
#endif
|
||||
Wire.endTransmission(); // end transmission
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
uint16_t Adafruit_BMP085::read16(uint8_t a) {
|
||||
uint16_t ret;
|
||||
|
||||
Wire.beginTransmission(BMP085_I2CADDR); // start transmission to device
|
||||
#if (ARDUINO >= 100)
|
||||
Wire.write(a); // sends register address to read from
|
||||
#else
|
||||
Wire.send(a); // sends register address to read from
|
||||
#endif
|
||||
Wire.endTransmission(); // end transmission
|
||||
|
||||
Wire.beginTransmission(BMP085_I2CADDR); // start transmission to device
|
||||
Wire.requestFrom(BMP085_I2CADDR, 2);// send data n-bytes read
|
||||
#if (ARDUINO >= 100)
|
||||
ret = Wire.read(); // receive DATA
|
||||
ret <<= 8;
|
||||
ret |= Wire.read(); // receive DATA
|
||||
#else
|
||||
ret = Wire.receive(); // receive DATA
|
||||
ret <<= 8;
|
||||
ret |= Wire.receive(); // receive DATA
|
||||
#endif
|
||||
Wire.endTransmission(); // end transmission
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
void Adafruit_BMP085::write8(uint8_t a, uint8_t d) {
|
||||
Wire.beginTransmission(BMP085_I2CADDR); // start transmission to device
|
||||
#if (ARDUINO >= 100)
|
||||
Wire.write(a); // sends register address to read from
|
||||
Wire.write(d); // write data
|
||||
#else
|
||||
Wire.send(a); // sends register address to read from
|
||||
Wire.send(d); // write data
|
||||
#endif
|
||||
Wire.endTransmission(); // end transmission
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
/***************************************************
|
||||
This is a library for the Adafruit BMP085/BMP180 Barometric Pressure + Temp sensor
|
||||
|
||||
Designed specifically to work with the Adafruit BMP085 or BMP180 Breakout
|
||||
----> http://www.adafruit.com/products/391
|
||||
----> http://www.adafruit.com/products/1603
|
||||
|
||||
These displays use I2C to communicate, 2 pins are required to
|
||||
interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
#ifndef ADAFRUIT_BMP085_H
|
||||
#define ADAFRUIT_BMP085_H
|
||||
|
||||
#if (ARDUINO >= 100)
|
||||
#include "Arduino.h"
|
||||
#else
|
||||
#include "WProgram.h"
|
||||
#endif
|
||||
#include "Wire.h"
|
||||
|
||||
#define BMP085_DEBUG 0
|
||||
|
||||
#define BMP085_I2CADDR 0x77
|
||||
|
||||
#define BMP085_ULTRALOWPOWER 0
|
||||
#define BMP085_STANDARD 1
|
||||
#define BMP085_HIGHRES 2
|
||||
#define BMP085_ULTRAHIGHRES 3
|
||||
#define BMP085_CAL_AC1 0xAA // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_AC2 0xAC // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_AC3 0xAE // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_AC4 0xB0 // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_AC5 0xB2 // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_AC6 0xB4 // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_B1 0xB6 // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_B2 0xB8 // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_MB 0xBA // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_MC 0xBC // R Calibration data (16 bits)
|
||||
#define BMP085_CAL_MD 0xBE // R Calibration data (16 bits)
|
||||
|
||||
#define BMP085_CONTROL 0xF4
|
||||
#define BMP085_TEMPDATA 0xF6
|
||||
#define BMP085_PRESSUREDATA 0xF6
|
||||
#define BMP085_READTEMPCMD 0x2E
|
||||
#define BMP085_READPRESSURECMD 0x34
|
||||
|
||||
|
||||
class Adafruit_BMP085 {
|
||||
public:
|
||||
Adafruit_BMP085();
|
||||
boolean begin(uint8_t mode = BMP085_ULTRAHIGHRES); // by default go highres
|
||||
float readTemperature(void);
|
||||
int32_t readPressure(void);
|
||||
int32_t readSealevelPressure(float altitude_meters = 0);
|
||||
float readAltitude(float sealevelPressure = 101325); // std atmosphere
|
||||
uint16_t readRawTemperature(void);
|
||||
uint32_t readRawPressure(void);
|
||||
|
||||
private:
|
||||
int32_t computeB5(int32_t UT);
|
||||
uint8_t read8(uint8_t addr);
|
||||
uint16_t read16(uint8_t addr);
|
||||
void write8(uint8_t addr, uint8_t data);
|
||||
|
||||
uint8_t oversampling;
|
||||
|
||||
int16_t ac1, ac2, ac3, b1, b2, mb, mc, md;
|
||||
uint16_t ac4, ac5, ac6;
|
||||
};
|
||||
|
||||
|
||||
#endif // ADAFRUIT_BMP085_H
|
||||
@@ -1,28 +0,0 @@
|
||||
This is a library for the Adafruit BMP085/BMP180 Barometric Pressure + Temp sensor
|
||||
|
||||
Designed specifically to work with the Adafruit BMP085 or BMP180 Breakout
|
||||
----> http://www.adafruit.com/products/391
|
||||
----> http://www.adafruit.com/products/1603
|
||||
|
||||
These displays use I2C to communicate, 2 pins are required to interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Check out the links above for our tutorials and wiring diagrams
|
||||
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
|
||||
To download. click the DOWNLOAD ZIP button, rename the uncompressed folder Adafruit_BMP085.
|
||||
Check that the Adafruit_BMP085 folder contains Adafruit_BMP085.cpp and Adafruit_BMP085.h
|
||||
|
||||
Place the Adafruit_BMP085 library folder your arduinosketchfolder/libraries/ folder.
|
||||
You may need to create the libraries subfolder if its your first library. Restart the IDE.
|
||||
|
||||
We also have a great tutorial on Arduino library installation at:
|
||||
http://learn.adafruit.com/adafruit-all-about-arduino-libraries-install-use
|
||||
@@ -1,62 +0,0 @@
|
||||
#include <Wire.h>
|
||||
#include <Adafruit_BMP085.h>
|
||||
|
||||
/***************************************************
|
||||
This is an example for the BMP085 Barometric Pressure & Temp Sensor
|
||||
|
||||
Designed specifically to work with the Adafruit BMP085 Breakout
|
||||
----> https://www.adafruit.com/products/391
|
||||
|
||||
These displays use I2C to communicate, 2 pins are required to
|
||||
interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
// Connect VCC of the BMP085 sensor to 3.3V (NOT 5.0V!)
|
||||
// Connect GND to Ground
|
||||
// Connect SCL to i2c clock - on '168/'328 Arduino Nano/Uno/Duemilanove/etc thats Analog 5
|
||||
// Connect SDA to i2c data - on '168/'328 Arduino Nano/Uno/Duemilanove/etc thats Analog 4
|
||||
// EOC is not used, it signifies an end of conversion
|
||||
// XCLR is a reset pin, also not used here
|
||||
|
||||
Adafruit_BMP085 bmp;
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
if (!bmp.begin()) {
|
||||
Serial.println("Could not find a valid BMP085 sensor, check wiring!");
|
||||
while (1) {}
|
||||
}
|
||||
}
|
||||
|
||||
void loop() {
|
||||
Serial.print("Temperature = ");
|
||||
Serial.print(bmp.readTemperature());
|
||||
Serial.println(" *C");
|
||||
|
||||
Serial.print("Pressure = ");
|
||||
Serial.print(bmp.readPressure());
|
||||
Serial.println(" Pa");
|
||||
|
||||
// Calculate altitude assuming 'standard' barometric
|
||||
// pressure of 1013.25 millibar = 101325 Pascal
|
||||
Serial.print("Altitude = ");
|
||||
Serial.print(bmp.readAltitude());
|
||||
Serial.println(" meters");
|
||||
|
||||
// you can get a more precise measurement of altitude
|
||||
// if you know the current sea level pressure which will
|
||||
// vary with weather and such. If it is 1015 millibars
|
||||
// that is equal to 101500 Pascals.
|
||||
Serial.print("Real altitude = ");
|
||||
Serial.print(bmp.readAltitude(101500));
|
||||
Serial.println(" meters");
|
||||
|
||||
Serial.println();
|
||||
delay(500);
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
language: c
|
||||
sudo: false
|
||||
before_install:
|
||||
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
|
||||
script:
|
||||
- build_main_platforms
|
||||
notifications:
|
||||
email:
|
||||
on_success: change
|
||||
on_failure: change
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,257 +0,0 @@
|
||||
/***************************************************
|
||||
This is a library for our Adafruit FONA Cellular Module
|
||||
|
||||
Designed specifically to work with the Adafruit FONA
|
||||
----> http://www.adafruit.com/products/1946
|
||||
----> http://www.adafruit.com/products/1963
|
||||
|
||||
These displays use TTL Serial to communicate, 2 pins are required to
|
||||
interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
#ifndef ADAFRUIT_FONA_H
|
||||
#define ADAFRUIT_FONA_H
|
||||
|
||||
#if (ARDUINO >= 100)
|
||||
#include "Arduino.h"
|
||||
#ifndef __SAM3X8E__ // Arduino Due doesn't support SoftwareSerial
|
||||
#include <SoftwareSerial.h>
|
||||
#endif
|
||||
#else
|
||||
#include "WProgram.h"
|
||||
#include <NewSoftSerial.h>
|
||||
#endif
|
||||
|
||||
#define ADAFRUIT_FONA_DEBUG
|
||||
|
||||
#define FONA800L 1
|
||||
#define FONA800H 6
|
||||
|
||||
#define FONA808_V1 2
|
||||
#define FONA808_V2 3
|
||||
|
||||
#define FONA3G_A 4
|
||||
#define FONA3G_E 5
|
||||
|
||||
|
||||
#define FONA_HEADSETAUDIO 0
|
||||
#define FONA_EXTAUDIO 1
|
||||
|
||||
#define FONA_STTONE_DIALTONE 1
|
||||
#define FONA_STTONE_BUSY 2
|
||||
#define FONA_STTONE_CONGESTION 3
|
||||
#define FONA_STTONE_PATHACK 4
|
||||
#define FONA_STTONE_DROPPED 5
|
||||
#define FONA_STTONE_ERROR 6
|
||||
#define FONA_STTONE_CALLWAIT 7
|
||||
#define FONA_STTONE_RINGING 8
|
||||
#define FONA_STTONE_BEEP 16
|
||||
#define FONA_STTONE_POSTONE 17
|
||||
#define FONA_STTONE_ERRTONE 18
|
||||
#define FONA_STTONE_INDIANDIALTONE 19
|
||||
#define FONA_STTONE_USADIALTONE 20
|
||||
|
||||
#define FONA_DEFAULT_TIMEOUT_MS 500
|
||||
|
||||
#define FONA_HTTP_GET 0
|
||||
#define FONA_HTTP_POST 1
|
||||
#define FONA_HTTP_HEAD 2
|
||||
|
||||
class Adafruit_FONA : public Stream {
|
||||
public:
|
||||
Adafruit_FONA(int8_t r);
|
||||
boolean begin(Stream &port);
|
||||
uint8_t type();
|
||||
|
||||
// Stream
|
||||
int available(void);
|
||||
size_t write(uint8_t x);
|
||||
int read(void);
|
||||
int peek(void);
|
||||
void flush();
|
||||
|
||||
// FONA 3G requirements
|
||||
boolean setBaudrate(uint16_t baud);
|
||||
|
||||
// RTC
|
||||
boolean enableRTC(uint8_t i);
|
||||
boolean readRTC(uint8_t *year, uint8_t *month, uint8_t *date, uint8_t *hr, uint8_t *min, uint8_t *sec);
|
||||
|
||||
// Battery and ADC
|
||||
boolean getADCVoltage(uint16_t *v);
|
||||
boolean getBattPercent(uint16_t *p);
|
||||
boolean getBattVoltage(uint16_t *v);
|
||||
|
||||
// SIM query
|
||||
uint8_t unlockSIM(char *pin);
|
||||
uint8_t getSIMCCID(char *ccid);
|
||||
uint8_t getNetworkStatus(void);
|
||||
uint8_t getRSSI(void);
|
||||
|
||||
// IMEI
|
||||
uint8_t getIMEI(char *imei);
|
||||
|
||||
// set Audio output
|
||||
boolean setAudio(uint8_t a);
|
||||
boolean setVolume(uint8_t i);
|
||||
uint8_t getVolume(void);
|
||||
boolean playToolkitTone(uint8_t t, uint16_t len);
|
||||
boolean setMicVolume(uint8_t a, uint8_t level);
|
||||
boolean playDTMF(char tone);
|
||||
|
||||
// FM radio functions.
|
||||
boolean tuneFMradio(uint16_t station);
|
||||
boolean FMradio(boolean onoff, uint8_t a = FONA_HEADSETAUDIO);
|
||||
boolean setFMVolume(uint8_t i);
|
||||
int8_t getFMVolume();
|
||||
int8_t getFMSignalLevel(uint16_t station);
|
||||
|
||||
// SMS handling
|
||||
boolean setSMSInterrupt(uint8_t i);
|
||||
uint8_t getSMSInterrupt(void);
|
||||
int8_t getNumSMS(void);
|
||||
boolean readSMS(uint8_t i, char *smsbuff, uint16_t max, uint16_t *readsize);
|
||||
boolean sendSMS(char *smsaddr, char *smsmsg);
|
||||
boolean deleteSMS(uint8_t i);
|
||||
boolean getSMSSender(uint8_t i, char *sender, int senderlen);
|
||||
|
||||
// Time
|
||||
boolean enableNetworkTimeSync(boolean onoff);
|
||||
boolean enableNTPTimeSync(boolean onoff, const __FlashStringHelper *ntpserver=0);
|
||||
boolean getTime(char *buff, uint16_t maxlen);
|
||||
|
||||
// GPRS handling
|
||||
boolean enableGPRS(boolean onoff);
|
||||
uint8_t GPRSstate(void);
|
||||
boolean getGSMLoc(uint16_t *replycode, char *buff, uint16_t maxlen);
|
||||
boolean getGSMLoc(float *lat, float *lon);
|
||||
void setGPRSNetworkSettings(const __FlashStringHelper *apn, const __FlashStringHelper *username=0, const __FlashStringHelper *password=0);
|
||||
|
||||
// GPS handling
|
||||
boolean enableGPS(boolean onoff);
|
||||
int8_t GPSstatus(void);
|
||||
uint8_t getGPS(uint8_t arg, char *buffer, uint8_t maxbuff);
|
||||
boolean getGPS(float *lat, float *lon, float *speed_kph=0, float *heading=0, float *altitude=0);
|
||||
boolean enableGPSNMEA(uint8_t nmea);
|
||||
|
||||
// TCP raw connections
|
||||
boolean TCPconnect(char *server, uint16_t port);
|
||||
boolean TCPclose(void);
|
||||
boolean TCPconnected(void);
|
||||
boolean TCPsend(char *packet, uint8_t len);
|
||||
uint16_t TCPavailable(void);
|
||||
uint16_t TCPread(uint8_t *buff, uint8_t len);
|
||||
|
||||
// HTTP low level interface (maps directly to SIM800 commands).
|
||||
boolean HTTP_init();
|
||||
boolean HTTP_term();
|
||||
void HTTP_para_start(const __FlashStringHelper *parameter, boolean quoted = true);
|
||||
boolean HTTP_para_end(boolean quoted = true);
|
||||
boolean HTTP_para(const __FlashStringHelper *parameter, const char *value);
|
||||
boolean HTTP_para(const __FlashStringHelper *parameter, const __FlashStringHelper *value);
|
||||
boolean HTTP_para(const __FlashStringHelper *parameter, int32_t value);
|
||||
boolean HTTP_data(uint32_t size, uint32_t maxTime=10000);
|
||||
boolean HTTP_action(uint8_t method, uint16_t *status, uint16_t *datalen, int32_t timeout = 10000);
|
||||
boolean HTTP_readall(uint16_t *datalen);
|
||||
boolean HTTP_ssl(boolean onoff);
|
||||
|
||||
// HTTP high level interface (easier to use, less flexible).
|
||||
boolean HTTP_GET_start(char *url, uint16_t *status, uint16_t *datalen);
|
||||
void HTTP_GET_end(void);
|
||||
boolean HTTP_POST_start(char *url, const __FlashStringHelper *contenttype, const uint8_t *postdata, uint16_t postdatalen, uint16_t *status, uint16_t *datalen);
|
||||
void HTTP_POST_end(void);
|
||||
void setUserAgent(const __FlashStringHelper *useragent);
|
||||
|
||||
// HTTPS
|
||||
void setHTTPSRedirect(boolean onoff);
|
||||
|
||||
// PWM (buzzer)
|
||||
boolean setPWM(uint16_t period, uint8_t duty = 50);
|
||||
|
||||
// Phone calls
|
||||
boolean callPhone(char *phonenum);
|
||||
boolean hangUp(void);
|
||||
boolean pickUp(void);
|
||||
boolean callerIdNotification(boolean enable, uint8_t interrupt = 0);
|
||||
boolean incomingCallNumber(char* phonenum);
|
||||
|
||||
// Helper functions to verify responses.
|
||||
boolean expectReply(const __FlashStringHelper *reply, uint16_t timeout = 10000);
|
||||
boolean sendCheckReply(char *send, char *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
boolean sendCheckReply(const __FlashStringHelper *send, const __FlashStringHelper *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
|
||||
|
||||
protected:
|
||||
int8_t _rstpin;
|
||||
uint8_t _type;
|
||||
|
||||
char replybuffer[255];
|
||||
const __FlashStringHelper *apn;
|
||||
const __FlashStringHelper *apnusername;
|
||||
const __FlashStringHelper *apnpassword;
|
||||
boolean httpsredirect;
|
||||
const __FlashStringHelper *useragent;
|
||||
|
||||
// HTTP helpers
|
||||
boolean HTTP_setup(char *url);
|
||||
|
||||
void flushInput();
|
||||
uint16_t readRaw(uint16_t b);
|
||||
uint8_t readline(uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS, boolean multiline = false);
|
||||
uint8_t getReply(char *send, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
uint8_t getReply(const __FlashStringHelper *send, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
uint8_t getReply(const __FlashStringHelper *prefix, char *suffix, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
uint8_t getReply(const __FlashStringHelper *prefix, int32_t suffix, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
uint8_t getReply(const __FlashStringHelper *prefix, int32_t suffix1, int32_t suffix2, uint16_t timeout); // Don't set default value or else function call is ambiguous.
|
||||
uint8_t getReplyQuoted(const __FlashStringHelper *prefix, const __FlashStringHelper *suffix, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
|
||||
boolean sendCheckReply(const __FlashStringHelper *prefix, char *suffix, const __FlashStringHelper *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
boolean sendCheckReply(const __FlashStringHelper *prefix, int32_t suffix, const __FlashStringHelper *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
boolean sendCheckReply(const __FlashStringHelper *prefix, int32_t suffix, int32_t suffix2, const __FlashStringHelper *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
boolean sendCheckReplyQuoted(const __FlashStringHelper *prefix, const __FlashStringHelper *suffix, const __FlashStringHelper *reply, uint16_t timeout = FONA_DEFAULT_TIMEOUT_MS);
|
||||
|
||||
|
||||
boolean parseReply(const __FlashStringHelper *toreply,
|
||||
uint16_t *v, char divider = ',', uint8_t index=0);
|
||||
boolean parseReply(const __FlashStringHelper *toreply,
|
||||
char *v, char divider = ',', uint8_t index=0);
|
||||
boolean parseReplyQuoted(const __FlashStringHelper *toreply,
|
||||
char *v, int maxlen, char divider, uint8_t index);
|
||||
|
||||
boolean sendParseReply(const __FlashStringHelper *tosend,
|
||||
const __FlashStringHelper *toreply,
|
||||
uint16_t *v, char divider = ',', uint8_t index=0);
|
||||
|
||||
static boolean _incomingCall;
|
||||
static void onIncomingCall();
|
||||
|
||||
Stream *mySerial;
|
||||
};
|
||||
|
||||
class Adafruit_FONA_3G : public Adafruit_FONA {
|
||||
|
||||
public:
|
||||
Adafruit_FONA_3G (int8_t r) : Adafruit_FONA(r) { _type = FONA3G_A; }
|
||||
|
||||
boolean getBattVoltage(uint16_t *v);
|
||||
boolean playToolkitTone(uint8_t t, uint16_t len);
|
||||
boolean hangUp(void);
|
||||
boolean pickUp(void);
|
||||
boolean enableGPRS(boolean onoff);
|
||||
boolean enableGPS(boolean onoff);
|
||||
|
||||
protected:
|
||||
boolean parseReply(const __FlashStringHelper *toreply,
|
||||
float *f, char divider, uint8_t index);
|
||||
|
||||
boolean sendParseReply(const __FlashStringHelper *tosend,
|
||||
const __FlashStringHelper *toreply,
|
||||
float *f, char divider = ',', uint8_t index=0);
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,29 +0,0 @@
|
||||
# Adafruit FONA Library [](https://travis-ci.org/adafruit/Adafruit_FONA_Library)
|
||||
|
||||
**This library requires Arduino v1.0.6 or higher**
|
||||
|
||||
This is a library for the Adafruit FONA Cellular GSM Breakouts etc
|
||||
|
||||
Designed specifically to work with the Adafruit FONA Breakout
|
||||
* https://www.adafruit.com/products/1946
|
||||
* https://www.adafruit.com/products/1963
|
||||
* http://www.adafruit.com/products/2468
|
||||
* http://www.adafruit.com/products/2542
|
||||
|
||||
These modules use TTL Serial to communicate, 2 pins are required to interface
|
||||
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Check out the links above for our tutorials and wiring diagrams
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
With updates from Samy Kamkar
|
||||
|
||||
To download. click the DOWNLOADS button in the top right corner, rename the uncompressed folder Adafruit_FONA
|
||||
Check that the Adafruit_FONA folder contains Adafruit_FONA.cpp and Adafruit_FONA.h
|
||||
|
||||
Place the Adafruit_FONA library folder your *arduinosketchfolder*/libraries/ folder.
|
||||
You may need to create the libraries subfolder if its your first library. Restart the IDE.
|
||||
@@ -1,77 +0,0 @@
|
||||
/***************************************************
|
||||
This is an example for our Adafruit FONA Cellular Module
|
||||
since the FONA 3G does not do auto-baud very well, this demo
|
||||
fixes the baud rate to 4800 from the default 115200
|
||||
|
||||
Designed specifically to work with the Adafruit FONA 3G
|
||||
----> http://www.adafruit.com/products/2691
|
||||
----> http://www.adafruit.com/products/2687
|
||||
|
||||
These cellular modules use TTL Serial to communicate, 2 pins are
|
||||
required to interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
#include "Adafruit_FONA.h"
|
||||
|
||||
#define FONA_RX 2
|
||||
#define FONA_TX 3
|
||||
#define FONA_RST 4
|
||||
|
||||
// this is a large buffer for replies
|
||||
char replybuffer[255];
|
||||
|
||||
// We default to using software serial. If you want to use hardware serial
|
||||
// (because softserial isnt supported) comment out the following three lines
|
||||
// and uncomment the HardwareSerial line
|
||||
#include <SoftwareSerial.h>
|
||||
SoftwareSerial fonaSS = SoftwareSerial(FONA_TX, FONA_RX);
|
||||
SoftwareSerial *fonaSerial = &fonaSS;
|
||||
|
||||
// Hardware serial is also possible!
|
||||
// HardwareSerial *fonaSerial = &Serial1;
|
||||
|
||||
Adafruit_FONA fona = Adafruit_FONA(FONA_RST);
|
||||
|
||||
uint8_t readline(char *buff, uint8_t maxbuff, uint16_t timeout = 0);
|
||||
|
||||
void setup() {
|
||||
while (!Serial);
|
||||
|
||||
Serial.begin(115200);
|
||||
Serial.println(F("FONA set baudrate"));
|
||||
|
||||
Serial.println(F("First trying 115200 baud"));
|
||||
// start at 115200 baud
|
||||
fonaSerial->begin(115200);
|
||||
fona.begin(*fonaSerial);
|
||||
|
||||
// send the command to reset the baud rate to 4800
|
||||
fona.setBaudrate(4800);
|
||||
|
||||
// restart with 4800 baud
|
||||
fonaSerial->begin(4800);
|
||||
Serial.println(F("Initializing @ 4800 baud..."));
|
||||
|
||||
if (! fona.begin(*fonaSerial)) {
|
||||
Serial.println(F("Couldn't find FONA"));
|
||||
while(1);
|
||||
}
|
||||
Serial.println(F("FONA is OK"));
|
||||
|
||||
// Print module IMEI number.
|
||||
char imei[15] = {0}; // MUST use a 16 character buffer for IMEI!
|
||||
uint8_t imeiLen = fona.getIMEI(imei);
|
||||
if (imeiLen > 0) {
|
||||
Serial.print("Module IMEI: "); Serial.println(imei);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
void loop() {
|
||||
}
|
||||
@@ -1,122 +0,0 @@
|
||||
/***************************************************
|
||||
This is an example for our Adafruit FONA Cellular Module
|
||||
|
||||
Designed specifically to work with the Adafruit FONA
|
||||
----> http://www.adafruit.com/products/1946
|
||||
----> http://www.adafruit.com/products/1963
|
||||
----> http://www.adafruit.com/products/2468
|
||||
----> http://www.adafruit.com/products/2542
|
||||
|
||||
These cellular modules use TTL Serial to communicate, 2 pins are
|
||||
required to interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
/*
|
||||
THIS CODE IS STILL IN PROGRESS!
|
||||
|
||||
Open up the serial console on the Arduino at 115200 baud to interact with FONA
|
||||
|
||||
|
||||
This code will receive an SMS, identify the sender's phone number, and automatically send a response
|
||||
|
||||
*/
|
||||
|
||||
#include "Adafruit_FONA.h"
|
||||
|
||||
#define FONA_RX 2
|
||||
#define FONA_TX 3
|
||||
#define FONA_RST 4
|
||||
|
||||
// this is a large buffer for replies
|
||||
char replybuffer[255];
|
||||
|
||||
// We default to using software serial. If you want to use hardware serial
|
||||
// (because softserial isnt supported) comment out the following three lines
|
||||
// and uncomment the HardwareSerial line
|
||||
#include <SoftwareSerial.h>
|
||||
SoftwareSerial fonaSS = SoftwareSerial(FONA_TX, FONA_RX);
|
||||
SoftwareSerial *fonaSerial = &fonaSS;
|
||||
|
||||
// Hardware serial is also possible!
|
||||
// HardwareSerial *fonaSerial = &Serial1;
|
||||
|
||||
Adafruit_FONA fona = Adafruit_FONA(FONA_RST);
|
||||
|
||||
uint8_t readline(char *buff, uint8_t maxbuff, uint16_t timeout = 0);
|
||||
|
||||
void setup() {
|
||||
while (!Serial);
|
||||
|
||||
Serial.begin(115200);
|
||||
Serial.println(F("FONA SMS caller ID test"));
|
||||
Serial.println(F("Initializing....(May take 3 seconds)"));
|
||||
|
||||
// make it slow so its easy to read!
|
||||
fonaSerial->begin(4800);
|
||||
if (! fona.begin(*fonaSerial)) {
|
||||
Serial.println(F("Couldn't find FONA"));
|
||||
while(1);
|
||||
}
|
||||
Serial.println(F("FONA is OK"));
|
||||
|
||||
// Print SIM card IMEI number.
|
||||
char imei[15] = {0}; // MUST use a 16 character buffer for IMEI!
|
||||
uint8_t imeiLen = fona.getIMEI(imei);
|
||||
if (imeiLen > 0) {
|
||||
Serial.print("SIM card IMEI: "); Serial.println(imei);
|
||||
}
|
||||
|
||||
Serial.println("FONA Ready");
|
||||
}
|
||||
|
||||
|
||||
char fonaInBuffer[64]; //for notifications from the FONA
|
||||
|
||||
void loop() {
|
||||
|
||||
char* bufPtr = fonaInBuffer; //handy buffer pointer
|
||||
|
||||
if (fona.available()) //any data available from the FONA?
|
||||
{
|
||||
int slot = 0; //this will be the slot number of the SMS
|
||||
int charCount = 0;
|
||||
//Read the notification into fonaInBuffer
|
||||
do {
|
||||
*bufPtr = fona.read();
|
||||
Serial.write(*bufPtr);
|
||||
delay(1);
|
||||
} while ((*bufPtr++ != '\n') && (fona.available()) && (++charCount < (sizeof(fonaInBuffer)-1)));
|
||||
|
||||
//Add a terminal NULL to the notification string
|
||||
*bufPtr = 0;
|
||||
|
||||
//Scan the notification string for an SMS received notification.
|
||||
// If it's an SMS message, we'll get the slot number in 'slot'
|
||||
if (1 == sscanf(fonaInBuffer, "+CMTI: \"SM\",%d", &slot)) {
|
||||
Serial.print("slot: "); Serial.println(slot);
|
||||
|
||||
char callerIDbuffer[32]; //we'll store the SMS sender number in here
|
||||
|
||||
// Retrieve SMS sender address/phone number.
|
||||
if (! fona.getSMSSender(slot, callerIDbuffer, 31)) {
|
||||
Serial.println("Didn't find SMS message in slot!");
|
||||
}
|
||||
Serial.print(F("FROM: ")); Serial.println(callerIDbuffer);
|
||||
|
||||
//Send back an automatic response
|
||||
Serial.println("Sending reponse...");
|
||||
if (!fona.sendSMS(callerIDbuffer, "Hey, I got your text!")) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("Sent!"));
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,851 +0,0 @@
|
||||
/***************************************************
|
||||
This is an example for our Adafruit FONA Cellular Module
|
||||
|
||||
Designed specifically to work with the Adafruit FONA
|
||||
----> http://www.adafruit.com/products/1946
|
||||
----> http://www.adafruit.com/products/1963
|
||||
----> http://www.adafruit.com/products/2468
|
||||
----> http://www.adafruit.com/products/2542
|
||||
|
||||
These cellular modules use TTL Serial to communicate, 2 pins are
|
||||
required to interface
|
||||
Adafruit invests time and resources providing this open source code,
|
||||
please support Adafruit and open-source hardware by purchasing
|
||||
products from Adafruit!
|
||||
|
||||
Written by Limor Fried/Ladyada for Adafruit Industries.
|
||||
BSD license, all text above must be included in any redistribution
|
||||
****************************************************/
|
||||
|
||||
/*
|
||||
THIS CODE IS STILL IN PROGRESS!
|
||||
|
||||
Open up the serial console on the Arduino at 115200 baud to interact with FONA
|
||||
|
||||
Note that if you need to set a GPRS APN, username, and password scroll down to
|
||||
the commented section below at the end of the setup() function.
|
||||
*/
|
||||
#include "Adafruit_FONA.h"
|
||||
|
||||
#define FONA_RX 2
|
||||
#define FONA_TX 3
|
||||
#define FONA_RST 4
|
||||
|
||||
// this is a large buffer for replies
|
||||
char replybuffer[255];
|
||||
|
||||
// We default to using software serial. If you want to use hardware serial
|
||||
// (because softserial isnt supported) comment out the following three lines
|
||||
// and uncomment the HardwareSerial line
|
||||
#include <SoftwareSerial.h>
|
||||
SoftwareSerial fonaSS = SoftwareSerial(FONA_TX, FONA_RX);
|
||||
SoftwareSerial *fonaSerial = &fonaSS;
|
||||
|
||||
// Hardware serial is also possible!
|
||||
// HardwareSerial *fonaSerial = &Serial1;
|
||||
|
||||
// Use this for FONA 800 and 808s
|
||||
Adafruit_FONA fona = Adafruit_FONA(FONA_RST);
|
||||
// Use this one for FONA 3G
|
||||
//Adafruit_FONA_3G fona = Adafruit_FONA_3G(FONA_RST);
|
||||
|
||||
uint8_t readline(char *buff, uint8_t maxbuff, uint16_t timeout = 0);
|
||||
|
||||
uint8_t type;
|
||||
|
||||
void setup() {
|
||||
while (!Serial);
|
||||
|
||||
Serial.begin(115200);
|
||||
Serial.println(F("FONA basic test"));
|
||||
Serial.println(F("Initializing....(May take 3 seconds)"));
|
||||
|
||||
fonaSerial->begin(4800);
|
||||
if (! fona.begin(*fonaSerial)) {
|
||||
Serial.println(F("Couldn't find FONA"));
|
||||
while (1);
|
||||
}
|
||||
type = fona.type();
|
||||
Serial.println(F("FONA is OK"));
|
||||
Serial.print(F("Found "));
|
||||
switch (type) {
|
||||
case FONA800L:
|
||||
Serial.println(F("FONA 800L")); break;
|
||||
case FONA800H:
|
||||
Serial.println(F("FONA 800H")); break;
|
||||
case FONA808_V1:
|
||||
Serial.println(F("FONA 808 (v1)")); break;
|
||||
case FONA808_V2:
|
||||
Serial.println(F("FONA 808 (v2)")); break;
|
||||
case FONA3G_A:
|
||||
Serial.println(F("FONA 3G (American)")); break;
|
||||
case FONA3G_E:
|
||||
Serial.println(F("FONA 3G (European)")); break;
|
||||
default:
|
||||
Serial.println(F("???")); break;
|
||||
}
|
||||
|
||||
// Print module IMEI number.
|
||||
char imei[15] = {0}; // MUST use a 16 character buffer for IMEI!
|
||||
uint8_t imeiLen = fona.getIMEI(imei);
|
||||
if (imeiLen > 0) {
|
||||
Serial.print("Module IMEI: "); Serial.println(imei);
|
||||
}
|
||||
|
||||
// Optionally configure a GPRS APN, username, and password.
|
||||
// You might need to do this to access your network's GPRS/data
|
||||
// network. Contact your provider for the exact APN, username,
|
||||
// and password values. Username and password are optional and
|
||||
// can be removed, but APN is required.
|
||||
//fona.setGPRSNetworkSettings(F("your APN"), F("your username"), F("your password"));
|
||||
|
||||
// Optionally configure HTTP gets to follow redirects over SSL.
|
||||
// Default is not to follow SSL redirects, however if you uncomment
|
||||
// the following line then redirects over SSL will be followed.
|
||||
//fona.setHTTPSRedirect(true);
|
||||
|
||||
printMenu();
|
||||
}
|
||||
|
||||
void printMenu(void) {
|
||||
Serial.println(F("-------------------------------------"));
|
||||
Serial.println(F("[?] Print this menu"));
|
||||
Serial.println(F("[a] read the ADC 2.8V max (FONA800 & 808)"));
|
||||
Serial.println(F("[b] read the Battery V and % charged"));
|
||||
Serial.println(F("[C] read the SIM CCID"));
|
||||
Serial.println(F("[U] Unlock SIM with PIN code"));
|
||||
Serial.println(F("[i] read RSSI"));
|
||||
Serial.println(F("[n] get Network status"));
|
||||
Serial.println(F("[v] set audio Volume"));
|
||||
Serial.println(F("[V] get Volume"));
|
||||
Serial.println(F("[H] set Headphone audio (FONA800 & 808)"));
|
||||
Serial.println(F("[e] set External audio (FONA800 & 808)"));
|
||||
Serial.println(F("[T] play audio Tone"));
|
||||
Serial.println(F("[P] PWM/Buzzer out (FONA800 & 808)"));
|
||||
|
||||
// FM (SIM800 only!)
|
||||
Serial.println(F("[f] tune FM radio (FONA800)"));
|
||||
Serial.println(F("[F] turn off FM (FONA800)"));
|
||||
Serial.println(F("[m] set FM volume (FONA800)"));
|
||||
Serial.println(F("[M] get FM volume (FONA800)"));
|
||||
Serial.println(F("[q] get FM station signal level (FONA800)"));
|
||||
|
||||
// Phone
|
||||
Serial.println(F("[c] make phone Call"));
|
||||
Serial.println(F("[h] Hang up phone"));
|
||||
Serial.println(F("[p] Pick up phone"));
|
||||
|
||||
// SMS
|
||||
Serial.println(F("[N] Number of SMSs"));
|
||||
Serial.println(F("[r] Read SMS #"));
|
||||
Serial.println(F("[R] Read All SMS"));
|
||||
Serial.println(F("[d] Delete SMS #"));
|
||||
Serial.println(F("[s] Send SMS"));
|
||||
|
||||
// Time
|
||||
Serial.println(F("[y] Enable network time sync (FONA 800 & 808)"));
|
||||
Serial.println(F("[Y] Enable NTP time sync (GPRS FONA 800 & 808)"));
|
||||
Serial.println(F("[t] Get network time"));
|
||||
|
||||
// GPRS
|
||||
Serial.println(F("[G] Enable GPRS"));
|
||||
Serial.println(F("[g] Disable GPRS"));
|
||||
Serial.println(F("[l] Query GSMLOC (GPRS)"));
|
||||
Serial.println(F("[w] Read webpage (GPRS)"));
|
||||
Serial.println(F("[W] Post to website (GPRS)"));
|
||||
|
||||
// GPS
|
||||
if ((type == FONA3G_A) || (type == FONA3G_E) || (type == FONA808_V1) || (type == FONA808_V2)) {
|
||||
Serial.println(F("[O] Turn GPS on (FONA 808 & 3G)"));
|
||||
Serial.println(F("[o] Turn GPS off (FONA 808 & 3G)"));
|
||||
Serial.println(F("[L] Query GPS location (FONA 808 & 3G)"));
|
||||
if (type == FONA808_V1) {
|
||||
Serial.println(F("[x] GPS fix status (FONA808 v1 only)"));
|
||||
}
|
||||
Serial.println(F("[E] Raw NMEA out (FONA808)"));
|
||||
}
|
||||
|
||||
Serial.println(F("[S] create Serial passthru tunnel"));
|
||||
Serial.println(F("-------------------------------------"));
|
||||
Serial.println(F(""));
|
||||
|
||||
}
|
||||
void loop() {
|
||||
Serial.print(F("FONA> "));
|
||||
while (! Serial.available() ) {
|
||||
if (fona.available()) {
|
||||
Serial.write(fona.read());
|
||||
}
|
||||
}
|
||||
|
||||
char command = Serial.read();
|
||||
Serial.println(command);
|
||||
|
||||
|
||||
switch (command) {
|
||||
case '?': {
|
||||
printMenu();
|
||||
break;
|
||||
}
|
||||
|
||||
case 'a': {
|
||||
// read the ADC
|
||||
uint16_t adc;
|
||||
if (! fona.getADCVoltage(&adc)) {
|
||||
Serial.println(F("Failed to read ADC"));
|
||||
} else {
|
||||
Serial.print(F("ADC = ")); Serial.print(adc); Serial.println(F(" mV"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'b': {
|
||||
// read the battery voltage and percentage
|
||||
uint16_t vbat;
|
||||
if (! fona.getBattVoltage(&vbat)) {
|
||||
Serial.println(F("Failed to read Batt"));
|
||||
} else {
|
||||
Serial.print(F("VBat = ")); Serial.print(vbat); Serial.println(F(" mV"));
|
||||
}
|
||||
|
||||
|
||||
if (! fona.getBattPercent(&vbat)) {
|
||||
Serial.println(F("Failed to read Batt"));
|
||||
} else {
|
||||
Serial.print(F("VPct = ")); Serial.print(vbat); Serial.println(F("%"));
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
case 'U': {
|
||||
// Unlock the SIM with a PIN code
|
||||
char PIN[5];
|
||||
flushSerial();
|
||||
Serial.println(F("Enter 4-digit PIN"));
|
||||
readline(PIN, 3);
|
||||
Serial.println(PIN);
|
||||
Serial.print(F("Unlocking SIM card: "));
|
||||
if (! fona.unlockSIM(PIN)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'C': {
|
||||
// read the CCID
|
||||
fona.getSIMCCID(replybuffer); // make sure replybuffer is at least 21 bytes!
|
||||
Serial.print(F("SIM CCID = ")); Serial.println(replybuffer);
|
||||
break;
|
||||
}
|
||||
|
||||
case 'i': {
|
||||
// read the RSSI
|
||||
uint8_t n = fona.getRSSI();
|
||||
int8_t r;
|
||||
|
||||
Serial.print(F("RSSI = ")); Serial.print(n); Serial.print(": ");
|
||||
if (n == 0) r = -115;
|
||||
if (n == 1) r = -111;
|
||||
if (n == 31) r = -52;
|
||||
if ((n >= 2) && (n <= 30)) {
|
||||
r = map(n, 2, 30, -110, -54);
|
||||
}
|
||||
Serial.print(r); Serial.println(F(" dBm"));
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
case 'n': {
|
||||
// read the network/cellular status
|
||||
uint8_t n = fona.getNetworkStatus();
|
||||
Serial.print(F("Network status "));
|
||||
Serial.print(n);
|
||||
Serial.print(F(": "));
|
||||
if (n == 0) Serial.println(F("Not registered"));
|
||||
if (n == 1) Serial.println(F("Registered (home)"));
|
||||
if (n == 2) Serial.println(F("Not registered (searching)"));
|
||||
if (n == 3) Serial.println(F("Denied"));
|
||||
if (n == 4) Serial.println(F("Unknown"));
|
||||
if (n == 5) Serial.println(F("Registered roaming"));
|
||||
break;
|
||||
}
|
||||
|
||||
/*** Audio ***/
|
||||
case 'v': {
|
||||
// set volume
|
||||
flushSerial();
|
||||
if ( (type == FONA3G_A) || (type == FONA3G_E) ) {
|
||||
Serial.print(F("Set Vol [0-8] "));
|
||||
} else {
|
||||
Serial.print(F("Set Vol % [0-100] "));
|
||||
}
|
||||
uint8_t vol = readnumber();
|
||||
Serial.println();
|
||||
if (! fona.setVolume(vol)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'V': {
|
||||
uint8_t v = fona.getVolume();
|
||||
Serial.print(v);
|
||||
if ( (type == FONA3G_A) || (type == FONA3G_E) ) {
|
||||
Serial.println(" / 8");
|
||||
} else {
|
||||
Serial.println("%");
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'H': {
|
||||
// Set Headphone output
|
||||
if (! fona.setAudio(FONA_HEADSETAUDIO)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
fona.setMicVolume(FONA_HEADSETAUDIO, 15);
|
||||
break;
|
||||
}
|
||||
case 'e': {
|
||||
// Set External output
|
||||
if (! fona.setAudio(FONA_EXTAUDIO)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
|
||||
fona.setMicVolume(FONA_EXTAUDIO, 10);
|
||||
break;
|
||||
}
|
||||
|
||||
case 'T': {
|
||||
// play tone
|
||||
flushSerial();
|
||||
Serial.print(F("Play tone #"));
|
||||
uint8_t kittone = readnumber();
|
||||
Serial.println();
|
||||
// play for 1 second (1000 ms)
|
||||
if (! fona.playToolkitTone(kittone, 1000)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
/*** FM Radio ***/
|
||||
|
||||
case 'f': {
|
||||
// get freq
|
||||
flushSerial();
|
||||
Serial.print(F("FM Freq (eg 1011 == 101.1 MHz): "));
|
||||
uint16_t station = readnumber();
|
||||
Serial.println();
|
||||
// FM radio ON using headset
|
||||
if (fona.FMradio(true, FONA_HEADSETAUDIO)) {
|
||||
Serial.println(F("Opened"));
|
||||
}
|
||||
if (! fona.tuneFMradio(station)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("Tuned"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'F': {
|
||||
// FM radio off
|
||||
if (! fona.FMradio(false)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'm': {
|
||||
// Set FM volume.
|
||||
flushSerial();
|
||||
Serial.print(F("Set FM Vol [0-6]:"));
|
||||
uint8_t vol = readnumber();
|
||||
Serial.println();
|
||||
if (!fona.setFMVolume(vol)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'M': {
|
||||
// Get FM volume.
|
||||
uint8_t fmvol = fona.getFMVolume();
|
||||
if (fmvol < 0) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.print(F("FM volume: "));
|
||||
Serial.println(fmvol, DEC);
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'q': {
|
||||
// Get FM station signal level (in decibels).
|
||||
flushSerial();
|
||||
Serial.print(F("FM Freq (eg 1011 == 101.1 MHz): "));
|
||||
uint16_t station = readnumber();
|
||||
Serial.println();
|
||||
int8_t level = fona.getFMSignalLevel(station);
|
||||
if (level < 0) {
|
||||
Serial.println(F("Failed! Make sure FM radio is on (tuned to station)."));
|
||||
} else {
|
||||
Serial.print(F("Signal level (dB): "));
|
||||
Serial.println(level, DEC);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
/*** PWM ***/
|
||||
|
||||
case 'P': {
|
||||
// PWM Buzzer output @ 2KHz max
|
||||
flushSerial();
|
||||
Serial.print(F("PWM Freq, 0 = Off, (1-2000): "));
|
||||
uint16_t freq = readnumber();
|
||||
Serial.println();
|
||||
if (! fona.setPWM(freq)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
/*** Call ***/
|
||||
case 'c': {
|
||||
// call a phone!
|
||||
char number[30];
|
||||
flushSerial();
|
||||
Serial.print(F("Call #"));
|
||||
readline(number, 30);
|
||||
Serial.println();
|
||||
Serial.print(F("Calling ")); Serial.println(number);
|
||||
if (!fona.callPhone(number)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("Sent!"));
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 'h': {
|
||||
// hang up!
|
||||
if (! fona.hangUp()) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'p': {
|
||||
// pick up!
|
||||
if (! fona.pickUp()) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("OK!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
/*** SMS ***/
|
||||
|
||||
case 'N': {
|
||||
// read the number of SMS's!
|
||||
int8_t smsnum = fona.getNumSMS();
|
||||
if (smsnum < 0) {
|
||||
Serial.println(F("Could not read # SMS"));
|
||||
} else {
|
||||
Serial.print(smsnum);
|
||||
Serial.println(F(" SMS's on SIM card!"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'r': {
|
||||
// read an SMS
|
||||
flushSerial();
|
||||
Serial.print(F("Read #"));
|
||||
uint8_t smsn = readnumber();
|
||||
Serial.print(F("\n\rReading SMS #")); Serial.println(smsn);
|
||||
|
||||
// Retrieve SMS sender address/phone number.
|
||||
if (! fona.getSMSSender(smsn, replybuffer, 250)) {
|
||||
Serial.println("Failed!");
|
||||
break;
|
||||
}
|
||||
Serial.print(F("FROM: ")); Serial.println(replybuffer);
|
||||
|
||||
// Retrieve SMS value.
|
||||
uint16_t smslen;
|
||||
if (! fona.readSMS(smsn, replybuffer, 250, &smslen)) { // pass in buffer and max len!
|
||||
Serial.println("Failed!");
|
||||
break;
|
||||
}
|
||||
Serial.print(F("***** SMS #")); Serial.print(smsn);
|
||||
Serial.print(" ("); Serial.print(smslen); Serial.println(F(") bytes *****"));
|
||||
Serial.println(replybuffer);
|
||||
Serial.println(F("*****"));
|
||||
|
||||
break;
|
||||
}
|
||||
case 'R': {
|
||||
// read all SMS
|
||||
int8_t smsnum = fona.getNumSMS();
|
||||
uint16_t smslen;
|
||||
int8_t smsn;
|
||||
|
||||
if ( (type == FONA3G_A) || (type == FONA3G_E) ) {
|
||||
smsn = 0; // zero indexed
|
||||
smsnum--;
|
||||
} else {
|
||||
smsn = 1; // 1 indexed
|
||||
}
|
||||
|
||||
for ( ; smsn <= smsnum; smsn++) {
|
||||
Serial.print(F("\n\rReading SMS #")); Serial.println(smsn);
|
||||
if (!fona.readSMS(smsn, replybuffer, 250, &smslen)) { // pass in buffer and max len!
|
||||
Serial.println(F("Failed!"));
|
||||
break;
|
||||
}
|
||||
// if the length is zero, its a special case where the index number is higher
|
||||
// so increase the max we'll look at!
|
||||
if (smslen == 0) {
|
||||
Serial.println(F("[empty slot]"));
|
||||
smsnum++;
|
||||
continue;
|
||||
}
|
||||
|
||||
Serial.print(F("***** SMS #")); Serial.print(smsn);
|
||||
Serial.print(" ("); Serial.print(smslen); Serial.println(F(") bytes *****"));
|
||||
Serial.println(replybuffer);
|
||||
Serial.println(F("*****"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'd': {
|
||||
// delete an SMS
|
||||
flushSerial();
|
||||
Serial.print(F("Delete #"));
|
||||
uint8_t smsn = readnumber();
|
||||
|
||||
Serial.print(F("\n\rDeleting SMS #")); Serial.println(smsn);
|
||||
if (fona.deleteSMS(smsn)) {
|
||||
Serial.println(F("OK!"));
|
||||
} else {
|
||||
Serial.println(F("Couldn't delete"));
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 's': {
|
||||
// send an SMS!
|
||||
char sendto[21], message[141];
|
||||
flushSerial();
|
||||
Serial.print(F("Send to #"));
|
||||
readline(sendto, 20);
|
||||
Serial.println(sendto);
|
||||
Serial.print(F("Type out one-line message (140 char): "));
|
||||
readline(message, 140);
|
||||
Serial.println(message);
|
||||
if (!fona.sendSMS(sendto, message)) {
|
||||
Serial.println(F("Failed"));
|
||||
} else {
|
||||
Serial.println(F("Sent!"));
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
/*** Time ***/
|
||||
|
||||
case 'y': {
|
||||
// enable network time sync
|
||||
if (!fona.enableNetworkTimeSync(true))
|
||||
Serial.println(F("Failed to enable"));
|
||||
break;
|
||||
}
|
||||
|
||||
case 'Y': {
|
||||
// enable NTP time sync
|
||||
if (!fona.enableNTPTimeSync(true, F("pool.ntp.org")))
|
||||
Serial.println(F("Failed to enable"));
|
||||
break;
|
||||
}
|
||||
|
||||
case 't': {
|
||||
// read the time
|
||||
char buffer[23];
|
||||
|
||||
fona.getTime(buffer, 23); // make sure replybuffer is at least 23 bytes!
|
||||
Serial.print(F("Time = ")); Serial.println(buffer);
|
||||
break;
|
||||
}
|
||||
|
||||
|
||||
/*********************************** GPS (SIM808 only) */
|
||||
|
||||
case 'o': {
|
||||
// turn GPS off
|
||||
if (!fona.enableGPS(false))
|
||||
Serial.println(F("Failed to turn off"));
|
||||
break;
|
||||
}
|
||||
case 'O': {
|
||||
// turn GPS on
|
||||
if (!fona.enableGPS(true))
|
||||
Serial.println(F("Failed to turn on"));
|
||||
break;
|
||||
}
|
||||
case 'x': {
|
||||
int8_t stat;
|
||||
// check GPS fix
|
||||
stat = fona.GPSstatus();
|
||||
if (stat < 0)
|
||||
Serial.println(F("Failed to query"));
|
||||
if (stat == 0) Serial.println(F("GPS off"));
|
||||
if (stat == 1) Serial.println(F("No fix"));
|
||||
if (stat == 2) Serial.println(F("2D fix"));
|
||||
if (stat == 3) Serial.println(F("3D fix"));
|
||||
break;
|
||||
}
|
||||
|
||||
case 'L': {
|
||||
// check for GPS location
|
||||
char gpsdata[120];
|
||||
fona.getGPS(0, gpsdata, 120);
|
||||
if (type == FONA808_V1)
|
||||
Serial.println(F("Reply in format: mode,longitude,latitude,altitude,utctime(yyyymmddHHMMSS),ttff,satellites,speed,course"));
|
||||
else
|
||||
Serial.println(F("Reply in format: mode,fixstatus,utctime(yyyymmddHHMMSS),latitude,longitude,altitude,speed,course,fixmode,reserved1,HDOP,PDOP,VDOP,reserved2,view_satellites,used_satellites,reserved3,C/N0max,HPA,VPA"));
|
||||
Serial.println(gpsdata);
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
case 'E': {
|
||||
flushSerial();
|
||||
if (type == FONA808_V1) {
|
||||
Serial.print(F("GPS NMEA output sentences (0 = off, 34 = RMC+GGA, 255 = all)"));
|
||||
} else {
|
||||
Serial.print(F("On (1) or Off (0)? "));
|
||||
}
|
||||
uint8_t nmeaout = readnumber();
|
||||
|
||||
// turn on NMEA output
|
||||
fona.enableGPSNMEA(nmeaout);
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
/*********************************** GPRS */
|
||||
|
||||
case 'g': {
|
||||
// turn GPRS off
|
||||
if (!fona.enableGPRS(false))
|
||||
Serial.println(F("Failed to turn off"));
|
||||
break;
|
||||
}
|
||||
case 'G': {
|
||||
// turn GPRS on
|
||||
if (!fona.enableGPRS(true))
|
||||
Serial.println(F("Failed to turn on"));
|
||||
break;
|
||||
}
|
||||
case 'l': {
|
||||
// check for GSMLOC (requires GPRS)
|
||||
uint16_t returncode;
|
||||
|
||||
if (!fona.getGSMLoc(&returncode, replybuffer, 250))
|
||||
Serial.println(F("Failed!"));
|
||||
if (returncode == 0) {
|
||||
Serial.println(replybuffer);
|
||||
} else {
|
||||
Serial.print(F("Fail code #")); Serial.println(returncode);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
case 'w': {
|
||||
// read website URL
|
||||
uint16_t statuscode;
|
||||
int16_t length;
|
||||
char url[80];
|
||||
|
||||
flushSerial();
|
||||
Serial.println(F("NOTE: in beta! Use small webpages to read!"));
|
||||
Serial.println(F("URL to read (e.g. www.adafruit.com/testwifi/index.html):"));
|
||||
Serial.print(F("http://")); readline(url, 79);
|
||||
Serial.println(url);
|
||||
|
||||
Serial.println(F("****"));
|
||||
if (!fona.HTTP_GET_start(url, &statuscode, (uint16_t *)&length)) {
|
||||
Serial.println("Failed!");
|
||||
break;
|
||||
}
|
||||
while (length > 0) {
|
||||
while (fona.available()) {
|
||||
char c = fona.read();
|
||||
|
||||
// Serial.write is too slow, we'll write directly to Serial register!
|
||||
#if defined(__AVR_ATmega328P__) || defined(__AVR_ATmega168__)
|
||||
loop_until_bit_is_set(UCSR0A, UDRE0); /* Wait until data register empty. */
|
||||
UDR0 = c;
|
||||
#else
|
||||
Serial.write(c);
|
||||
#endif
|
||||
length--;
|
||||
if (! length) break;
|
||||
}
|
||||
}
|
||||
Serial.println(F("\n****"));
|
||||
fona.HTTP_GET_end();
|
||||
break;
|
||||
}
|
||||
|
||||
case 'W': {
|
||||
// Post data to website
|
||||
uint16_t statuscode;
|
||||
int16_t length;
|
||||
char url[80];
|
||||
char data[80];
|
||||
|
||||
flushSerial();
|
||||
Serial.println(F("NOTE: in beta! Use simple websites to post!"));
|
||||
Serial.println(F("URL to post (e.g. httpbin.org/post):"));
|
||||
Serial.print(F("http://")); readline(url, 79);
|
||||
Serial.println(url);
|
||||
Serial.println(F("Data to post (e.g. \"foo\" or \"{\"simple\":\"json\"}\"):"));
|
||||
readline(data, 79);
|
||||
Serial.println(data);
|
||||
|
||||
Serial.println(F("****"));
|
||||
if (!fona.HTTP_POST_start(url, F("text/plain"), (uint8_t *) data, strlen(data), &statuscode, (uint16_t *)&length)) {
|
||||
Serial.println("Failed!");
|
||||
break;
|
||||
}
|
||||
while (length > 0) {
|
||||
while (fona.available()) {
|
||||
char c = fona.read();
|
||||
|
||||
#if defined(__AVR_ATmega328P__) || defined(__AVR_ATmega168__)
|
||||
loop_until_bit_is_set(UCSR0A, UDRE0); /* Wait until data register empty. */
|
||||
UDR0 = c;
|
||||
#else
|
||||
Serial.write(c);
|
||||
#endif
|
||||
|
||||
length--;
|
||||
if (! length) break;
|
||||
}
|
||||
}
|
||||
Serial.println(F("\n****"));
|
||||
fona.HTTP_POST_end();
|
||||
break;
|
||||
}
|
||||
/*****************************************/
|
||||
|
||||
case 'S': {
|
||||
Serial.println(F("Creating SERIAL TUBE"));
|
||||
while (1) {
|
||||
while (Serial.available()) {
|
||||
delay(1);
|
||||
fona.write(Serial.read());
|
||||
}
|
||||
if (fona.available()) {
|
||||
Serial.write(fona.read());
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
default: {
|
||||
Serial.println(F("Unknown command"));
|
||||
printMenu();
|
||||
break;
|
||||
}
|
||||
}
|
||||
// flush input
|
||||
flushSerial();
|
||||
while (fona.available()) {
|
||||
Serial.write(fona.read());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
void flushSerial() {
|
||||
while (Serial.available())
|
||||
Serial.read();
|
||||
}
|
||||
|
||||
char readBlocking() {
|
||||
while (!Serial.available());
|
||||
return Serial.read();
|
||||
}
|
||||
uint16_t readnumber() {
|
||||
uint16_t x = 0;
|
||||
char c;
|
||||
while (! isdigit(c = readBlocking())) {
|
||||
//Serial.print(c);
|
||||
}
|
||||
Serial.print(c);
|
||||
x = c - '0';
|
||||
while (isdigit(c = readBlocking())) {
|
||||
Serial.print(c);
|
||||
x *= 10;
|
||||
x += c - '0';
|
||||
}
|
||||
return x;
|
||||
}
|
||||
|
||||
uint8_t readline(char *buff, uint8_t maxbuff, uint16_t timeout) {
|
||||
uint16_t buffidx = 0;
|
||||
boolean timeoutvalid = true;
|
||||
if (timeout == 0) timeoutvalid = false;
|
||||
|
||||
while (true) {
|
||||
if (buffidx > maxbuff) {
|
||||
//Serial.println(F("SPACE"));
|
||||
break;
|
||||
}
|
||||
|
||||
while (Serial.available()) {
|
||||
char c = Serial.read();
|
||||
|
||||
//Serial.print(c, HEX); Serial.print("#"); Serial.println(c);
|
||||
|
||||
if (c == '\r') continue;
|
||||
if (c == 0xA) {
|
||||
if (buffidx == 0) // the first 0x0A is ignored
|
||||
continue;
|
||||
|
||||
timeout = 0; // the second 0x0A is the end of the line
|
||||
timeoutvalid = true;
|
||||
break;
|
||||
}
|
||||
buff[buffidx] = c;
|
||||
buffidx++;
|
||||
}
|
||||
|
||||
if (timeoutvalid && timeout == 0) {
|
||||
//Serial.println(F("TIMEOUT"));
|
||||
break;
|
||||
}
|
||||
delay(1);
|
||||
}
|
||||
buff[buffidx] = 0; // null term
|
||||
return buffidx;
|
||||
}
|
||||
@@ -1,112 +0,0 @@
|
||||
/**
|
||||
* ___ ___ _ _ _ ___ __ ___ ___ ___ ___
|
||||
* | __/ _ \| \| | /_\ ( _ )/ \( _ ) / __| _ \/ __|
|
||||
* | _| (_) | .` |/ _ \ / _ \ () / _ \ | (_ | _/\__ \
|
||||
* |_| \___/|_|\_/_/ \_\ \___/\__/\___/ \___|_| |___/
|
||||
*
|
||||
* This example is meant to work with the Adafruit
|
||||
* FONA 808 or 3G Shield or Breakout
|
||||
*
|
||||
* Copyright: 2015 Adafruit
|
||||
* Author: Todd Treece
|
||||
* Licence: MIT
|
||||
*
|
||||
*/
|
||||
#include "Adafruit_FONA.h"
|
||||
|
||||
// standard pins for the shield, adjust as necessary
|
||||
#define FONA_RX 2
|
||||
#define FONA_TX 3
|
||||
#define FONA_RST 4
|
||||
|
||||
// We default to using software serial. If you want to use hardware serial
|
||||
// (because softserial isnt supported) comment out the following three lines
|
||||
// and uncomment the HardwareSerial line
|
||||
#include <SoftwareSerial.h>
|
||||
SoftwareSerial fonaSS = SoftwareSerial(FONA_TX, FONA_RX);
|
||||
SoftwareSerial *fonaSerial = &fonaSS;
|
||||
|
||||
// Hardware serial is also possible!
|
||||
// HardwareSerial *fonaSerial = &Serial1;
|
||||
|
||||
Adafruit_FONA fona = Adafruit_FONA(FONA_RST);
|
||||
|
||||
// Have a FONA 3G? use this object type instead
|
||||
//Adafruit_FONA_3G fona = Adafruit_FONA_3G(FONA_RST);
|
||||
|
||||
|
||||
void setup() {
|
||||
|
||||
while (! Serial);
|
||||
|
||||
Serial.begin(115200);
|
||||
Serial.println(F("Adafruit FONA 808 & 3G GPS demo"));
|
||||
Serial.println(F("Initializing FONA... (May take a few seconds)"));
|
||||
|
||||
fonaSerial->begin(4800);
|
||||
if (! fona.begin(*fonaSerial)) {
|
||||
Serial.println(F("Couldn't find FONA"));
|
||||
while(1);
|
||||
}
|
||||
Serial.println(F("FONA is OK"));
|
||||
// Try to enable GPRS
|
||||
|
||||
|
||||
Serial.println(F("Enabling GPS..."));
|
||||
fona.enableGPS(true);
|
||||
}
|
||||
|
||||
void loop() {
|
||||
delay(2000);
|
||||
|
||||
float latitude, longitude, speed_kph, heading, speed_mph, altitude;
|
||||
|
||||
// if you ask for an altitude reading, getGPS will return false if there isn't a 3D fix
|
||||
boolean gps_success = fona.getGPS(&latitude, &longitude, &speed_kph, &heading, &altitude);
|
||||
|
||||
if (gps_success) {
|
||||
|
||||
Serial.print("GPS lat:");
|
||||
Serial.println(latitude, 6);
|
||||
Serial.print("GPS long:");
|
||||
Serial.println(longitude, 6);
|
||||
Serial.print("GPS speed KPH:");
|
||||
Serial.println(speed_kph);
|
||||
Serial.print("GPS speed MPH:");
|
||||
speed_mph = speed_kph * 0.621371192;
|
||||
Serial.println(speed_mph);
|
||||
Serial.print("GPS heading:");
|
||||
Serial.println(heading);
|
||||
Serial.print("GPS altitude:");
|
||||
Serial.println(altitude);
|
||||
|
||||
} else {
|
||||
Serial.println("Waiting for FONA GPS 3D fix...");
|
||||
}
|
||||
|
||||
// Fona 3G doesnt have GPRSlocation :/
|
||||
if ((fona.type() == FONA3G_A) || (fona.type() == FONA3G_E))
|
||||
return;
|
||||
// Check for network, then GPRS
|
||||
Serial.println(F("Checking for Cell network..."));
|
||||
if (fona.getNetworkStatus() == 1) {
|
||||
// network & GPRS? Great! Print out the GSM location to compare
|
||||
boolean gsmloc_success = fona.getGSMLoc(&latitude, &longitude);
|
||||
|
||||
if (gsmloc_success) {
|
||||
Serial.print("GSMLoc lat:");
|
||||
Serial.println(latitude, 6);
|
||||
Serial.print("GSMLoc long:");
|
||||
Serial.println(longitude, 6);
|
||||
} else {
|
||||
Serial.println("GSM location failed...");
|
||||
Serial.println(F("Disabling GPRS"));
|
||||
fona.enableGPRS(false);
|
||||
Serial.println(F("Enabling GPRS"));
|
||||
if (!fona.enableGPRS(true)) {
|
||||
Serial.println(F("Failed to turn GPRS on"));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,62 +0,0 @@
|
||||
// FONA Incoming Call Number Example
|
||||
// Listens for a call and displays the phone number of the caller (if available).
|
||||
// Use this example to add phone call detection to your own FONA sketch.
|
||||
#include "Adafruit_FONA.h"
|
||||
|
||||
// Pins which are connected to the FONA.
|
||||
// Note that this is different from FONAtest!
|
||||
#define FONA_RX 3
|
||||
#define FONA_TX 4
|
||||
#define FONA_RST 5
|
||||
|
||||
// Note you need to map interrupt number to pin number
|
||||
// for your board. On an Uno & Mega interrupt 0 is
|
||||
// digital pin 2, and on a Leonardo interrupt 0 is
|
||||
// digital pin 3. See this page for a complete table:
|
||||
// http://arduino.cc/en/Reference/attachInterrupt
|
||||
// Make sure this interrupt pin is connected to FONA RI!
|
||||
#define FONA_RI_INTERRUPT 0
|
||||
|
||||
// We default to using software serial. If you want to use hardware serial
|
||||
// (because softserial isnt supported) comment out the following three lines
|
||||
// and uncomment the HardwareSerial line
|
||||
#include <SoftwareSerial.h>
|
||||
SoftwareSerial fonaSS = SoftwareSerial(FONA_TX, FONA_RX);
|
||||
SoftwareSerial *fonaSerial = &fonaSS;
|
||||
|
||||
// Hardware serial is also possible!
|
||||
// HardwareSerial *fonaSerial = &Serial1;
|
||||
|
||||
Adafruit_FONA fona = Adafruit_FONA(FONA_RST);
|
||||
|
||||
void setup() {
|
||||
Serial.begin(115200);
|
||||
Serial.println(F("FONA incoming call example"));
|
||||
Serial.println(F("Initializing....(May take 3 seconds)"));
|
||||
|
||||
fonaSerial->begin(4800);
|
||||
if (! fona.begin(*fonaSerial)) {
|
||||
Serial.println(F("Couldn't find FONA"));
|
||||
while(1);
|
||||
}
|
||||
Serial.println(F("FONA is OK"));
|
||||
|
||||
// Enable incoming call notification.
|
||||
if(fona.callerIdNotification(true, FONA_RI_INTERRUPT)) {
|
||||
Serial.println(F("Caller id notification enabled."));
|
||||
}
|
||||
else {
|
||||
Serial.println(F("Caller id notification disabled"));
|
||||
}
|
||||
}
|
||||
|
||||
void loop(){
|
||||
// Create a small string buffer to hold incoming call number.
|
||||
char phone[32] = {0};
|
||||
// Check for an incoming call. Will return true if a call is incoming.
|
||||
if(fona.incomingCallNumber(phone)){
|
||||
Serial.println(F("RING!"));
|
||||
Serial.print(F("Phone Number: "));
|
||||
Serial.println(phone);
|
||||
}
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
name=Adafruit FONA Library
|
||||
version=1.3.0
|
||||
author=Adafruit
|
||||
maintainer=Adafruit <info@adafruit.com>
|
||||
sentence=Arduino library for the Adafruit FONA
|
||||
paragraph=Arduino library for the Adafruit FONA
|
||||
category=Communication
|
||||
url=https://github.com/adafruit/Adafruit_FONA_Library
|
||||
architectures=*
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,97 +0,0 @@
|
||||
/*--------------------------------------------------------------------
|
||||
This file is part of the Adafruit NeoPixel library.
|
||||
|
||||
NeoPixel is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Lesser General Public License as
|
||||
published by the Free Software Foundation, either version 3 of
|
||||
the License, or (at your option) any later version.
|
||||
|
||||
NeoPixel 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 Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with NeoPixel. If not, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
--------------------------------------------------------------------*/
|
||||
|
||||
#ifndef ADAFRUIT_NEOPIXEL_H
|
||||
#define ADAFRUIT_NEOPIXEL_H
|
||||
|
||||
#if (ARDUINO >= 100)
|
||||
#include <Arduino.h>
|
||||
#else
|
||||
#include <WProgram.h>
|
||||
#include <pins_arduino.h>
|
||||
#endif
|
||||
|
||||
// 'type' flags for LED pixels (third parameter to constructor):
|
||||
#define NEO_RGB 0x00 // Wired for RGB data order
|
||||
#define NEO_GRB 0x01 // Wired for GRB data order
|
||||
#define NEO_BRG 0x04
|
||||
|
||||
#define NEO_COLMASK 0x01
|
||||
#define NEO_KHZ800 0x02 // 800 KHz datastream
|
||||
#define NEO_SPDMASK 0x02
|
||||
// Trinket flash space is tight, v1 NeoPixels aren't handled by default.
|
||||
// Remove the ifndef/endif to add support -- but code will be bigger.
|
||||
// Conversely, can comment out the #defines to save space on other MCUs.
|
||||
#ifndef __AVR_ATtiny85__
|
||||
#define NEO_KHZ400 0x00 // 400 KHz datastream
|
||||
#endif
|
||||
|
||||
class Adafruit_NeoPixel {
|
||||
|
||||
public:
|
||||
|
||||
// Constructor: number of LEDs, pin number, LED type
|
||||
Adafruit_NeoPixel(uint16_t n, uint8_t p=6, uint8_t t=NEO_GRB + NEO_KHZ800);
|
||||
~Adafruit_NeoPixel();
|
||||
|
||||
void
|
||||
begin(void),
|
||||
show(void),
|
||||
setPin(uint8_t p),
|
||||
setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b),
|
||||
setPixelColor(uint16_t n, uint32_t c),
|
||||
setBrightness(uint8_t),
|
||||
clear();
|
||||
uint8_t
|
||||
*getPixels(void) const,
|
||||
getBrightness(void) const;
|
||||
uint16_t
|
||||
numPixels(void) const;
|
||||
static uint32_t
|
||||
Color(uint8_t r, uint8_t g, uint8_t b);
|
||||
uint32_t
|
||||
getPixelColor(uint16_t n) const;
|
||||
inline bool
|
||||
canShow(void) { return (micros() - endTime) >= 50L; }
|
||||
|
||||
private:
|
||||
|
||||
const uint16_t
|
||||
numLEDs, // Number of RGB LEDs in strip
|
||||
numBytes; // Size of 'pixels' buffer below
|
||||
uint8_t
|
||||
pin, // Output pin number
|
||||
brightness,
|
||||
*pixels, // Holds LED color values (3 bytes each)
|
||||
rOffset, // Index of red byte within each 3-byte pixel
|
||||
gOffset, // Index of green byte
|
||||
bOffset; // Index of blue byte
|
||||
const uint8_t
|
||||
type; // Pixel flags (400 vs 800 KHz, RGB vs GRB color)
|
||||
uint32_t
|
||||
endTime; // Latch timing reference
|
||||
#ifdef __AVR__
|
||||
const volatile uint8_t
|
||||
*port; // Output PORT register
|
||||
uint8_t
|
||||
pinMask; // Output PORT bitmask
|
||||
#endif
|
||||
|
||||
};
|
||||
|
||||
#endif // ADAFRUIT_NEOPIXEL_H
|
||||
@@ -1,794 +0,0 @@
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
LGPL ADDENDUM:
|
||||
|
||||
|
||||
|
||||
GNU LESSER 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.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser 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
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
@@ -1,12 +0,0 @@
|
||||
Adafruit NeoPixel library
|
||||
=========================
|
||||
|
||||
Arduino library for controlling single-wire-based LED pixels and strip such as the [Adafruit 60 LED/meter Digital LED strip][strip], the [Adafruit FLORA RGB Smart Pixel][flora], the [Adafruit Breadboard-friendly RGB Smart Pixel][pixel], the [Adafruit NeoPixel Stick][stick], and the [Adafruit NeoPixel Shield][shield].
|
||||
|
||||
After downloading, rename folder to 'Adafruit_NeoPixel' and install in Arduino Libraries folder. Restart Arduino IDE, then open File->Sketchbook->Library->Adafruit_NeoPixel->strandtest sketch.
|
||||
|
||||
[flora]: http://adafruit.com/products/1060
|
||||
[strip]: http://adafruit.com/products/1138
|
||||
[pixel]: http://adafruit.com/products/1312
|
||||
[stick]: http://adafruit.com/products/1426
|
||||
[shield]: http://adafruit.com/products/1430
|
||||
@@ -1,165 +0,0 @@
|
||||
// This is a demonstration on how to use an input device to trigger changes on your neo pixels.
|
||||
// You should wire a momentary push button to connect from ground to a digital IO pin. When you
|
||||
// press the button it will change to a new pixel animation. Note that you need to press the
|
||||
// button once to start the first animation!
|
||||
|
||||
#include <Adafruit_NeoPixel.h>
|
||||
|
||||
#define BUTTON_PIN 2 // Digital IO pin connected to the button. This will be
|
||||
// driven with a pull-up resistor so the switch should
|
||||
// pull the pin to ground momentarily. On a high -> low
|
||||
// transition the button press logic will execute.
|
||||
|
||||
#define PIXEL_PIN 6 // Digital IO pin connected to the NeoPixels.
|
||||
|
||||
#define PIXEL_COUNT 16
|
||||
|
||||
// Parameter 1 = number of pixels in strip, neopixel stick has 8
|
||||
// Parameter 2 = pin number (most are valid)
|
||||
// Parameter 3 = pixel type flags, add together as needed:
|
||||
// NEO_RGB Pixels are wired for RGB bitstream
|
||||
// NEO_GRB Pixels are wired for GRB bitstream, correct for neopixel stick
|
||||
// NEO_KHZ400 400 KHz bitstream (e.g. FLORA pixels)
|
||||
// NEO_KHZ800 800 KHz bitstream (e.g. High Density LED strip), correct for neopixel stick
|
||||
Adafruit_NeoPixel strip = Adafruit_NeoPixel(PIXEL_COUNT, PIXEL_PIN, NEO_GRB + NEO_KHZ800);
|
||||
|
||||
bool oldState = HIGH;
|
||||
int showType = 0;
|
||||
|
||||
void setup() {
|
||||
pinMode(BUTTON_PIN, INPUT_PULLUP);
|
||||
strip.begin();
|
||||
strip.show(); // Initialize all pixels to 'off'
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Get current button state.
|
||||
bool newState = digitalRead(BUTTON_PIN);
|
||||
|
||||
// Check if state changed from high to low (button press).
|
||||
if (newState == LOW && oldState == HIGH) {
|
||||
// Short delay to debounce button.
|
||||
delay(20);
|
||||
// Check if button is still low after debounce.
|
||||
newState = digitalRead(BUTTON_PIN);
|
||||
if (newState == LOW) {
|
||||
showType++;
|
||||
if (showType > 9)
|
||||
showType=0;
|
||||
startShow(showType);
|
||||
}
|
||||
}
|
||||
|
||||
// Set the last button state to the old state.
|
||||
oldState = newState;
|
||||
}
|
||||
|
||||
void startShow(int i) {
|
||||
switch(i){
|
||||
case 0: colorWipe(strip.Color(0, 0, 0), 50); // Black/off
|
||||
break;
|
||||
case 1: colorWipe(strip.Color(255, 0, 0), 50); // Red
|
||||
break;
|
||||
case 2: colorWipe(strip.Color(0, 255, 0), 50); // Green
|
||||
break;
|
||||
case 3: colorWipe(strip.Color(0, 0, 255), 50); // Blue
|
||||
break;
|
||||
case 4: theaterChase(strip.Color(127, 127, 127), 50); // White
|
||||
break;
|
||||
case 5: theaterChase(strip.Color(127, 0, 0), 50); // Red
|
||||
break;
|
||||
case 6: theaterChase(strip.Color( 0, 0, 127), 50); // Blue
|
||||
break;
|
||||
case 7: rainbow(20);
|
||||
break;
|
||||
case 8: rainbowCycle(20);
|
||||
break;
|
||||
case 9: theaterChaseRainbow(50);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Fill the dots one after the other with a color
|
||||
void colorWipe(uint32_t c, uint8_t wait) {
|
||||
for(uint16_t i=0; i<strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, c);
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
void rainbow(uint8_t wait) {
|
||||
uint16_t i, j;
|
||||
|
||||
for(j=0; j<256; j++) {
|
||||
for(i=0; i<strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, Wheel((i+j) & 255));
|
||||
}
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
// Slightly different, this makes the rainbow equally distributed throughout
|
||||
void rainbowCycle(uint8_t wait) {
|
||||
uint16_t i, j;
|
||||
|
||||
for(j=0; j<256*5; j++) { // 5 cycles of all colors on wheel
|
||||
for(i=0; i< strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, Wheel(((i * 256 / strip.numPixels()) + j) & 255));
|
||||
}
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
//Theatre-style crawling lights.
|
||||
void theaterChase(uint32_t c, uint8_t wait) {
|
||||
for (int j=0; j<10; j++) { //do 10 cycles of chasing
|
||||
for (int q=0; q < 3; q++) {
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, c); //turn every third pixel on
|
||||
}
|
||||
strip.show();
|
||||
|
||||
delay(wait);
|
||||
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, 0); //turn every third pixel off
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Theatre-style crawling lights with rainbow effect
|
||||
void theaterChaseRainbow(uint8_t wait) {
|
||||
for (int j=0; j < 256; j++) { // cycle all 256 colors in the wheel
|
||||
for (int q=0; q < 3; q++) {
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, Wheel( (i+j) % 255)); //turn every third pixel on
|
||||
}
|
||||
strip.show();
|
||||
|
||||
delay(wait);
|
||||
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, 0); //turn every third pixel off
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Input a value 0 to 255 to get a color value.
|
||||
// The colours are a transition r - g - b - back to r.
|
||||
uint32_t Wheel(byte WheelPos) {
|
||||
WheelPos = 255 - WheelPos;
|
||||
if(WheelPos < 85) {
|
||||
return strip.Color(255 - WheelPos * 3, 0, WheelPos * 3);
|
||||
} else if(WheelPos < 170) {
|
||||
WheelPos -= 85;
|
||||
return strip.Color(0, WheelPos * 3, 255 - WheelPos * 3);
|
||||
} else {
|
||||
WheelPos -= 170;
|
||||
return strip.Color(WheelPos * 3, 255 - WheelPos * 3, 0);
|
||||
}
|
||||
}
|
||||
@@ -1,45 +0,0 @@
|
||||
// NeoPixel Ring simple sketch (c) 2013 Shae Erisson
|
||||
// released under the GPLv3 license to match the rest of the AdaFruit NeoPixel library
|
||||
|
||||
#include <Adafruit_NeoPixel.h>
|
||||
#include <avr/power.h>
|
||||
|
||||
// Which pin on the Arduino is connected to the NeoPixels?
|
||||
// On a Trinket or Gemma we suggest changing this to 1
|
||||
#define PIN 6
|
||||
|
||||
// How many NeoPixels are attached to the Arduino?
|
||||
#define NUMPIXELS 16
|
||||
|
||||
// When we setup the NeoPixel library, we tell it how many pixels, and which pin to use to send signals.
|
||||
// Note that for older NeoPixel strips you might need to change the third parameter--see the strandtest
|
||||
// example for more information on possible values.
|
||||
Adafruit_NeoPixel pixels = Adafruit_NeoPixel(NUMPIXELS, PIN, NEO_GRB + NEO_KHZ800);
|
||||
|
||||
int delayval = 500; // delay for half a second
|
||||
|
||||
void setup() {
|
||||
// This is for Trinket 5V 16MHz, you can remove these three lines if you are not using a Trinket
|
||||
#if defined (__AVR_ATtiny85__)
|
||||
if (F_CPU == 16000000) clock_prescale_set(clock_div_1);
|
||||
#endif
|
||||
// End of trinket special code
|
||||
|
||||
pixels.begin(); // This initializes the NeoPixel library.
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
// For a set of NeoPixels the first NeoPixel is 0, second is 1, all the way up to the count of pixels minus one.
|
||||
|
||||
for(int i=0;i<NUMPIXELS;i++){
|
||||
|
||||
// pixels.Color takes RGB values, from 0,0,0 up to 255,255,255
|
||||
pixels.setPixelColor(i, pixels.Color(0,150,0)); // Moderately bright green color.
|
||||
|
||||
pixels.show(); // This sends the updated pixel color to the hardware.
|
||||
|
||||
delay(delayval); // Delay for a period of time (in milliseconds).
|
||||
|
||||
}
|
||||
}
|
||||
@@ -1,131 +0,0 @@
|
||||
#include <Adafruit_NeoPixel.h>
|
||||
#include <avr/power.h>
|
||||
|
||||
#define PIN 6
|
||||
|
||||
// Parameter 1 = number of pixels in strip
|
||||
// Parameter 2 = Arduino pin number (most are valid)
|
||||
// Parameter 3 = pixel type flags, add together as needed:
|
||||
// NEO_KHZ800 800 KHz bitstream (most NeoPixel products w/WS2812 LEDs)
|
||||
// NEO_KHZ400 400 KHz (classic 'v1' (not v2) FLORA pixels, WS2811 drivers)
|
||||
// NEO_GRB Pixels are wired for GRB bitstream (most NeoPixel products)
|
||||
// NEO_RGB Pixels are wired for RGB bitstream (v1 FLORA pixels, not v2)
|
||||
Adafruit_NeoPixel strip = Adafruit_NeoPixel(60, PIN, NEO_GRB + NEO_KHZ800);
|
||||
|
||||
// IMPORTANT: To reduce NeoPixel burnout risk, add 1000 uF capacitor across
|
||||
// pixel power leads, add 300 - 500 Ohm resistor on first pixel's data input
|
||||
// and minimize distance between Arduino and first pixel. Avoid connecting
|
||||
// on a live circuit...if you must, connect GND first.
|
||||
|
||||
void setup() {
|
||||
// This is for Trinket 5V 16MHz, you can remove these three lines if you are not using a Trinket
|
||||
#if defined (__AVR_ATtiny85__)
|
||||
if (F_CPU == 16000000) clock_prescale_set(clock_div_1);
|
||||
#endif
|
||||
// End of trinket special code
|
||||
|
||||
|
||||
strip.begin();
|
||||
strip.show(); // Initialize all pixels to 'off'
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Some example procedures showing how to display to the pixels:
|
||||
colorWipe(strip.Color(255, 0, 0), 50); // Red
|
||||
colorWipe(strip.Color(0, 255, 0), 50); // Green
|
||||
colorWipe(strip.Color(0, 0, 255), 50); // Blue
|
||||
// Send a theater pixel chase in...
|
||||
theaterChase(strip.Color(127, 127, 127), 50); // White
|
||||
theaterChase(strip.Color(127, 0, 0), 50); // Red
|
||||
theaterChase(strip.Color( 0, 0, 127), 50); // Blue
|
||||
|
||||
rainbow(20);
|
||||
rainbowCycle(20);
|
||||
theaterChaseRainbow(50);
|
||||
}
|
||||
|
||||
// Fill the dots one after the other with a color
|
||||
void colorWipe(uint32_t c, uint8_t wait) {
|
||||
for(uint16_t i=0; i<strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, c);
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
void rainbow(uint8_t wait) {
|
||||
uint16_t i, j;
|
||||
|
||||
for(j=0; j<256; j++) {
|
||||
for(i=0; i<strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, Wheel((i+j) & 255));
|
||||
}
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
// Slightly different, this makes the rainbow equally distributed throughout
|
||||
void rainbowCycle(uint8_t wait) {
|
||||
uint16_t i, j;
|
||||
|
||||
for(j=0; j<256*5; j++) { // 5 cycles of all colors on wheel
|
||||
for(i=0; i< strip.numPixels(); i++) {
|
||||
strip.setPixelColor(i, Wheel(((i * 256 / strip.numPixels()) + j) & 255));
|
||||
}
|
||||
strip.show();
|
||||
delay(wait);
|
||||
}
|
||||
}
|
||||
|
||||
//Theatre-style crawling lights.
|
||||
void theaterChase(uint32_t c, uint8_t wait) {
|
||||
for (int j=0; j<10; j++) { //do 10 cycles of chasing
|
||||
for (int q=0; q < 3; q++) {
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, c); //turn every third pixel on
|
||||
}
|
||||
strip.show();
|
||||
|
||||
delay(wait);
|
||||
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, 0); //turn every third pixel off
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Theatre-style crawling lights with rainbow effect
|
||||
void theaterChaseRainbow(uint8_t wait) {
|
||||
for (int j=0; j < 256; j++) { // cycle all 256 colors in the wheel
|
||||
for (int q=0; q < 3; q++) {
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, Wheel( (i+j) % 255)); //turn every third pixel on
|
||||
}
|
||||
strip.show();
|
||||
|
||||
delay(wait);
|
||||
|
||||
for (int i=0; i < strip.numPixels(); i=i+3) {
|
||||
strip.setPixelColor(i+q, 0); //turn every third pixel off
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Input a value 0 to 255 to get a color value.
|
||||
// The colours are a transition r - g - b - back to r.
|
||||
uint32_t Wheel(byte WheelPos) {
|
||||
WheelPos = 255 - WheelPos;
|
||||
if(WheelPos < 85) {
|
||||
return strip.Color(255 - WheelPos * 3, 0, WheelPos * 3);
|
||||
} else if(WheelPos < 170) {
|
||||
WheelPos -= 85;
|
||||
return strip.Color(0, WheelPos * 3, 255 - WheelPos * 3);
|
||||
} else {
|
||||
WheelPos -= 170;
|
||||
return strip.Color(WheelPos * 3, 255 - WheelPos * 3, 0);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
#######################################
|
||||
# Syntax Coloring Map For Adafruit_NeoPixel
|
||||
#######################################
|
||||
# Class
|
||||
#######################################
|
||||
|
||||
Adafruit_NeoPixel KEYWORD1
|
||||
|
||||
#######################################
|
||||
# Methods and Functions
|
||||
#######################################
|
||||
|
||||
setPixelColor KEYWORD2
|
||||
setPin KEYWORD2
|
||||
setBrightness KEYWORD2
|
||||
numPixels KEYWORD2
|
||||
getPixelColor KEYWORD2
|
||||
Color KEYWORD2
|
||||
|
||||
#######################################
|
||||
# Constants
|
||||
#######################################
|
||||
|
||||
NEO_GRB LITERAL1
|
||||
NEO_COLMASK LITERAL1
|
||||
NEO_KHZ800 LITERAL1
|
||||
NEO_SPDMASK LITERAL1
|
||||
NEO_RGB LITERAL1
|
||||
NEO_KHZ400 LITERAL1
|
||||
@@ -1,9 +0,0 @@
|
||||
name=Adafruit NeoPixel
|
||||
version=1.0
|
||||
author=Adafruit
|
||||
maintainer=Adafruit <info@adafruit.com>
|
||||
sentence=Arduino library for controlling single-wire-based LED pixels and strip.
|
||||
paragraph=Arduino library for controlling single-wire-based LED pixels and strip.
|
||||
category=Display
|
||||
url=https://github.com/adafruit/Adafruit_NeoPixel
|
||||
architectures=*
|
||||
@@ -1,97 +0,0 @@
|
||||
/*
|
||||
|
||||
This is a library for the BH1750FVI Digital Light Sensor
|
||||
breakout board.
|
||||
|
||||
The board uses I2C for communication. 2 pins are required to
|
||||
interface to the device.
|
||||
|
||||
|
||||
Written by Christopher Laws, March, 2013.
|
||||
|
||||
*/
|
||||
|
||||
#include "BH1750.h"
|
||||
#include <util/delay.h>
|
||||
|
||||
|
||||
BH1750::BH1750() {
|
||||
}
|
||||
|
||||
void BH1750::begin(uint8_t mode) {
|
||||
|
||||
Wire.begin();
|
||||
//write8(mode);
|
||||
configure(mode);
|
||||
}
|
||||
|
||||
|
||||
void BH1750::configure(uint8_t mode) {
|
||||
|
||||
switch (mode) {
|
||||
case BH1750_CONTINUOUS_HIGH_RES_MODE:
|
||||
case BH1750_CONTINUOUS_HIGH_RES_MODE_2:
|
||||
case BH1750_CONTINUOUS_LOW_RES_MODE:
|
||||
case BH1750_ONE_TIME_HIGH_RES_MODE:
|
||||
case BH1750_ONE_TIME_HIGH_RES_MODE_2:
|
||||
case BH1750_ONE_TIME_LOW_RES_MODE:
|
||||
// apply a valid mode change
|
||||
write8(mode);
|
||||
_delay_ms(10);
|
||||
break;
|
||||
default:
|
||||
// Invalid measurement mode
|
||||
#if BH1750_DEBUG == 1
|
||||
Serial.println("Invalid measurement mode");
|
||||
#endif
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
uint16_t BH1750::readLightLevel(void) {
|
||||
|
||||
uint16_t level;
|
||||
|
||||
Wire.beginTransmission(BH1750_I2CADDR);
|
||||
Wire.requestFrom(BH1750_I2CADDR, 2);
|
||||
#if (ARDUINO >= 100)
|
||||
level = Wire.read();
|
||||
level <<= 8;
|
||||
level |= Wire.read();
|
||||
#else
|
||||
level = Wire.receive();
|
||||
level <<= 8;
|
||||
level |= Wire.receive();
|
||||
#endif
|
||||
Wire.endTransmission();
|
||||
|
||||
#if BH1750_DEBUG == 1
|
||||
Serial.print("Raw light level: ");
|
||||
Serial.println(level);
|
||||
#endif
|
||||
|
||||
level = level/1.2; // convert to lux
|
||||
|
||||
#if BH1750_DEBUG == 1
|
||||
Serial.print("Light level: ");
|
||||
Serial.println(level);
|
||||
#endif
|
||||
return level;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*********************************************************************/
|
||||
|
||||
|
||||
void BH1750::write8(uint8_t d) {
|
||||
Wire.beginTransmission(BH1750_I2CADDR);
|
||||
#if (ARDUINO >= 100)
|
||||
Wire.write(d);
|
||||
#else
|
||||
Wire.send(d);
|
||||
#endif
|
||||
Wire.endTransmission();
|
||||
}
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
/*
|
||||
|
||||
This is a library for the BH1750FVI Digital Light Sensor
|
||||
breakout board.
|
||||
|
||||
The board uses I2C for communication. 2 pins are required to
|
||||
interface to the device.
|
||||
|
||||
Datasheet:
|
||||
http://rohmfs.rohm.com/en/products/databook/datasheet/ic/sensor/light/bh1750fvi-e.pdf
|
||||
|
||||
Written by Christopher Laws, March, 2013.
|
||||
|
||||
*/
|
||||
|
||||
#ifndef BH1750_h
|
||||
#define BH1750_h
|
||||
|
||||
#if (ARDUINO >= 100)
|
||||
#include <Arduino.h>
|
||||
#else
|
||||
#include <WProgram.h>
|
||||
#endif
|
||||
#include "Wire.h"
|
||||
|
||||
#define BH1750_DEBUG 0
|
||||
|
||||
#define BH1750_I2CADDR 0x23
|
||||
|
||||
// No active state
|
||||
#define BH1750_POWER_DOWN 0x00
|
||||
|
||||
// Wating for measurment command
|
||||
#define BH1750_POWER_ON 0x01
|
||||
|
||||
// Reset data register value - not accepted in POWER_DOWN mode
|
||||
#define BH1750_RESET 0x07
|
||||
|
||||
// Start measurement at 1lx resolution. Measurement time is approx 120ms.
|
||||
#define BH1750_CONTINUOUS_HIGH_RES_MODE 0x10
|
||||
|
||||
// Start measurement at 0.5lx resolution. Measurement time is approx 120ms.
|
||||
#define BH1750_CONTINUOUS_HIGH_RES_MODE_2 0x11
|
||||
|
||||
// Start measurement at 4lx resolution. Measurement time is approx 16ms.
|
||||
#define BH1750_CONTINUOUS_LOW_RES_MODE 0x13
|
||||
|
||||
// Start measurement at 1lx resolution. Measurement time is approx 120ms.
|
||||
// Device is automatically set to Power Down after measurement.
|
||||
#define BH1750_ONE_TIME_HIGH_RES_MODE 0x20
|
||||
|
||||
// Start measurement at 0.5lx resolution. Measurement time is approx 120ms.
|
||||
// Device is automatically set to Power Down after measurement.
|
||||
#define BH1750_ONE_TIME_HIGH_RES_MODE_2 0x21
|
||||
|
||||
// Start measurement at 1lx resolution. Measurement time is approx 120ms.
|
||||
// Device is automatically set to Power Down after measurement.
|
||||
#define BH1750_ONE_TIME_LOW_RES_MODE 0x23
|
||||
|
||||
class BH1750 {
|
||||
public:
|
||||
BH1750();
|
||||
void begin(uint8_t mode = BH1750_CONTINUOUS_HIGH_RES_MODE);
|
||||
void configure(uint8_t mode);
|
||||
uint16_t readLightLevel(void);
|
||||
|
||||
private:
|
||||
void write8(uint8_t data);
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,58 +0,0 @@
|
||||
BH1750
|
||||
======
|
||||
|
||||
An Arduino library for digital light sensor breakout boards containing the BH1750FVI IC.
|
||||
|
||||
The board uses I2C for communication.
|
||||
|
||||
2 pins are required to interface to the device.
|
||||
|
||||
Datasheet for the light sensor:
|
||||
http://rohmfs.rohm.com/en/products/databook/datasheet/ic/sensor/light/bh1750fvi-e.pdf
|
||||
|
||||
|
||||
To download, click the ZIP button above. Extract the zip file and rename the uncompressed folder to BH1750. Check that it contains BH1750.cpp and BH1750.h, keywords.txt.
|
||||
|
||||
Place the BH1750 library folder your <arduinosketchfolder>/libraries/ folder. Restart the IDE.
|
||||
|
||||
|
||||
Example usage:
|
||||
```c
|
||||
/*
|
||||
|
||||
Example of BH1750 library usage.
|
||||
|
||||
This example initalises the BH1750 object using the default
|
||||
high resolution mode and then makes a light level reading every second.
|
||||
|
||||
Connection:
|
||||
VCC-5v
|
||||
GND-GND
|
||||
SCL-SCL(analog pin 5)
|
||||
SDA-SDA(analog pin 4)
|
||||
ADD-NC or GND
|
||||
|
||||
*/
|
||||
|
||||
#include <Wire.h>
|
||||
#include <BH1750.h>
|
||||
|
||||
|
||||
BH1750 lightMeter;
|
||||
|
||||
|
||||
void setup(){
|
||||
Serial.begin(9600);
|
||||
lightMeter.begin();
|
||||
Serial.println("Running...");
|
||||
}
|
||||
|
||||
|
||||
void loop() {
|
||||
uint16_t lux = lightMeter.readLightLevel();
|
||||
Serial.print("Light: ");
|
||||
Serial.print(lux);
|
||||
Serial.println(" lx");
|
||||
delay(1000);
|
||||
}
|
||||
```
|
||||
@@ -1,37 +0,0 @@
|
||||
/*
|
||||
|
||||
Example of BH1750 library usage.
|
||||
|
||||
This example initalises the BH1750 object using the default
|
||||
high resolution mode and then makes a light level reading every second.
|
||||
|
||||
Connection:
|
||||
VCC-5v
|
||||
GND-GND
|
||||
SCL-SCL(analog pin 5)
|
||||
SDA-SDA(analog pin 4)
|
||||
ADD-NC or GND
|
||||
|
||||
*/
|
||||
|
||||
#include <Wire.h>
|
||||
#include <BH1750.h>
|
||||
|
||||
|
||||
BH1750 lightMeter;
|
||||
|
||||
|
||||
void setup(){
|
||||
Serial.begin(9600);
|
||||
lightMeter.begin();
|
||||
Serial.println("Running...");
|
||||
}
|
||||
|
||||
|
||||
void loop() {
|
||||
uint16_t lux = lightMeter.readLightLevel();
|
||||
Serial.print("Light: ");
|
||||
Serial.print(lux);
|
||||
Serial.println(" lx");
|
||||
delay(1000);
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
#######################################
|
||||
# Syntax Coloring Map For BH1750
|
||||
#######################################
|
||||
|
||||
#######################################
|
||||
# Datatypes (KEYWORD1)
|
||||
#######################################
|
||||
|
||||
BH1750 KEYWORD1
|
||||
|
||||
#######################################
|
||||
# Methods and Functions (KEYWORD2)
|
||||
#######################################
|
||||
|
||||
begin KEYWORD2
|
||||
configure KEYWORD2
|
||||
readLightLevel KEYWORD2
|
||||
|
||||
|
||||
#######################################
|
||||
# Instances (KEYWORD2)
|
||||
#######################################
|
||||
|
||||
|
||||
#######################################
|
||||
# Constants (LITERAL1)
|
||||
#######################################
|
||||
@@ -1,84 +0,0 @@
|
||||
|
||||
// Please read Bounce.h for information about the liscence and authors
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#include "Arduino.h"
|
||||
#else
|
||||
#include "WProgram.h"
|
||||
#endif
|
||||
#include "Bounce2.h"
|
||||
|
||||
|
||||
|
||||
Bounce::Bounce() {
|
||||
this->interval_millis = 10;
|
||||
|
||||
}
|
||||
|
||||
void Bounce::attach(int pin) {
|
||||
this->pin = pin;
|
||||
debouncedState = unstableState = digitalRead(pin);
|
||||
#ifdef BOUNCE_LOCK_OUT
|
||||
previous_millis = 0;
|
||||
#else
|
||||
previous_millis = millis();
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
|
||||
void Bounce::interval(unsigned long interval_millis)
|
||||
{
|
||||
this->interval_millis = interval_millis;
|
||||
|
||||
}
|
||||
|
||||
|
||||
bool Bounce::update()
|
||||
{
|
||||
|
||||
#ifdef BOUNCE_LOCK_OUT
|
||||
stateChanged = false;
|
||||
// Ignore everything if we are locked out
|
||||
if (millis() - previous_millis >= interval_millis) {
|
||||
uint8_t currentState = digitalRead(pin);
|
||||
if (debouncedState != currentState ) {
|
||||
previous_millis = millis();
|
||||
debouncedState = currentState;
|
||||
stateChanged = true;
|
||||
}
|
||||
}
|
||||
return stateChanged;
|
||||
|
||||
#else
|
||||
// Lire l'etat de l'interrupteur dans une variable temporaire.
|
||||
uint8_t currentState = digitalRead(pin);
|
||||
stateChanged = false;
|
||||
|
||||
// Redemarrer le compteur timeStamp tant et aussi longtemps que
|
||||
// la lecture ne se stabilise pas.
|
||||
if ( currentState != unstableState ) {
|
||||
previous_millis = millis();
|
||||
} else if ( millis() - previous_millis >= interval_millis ) {
|
||||
// Rendu ici, la lecture est stable
|
||||
|
||||
// Est-ce que la lecture est différente de l'etat emmagasine de l'interrupteur?
|
||||
if ( currentState != debouncedState ) {
|
||||
debouncedState = currentState;
|
||||
stateChanged = true;
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
unstableState = currentState;
|
||||
return stateChanged;
|
||||
#endif
|
||||
|
||||
}
|
||||
|
||||
uint8_t Bounce::read()
|
||||
{
|
||||
return debouncedState;
|
||||
}
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
|
||||
/*
|
||||
* 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 2 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, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
||||
* MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/* * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||||
Main code by Thomas O Fredericks (tof@t-o-f.info)
|
||||
Previous contributions by Eric Lowry, Jim Schimpf and Tom Harkaway
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
// Uncomment the following line for "LOCK-OUT" debounce method
|
||||
//#define BOUNCE_LOCK_OUT
|
||||
|
||||
|
||||
#ifndef Bounce2_h
|
||||
#define Bounce2_h
|
||||
|
||||
#include <inttypes.h>
|
||||
|
||||
class Bounce
|
||||
{
|
||||
|
||||
public:
|
||||
// Create an instance of the bounce library
|
||||
Bounce();
|
||||
// Attach to a pin (and also sets initial state)
|
||||
void attach(int pin);
|
||||
// Sets the debounce interval
|
||||
void interval(unsigned long interval_millis);
|
||||
// Updates the pin
|
||||
// Returns 1 if the state changed
|
||||
// Returns 0 if the state did not change
|
||||
bool update();
|
||||
// Returns the updated pin state
|
||||
uint8_t read();
|
||||
|
||||
|
||||
protected:
|
||||
int debounce();
|
||||
unsigned long previous_millis, interval_millis;
|
||||
uint8_t debouncedState;
|
||||
uint8_t unstableState;
|
||||
uint8_t pin;
|
||||
uint8_t stateChanged;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2013 thomasfredericks
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -1 +0,0 @@
|
||||
Please visit https://github.com/thomasfredericks/Bounce-Arduino-Wiring for latest code and documentation.
|
||||
@@ -1,52 +0,0 @@
|
||||
#include <Bounce2.h>
|
||||
|
||||
/*
|
||||
DESCRIPTION
|
||||
====================
|
||||
Simple example of the bounce library that switches the debug LED when a button is pressed.
|
||||
|
||||
CIRCUIT
|
||||
====================
|
||||
https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/Bounce/examples/circuit-bounce-change-duration-retrigger.png
|
||||
*/
|
||||
|
||||
|
||||
#define BUTTON_PIN 2
|
||||
#define LED_PIN 13
|
||||
|
||||
|
||||
|
||||
// Instantiate a Bounce object
|
||||
Bounce debouncer = Bounce();
|
||||
|
||||
void setup() {
|
||||
// Setup the button
|
||||
pinMode(BUTTON_PIN,INPUT);
|
||||
// Activate internal pull-up
|
||||
digitalWrite(BUTTON_PIN,HIGH);
|
||||
|
||||
// After setting up the button, setup debouncer
|
||||
debouncer.attach(BUTTON_PIN);
|
||||
debouncer.interval(5);
|
||||
|
||||
//Setup the LED
|
||||
pinMode(LED_PIN,OUTPUT);
|
||||
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Update the debouncer
|
||||
debouncer.update();
|
||||
|
||||
// Get the update value
|
||||
int value = debouncer.read();
|
||||
|
||||
// Turn on or off the LED
|
||||
if ( value == HIGH) {
|
||||
digitalWrite(LED_PIN, HIGH );
|
||||
} else {
|
||||
digitalWrite(LED_PIN, LOW );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
#include <Bounce2.h>
|
||||
|
||||
// Detect the falling edge
|
||||
|
||||
// Circuit :
|
||||
// https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/Bounce/examples/circuit-bounce-change-duration-retrigger.png
|
||||
|
||||
#define BUTTON_PIN 2
|
||||
#define LED_PIN 13
|
||||
|
||||
int ledState = LOW;
|
||||
|
||||
|
||||
// Instantiate a Bounce object
|
||||
Bounce debouncer = Bounce();
|
||||
|
||||
void setup() {
|
||||
// Setup the button
|
||||
pinMode(BUTTON_PIN,INPUT);
|
||||
digitalWrite(BUTTON_PIN,HIGH);
|
||||
|
||||
// After setting up the button, setup Bounce object
|
||||
debouncer.attach(BUTTON_PIN);
|
||||
debouncer.interval(500);
|
||||
|
||||
//Setup the LED
|
||||
pinMode(LED_PIN,OUTPUT);
|
||||
digitalWrite(LED_PIN,ledState);
|
||||
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
|
||||
boolean stateChanged = debouncer.update();
|
||||
int state = debouncer.read();
|
||||
|
||||
// Detect the falling edge
|
||||
if ( stateChanged && state == LOW ) {
|
||||
|
||||
if ( ledState == LOW ) {
|
||||
ledState = HIGH;
|
||||
} else {
|
||||
ledState = LOW;
|
||||
}
|
||||
digitalWrite(LED_PIN,ledState);
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB |
@@ -1,78 +0,0 @@
|
||||
#include <Bounce2.h>
|
||||
|
||||
/*
|
||||
DESCRIPTION
|
||||
====================
|
||||
Simple example of the bounce library that sets three states for a button through the duration of the press.
|
||||
Open the Serial Monitor (57600 baud) for debug messages.
|
||||
|
||||
CIRCUIT
|
||||
====================
|
||||
https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/Bounce/examples/circuit-bounce-change-duration-retrigger.png
|
||||
*/
|
||||
|
||||
#define BUTTON_PIN 2
|
||||
#define LED_PIN 13
|
||||
|
||||
// Instantiate a Bounce object
|
||||
Bounce debouncer = Bounce();
|
||||
|
||||
// The current buttonState
|
||||
// 0 : released
|
||||
// 1 : pressed less than 2 seconds
|
||||
// 2 : pressed longer than 2 seconds
|
||||
int buttonState;
|
||||
unsigned long buttonPressTimeStamp;
|
||||
|
||||
void setup() {
|
||||
|
||||
Serial.begin(57600);
|
||||
|
||||
// Setup the button
|
||||
pinMode(BUTTON_PIN,INPUT);
|
||||
// Activate internal pull-up
|
||||
digitalWrite(BUTTON_PIN,HIGH);
|
||||
|
||||
// After setting up the button, setup debouncer
|
||||
debouncer.attach(BUTTON_PIN);
|
||||
debouncer.interval(5);
|
||||
|
||||
//Setup the LED
|
||||
pinMode(LED_PIN,OUTPUT);
|
||||
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Update the debouncer and get the changed state
|
||||
boolean changed = debouncer.update();
|
||||
|
||||
|
||||
|
||||
if ( changed ) {
|
||||
// Get the update value
|
||||
int value = debouncer.read();
|
||||
if ( value == HIGH) {
|
||||
digitalWrite(LED_PIN, HIGH );
|
||||
|
||||
buttonState = 0;
|
||||
Serial.println("Button released (state 0)");
|
||||
|
||||
} else {
|
||||
digitalWrite(LED_PIN, LOW );
|
||||
buttonState = 1;
|
||||
Serial.println("Button pressed (state 1)");
|
||||
buttonPressTimeStamp = millis();
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
if ( buttonState == 1 ) {
|
||||
if ( millis() - buttonPressTimeStamp >= 2000 ) {
|
||||
buttonState = 2;
|
||||
Serial.println("Button held for two seconds (state 2)");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
@@ -1,85 +0,0 @@
|
||||
#include <Bounce2.h>
|
||||
|
||||
/*
|
||||
DESCRIPTION
|
||||
====================
|
||||
Simple example of the bounce library that shows how to retrigger an event when a button is held down.
|
||||
In this case, the debug LED will blink every 500 ms as long as the button is held down.
|
||||
Open the Serial Monitor (57600 baud) for debug messages.
|
||||
|
||||
CIRCUIT
|
||||
====================
|
||||
https://raw.github.com/thomasfredericks/Bounce-Arduino-Wiring/master/Bounce/examples/circuit-bounce-change-duration-retrigger.png
|
||||
*/
|
||||
|
||||
#define BUTTON_PIN 2
|
||||
#define LED_PIN 13
|
||||
|
||||
// Instantiate a Bounce object
|
||||
Bounce debouncer = Bounce();
|
||||
|
||||
int buttonState;
|
||||
unsigned long buttonPressTimeStamp;
|
||||
|
||||
int ledState;
|
||||
|
||||
void setup() {
|
||||
|
||||
Serial.begin(57600);
|
||||
|
||||
// Setup the button
|
||||
pinMode(BUTTON_PIN,INPUT);
|
||||
// Activate internal pull-up
|
||||
digitalWrite(BUTTON_PIN,HIGH);
|
||||
|
||||
// After setting up the button, setup debouncer
|
||||
debouncer.attach(BUTTON_PIN);
|
||||
debouncer.interval(5);
|
||||
|
||||
//Setup the LED
|
||||
pinMode(LED_PIN,OUTPUT);
|
||||
digitalWrite(LED_PIN,ledState);
|
||||
|
||||
}
|
||||
|
||||
void loop() {
|
||||
// Update the debouncer and get the changed state
|
||||
boolean changed = debouncer.update();
|
||||
|
||||
|
||||
|
||||
if ( changed ) {
|
||||
// Get the update value
|
||||
int value = debouncer.read();
|
||||
if ( value == HIGH) {
|
||||
ledState = LOW;
|
||||
digitalWrite(LED_PIN, ledState );
|
||||
|
||||
buttonState = 0;
|
||||
Serial.println("Button released (state 0)");
|
||||
|
||||
} else {
|
||||
ledState = HIGH;
|
||||
digitalWrite(LED_PIN, ledState );
|
||||
|
||||
buttonState = 1;
|
||||
Serial.println("Button pressed (state 1)");
|
||||
buttonPressTimeStamp = millis();
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
if ( buttonState == 1 ) {
|
||||
if ( millis() - buttonPressTimeStamp >= 500 ) {
|
||||
buttonPressTimeStamp = millis();
|
||||
if ( ledState == HIGH ) ledState = LOW;
|
||||
else if ( ledState == LOW ) ledState = HIGH;
|
||||
digitalWrite(LED_PIN, ledState );
|
||||
Serial.println("Retriggering button");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -1,206 +0,0 @@
|
||||
/******************************************************************
|
||||
DHT Temperature & Humidity Sensor library for Arduino.
|
||||
|
||||
Features:
|
||||
- Support for DHT11 and DHT22/AM2302/RHT03
|
||||
- Auto detect sensor model
|
||||
- Very low memory footprint
|
||||
- Very small code
|
||||
|
||||
http://www.github.com/markruys/arduino-DHT
|
||||
|
||||
Written by Mark Ruys, mark@paracas.nl.
|
||||
|
||||
BSD license, check license.txt for more information.
|
||||
All text above must be included in any redistribution.
|
||||
|
||||
Datasheets:
|
||||
- http://www.micro4you.com/files/sensor/DHT11.pdf
|
||||
- http://www.adafruit.com/datasheets/DHT22.pdf
|
||||
- http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Sensors/Weather/RHT03.pdf
|
||||
- http://meteobox.tk/files/AM2302.pdf
|
||||
|
||||
Changelog:
|
||||
2013-06-10: Initial version
|
||||
2013-06-12: Refactored code
|
||||
2013-07-01: Add a resetTimer method
|
||||
******************************************************************/
|
||||
|
||||
#include "DHT.h"
|
||||
|
||||
void DHT::setup(uint8_t pin, DHT_MODEL_t model)
|
||||
{
|
||||
DHT::pin = pin;
|
||||
DHT::model = model;
|
||||
DHT::resetTimer(); // Make sure we do read the sensor in the next readSensor()
|
||||
|
||||
if ( model == AUTO_DETECT) {
|
||||
DHT::model = DHT22;
|
||||
readSensor();
|
||||
if ( error == ERROR_TIMEOUT ) {
|
||||
DHT::model = DHT11;
|
||||
// Warning: in case we auto detect a DHT11, you should wait at least 1000 msec
|
||||
// before your first read request. Otherwise you will get a time out error.
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void DHT::resetTimer()
|
||||
{
|
||||
DHT::lastReadTime = millis() - 3000;
|
||||
}
|
||||
|
||||
float DHT::getHumidity()
|
||||
{
|
||||
readSensor();
|
||||
return humidity;
|
||||
}
|
||||
|
||||
float DHT::getTemperature()
|
||||
{
|
||||
readSensor();
|
||||
return temperature;
|
||||
}
|
||||
|
||||
#ifndef OPTIMIZE_SRAM_SIZE
|
||||
|
||||
const char* DHT::getStatusString()
|
||||
{
|
||||
switch ( error ) {
|
||||
case DHT::ERROR_TIMEOUT:
|
||||
return "TIMEOUT";
|
||||
|
||||
case DHT::ERROR_CHECKSUM:
|
||||
return "CHECKSUM";
|
||||
|
||||
default:
|
||||
return "OK";
|
||||
}
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
// At the expense of 26 bytes of extra PROGMEM, we save 11 bytes of
|
||||
// SRAM by using the following method:
|
||||
|
||||
prog_char P_OK[] PROGMEM = "OK";
|
||||
prog_char P_TIMEOUT[] PROGMEM = "TIMEOUT";
|
||||
prog_char P_CHECKSUM[] PROGMEM = "CHECKSUM";
|
||||
|
||||
const char *DHT::getStatusString() {
|
||||
prog_char *c;
|
||||
switch ( error ) {
|
||||
case DHT::ERROR_CHECKSUM:
|
||||
c = P_CHECKSUM; break;
|
||||
|
||||
case DHT::ERROR_TIMEOUT:
|
||||
c = P_TIMEOUT; break;
|
||||
|
||||
default:
|
||||
c = P_OK; break;
|
||||
}
|
||||
|
||||
static char buffer[9];
|
||||
strcpy_P(buffer, c);
|
||||
|
||||
return buffer;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
void DHT::readSensor()
|
||||
{
|
||||
// Make sure we don't poll the sensor too often
|
||||
// - Max sample rate DHT11 is 1 Hz (duty cicle 1000 ms)
|
||||
// - Max sample rate DHT22 is 0.5 Hz (duty cicle 2000 ms)
|
||||
unsigned long startTime = millis();
|
||||
if ( (unsigned long)(startTime - lastReadTime) < (model == DHT11 ? 999L : 1999L) ) {
|
||||
return;
|
||||
}
|
||||
lastReadTime = startTime;
|
||||
|
||||
temperature = NAN;
|
||||
humidity = NAN;
|
||||
|
||||
// Request sample
|
||||
|
||||
digitalWrite(pin, LOW); // Send start signal
|
||||
pinMode(pin, OUTPUT);
|
||||
if ( model == DHT11 ) {
|
||||
delay(18);
|
||||
}
|
||||
else {
|
||||
// This will fail for a DHT11 - that's how we can detect such a device
|
||||
delayMicroseconds(800);
|
||||
}
|
||||
|
||||
pinMode(pin, INPUT);
|
||||
digitalWrite(pin, HIGH); // Switch bus to receive data
|
||||
|
||||
// We're going to read 83 edges:
|
||||
// - First a FALLING, RISING, and FALLING edge for the start bit
|
||||
// - Then 40 bits: RISING and then a FALLING edge per bit
|
||||
// To keep our code simple, we accept any HIGH or LOW reading if it's max 85 usecs long
|
||||
|
||||
word rawHumidity = 0;
|
||||
word rawTemperature = 0;
|
||||
word data = 0;
|
||||
|
||||
for ( int8_t i = -3 ; i < 2 * 40; i++ ) {
|
||||
byte age;
|
||||
startTime = micros();
|
||||
|
||||
do {
|
||||
age = (unsigned long)(micros() - startTime);
|
||||
if ( age > 90 ) {
|
||||
error = ERROR_TIMEOUT;
|
||||
return;
|
||||
}
|
||||
}
|
||||
while ( digitalRead(pin) == (i & 1) ? HIGH : LOW );
|
||||
|
||||
if ( i >= 0 && (i & 1) ) {
|
||||
// Now we are being fed our 40 bits
|
||||
data <<= 1;
|
||||
|
||||
// A zero max 30 usecs, a one at least 68 usecs.
|
||||
if ( age > 30 ) {
|
||||
data |= 1; // we got a one
|
||||
}
|
||||
}
|
||||
|
||||
switch ( i ) {
|
||||
case 31:
|
||||
rawHumidity = data;
|
||||
break;
|
||||
case 63:
|
||||
rawTemperature = data;
|
||||
data = 0;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Verify checksum
|
||||
|
||||
if ( (byte)(((byte)rawHumidity) + (rawHumidity >> 8) + ((byte)rawTemperature) + (rawTemperature >> 8)) != data ) {
|
||||
error = ERROR_CHECKSUM;
|
||||
return;
|
||||
}
|
||||
|
||||
// Store readings
|
||||
|
||||
if ( model == DHT11 ) {
|
||||
humidity = rawHumidity >> 8;
|
||||
temperature = rawTemperature >> 8;
|
||||
}
|
||||
else {
|
||||
humidity = rawHumidity * 0.1;
|
||||
|
||||
if ( rawTemperature & 0x8000 ) {
|
||||
rawTemperature = -(int16_t)(rawTemperature & 0x7FFF);
|
||||
}
|
||||
temperature = ((int16_t)rawTemperature) * 0.1;
|
||||
}
|
||||
|
||||
error = ERROR_NONE;
|
||||
}
|
||||
@@ -1,96 +0,0 @@
|
||||
/******************************************************************
|
||||
DHT Temperature & Humidity Sensor library for Arduino.
|
||||
|
||||
Features:
|
||||
- Support for DHT11 and DHT22/AM2302/RHT03
|
||||
- Auto detect sensor model
|
||||
- Very low memory footprint
|
||||
- Very small code
|
||||
|
||||
http://www.github.com/markruys/arduino-DHT
|
||||
|
||||
Written by Mark Ruys, mark@paracas.nl.
|
||||
|
||||
BSD license, check license.txt for more information.
|
||||
All text above must be included in any redistribution.
|
||||
|
||||
Datasheets:
|
||||
- http://www.micro4you.com/files/sensor/DHT11.pdf
|
||||
- http://www.adafruit.com/datasheets/DHT22.pdf
|
||||
- http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Sensors/Weather/RHT03.pdf
|
||||
- http://meteobox.tk/files/AM2302.pdf
|
||||
|
||||
Changelog:
|
||||
2013-06-10: Initial version
|
||||
2013-06-12: Refactored code
|
||||
2013-07-01: Add a resetTimer method
|
||||
******************************************************************/
|
||||
|
||||
#ifndef dht_h
|
||||
#define dht_h
|
||||
|
||||
#if ARDUINO < 100
|
||||
#include <WProgram.h>
|
||||
#else
|
||||
#include <Arduino.h>
|
||||
#endif
|
||||
|
||||
class DHT
|
||||
{
|
||||
public:
|
||||
|
||||
typedef enum {
|
||||
AUTO_DETECT,
|
||||
DHT11,
|
||||
DHT22,
|
||||
AM2302, // Packaged DHT22
|
||||
RHT03 // Equivalent to DHT22
|
||||
}
|
||||
DHT_MODEL_t;
|
||||
|
||||
typedef enum {
|
||||
ERROR_NONE = 0,
|
||||
ERROR_TIMEOUT,
|
||||
ERROR_CHECKSUM
|
||||
}
|
||||
DHT_ERROR_t;
|
||||
|
||||
void setup(uint8_t pin, DHT_MODEL_t model=AUTO_DETECT);
|
||||
void resetTimer();
|
||||
|
||||
float getTemperature();
|
||||
float getHumidity();
|
||||
|
||||
DHT_ERROR_t getStatus() { return error; };
|
||||
const char* getStatusString();
|
||||
|
||||
DHT_MODEL_t getModel() { return model; }
|
||||
|
||||
int getMinimumSamplingPeriod() { return model == DHT11 ? 1000 : 2000; }
|
||||
|
||||
int8_t getNumberOfDecimalsTemperature() { return model == DHT11 ? 0 : 1; };
|
||||
int8_t getLowerBoundTemperature() { return model == DHT11 ? 0 : -40; };
|
||||
int8_t getUpperBoundTemperature() { return model == DHT11 ? 50 : 125; };
|
||||
|
||||
int8_t getNumberOfDecimalsHumidity() { return 0; };
|
||||
int8_t getLowerBoundHumidity() { return model == DHT11 ? 20 : 0; };
|
||||
int8_t getUpperBoundHumidity() { return model == DHT11 ? 90 : 100; };
|
||||
|
||||
static float toFahrenheit(float fromCelcius) { return 1.8 * fromCelcius + 32.0; };
|
||||
static float toCelsius(float fromFahrenheit) { return (fromFahrenheit - 32.0) / 1.8; };
|
||||
|
||||
protected:
|
||||
void readSensor();
|
||||
|
||||
float temperature;
|
||||
float humidity;
|
||||
|
||||
uint8_t pin;
|
||||
|
||||
private:
|
||||
DHT_MODEL_t model;
|
||||
DHT_ERROR_t error;
|
||||
unsigned long lastReadTime;
|
||||
};
|
||||
|
||||
#endif /*dht_h*/
|
||||
@@ -1,49 +0,0 @@
|
||||
DHT
|
||||
===
|
||||
|
||||
An Arduino library for reading the DHT family of temperature and humidity sensors.
|
||||
|
||||
Written by Mark Ruys, <mark@paracas.nl>.
|
||||
|
||||
Features
|
||||
--------
|
||||
- Support for DHT11 and DHT22, AM2302, RHT03
|
||||
- Auto detect sensor model
|
||||
- Low memory footprint
|
||||
- Very small code
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
```
|
||||
#include "DHT.h"
|
||||
|
||||
DHT dht;
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(9600);
|
||||
|
||||
dht.setup(2); // data pin 2
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
delay(dht.getMinimumSamplingPeriod());
|
||||
|
||||
Serial.print(dht.getHumidity());
|
||||
Serial.print("\t");
|
||||
Serial.print(dht.getTemperature());
|
||||
}
|
||||
```
|
||||
Also check out the [example] how to read out your sensor. For all the options, see [dht.h][header].
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Place the [DHT][download] library folder in your `<arduinosketchfolder>/libraries/` folder. You may need to create the `libraries` subfolder if its your first library. Restart the Arduino IDE.
|
||||
|
||||
[download]: https://github.com/markruys/arduino-DHT/archive/master.zip "Download DHT library"
|
||||
[example]: https://github.com/markruys/arduino-DHT/blob/master/examples/DHT_Test/DHT_Test.pde "Show DHT example"
|
||||
[header]: https://github.com/markruys/arduino-DHT/blob/master/DHT.h "Show header file"
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
#include "DHT.h"
|
||||
|
||||
DHT dht;
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(9600);
|
||||
Serial.println();
|
||||
Serial.println("Status\tHumidity (%)\tTemperature (C)\t(F)");
|
||||
|
||||
dht.setup(2); // data pin 2
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
delay(dht.getMinimumSamplingPeriod());
|
||||
|
||||
float humidity = dht.getHumidity();
|
||||
float temperature = dht.getTemperature();
|
||||
|
||||
Serial.print(dht.getStatusString());
|
||||
Serial.print("\t");
|
||||
Serial.print(humidity, 1);
|
||||
Serial.print("\t\t");
|
||||
Serial.print(temperature, 1);
|
||||
Serial.print("\t\t");
|
||||
Serial.println(dht.toFahrenheit(temperature), 1);
|
||||
}
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
#######################################
|
||||
# Syntax Coloring Map For DHT
|
||||
#######################################
|
||||
|
||||
#######################################
|
||||
# Datatypes (KEYWORD1)
|
||||
#######################################
|
||||
|
||||
DHT KEYWORD1
|
||||
|
||||
#######################################
|
||||
# Methods and Functions (KEYWORD2)
|
||||
#######################################
|
||||
|
||||
setup KEYWORD2
|
||||
getTemperature KEYWORD2
|
||||
getHumidity KEYWORD2
|
||||
getStatus KEYWORD2
|
||||
getStatusString KEYWORD2
|
||||
getModel KEYWORD2
|
||||
getMinimumSamplingPeriod KEYWORD2
|
||||
toFahrenheit KEYWORD2
|
||||
toCelsius KEYWORD2
|
||||
|
||||
#######################################
|
||||
# Instances (KEYWORD2)
|
||||
#######################################
|
||||
|
||||
|
||||
#######################################
|
||||
# Constants (LITERAL1)
|
||||
#######################################
|
||||
|
||||
AUTO_DETECT LITERAL1
|
||||
DHT11 LITERAL1
|
||||
DHT22 LITERAL1
|
||||
AM2302 LITERAL1
|
||||
RHT03 LITERAL1
|
||||
|
||||
ERROR_NONE LITERAL1
|
||||
ERROR_TIMEOUT LITERAL1
|
||||
ERROR_CHECKSUM LITERAL1
|
||||
@@ -1,26 +0,0 @@
|
||||
Software License Agreement (BSD License)
|
||||
|
||||
Copyright (c) 2013, Mark Ruys. All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of the University of California, Berkeley nor the
|
||||
names of its contributors may be used to endorse or promote products
|
||||
derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
|
||||
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
Binary file not shown.
@@ -1,2 +0,0 @@
|
||||
*.zip
|
||||
*.7z
|
||||
@@ -1,335 +0,0 @@
|
||||
/*----------------------------------------------------------------------*
|
||||
* DS3232RTC.cpp - Arduino library for the Maxim Integrated DS3232 *
|
||||
* Real-Time Clock. This library is intended for use with the Arduino *
|
||||
* Time.h library, http://www.arduino.cc/playground/Code/Time *
|
||||
* *
|
||||
* This library is a drop-in replacement for the DS1307RTC.h library *
|
||||
* by Michael Margolis that is supplied with the Arduino Time library *
|
||||
* above. To change from using a DS1307 RTC to an DS3232 RTC, it is *
|
||||
* only necessary to change the #include statement to include this *
|
||||
* library instead of DS1307RTC.h. *
|
||||
* *
|
||||
* In addition, this library implements functions to support the *
|
||||
* additional features of the DS3232. *
|
||||
* *
|
||||
* This library will also work with the DS3231 RTC, which has the same *
|
||||
* features of the DS3232 except: (1) Battery-backed SRAM, (2) Battery- *
|
||||
* backed 32kHz output (BB32kHz bit in Control/Status register 0x0F), *
|
||||
* and (3) Adjustable temperature sensor sample rate (CRATE1:0 bits in *
|
||||
* the Control/Status register). *
|
||||
* *
|
||||
* Whether used with the DS3232 or DS3231, the user is responsible for *
|
||||
* ensuring reads and writes do not exceed the device's address space *
|
||||
* (0x00-0x12 for DS3231, 0x00-0xFF for DS3232); no bounds checking *
|
||||
* is done by this library. *
|
||||
* *
|
||||
* Jack Christensen 06Mar2013 *
|
||||
* 28Aug2013 Changed the lower level methods to return the status of *
|
||||
* the I2C communication with the RTC. Thanks to *
|
||||
* Rob Tillaart for the suggestion. (Fixes issue #1.) *
|
||||
* *
|
||||
* This work is licensed under the Creative Commons Attribution- *
|
||||
* ShareAlike 3.0 Unported License. To view a copy of this license, *
|
||||
* visit http://creativecommons.org/licenses/by-sa/3.0/ or send a *
|
||||
* letter to Creative Commons, 444 Castro Street, Suite 900, *
|
||||
* Mountain View, CA 94041. *
|
||||
*----------------------------------------------------------------------*/
|
||||
|
||||
#include <DS3232RTC.h>
|
||||
|
||||
//define release-independent I2C functions
|
||||
#if defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
|
||||
#include <TinyWireM.h>
|
||||
#define i2cBegin TinyWireM.begin
|
||||
#define i2cBeginTransmission TinyWireM.beginTransmission
|
||||
#define i2cEndTransmission TinyWireM.endTransmission
|
||||
#define i2cRequestFrom TinyWireM.requestFrom
|
||||
#define i2cRead TinyWireM.receive
|
||||
#define i2cWrite TinyWireM.send
|
||||
#elif ARDUINO >= 100
|
||||
#include <Wire.h>
|
||||
#define i2cBegin Wire.begin
|
||||
#define i2cBeginTransmission Wire.beginTransmission
|
||||
#define i2cEndTransmission Wire.endTransmission
|
||||
#define i2cRequestFrom Wire.requestFrom
|
||||
#define i2cRead Wire.read
|
||||
#define i2cWrite Wire.write
|
||||
#else
|
||||
#include <Wire.h>
|
||||
#define i2cBegin Wire.begin
|
||||
#define i2cBeginTransmission Wire.beginTransmission
|
||||
#define i2cEndTransmission Wire.endTransmission
|
||||
#define i2cRequestFrom Wire.requestFrom
|
||||
#define i2cRead Wire.receive
|
||||
#define i2cWrite Wire.send
|
||||
#endif
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Constructor. *
|
||||
*----------------------------------------------------------------------*/
|
||||
DS3232RTC::DS3232RTC()
|
||||
{
|
||||
i2cBegin();
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Read the current time from the RTC and return it as a time_t value. *
|
||||
* Returns a zero value if an I2C error occurred (e.g. RTC *
|
||||
* not present). *
|
||||
*----------------------------------------------------------------------*/
|
||||
time_t DS3232RTC::get()
|
||||
{
|
||||
tmElements_t tm;
|
||||
|
||||
if ( read(tm) ) return 0;
|
||||
return( makeTime(tm) );
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Set the RTC to the given time_t value. *
|
||||
* Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::set(time_t t)
|
||||
{
|
||||
tmElements_t tm;
|
||||
|
||||
breakTime(t, tm);
|
||||
return ( write(tm) );
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Read the current time from the RTC and return it in a tmElements_t *
|
||||
* structure. Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::read(tmElements_t &tm)
|
||||
{
|
||||
i2cBeginTransmission(RTC_ADDR);
|
||||
i2cWrite((uint8_t)RTC_SECONDS);
|
||||
if ( byte e = i2cEndTransmission() ) return e;
|
||||
//request 7 bytes (secs, min, hr, dow, date, mth, yr)
|
||||
i2cRequestFrom(RTC_ADDR, tmNbrFields);
|
||||
tm.Second = bcd2dec(i2cRead() & ~_BV(DS1307_CH));
|
||||
tm.Minute = bcd2dec(i2cRead());
|
||||
tm.Hour = bcd2dec(i2cRead() & ~_BV(HR1224)); //assumes 24hr clock
|
||||
tm.Wday = i2cRead();
|
||||
tm.Day = bcd2dec(i2cRead());
|
||||
tm.Month = bcd2dec(i2cRead() & ~_BV(CENTURY)); //don't use the Century bit
|
||||
tm.Year = y2kYearToTm(bcd2dec(i2cRead()));
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Set the RTC's time from a tmElements_t structure. *
|
||||
* Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::write(tmElements_t &tm)
|
||||
{
|
||||
i2cBeginTransmission(RTC_ADDR);
|
||||
i2cWrite((uint8_t)RTC_SECONDS);
|
||||
i2cWrite(dec2bcd(tm.Second));
|
||||
i2cWrite(dec2bcd(tm.Minute));
|
||||
i2cWrite(dec2bcd(tm.Hour)); //sets 24 hour format (Bit 6 == 0)
|
||||
i2cWrite(tm.Wday);
|
||||
i2cWrite(dec2bcd(tm.Day));
|
||||
i2cWrite(dec2bcd(tm.Month));
|
||||
i2cWrite(dec2bcd(tmYearToY2k(tm.Year)));
|
||||
return i2cEndTransmission();
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Write multiple bytes to RTC RAM. *
|
||||
* Valid address range is 0x00 - 0xFF, no checking. *
|
||||
* Number of bytes (nBytes) must be between 1 and 31 (Wire library *
|
||||
* limitation). *
|
||||
* Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::writeRTC(byte addr, byte *values, byte nBytes)
|
||||
{
|
||||
i2cBeginTransmission(RTC_ADDR);
|
||||
i2cWrite(addr);
|
||||
for (byte i=0; i<nBytes; i++) i2cWrite(values[i]);
|
||||
return i2cEndTransmission();
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Write a single byte to RTC RAM. *
|
||||
* Valid address range is 0x00 - 0xFF, no checking. *
|
||||
* Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::writeRTC(byte addr, byte value)
|
||||
{
|
||||
return ( writeRTC(addr, &value, 1) );
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Read multiple bytes from RTC RAM. *
|
||||
* Valid address range is 0x00 - 0xFF, no checking. *
|
||||
* Number of bytes (nBytes) must be between 1 and 32 (Wire library *
|
||||
* limitation). *
|
||||
* Returns the I2C status (zero if successful). *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::readRTC(byte addr, byte *values, byte nBytes)
|
||||
{
|
||||
i2cBeginTransmission(RTC_ADDR);
|
||||
i2cWrite(addr);
|
||||
if ( byte e = i2cEndTransmission() ) return e;
|
||||
i2cRequestFrom( (uint8_t)RTC_ADDR, nBytes );
|
||||
for (byte i=0; i<nBytes; i++) values[i] = i2cRead();
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Read a single byte from RTC RAM. *
|
||||
* Valid address range is 0x00 - 0xFF, no checking. *
|
||||
*----------------------------------------------------------------------*/
|
||||
byte DS3232RTC::readRTC(byte addr)
|
||||
{
|
||||
byte b;
|
||||
|
||||
readRTC(addr, &b, 1);
|
||||
return b;
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Set an alarm time. Sets the alarm registers only. To cause the *
|
||||
* INT pin to be asserted on alarm match, use alarmInterrupt(). *
|
||||
* This method can set either Alarm 1 or Alarm 2, depending on the *
|
||||
* value of alarmType (use a value from the ALARM_TYPES_t enumeration). *
|
||||
* When setting Alarm 2, the seconds value must be supplied but is *
|
||||
* ignored, recommend using zero. (Alarm 2 has no seconds register.) *
|
||||
*----------------------------------------------------------------------*/
|
||||
void DS3232RTC::setAlarm(ALARM_TYPES_t alarmType, byte seconds, byte minutes, byte hours, byte daydate)
|
||||
{
|
||||
uint8_t addr;
|
||||
|
||||
seconds = dec2bcd(seconds);
|
||||
minutes = dec2bcd(minutes);
|
||||
hours = dec2bcd(hours);
|
||||
daydate = dec2bcd(daydate);
|
||||
if (alarmType & 0x01) seconds |= _BV(A1M1);
|
||||
if (alarmType & 0x02) minutes |= _BV(A1M2);
|
||||
if (alarmType & 0x04) hours |= _BV(A1M3);
|
||||
if (alarmType & 0x10) hours |= _BV(DYDT);
|
||||
if (alarmType & 0x08) daydate |= _BV(A1M4);
|
||||
|
||||
if ( !(alarmType & 0x80) ) { //alarm 1
|
||||
addr = ALM1_SECONDS;
|
||||
writeRTC(addr++, seconds);
|
||||
}
|
||||
else {
|
||||
addr = ALM2_MINUTES;
|
||||
}
|
||||
writeRTC(addr++, minutes);
|
||||
writeRTC(addr++, hours);
|
||||
writeRTC(addr++, daydate);
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Set an alarm time. Sets the alarm registers only. To cause the *
|
||||
* INT pin to be asserted on alarm match, use alarmInterrupt(). *
|
||||
* This method can set either Alarm 1 or Alarm 2, depending on the *
|
||||
* value of alarmType (use a value from the ALARM_TYPES_t enumeration). *
|
||||
* However, when using this method to set Alarm 1, the seconds value *
|
||||
* is set to zero. (Alarm 2 has no seconds register.) *
|
||||
*----------------------------------------------------------------------*/
|
||||
void DS3232RTC::setAlarm(ALARM_TYPES_t alarmType, byte minutes, byte hours, byte daydate)
|
||||
{
|
||||
setAlarm(alarmType, 0, minutes, hours, daydate);
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Enable or disable an alarm "interrupt" which asserts the INT pin *
|
||||
* on the RTC. *
|
||||
*----------------------------------------------------------------------*/
|
||||
void DS3232RTC::alarmInterrupt(byte alarmNumber, boolean interruptEnabled)
|
||||
{
|
||||
uint8_t controlReg, mask;
|
||||
|
||||
controlReg = readRTC(RTC_CONTROL);
|
||||
mask = _BV(A1IE) << (alarmNumber - 1);
|
||||
if (interruptEnabled)
|
||||
controlReg |= mask;
|
||||
else
|
||||
controlReg &= ~mask;
|
||||
writeRTC(RTC_CONTROL, controlReg);
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Returns true or false depending on whether the given alarm has been *
|
||||
* triggered, and resets the alarm flag bit. *
|
||||
*----------------------------------------------------------------------*/
|
||||
boolean DS3232RTC::alarm(byte alarmNumber)
|
||||
{
|
||||
uint8_t statusReg, mask;
|
||||
|
||||
statusReg = readRTC(RTC_STATUS);
|
||||
mask = _BV(A1F) << (alarmNumber - 1);
|
||||
if (statusReg & mask) {
|
||||
statusReg &= ~mask;
|
||||
writeRTC(RTC_STATUS, statusReg);
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Enable or disable the square wave output. *
|
||||
* Use a value from the SQWAVE_FREQS_t enumeration for the parameter. *
|
||||
*----------------------------------------------------------------------*/
|
||||
void DS3232RTC::squareWave(SQWAVE_FREQS_t freq)
|
||||
{
|
||||
uint8_t controlReg;
|
||||
|
||||
controlReg = readRTC(RTC_CONTROL);
|
||||
if (freq >= SQWAVE_NONE) {
|
||||
controlReg |= _BV(INTCN);
|
||||
}
|
||||
else {
|
||||
controlReg = (controlReg & 0xE3) | (freq << RS1);
|
||||
}
|
||||
writeRTC(RTC_CONTROL, controlReg);
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Checks the OSF bit in the status register which indicates that the *
|
||||
* oscillator is or was stopped. *
|
||||
*----------------------------------------------------------------------*/
|
||||
boolean DS3232RTC::oscStopped(void)
|
||||
{
|
||||
return ( readRTC(RTC_STATUS) & _BV(OSF) );
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Returns the temperature in Celsius times four. *
|
||||
*----------------------------------------------------------------------*/
|
||||
int DS3232RTC::temperature(void)
|
||||
{
|
||||
union int16_byte {
|
||||
int i;
|
||||
byte b[2];
|
||||
} rtcTemp;
|
||||
|
||||
rtcTemp.b[0] = readRTC(TEMP_LSB);
|
||||
rtcTemp.b[1] = readRTC(TEMP_MSB);
|
||||
return rtcTemp.i >> 6;
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* Decimal-to-BCD conversion *
|
||||
*----------------------------------------------------------------------*/
|
||||
uint8_t DS3232RTC::dec2bcd(uint8_t n)
|
||||
{
|
||||
return n + 6 * (n / 10);
|
||||
}
|
||||
|
||||
/*----------------------------------------------------------------------*
|
||||
* BCD-to-Decimal conversion *
|
||||
*----------------------------------------------------------------------*/
|
||||
uint8_t __attribute__ ((noinline)) DS3232RTC::bcd2dec(uint8_t n)
|
||||
{
|
||||
return n - 6 * (n >> 4);
|
||||
}
|
||||
|
||||
DS3232RTC RTC = DS3232RTC(); //instantiate an RTC object
|
||||
@@ -1,157 +0,0 @@
|
||||
/*----------------------------------------------------------------------*
|
||||
* DS3232RTC.h - Arduino library for the Maxim Integrated DS3232 *
|
||||
* Real-Time Clock. This library is intended for use with the Arduino *
|
||||
* Time.h library, http://www.arduino.cc/playground/Code/Time *
|
||||
* *
|
||||
* This library is a drop-in replacement for the DS1307RTC.h library *
|
||||
* by Michael Margolis that is supplied with the Arduino Time library *
|
||||
* above. To change from using a DS1307 RTC to an DS3232 RTC, it is *
|
||||
* only necessary to change the #include statement to include this *
|
||||
* library instead of DS1307RTC.h. *
|
||||
* *
|
||||
* In addition, this library implements functions to support the *
|
||||
* additional features of the DS3232. *
|
||||
* *
|
||||
* This library will also work with the DS3231 RTC, which has the same *
|
||||
* features of the DS3232 except: (1) Battery-backed SRAM, (2) Battery- *
|
||||
* backed 32kHz output (BB32kHz bit in Control/Status register 0x0F), *
|
||||
* and (3) Adjustable temperature sensor sample rate (CRATE1:0 bits in *
|
||||
* the Control/Status register). *
|
||||
* *
|
||||
* Whether used with the DS3232 or DS3231, the user is responsible for *
|
||||
* ensuring reads and writes do not exceed the device's address space *
|
||||
* (0x00-0x12 for DS3231, 0x00-0xFF for DS3232); no bounds checking *
|
||||
* is done by this library. *
|
||||
* *
|
||||
* Jack Christensen 06Mar2013 *
|
||||
* 28Aug2013 Changed the lower level methods to return the status of *
|
||||
* the I2C communication with the RTC. Thanks to *
|
||||
* Rob Tillaart for the suggestion. (Fixes issue #1.) *
|
||||
* *
|
||||
* This work is licensed under the Creative Commons Attribution- *
|
||||
* ShareAlike 3.0 Unported License. To view a copy of this license, *
|
||||
* visit http://creativecommons.org/licenses/by-sa/3.0/ or send a *
|
||||
* letter to Creative Commons, 444 Castro Street, Suite 900, *
|
||||
* Mountain View, CA 94041. *
|
||||
*----------------------------------------------------------------------*/
|
||||
|
||||
#ifndef DS3232RTC_h
|
||||
#define DS3232RTC_h
|
||||
#include <Time.h>
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#include <Arduino.h>
|
||||
#else
|
||||
#include <WProgram.h>
|
||||
#endif
|
||||
|
||||
//DS3232 I2C Address
|
||||
#define RTC_ADDR 0x68
|
||||
|
||||
//DS3232 Register Addresses
|
||||
#define RTC_SECONDS 0x00
|
||||
#define RTC_MINUTES 0x01
|
||||
#define RTC_HOURS 0x02
|
||||
#define RTC_DAY 0x03
|
||||
#define RTC_DATE 0x04
|
||||
#define RTC_MONTH 0x05
|
||||
#define RTC_YEAR 0x06
|
||||
#define ALM1_SECONDS 0x07
|
||||
#define ALM1_MINUTES 0x08
|
||||
#define ALM1_HOURS 0x09
|
||||
#define ALM1_DAYDATE 0x0A
|
||||
#define ALM2_MINUTES 0x0B
|
||||
#define ALM2_HOURS 0x0C
|
||||
#define ALM2_DAYDATE 0x0D
|
||||
#define RTC_CONTROL 0x0E
|
||||
#define RTC_STATUS 0x0F
|
||||
#define RTC_AGING 0x10
|
||||
#define TEMP_MSB 0x11
|
||||
#define TEMP_LSB 0x12
|
||||
#define SRAM_START_ADDR 0x14 //first SRAM address
|
||||
#define SRAM_SIZE 236 //number of bytes of SRAM
|
||||
|
||||
//Alarm mask bits
|
||||
#define A1M1 7
|
||||
#define A1M2 7
|
||||
#define A1M3 7
|
||||
#define A1M4 7
|
||||
#define A2M2 7
|
||||
#define A2M3 7
|
||||
#define A2M4 7
|
||||
|
||||
//Control register bits
|
||||
#define EOSC 7
|
||||
#define BBSQW 6
|
||||
#define CONV 5
|
||||
#define RS2 4
|
||||
#define RS1 3
|
||||
#define INTCN 2
|
||||
#define A2IE 1
|
||||
#define A1IE 0
|
||||
|
||||
//Status register bits
|
||||
#define OSF 7
|
||||
#define BB32KHZ 6
|
||||
#define CRATE1 5
|
||||
#define CRATE0 4
|
||||
#define EN32KHZ 3
|
||||
#define BSY 2
|
||||
#define A2F 1
|
||||
#define A1F 0
|
||||
|
||||
//Square-wave output frequency (TS2, RS1 bits)
|
||||
enum SQWAVE_FREQS_t {SQWAVE_1_HZ, SQWAVE_1024_HZ, SQWAVE_4096_HZ, SQWAVE_8192_HZ, SQWAVE_NONE};
|
||||
|
||||
//Alarm masks
|
||||
enum ALARM_TYPES_t {
|
||||
ALM1_EVERY_SECOND = 0x0F,
|
||||
ALM1_MATCH_SECONDS = 0x0E,
|
||||
ALM1_MATCH_MINUTES = 0x0C, //match minutes *and* seconds
|
||||
ALM1_MATCH_HOURS = 0x08, //match hours *and* minutes, seconds
|
||||
ALM1_MATCH_DATE = 0x00, //match date *and* hours, minutes, seconds
|
||||
ALM1_MATCH_DAY = 0x10, //match day *and* hours, minutes, seconds
|
||||
ALM2_EVERY_MINUTE = 0x8E,
|
||||
ALM2_MATCH_MINUTES = 0x8C, //match minutes
|
||||
ALM2_MATCH_HOURS = 0x88, //match hours *and* minutes
|
||||
ALM2_MATCH_DATE = 0x80, //match date *and* hours, minutes
|
||||
ALM2_MATCH_DAY = 0x90, //match day *and* hours, minutes
|
||||
};
|
||||
|
||||
#define ALARM_1 1 //constants for calling functions
|
||||
#define ALARM_2 2
|
||||
|
||||
//Other
|
||||
#define DS1307_CH 7 //for DS1307 compatibility, Clock Halt bit in Seconds register
|
||||
#define HR1224 6 //Hours register 12 or 24 hour mode (24 hour mode==0)
|
||||
#define CENTURY 7 //Century bit in Month register
|
||||
#define DYDT 6 //Day/Date flag bit in alarm Day/Date registers
|
||||
|
||||
class DS3232RTC
|
||||
{
|
||||
public:
|
||||
DS3232RTC();
|
||||
static time_t get(void);
|
||||
static byte set(time_t t);
|
||||
static byte read(tmElements_t &tm);
|
||||
static byte write(tmElements_t &tm);
|
||||
byte writeRTC(byte addr, byte *values, byte nBytes);
|
||||
byte writeRTC(byte addr, byte value);
|
||||
byte readRTC(byte addr, byte *values, byte nBytes);
|
||||
byte readRTC(byte addr);
|
||||
void setAlarm(ALARM_TYPES_t alarmType, byte seconds, byte minutes, byte hours, byte daydate);
|
||||
void setAlarm(ALARM_TYPES_t alarmType, byte minutes, byte hours, byte daydate);
|
||||
void alarmInterrupt(byte alarmNumber, boolean alarmEnabled);
|
||||
boolean alarm(byte alarmNumber);
|
||||
void squareWave(SQWAVE_FREQS_t freq);
|
||||
boolean oscStopped(void);
|
||||
int temperature(void);
|
||||
|
||||
private:
|
||||
static uint8_t dec2bcd(uint8_t n);
|
||||
static uint8_t bcd2dec(uint8_t n);
|
||||
};
|
||||
|
||||
extern DS3232RTC RTC;
|
||||
|
||||
#endif
|
||||
@@ -1,8 +0,0 @@
|
||||
# Arduino DS3232RTC Library v1.0 #
|
||||
https://github.com/JChristensen/DS3232RTC
|
||||
LICENSE file
|
||||
Jack Christensen Mar 2013
|
||||
|
||||

|
||||
## CC BY-SA ##
|
||||
"Arduino DS3232RTC Library" by Jack Christensen is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
|
||||
@@ -1,345 +0,0 @@
|
||||
# Arduino DS3232RTC Library v1.0 #
|
||||
https://github.com/JChristensen/DS3232RTC
|
||||
ReadMe file
|
||||
Jack Christensen Mar 2013
|
||||
|
||||

|
||||
|
||||
## Introduction ##
|
||||
**DS3232RTC** is an Arduino library that supports the Maxim Integrated DS3232 and DS3231 Real-Time Clocks. This library is intended to be used with the [Arduino Time library](http://www.arduino.cc/playground/Code/Time).
|
||||
|
||||
The **DS3232RTC** library is a drop-in replacement for the DS1307RTC.h library by Michael Margolis that is supplied with the Arduino Time library above. To change from using a DS1307 RTC to an DS323x RTC, it is only necessary to use `#include <DS3232RTC.h>` instead of `#include <DS1307RTC.h>`.
|
||||
|
||||
**DS3232RTC** also implements functions to support the additional features of the DS3232 and DS3231. The DS3231 has the same features as the DS3232 except: (1) Battery-backed SRAM, (2) Battery-backed 32kHz output (BB32kHz bit in Control/Status register 0x0F), and (3) Adjustable temperature sensor sample rate (CRATE1:0 bits in the Control/Status register).
|
||||
|
||||
"Arduino DS3232RTC Library" by Jack Christensen is licensed under CC BY-SA 4.0.
|
||||
|
||||
## Installation ##
|
||||
To use the **DS3232RTC** library:
|
||||
- Go to https://github.com/JChristensen/DS3232RTC, click the **Download ZIP** button and save the ZIP file to a convenient location on your PC.
|
||||
- Uncompress the downloaded file. This will result in a folder containing all the files for the library, that has a name that includes the branch name, usually **DS3232RTC-master**.
|
||||
- Rename the folder to just **DS3232RTC**.
|
||||
- Copy the renamed folder to the Arduino sketchbook\libraries folder.
|
||||
|
||||
## Examples ##
|
||||
The following example sketches are included with the **DS3232RTC** library:
|
||||
- **SetSerial:** Set the RTC's date and time from the Arduino serial monitor. Displays date, time and temperature.
|
||||
- **TimeRTC:** Same as the example of the same name provided with the **Time** library, demonstrating the interchangeability of the **DS3232RTC** library with the **DS1307RTC** library.
|
||||
- **tiny3232_KnockBang:** Demonstrates interfacing an ATtiny45/85 to a DS3231 or DS3232 RTC.
|
||||
|
||||
## Usage notes ##
|
||||
|
||||
When using the **DS3232RTC** library, the user is responsible for ensuring that reads and writes do not exceed the device's address space (0x00-0x12 for DS3231, 0x00-0xFF for DS3232); no bounds checking is done by the library.
|
||||
|
||||
Similar to the **DS1307RTC** library, the **DS3232RTC** library instantiates an RTC object; the user does not need to do this.
|
||||
|
||||
To use the **DS3232RTC** library, the Time and Wire libraries must also be included. For brevity, these includes are not repeated in the examples below:
|
||||
```c++
|
||||
#include <DS3232RTC.h> //http://github.com/JChristensen/DS3232RTC
|
||||
#include <Time.h> //http://www.arduino.cc/playground/Code/Time
|
||||
#include <Wire.h> //http://arduino.cc/en/Reference/Wire (included with Arduino IDE)
|
||||
```
|
||||
|
||||
## Enumerations ##
|
||||
### SQWAVE_FREQS_t
|
||||
##### Description
|
||||
Symbolic names used with the squareWave() method (described below).
|
||||
##### Values
|
||||
- SQWAVE_NONE
|
||||
- SQWAVE_1_HZ
|
||||
- SQWAVE_1024_HZ
|
||||
- SQWAVE_4096_HZ
|
||||
- SQWAVE_8192_HZ
|
||||
|
||||
### ALARM_TYPES_t
|
||||
##### Description
|
||||
Symbolic names used with the setAlarm() method (described below).
|
||||
##### Values for Alarm 1
|
||||
- ALM1_EVERY_SECOND -- causes an alarm once per second.
|
||||
- ALM1_MATCH_SECONDS -- causes an alarm when the seconds match (i.e. once per minute).
|
||||
- ALM1_MATCH_MINUTES -- causes an alarm when the minutes *and* seconds match.
|
||||
- ALM1_MATCH_HOURS -- causes an alarm when the hours *and* minutes *and* seconds match.
|
||||
- ALM1_MATCH_DATE -- causes an alarm when the date of the month *and* hours *and* minutes *and* seconds match.
|
||||
- ALM1_MATCH_DAY -- causes an alarm when the day of the week *and* hours *and* minutes *and* seconds match.
|
||||
|
||||
##### Values for Alarm 2
|
||||
- ALM2_EVERY_MINUTE -- causes an alarm once per minute.
|
||||
- ALM2_MATCH_MINUTES -- causes an alarm when the minutes match (i.e. once per hour).
|
||||
- ALM2_MATCH_HOURS -- causes an alarm when the hours *and* minutes match.
|
||||
- ALM2_MATCH_DATE -- causes an alarm when the date of the month *and* hours *and* minutes match.
|
||||
- ALM2_MATCH_DAY -- causes an alarm when the day of the week *and* hours *and* minutes match.
|
||||
|
||||
|
||||
## Methods for setting and reading the time ##
|
||||
|
||||
###get(void)
|
||||
#####Description
|
||||
Reads the current date and time from the RTC and returns it as a *time_t* value. Returns zero if an I2C error occurs (RTC not present, etc.).
|
||||
#####Syntax
|
||||
`RTC.get();`
|
||||
#####Parameters
|
||||
None.
|
||||
#####Returns
|
||||
Current date and time *(time_t)*
|
||||
#####Example
|
||||
```c++
|
||||
time_t myTime;
|
||||
myTime = RTC.get();
|
||||
```
|
||||
|
||||
###set(time_t t)
|
||||
#####Description
|
||||
Sets the RTC date and time to the given *time_t* value.
|
||||
#####Syntax
|
||||
`RTC.set(t);`
|
||||
#####Parameters
|
||||
**t:** The date and time to set the RTC to *(time_t)*
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful.
|
||||
#####Example
|
||||
```c++
|
||||
//this example first sets the system time (maintained by the Time library) to
|
||||
//a hard-coded date and time, and then sets the RTC from the system time.
|
||||
//the setTime() function is part of the Time library.
|
||||
setTime(23, 31, 30, 13, 2, 2009); //set the system time to 23h31m30s on 13Feb2009
|
||||
RTC.set(now()); //set the RTC from the system time
|
||||
```
|
||||
|
||||
###read(tmElements_t &tm)
|
||||
#####Description
|
||||
Reads the current date and time from the RTC and returns it as a *tmElements_t* structure. See the [Arduino Time library](http://www.arduino.cc/playground/Code/Time) for details on the *tmElements_t* structure.
|
||||
#####Syntax
|
||||
`RTC.read(tm);`
|
||||
#####Parameters
|
||||
**tm:** Address of a *tmElements_t* structure to which the date and time are returned.
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful. The date and time read from the RTC are returned to the **tm** parameter.
|
||||
#####Example
|
||||
```c++
|
||||
tmElements_t tm;
|
||||
RTC.read(tm);
|
||||
Serial.print(tm.Hour, DEC);
|
||||
Serial.print(':');
|
||||
Serial.print(tm.Minute,DEC);
|
||||
Serial.print(':');
|
||||
Serial.println(tm.Second,DEC);
|
||||
```
|
||||
|
||||
###write(tmElements_t &tm)
|
||||
#####Description
|
||||
Sets the RTC to the date and time given by a *tmElements_t* structure.
|
||||
#####Syntax
|
||||
`RTC.write(tm);`
|
||||
#####Parameters
|
||||
**tm:** Address of a *tmElements_t* structure used to set the date and time.
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful.
|
||||
#####Example
|
||||
```c++
|
||||
tmElements_t tm;
|
||||
tm.Hour = 23; //set the tm structure to 23h31m30s on 13Feb2009
|
||||
tm.Minute = 31;
|
||||
tm.Minute = 30;
|
||||
tm.Day = 13;
|
||||
tm.Month = 2;
|
||||
tm.Year = 2009 - 1970; //tmElements_t.Year is the offset from 1970
|
||||
RTC.write(tm); //set the RTC from the tm structure
|
||||
```
|
||||
|
||||
## Methods for reading and writing RTC registers or static RAM (SRAM) for the DS3232 ##
|
||||
The DS3232RTC.h file defines symbolic names for the timekeeping, alarm, status and control registers. These can be used for the addr argument in the functions below.
|
||||
|
||||
###writeRTC(byte addr, byte *values, byte nBytes)
|
||||
#####Description
|
||||
Write one or more bytes to RTC memory.
|
||||
#####Syntax
|
||||
`RTC.writeRTC(addr, values, nbytes);`
|
||||
#####Parameters
|
||||
**addr:** First SRAM address to write *(byte)*. The valid address range is 0x00-0x12 for DS3231, 0x00-0xFF for DS3232. The general-purpose SRAM for the DS3232 begins at address 0x14. Address is not checked for validity by the library.
|
||||
**values:** An array of values to write _(*byte)_
|
||||
**nBytes:** Number of bytes to write *(byte)*. Must be between 1 and 31 (Wire library limitation) but is not checked by the library.
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful.
|
||||
#####Example
|
||||
```c++
|
||||
//write 1, 2, ..., 8 to the first eight DS3232 SRAM locations
|
||||
byte buf[8] = {1, 2, 3, 4, 5, 6, 7, 8};
|
||||
RTC.sramWrite(0x14, buf, 8);
|
||||
```
|
||||
|
||||
###writeRTC(byte addr, byte value)
|
||||
#####Description
|
||||
Write a single byte to RTC memory.
|
||||
#####Syntax
|
||||
`RTC.writeRTC(addr, value);`
|
||||
#####Parameters
|
||||
**addr:** SRAM address to write *(byte)*. The valid address range is 0x00-0x12 for DS3231, 0x00-0xFF for DS3232. The general-purpose SRAM for the DS3232 begins at address 0x14. Address is not checked for validity by the library.
|
||||
**value:** Value to write _(byte)_
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful.
|
||||
#####Example
|
||||
```c++
|
||||
RTC.writeRTC(3, 14); //write the value 14 to SRAM address 3
|
||||
```
|
||||
|
||||
###readRTC(byte addr, byte *values, byte nBytes)
|
||||
#####Description
|
||||
Read one or more bytes from RTC RAM.
|
||||
#####Syntax
|
||||
`RTC.readRTC(addr, values, nbytes);`
|
||||
#####Parameters
|
||||
**addr:** First SRAM address to read *(byte)*. The valid address range is 0x00-0x12 for DS3231, 0x00-0xFF for DS3232. The general-purpose SRAM for the DS3232 begins at address 0x14. Address is not checked for validity by the library.
|
||||
**values:** An array to receive the values read _(*byte)_
|
||||
**nBytes:** Number of bytes to read *(byte)*. Must be between 1 and 32 (Wire library limitation) but is not checked by the library.
|
||||
#####Returns
|
||||
I2C status *(byte)*. Returns zero if successful.
|
||||
#####Example
|
||||
```c++
|
||||
//read the last eight locations of SRAM into buf
|
||||
byte buf[8];
|
||||
RTC.sramRead(248, buf, 8);
|
||||
```
|
||||
|
||||
###readRTC(byte addr)
|
||||
#####Description
|
||||
Reads a single byte from RTC RAM.
|
||||
#####Syntax
|
||||
`RTC.readRTC(addr);`
|
||||
#####Parameters
|
||||
**addr:** SRAM address to read *(byte)*. The valid address range is 0x00-0x12 for DS3231, 0x00-0xFF for DS3232. The general-purpose SRAM for the DS3232 begins at address 0x14. Address is not checked for validity by the library.
|
||||
#####Returns
|
||||
Value read from the RTC *(byte)*
|
||||
#####Example
|
||||
```c++
|
||||
byte val;
|
||||
val = RTC.readRTC(3); //read the value from SRAM location 3
|
||||
```
|
||||
|
||||
## Alarm methods ##
|
||||
The DS3232 and DS3231 have two alarms. Alarm1 can be set to seconds precision; Alarm2 can only be set to minutes precision.
|
||||
|
||||
###setAlarm(ALARM_TYPES_t alarmType, byte seconds, byte minutes, byte hours, byte daydate)
|
||||
#####Description
|
||||
Set an alarm time. Sets the alarm registers only. To cause the INT pin to be asserted on alarm match, use alarmInterrupt(). This method can set either Alarm 1 or Alarm 2, depending on the value of alarmType (use the ALARM_TYPES_t enumeration above). When setting Alarm 2, the seconds value must be supplied but is ignored, recommend using zero. (Alarm 2 has no seconds register.)
|
||||
|
||||
#####Syntax
|
||||
`RTC.setAlarm(alarmType, seconds, minutes, hours, dayOrDate);`
|
||||
#####Parameters
|
||||
**alarmType:** A value from the ALARM_TYPES_t enumeration, above. *(ALARM_TYPES_t)*
|
||||
**seconds:** The seconds value to set the alarm to. *(byte)*
|
||||
**minutes:** The minutes value to set the alarm to. *(byte)*
|
||||
**hours:** The hours value to set the alarm to. *(byte)*
|
||||
**dayOrDate:** The day of the week or the date of the month. For day of the week, use a value from the Time library timeDayOfWeek_t enumeration, i.e. dowSunday, dowMonday, dowTuesday, dowWednesday, dowThursday, dowFriday, dowSaturday. *(byte)*
|
||||
#####Returns
|
||||
None.
|
||||
#####Example
|
||||
```c++
|
||||
//Set Alarm1 for 12:34:56 on Sunday
|
||||
RTC.setAlarm(ALM1_MATCH_DAY, 56, 34, 12, dowSunday);
|
||||
```
|
||||
|
||||
###setAlarm(ALARM_TYPES_t alarmType, byte minutes, byte hours, byte daydate)
|
||||
#####Description
|
||||
Set an alarm time. Sets the alarm registers only. To cause the INT pin to be asserted on alarm match, use alarmInterrupt(). This method can set either Alarm 1 or Alarm 2, depending on the value of alarmType (use the ALARM_TYPES_t enumeration above). However, when using this method to set Alarm 1, the seconds value is set to zero. (Alarm 2 has no seconds register.)
|
||||
|
||||
#####Syntax
|
||||
`RTC.setAlarm(alarmType, minutes, hours, dayOrDate);`
|
||||
#####Parameters
|
||||
**alarmType:** A value from the ALARM_TYPES_t enumeration, above. *(ALARM_TYPES_t)*
|
||||
**minutes:** The minutes value to set the alarm to. *(byte)*
|
||||
**hours:** The hours value to set the alarm to. *(byte)*
|
||||
**dayOrDate:** The day of the week or the date of the month. For day of the week, use a value from the Time library timeDayOfWeek_t enumeration, i.e. dowSunday, dowMonday, dowTuesday, dowWednesday, dowThursday, dowFriday, dowSaturday. *(byte)*
|
||||
#####Returns
|
||||
None.
|
||||
#####Example
|
||||
```c++
|
||||
//Set Alarm2 for 12:34 on the 4th day of the month
|
||||
RTC.setAlarm(ALM1_MATCH_DATE, 34, 12, 4);
|
||||
```
|
||||
|
||||
###alarmInterrupt(byte alarmNumber, boolean alarmEnabled)
|
||||
#####Description
|
||||
Enable or disable an alarm "interrupt". Note that this "interrupt" causes the RTC's INT pin to be asserted. To use this signal as an actual interrupt to a microcontroller, it will need to be connected properly and programmed in the application firmware.
|
||||
on the RTC.
|
||||
#####Syntax
|
||||
`RTC.alarmInterrupt(alarmNumber, enable);`
|
||||
#####Parameters
|
||||
**alarmNumber:** The number of the alarm to enable or disable, ALARM_1 or ALARM_2 *(byte)*
|
||||
**alarmEnabled:** true or false *(boolean)*
|
||||
#####Returns
|
||||
None.
|
||||
#####Example
|
||||
```c++
|
||||
RTC.alarmInterrupt(ALARM_1, true); //assert the INT pin when Alarm1 occurs.
|
||||
RTC.alarmInterrupt(ALARM_2, false); //disable Alarm2
|
||||
```
|
||||
|
||||
###alarm(byte alarmNumber)
|
||||
#####Description
|
||||
Tests whether an alarm has been triggered. If the alarm was triggered, returns true and resets the alarm flag in the RTC, else returns false.
|
||||
#####Syntax
|
||||
`RTC.alarm(alarmNumber);`
|
||||
#####Parameters
|
||||
**alarmNumber:** The number of the alarm to test, ALARM_1 or ALARM_2 *(byte)*
|
||||
#####Returns
|
||||
Description *(type)*
|
||||
#####Example
|
||||
```c++
|
||||
if ( RTC.alarm(ALARM_1) ) { //has Alarm1 triggered?
|
||||
//yes, act on the alarm
|
||||
}
|
||||
else {
|
||||
//no alarm
|
||||
}
|
||||
```
|
||||
|
||||
## Other methods ##
|
||||
###temperature(void)
|
||||
#####Description
|
||||
Returns the RTC temperature.
|
||||
#####Syntax
|
||||
`RTC.temperature();`
|
||||
#####Parameters
|
||||
None.
|
||||
#####Returns
|
||||
RTC temperature as degrees Celsius times four. *(int)*
|
||||
#####Example
|
||||
```c++
|
||||
int t = RTC.temperature();
|
||||
float celsius = t / 4.0;
|
||||
float fahrenheit = celsius * 9.0 / 5.0 + 32.0;
|
||||
```
|
||||
|
||||
###squareWave(SQWAVE_FREQS_t freq)
|
||||
#####Description
|
||||
Enables or disables the square wave output.
|
||||
#####Syntax
|
||||
`RTC.squareWave(freq);`
|
||||
#####Parameters
|
||||
**freq:** a value from the SQWAVE_FREQS_t enumeration above. *(SQWAVE_FREQS_t)*
|
||||
#####Returns
|
||||
None.
|
||||
#####Example
|
||||
```c++
|
||||
RTC.squareWave(SQWAVE_1_HZ); //1 Hz square wave
|
||||
RTC.squareWave(SQWAVE_NONE); //no square wave
|
||||
```
|
||||
|
||||
###oscStopped(void)
|
||||
#####Description
|
||||
Check whether the RTC oscillator is or was stopped. This may indicate that the RTC's time is not accurate.
|
||||
#####Syntax
|
||||
`RTC.oscStopped();`
|
||||
#####Parameters
|
||||
None.
|
||||
#####Returns
|
||||
True or false *(boolean)*
|
||||
#####Example
|
||||
```c++
|
||||
if ( RTC.oscStopped() ) { //check the oscillator
|
||||
//may be trouble
|
||||
}
|
||||
else {
|
||||
//all is well
|
||||
}
|
||||
```
|
||||
@@ -1,132 +0,0 @@
|
||||
/*----------------------------------------------------------------------*
|
||||
* Display the date and time from a DS3231 or DS3232 RTC every second. *
|
||||
* Display the temperature once per minute. (The DS3231 does a *
|
||||
* temperature conversion once every 64 seconds. This is also the *
|
||||
* default for the DS3232.) *
|
||||
* *
|
||||
* Set the date and time by entering the following on the Arduino *
|
||||
* serial monitor: *
|
||||
* year,month,day,hour,minute,second, *
|
||||
* *
|
||||
* Where *
|
||||
* year can be two or four digits, *
|
||||
* month is 1-12, *
|
||||
* day is 1-31, *
|
||||
* hour is 0-23, and *
|
||||
* minute and second are 0-59. *
|
||||
* *
|
||||
* Entering the final comma delimiter (after "second") will avoid a *
|
||||
* one-second timeout and will allow the RTC to be set more accurately. *
|
||||
* *
|
||||
* No validity checking is done, invalid values or incomplete syntax *
|
||||
* in the input will result in an incorrect RTC setting. *
|
||||
* *
|
||||
* Jack Christensen 08Aug2013 *
|
||||
* *
|
||||
* Tested with Arduino 1.0.5, Arduino Uno, DS3231/Chronodot, DS3232. *
|
||||
* *
|
||||
* This work is licensed under the Creative Commons Attribution- *
|
||||
* ShareAlike 3.0 Unported License. To view a copy of this license, *
|
||||
* visit http://creativecommons.org/licenses/by-sa/3.0/ or send a *
|
||||
* letter to Creative Commons, 171 Second Street, Suite 300, *
|
||||
* San Francisco, California, 94105, USA. *
|
||||
*----------------------------------------------------------------------*/
|
||||
|
||||
#include <DS3232RTC.h> //http://github.com/JChristensen/DS3232RTC
|
||||
#include <Streaming.h> //http://arduiniana.org/libraries/streaming/
|
||||
#include <Time.h> //http://playground.arduino.cc/Code/Time
|
||||
#include <Wire.h> //http://arduino.cc/en/Reference/Wire
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
Serial.begin(115200);
|
||||
|
||||
//setSyncProvider() causes the Time library to synchronize with the
|
||||
//external RTC by calling RTC.get() every five minutes by default.
|
||||
setSyncProvider(RTC.get);
|
||||
Serial << F("RTC Sync");
|
||||
if (timeStatus() != timeSet) Serial << F(" FAIL!");
|
||||
Serial << endl;
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
static time_t tLast;
|
||||
time_t t;
|
||||
tmElements_t tm;
|
||||
|
||||
//check for input to set the RTC, minimum length is 12, i.e. yy,m,d,h,m,s
|
||||
if (Serial.available() >= 12) {
|
||||
//note that the tmElements_t Year member is an offset from 1970,
|
||||
//but the RTC wants the last two digits of the calendar year.
|
||||
//use the convenience macros from Time.h to do the conversions.
|
||||
int y = Serial.parseInt();
|
||||
if (y >= 100 && y < 1000)
|
||||
Serial << F("Error: Year must be two digits or four digits!") << endl;
|
||||
else {
|
||||
if (y >= 1000)
|
||||
tm.Year = CalendarYrToTm(y);
|
||||
else //(y < 100)
|
||||
tm.Year = y2kYearToTm(y);
|
||||
tm.Month = Serial.parseInt();
|
||||
tm.Day = Serial.parseInt();
|
||||
tm.Hour = Serial.parseInt();
|
||||
tm.Minute = Serial.parseInt();
|
||||
tm.Second = Serial.parseInt();
|
||||
t = makeTime(tm);
|
||||
RTC.set(t); //use the time_t value to ensure correct weekday is set
|
||||
setTime(t);
|
||||
Serial << F("RTC set to: ");
|
||||
printDateTime(t);
|
||||
Serial << endl;
|
||||
//dump any extraneous input
|
||||
while (Serial.available() > 0) Serial.read();
|
||||
}
|
||||
}
|
||||
|
||||
t = now();
|
||||
if (t != tLast) {
|
||||
tLast = t;
|
||||
printDateTime(t);
|
||||
if (second(t) == 0) {
|
||||
float c = RTC.temperature() / 4.;
|
||||
float f = c * 9. / 5. + 32.;
|
||||
Serial << F(" ") << c << F(" C ") << f << F(" F");
|
||||
}
|
||||
Serial << endl;
|
||||
}
|
||||
}
|
||||
|
||||
//print date and time to Serial
|
||||
void printDateTime(time_t t)
|
||||
{
|
||||
printDate(t);
|
||||
Serial << ' ';
|
||||
printTime(t);
|
||||
}
|
||||
|
||||
//print time to Serial
|
||||
void printTime(time_t t)
|
||||
{
|
||||
printI00(hour(t), ':');
|
||||
printI00(minute(t), ':');
|
||||
printI00(second(t), ' ');
|
||||
}
|
||||
|
||||
//print date to Serial
|
||||
void printDate(time_t t)
|
||||
{
|
||||
printI00(day(t), 0);
|
||||
Serial << monthShortStr(month(t)) << _DEC(year(t));
|
||||
}
|
||||
|
||||
//Print an integer in "00" format (with leading zero),
|
||||
//followed by a delimiter character to Serial.
|
||||
//Input value assumed to be between 0 and 99.
|
||||
void printI00(int val, char delim)
|
||||
{
|
||||
if (val < 10) Serial << '0';
|
||||
Serial << _DEC(val);
|
||||
if (delim > 0) Serial << delim;
|
||||
return;
|
||||
}
|
||||
@@ -1,50 +0,0 @@
|
||||
/*
|
||||
* TimeRTC.pde
|
||||
* Example code illustrating Time library with Real Time Clock.
|
||||
* This example is identical to the example provided with the Time Library,
|
||||
* only the #include statement has been changed to include the DS3232RTC library.
|
||||
*/
|
||||
|
||||
#include <DS3232RTC.h> //http://github.com/JChristensen/DS3232RTC
|
||||
#include <Time.h> //http://www.arduino.cc/playground/Code/Time
|
||||
#include <Wire.h> //http://arduino.cc/en/Reference/Wire (included with Arduino IDE)
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
Serial.begin(9600);
|
||||
setSyncProvider(RTC.get); // the function to get the time from the RTC
|
||||
if(timeStatus() != timeSet)
|
||||
Serial.println("Unable to sync with the RTC");
|
||||
else
|
||||
Serial.println("RTC has set the system time");
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
digitalClockDisplay();
|
||||
delay(1000);
|
||||
}
|
||||
|
||||
void digitalClockDisplay(void)
|
||||
{
|
||||
// digital clock display of the time
|
||||
Serial.print(hour());
|
||||
printDigits(minute());
|
||||
printDigits(second());
|
||||
Serial.print(' ');
|
||||
Serial.print(day());
|
||||
Serial.print(' ');
|
||||
Serial.print(month());
|
||||
Serial.print(' ');
|
||||
Serial.print(year());
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
void printDigits(int digits)
|
||||
{
|
||||
// utility function for digital clock display: prints preceding colon and leading 0
|
||||
Serial.print(':');
|
||||
if(digits < 10)
|
||||
Serial.print('0');
|
||||
Serial.print(digits);
|
||||
}
|
||||
@@ -1,88 +0,0 @@
|
||||
/*----------------------------------------------------------------------*
|
||||
* Digital clock display using a DS3231/32 Real-Time Clock *
|
||||
* and an ATtiny45/85 with a 1MHz system clock. *
|
||||
* Also seems to work with a DS1307 which is fairly similar but the *
|
||||
* DS3232RTC library doesn't officially support it. *
|
||||
* *
|
||||
* Tested with Arduino 1.0.5. Also Arduino-Tiny Core, TinyISP, and *
|
||||
* TinyDebugKnockBang from http://code.google.com/p/arduino-tiny/ *
|
||||
* *
|
||||
* Run TinyISP on an ATmega microcontroller that does not have an LED *
|
||||
* connected to pin 13 (SCK). The LED causes problems because the SPI *
|
||||
* pins are also the I2C pins on the ATtiny. Connect MISO, MOSI, SCK *
|
||||
* on the ATmega to the corresponding pins on the ATtiny through 220Ω *
|
||||
* resistors for safety. Use 4.7K pullup resistors on the ATtiny *
|
||||
* I2C bus. *
|
||||
* *
|
||||
* Jack Christensen 21Aug2013 *
|
||||
* *
|
||||
* This work is licensed under the Creative Commons Attribution- *
|
||||
* ShareAlike 3.0 Unported License. To view a copy of this license, *
|
||||
* visit http://creativecommons.org/licenses/by-sa/3.0/ or send a *
|
||||
* letter to Creative Commons, 171 Second Street, Suite 300, *
|
||||
* San Francisco, California, 94105, USA. *
|
||||
*----------------------------------------------------------------------*/
|
||||
|
||||
#include <DS3232RTC.h> //http://github.com/JChristensen/DS3232RTC
|
||||
#include <Time.h> //http://playground.arduino.cc/Code/Time
|
||||
#include <TinyDebugKnockBang.h> //http://code.google.com/p/arduino-tiny/
|
||||
#include <TinyWireM.h> //http://playground.arduino.cc/Code/USIi2c
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
Debug.begin(250000);
|
||||
|
||||
//setSyncProvider() causes the Time library to synchronize with the
|
||||
//external RTC by calling RTC.get() every five minutes by default.
|
||||
setSyncProvider(RTC.get);
|
||||
Debug.print(F("RTC Sync"));
|
||||
if (timeStatus() != timeSet) Debug.print(F(" FAIL!"));
|
||||
Debug.println();
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
static time_t tLast;
|
||||
|
||||
time_t t = now();
|
||||
if (t != tLast) {
|
||||
tLast = t;
|
||||
printDateTime(t);
|
||||
Debug.println();
|
||||
}
|
||||
}
|
||||
|
||||
//print date and time to Serial
|
||||
void printDateTime(time_t t)
|
||||
{
|
||||
printDate(t);
|
||||
Debug.print(' ');
|
||||
printTime(t);
|
||||
}
|
||||
|
||||
//print time to Serial
|
||||
void printTime(time_t t)
|
||||
{
|
||||
printI00(hour(t), ':');
|
||||
printI00(minute(t), ':');
|
||||
printI00(second(t), ' ');
|
||||
}
|
||||
|
||||
//print date to Serial
|
||||
void printDate(time_t t)
|
||||
{
|
||||
printI00(day(t), 0);
|
||||
Debug.print(monthShortStr(month(t)));
|
||||
Debug.print(year(t), DEC);
|
||||
}
|
||||
|
||||
//Print an integer in "00" format (with leading zero),
|
||||
//followed by a delimiter character to Serial.
|
||||
//Input value assumed to be between 0 and 99.
|
||||
void printI00(int val, char delim)
|
||||
{
|
||||
if (val < 10) Debug.print('0');
|
||||
Debug.print(val, DEC);;
|
||||
if (delim > 0) Debug.print(delim);
|
||||
return;
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
DS3232RTC KEYWORD1
|
||||
get KEYWORD2
|
||||
set KEYWORD2
|
||||
read KEYWORD2
|
||||
write KEYWORD2
|
||||
writeRTC KEYWORD2
|
||||
readRTC KEYWORD2
|
||||
setAlarm KEYWORD2
|
||||
alarmInterrupt KEYWORD2
|
||||
alarm KEYWORD2
|
||||
squareWave KEYWORD2
|
||||
oscStopped KEYWORD2
|
||||
temperature KEYWORD2
|
||||
@@ -1,761 +0,0 @@
|
||||
// This library is free software; you can redistribute it and/or
|
||||
// modify it under the terms of the GNU Lesser General Public
|
||||
// License as published by the Free Software Foundation; either
|
||||
// version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
// Version 3.7.2 modified on Dec 6, 2011 to support Arduino 1.0
|
||||
// See Includes...
|
||||
// Modified by Jordan Hochenbaum
|
||||
|
||||
#include "DallasTemperature.h"
|
||||
|
||||
#if ARDUINO >= 100
|
||||
#include "Arduino.h"
|
||||
#else
|
||||
extern "C" {
|
||||
#include "WConstants.h"
|
||||
}
|
||||
#endif
|
||||
|
||||
DallasTemperature::DallasTemperature(OneWire* _oneWire)
|
||||
#if REQUIRESALARMS
|
||||
: _AlarmHandler(&defaultAlarmHandler)
|
||||
#endif
|
||||
{
|
||||
_wire = _oneWire;
|
||||
devices = 0;
|
||||
parasite = false;
|
||||
bitResolution = 9;
|
||||
waitForConversion = true;
|
||||
checkForConversion = true;
|
||||
}
|
||||
|
||||
// initialise the bus
|
||||
void DallasTemperature::begin(void)
|
||||
{
|
||||
DeviceAddress deviceAddress;
|
||||
|
||||
_wire->reset_search();
|
||||
devices = 0; // Reset the number of devices when we enumerate wire devices
|
||||
|
||||
while (_wire->search(deviceAddress))
|
||||
{
|
||||
if (validAddress(deviceAddress))
|
||||
{
|
||||
if (!parasite && readPowerSupply(deviceAddress)) parasite = true;
|
||||
|
||||
ScratchPad scratchPad;
|
||||
|
||||
readScratchPad(deviceAddress, scratchPad);
|
||||
|
||||
bitResolution = max(bitResolution, getResolution(deviceAddress));
|
||||
|
||||
devices++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// returns the number of devices found on the bus
|
||||
uint8_t DallasTemperature::getDeviceCount(void)
|
||||
{
|
||||
return devices;
|
||||
}
|
||||
|
||||
// returns true if address is valid
|
||||
bool DallasTemperature::validAddress(const uint8_t* deviceAddress)
|
||||
{
|
||||
return (_wire->crc8(deviceAddress, 7) == deviceAddress[7]);
|
||||
}
|
||||
|
||||
// finds an address at a given index on the bus
|
||||
// returns true if the device was found
|
||||
bool DallasTemperature::getAddress(uint8_t* deviceAddress, uint8_t index)
|
||||
{
|
||||
uint8_t depth = 0;
|
||||
|
||||
_wire->reset_search();
|
||||
|
||||
while (depth <= index && _wire->search(deviceAddress))
|
||||
{
|
||||
if (depth == index && validAddress(deviceAddress)) return true;
|
||||
depth++;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
// attempt to determine if the device at the given address is connected to the bus
|
||||
bool DallasTemperature::isConnected(const uint8_t* deviceAddress)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
return isConnected(deviceAddress, scratchPad);
|
||||
}
|
||||
|
||||
// attempt to determine if the device at the given address is connected to the bus
|
||||
// also allows for updating the read scratchpad
|
||||
bool DallasTemperature::isConnected(const uint8_t* deviceAddress, uint8_t* scratchPad)
|
||||
{
|
||||
readScratchPad(deviceAddress, scratchPad);
|
||||
return (_wire->crc8(scratchPad, 8) == scratchPad[SCRATCHPAD_CRC]);
|
||||
}
|
||||
|
||||
// read device's scratch pad
|
||||
void DallasTemperature::readScratchPad(const uint8_t* deviceAddress, uint8_t* scratchPad)
|
||||
{
|
||||
// send the command
|
||||
_wire->reset();
|
||||
_wire->select(deviceAddress);
|
||||
_wire->write(READSCRATCH);
|
||||
|
||||
// TODO => collect all comments & use simple loop
|
||||
// byte 0: temperature LSB
|
||||
// byte 1: temperature MSB
|
||||
// byte 2: high alarm temp
|
||||
// byte 3: low alarm temp
|
||||
// byte 4: DS18S20: store for crc
|
||||
// DS18B20 & DS1822: configuration register
|
||||
// byte 5: internal use & crc
|
||||
// byte 6: DS18S20: COUNT_REMAIN
|
||||
// DS18B20 & DS1822: store for crc
|
||||
// byte 7: DS18S20: COUNT_PER_C
|
||||
// DS18B20 & DS1822: store for crc
|
||||
// byte 8: SCRATCHPAD_CRC
|
||||
//
|
||||
// for(int i=0; i<9; i++)
|
||||
// {
|
||||
// scratchPad[i] = _wire->read();
|
||||
// }
|
||||
|
||||
|
||||
// read the response
|
||||
|
||||
// byte 0: temperature LSB
|
||||
scratchPad[TEMP_LSB] = _wire->read();
|
||||
|
||||
// byte 1: temperature MSB
|
||||
scratchPad[TEMP_MSB] = _wire->read();
|
||||
|
||||
// byte 2: high alarm temp
|
||||
scratchPad[HIGH_ALARM_TEMP] = _wire->read();
|
||||
|
||||
// byte 3: low alarm temp
|
||||
scratchPad[LOW_ALARM_TEMP] = _wire->read();
|
||||
|
||||
// byte 4:
|
||||
// DS18S20: store for crc
|
||||
// DS18B20 & DS1822: configuration register
|
||||
scratchPad[CONFIGURATION] = _wire->read();
|
||||
|
||||
// byte 5:
|
||||
// internal use & crc
|
||||
scratchPad[INTERNAL_BYTE] = _wire->read();
|
||||
|
||||
// byte 6:
|
||||
// DS18S20: COUNT_REMAIN
|
||||
// DS18B20 & DS1822: store for crc
|
||||
scratchPad[COUNT_REMAIN] = _wire->read();
|
||||
|
||||
// byte 7:
|
||||
// DS18S20: COUNT_PER_C
|
||||
// DS18B20 & DS1822: store for crc
|
||||
scratchPad[COUNT_PER_C] = _wire->read();
|
||||
|
||||
// byte 8:
|
||||
// SCTRACHPAD_CRC
|
||||
scratchPad[SCRATCHPAD_CRC] = _wire->read();
|
||||
|
||||
_wire->reset();
|
||||
}
|
||||
|
||||
// writes device's scratch pad
|
||||
void DallasTemperature::writeScratchPad(const uint8_t* deviceAddress, const uint8_t* scratchPad)
|
||||
{
|
||||
_wire->reset();
|
||||
_wire->select(deviceAddress);
|
||||
_wire->write(WRITESCRATCH);
|
||||
_wire->write(scratchPad[HIGH_ALARM_TEMP]); // high alarm temp
|
||||
_wire->write(scratchPad[LOW_ALARM_TEMP]); // low alarm temp
|
||||
// DS1820 and DS18S20 have no configuration register
|
||||
if (deviceAddress[0] != DS18S20MODEL) _wire->write(scratchPad[CONFIGURATION]); // configuration
|
||||
_wire->reset();
|
||||
_wire->select(deviceAddress); //<--this line was missing
|
||||
// save the newly written values to eeprom
|
||||
_wire->write(COPYSCRATCH, parasite);
|
||||
delay(20); // <--- added 20ms delay to allow 10ms long EEPROM write operation (as specified by datasheet)
|
||||
if (parasite) delay(10); // 10ms delay
|
||||
_wire->reset();
|
||||
}
|
||||
|
||||
// reads the device's power requirements
|
||||
bool DallasTemperature::readPowerSupply(const uint8_t* deviceAddress)
|
||||
{
|
||||
bool ret = false;
|
||||
_wire->reset();
|
||||
_wire->select(deviceAddress);
|
||||
_wire->write(READPOWERSUPPLY);
|
||||
if (_wire->read_bit() == 0) ret = true;
|
||||
_wire->reset();
|
||||
return ret;
|
||||
}
|
||||
|
||||
|
||||
// set resolution of all devices to 9, 10, 11, or 12 bits
|
||||
// if new resolution is out of range, it is constrained.
|
||||
void DallasTemperature::setResolution(uint8_t newResolution)
|
||||
{
|
||||
bitResolution = constrain(newResolution, 9, 12);
|
||||
DeviceAddress deviceAddress;
|
||||
for (int i=0; i<devices; i++)
|
||||
{
|
||||
getAddress(deviceAddress, i);
|
||||
setResolution(deviceAddress, bitResolution);
|
||||
}
|
||||
}
|
||||
|
||||
// set resolution of a device to 9, 10, 11, or 12 bits
|
||||
// if new resolution is out of range, 9 bits is used.
|
||||
bool DallasTemperature::setResolution(const uint8_t* deviceAddress, uint8_t newResolution)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad))
|
||||
{
|
||||
// DS1820 and DS18S20 have no resolution configuration register
|
||||
if (deviceAddress[0] != DS18S20MODEL)
|
||||
{
|
||||
switch (newResolution)
|
||||
{
|
||||
case 12:
|
||||
scratchPad[CONFIGURATION] = TEMP_12_BIT;
|
||||
break;
|
||||
case 11:
|
||||
scratchPad[CONFIGURATION] = TEMP_11_BIT;
|
||||
break;
|
||||
case 10:
|
||||
scratchPad[CONFIGURATION] = TEMP_10_BIT;
|
||||
break;
|
||||
case 9:
|
||||
default:
|
||||
scratchPad[CONFIGURATION] = TEMP_9_BIT;
|
||||
break;
|
||||
}
|
||||
writeScratchPad(deviceAddress, scratchPad);
|
||||
}
|
||||
return true; // new value set
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
// returns the global resolution
|
||||
uint8_t DallasTemperature::getResolution()
|
||||
{
|
||||
return bitResolution;
|
||||
}
|
||||
|
||||
// returns the current resolution of the device, 9-12
|
||||
// returns 0 if device not found
|
||||
uint8_t DallasTemperature::getResolution(const uint8_t* deviceAddress)
|
||||
{
|
||||
// DS1820 and DS18S20 have no resolution configuration register
|
||||
if (deviceAddress[0] == DS18S20MODEL) return 12;
|
||||
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad))
|
||||
{
|
||||
switch (scratchPad[CONFIGURATION])
|
||||
{
|
||||
case TEMP_12_BIT:
|
||||
return 12;
|
||||
|
||||
case TEMP_11_BIT:
|
||||
return 11;
|
||||
|
||||
case TEMP_10_BIT:
|
||||
return 10;
|
||||
|
||||
case TEMP_9_BIT:
|
||||
return 9;
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
// sets the value of the waitForConversion flag
|
||||
// TRUE : function requestTemperature() etc returns when conversion is ready
|
||||
// FALSE: function requestTemperature() etc returns immediately (USE WITH CARE!!)
|
||||
// (1) programmer has to check if the needed delay has passed
|
||||
// (2) but the application can do meaningful things in that time
|
||||
void DallasTemperature::setWaitForConversion(bool flag)
|
||||
{
|
||||
waitForConversion = flag;
|
||||
}
|
||||
|
||||
// gets the value of the waitForConversion flag
|
||||
bool DallasTemperature::getWaitForConversion()
|
||||
{
|
||||
return waitForConversion;
|
||||
}
|
||||
|
||||
|
||||
// sets the value of the checkForConversion flag
|
||||
// TRUE : function requestTemperature() etc will 'listen' to an IC to determine whether a conversion is complete
|
||||
// FALSE: function requestTemperature() etc will wait a set time (worst case scenario) for a conversion to complete
|
||||
void DallasTemperature::setCheckForConversion(bool flag)
|
||||
{
|
||||
checkForConversion = flag;
|
||||
}
|
||||
|
||||
// gets the value of the waitForConversion flag
|
||||
bool DallasTemperature::getCheckForConversion()
|
||||
{
|
||||
return checkForConversion;
|
||||
}
|
||||
|
||||
bool DallasTemperature::isConversionAvailable(const uint8_t* deviceAddress)
|
||||
{
|
||||
// Check if the clock has been raised indicating the conversion is complete
|
||||
ScratchPad scratchPad;
|
||||
readScratchPad(deviceAddress, scratchPad);
|
||||
return scratchPad[0];
|
||||
}
|
||||
|
||||
|
||||
// sends command for all devices on the bus to perform a temperature conversion
|
||||
void DallasTemperature::requestTemperatures()
|
||||
{
|
||||
_wire->reset();
|
||||
_wire->skip();
|
||||
_wire->write(STARTCONVO, parasite);
|
||||
|
||||
// ASYNC mode?
|
||||
if (!waitForConversion) return;
|
||||
blockTillConversionComplete(bitResolution, NULL);
|
||||
}
|
||||
|
||||
// sends command for one device to perform a temperature by address
|
||||
// returns FALSE if device is disconnected
|
||||
// returns TRUE otherwise
|
||||
bool DallasTemperature::requestTemperaturesByAddress(const uint8_t* deviceAddress)
|
||||
{
|
||||
_wire->reset();
|
||||
_wire->select(deviceAddress);
|
||||
_wire->write(STARTCONVO, parasite);
|
||||
|
||||
// check device
|
||||
ScratchPad scratchPad;
|
||||
if (!isConnected(deviceAddress, scratchPad)) return false;
|
||||
|
||||
// ASYNC mode?
|
||||
if (!waitForConversion) return true;
|
||||
blockTillConversionComplete(getResolution(deviceAddress), deviceAddress);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// returns number of milliseconds to wait till conversion is complete (based on IC datasheet)
|
||||
int16_t DallasTemperature::millisToWaitForConversion(uint8_t bitResolution)
|
||||
{
|
||||
switch (bitResolution)
|
||||
{
|
||||
case 9:
|
||||
return 94;
|
||||
case 10:
|
||||
return 188;
|
||||
case 11:
|
||||
return 375;
|
||||
default:
|
||||
return 750;
|
||||
}
|
||||
}
|
||||
|
||||
// Continue to check if the IC has responded with a temperature
|
||||
void DallasTemperature::blockTillConversionComplete(uint8_t bitResolution, const uint8_t* deviceAddress)
|
||||
{
|
||||
int delms = millisToWaitForConversion(bitResolution);
|
||||
if (deviceAddress != NULL && checkForConversion && !parasite)
|
||||
{
|
||||
unsigned long timend = millis() + delms;
|
||||
while(!isConversionAvailable(deviceAddress) && (millis() < timend));
|
||||
}
|
||||
else
|
||||
{
|
||||
delay(delms);
|
||||
}
|
||||
}
|
||||
|
||||
// sends command for one device to perform a temp conversion by index
|
||||
bool DallasTemperature::requestTemperaturesByIndex(uint8_t deviceIndex)
|
||||
{
|
||||
DeviceAddress deviceAddress;
|
||||
getAddress(deviceAddress, deviceIndex);
|
||||
return requestTemperaturesByAddress(deviceAddress);
|
||||
}
|
||||
|
||||
// Fetch temperature for device index
|
||||
float DallasTemperature::getTempCByIndex(uint8_t deviceIndex)
|
||||
{
|
||||
DeviceAddress deviceAddress;
|
||||
if (!getAddress(deviceAddress, deviceIndex))
|
||||
return DEVICE_DISCONNECTED_C;
|
||||
return getTempC((uint8_t*)deviceAddress);
|
||||
}
|
||||
|
||||
// Fetch temperature for device index
|
||||
float DallasTemperature::getTempFByIndex(uint8_t deviceIndex)
|
||||
{
|
||||
DeviceAddress deviceAddress;
|
||||
if (!getAddress(deviceAddress, deviceIndex))
|
||||
return DEVICE_DISCONNECTED_F;
|
||||
return getTempF((uint8_t*)deviceAddress);
|
||||
}
|
||||
|
||||
// reads scratchpad and returns fixed-point temperature, scaling factor 2^-7
|
||||
int16_t DallasTemperature::calculateTemperature(const uint8_t* deviceAddress, uint8_t* scratchPad)
|
||||
{
|
||||
int16_t fpTemperature =
|
||||
(((int16_t) scratchPad[TEMP_MSB]) << 11) |
|
||||
(((int16_t) scratchPad[TEMP_LSB]) << 3);
|
||||
|
||||
/*
|
||||
DS1820 and DS18S20 have a 9-bit temperature register.
|
||||
|
||||
Resolutions greater than 9-bit can be calculated using the data from
|
||||
the temperature, and COUNT REMAIN and COUNT PER °C registers in the
|
||||
scratchpad. The resolution of the calculation depends on the model.
|
||||
|
||||
While the COUNT PER °C register is hard-wired to 16 (10h) in a
|
||||
DS18S20, it changes with temperature in DS1820.
|
||||
|
||||
After reading the scratchpad, the TEMP_READ value is obtained by
|
||||
truncating the 0.5°C bit (bit 0) from the temperature data. The
|
||||
extended resolution temperature can then be calculated using the
|
||||
following equation:
|
||||
|
||||
COUNT_PER_C - COUNT_REMAIN
|
||||
TEMPERATURE = TEMP_READ - 0.25 + --------------------------
|
||||
COUNT_PER_C
|
||||
|
||||
Hagai Shatz simplified this to integer arithmetic for a 12 bits
|
||||
value for a DS18S20, and James Cameron added legacy DS1820 support.
|
||||
|
||||
See - http://myarduinotoy.blogspot.co.uk/2013/02/12bit-result-from-ds18s20.html
|
||||
*/
|
||||
|
||||
if (deviceAddress[0] == DS18S20MODEL)
|
||||
fpTemperature = ((fpTemperature & 0xfff0) << 3) - 16 +
|
||||
(
|
||||
((scratchPad[COUNT_PER_C] - scratchPad[COUNT_REMAIN]) << 7) /
|
||||
scratchPad[COUNT_PER_C]
|
||||
);
|
||||
|
||||
return fpTemperature;
|
||||
}
|
||||
|
||||
|
||||
// returns temperature in 1/128 degrees C or DEVICE_DISCONNECTED_RAW if the
|
||||
// device's scratch pad cannot be read successfully.
|
||||
// the numeric value of DEVICE_DISCONNECTED_RAW is defined in
|
||||
// DallasTemperature.h. It is a large negative number outside the
|
||||
// operating range of the device
|
||||
int16_t DallasTemperature::getTemp(const uint8_t* deviceAddress)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad)) return calculateTemperature(deviceAddress, scratchPad);
|
||||
return DEVICE_DISCONNECTED_RAW;
|
||||
}
|
||||
|
||||
// returns temperature in degrees C or DEVICE_DISCONNECTED_C if the
|
||||
// device's scratch pad cannot be read successfully.
|
||||
// the numeric value of DEVICE_DISCONNECTED_C is defined in
|
||||
// DallasTemperature.h. It is a large negative number outside the
|
||||
// operating range of the device
|
||||
float DallasTemperature::getTempC(const uint8_t* deviceAddress)
|
||||
{
|
||||
return rawToCelsius(getTemp(deviceAddress));
|
||||
}
|
||||
|
||||
// returns temperature in degrees F or DEVICE_DISCONNECTED_F if the
|
||||
// device's scratch pad cannot be read successfully.
|
||||
// the numeric value of DEVICE_DISCONNECTED_F is defined in
|
||||
// DallasTemperature.h. It is a large negative number outside the
|
||||
// operating range of the device
|
||||
float DallasTemperature::getTempF(const uint8_t* deviceAddress)
|
||||
{
|
||||
return rawToFahrenheit(getTemp(deviceAddress));
|
||||
}
|
||||
|
||||
// returns true if the bus requires parasite power
|
||||
bool DallasTemperature::isParasitePowerMode(void)
|
||||
{
|
||||
return parasite;
|
||||
}
|
||||
|
||||
#if REQUIRESALARMS
|
||||
|
||||
/*
|
||||
|
||||
ALARMS:
|
||||
|
||||
TH and TL Register Format
|
||||
|
||||
BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 BIT 1 BIT 0
|
||||
S 2^6 2^5 2^4 2^3 2^2 2^1 2^0
|
||||
|
||||
Only bits 11 through 4 of the temperature register are used
|
||||
in the TH and TL comparison since TH and TL are 8-bit
|
||||
registers. If the measured temperature is lower than or equal
|
||||
to TL or higher than or equal to TH, an alarm condition exists
|
||||
and an alarm flag is set inside the DS18B20. This flag is
|
||||
updated after every temperature measurement; therefore, if the
|
||||
alarm condition goes away, the flag will be turned off after
|
||||
the next temperature conversion.
|
||||
|
||||
*/
|
||||
|
||||
// sets the high alarm temperature for a device in degrees Celsius
|
||||
// accepts a float, but the alarm resolution will ignore anything
|
||||
// after a decimal point. valid range is -55C - 125C
|
||||
void DallasTemperature::setHighAlarmTemp(const uint8_t* deviceAddress, char celsius)
|
||||
{
|
||||
// make sure the alarm temperature is within the device's range
|
||||
if (celsius > 125) celsius = 125;
|
||||
else if (celsius < -55) celsius = -55;
|
||||
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad))
|
||||
{
|
||||
scratchPad[HIGH_ALARM_TEMP] = (uint8_t)celsius;
|
||||
writeScratchPad(deviceAddress, scratchPad);
|
||||
}
|
||||
}
|
||||
|
||||
// sets the low alarm temperature for a device in degrees Celsius
|
||||
// accepts a float, but the alarm resolution will ignore anything
|
||||
// after a decimal point. valid range is -55C - 125C
|
||||
void DallasTemperature::setLowAlarmTemp(const uint8_t* deviceAddress, char celsius)
|
||||
{
|
||||
// make sure the alarm temperature is within the device's range
|
||||
if (celsius > 125) celsius = 125;
|
||||
else if (celsius < -55) celsius = -55;
|
||||
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad))
|
||||
{
|
||||
scratchPad[LOW_ALARM_TEMP] = (uint8_t)celsius;
|
||||
writeScratchPad(deviceAddress, scratchPad);
|
||||
}
|
||||
}
|
||||
|
||||
// returns a char with the current high alarm temperature or
|
||||
// DEVICE_DISCONNECTED for an address
|
||||
char DallasTemperature::getHighAlarmTemp(const uint8_t* deviceAddress)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad)) return (char)scratchPad[HIGH_ALARM_TEMP];
|
||||
return DEVICE_DISCONNECTED_C;
|
||||
}
|
||||
|
||||
// returns a char with the current low alarm temperature or
|
||||
// DEVICE_DISCONNECTED for an address
|
||||
char DallasTemperature::getLowAlarmTemp(const uint8_t* deviceAddress)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad)) return (char)scratchPad[LOW_ALARM_TEMP];
|
||||
return DEVICE_DISCONNECTED_C;
|
||||
}
|
||||
|
||||
// resets internal variables used for the alarm search
|
||||
void DallasTemperature::resetAlarmSearch()
|
||||
{
|
||||
alarmSearchJunction = -1;
|
||||
alarmSearchExhausted = 0;
|
||||
for(uint8_t i = 0; i < 7; i++)
|
||||
alarmSearchAddress[i] = 0;
|
||||
}
|
||||
|
||||
// This is a modified version of the OneWire::search method.
|
||||
//
|
||||
// Also added the OneWire search fix documented here:
|
||||
// http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295
|
||||
//
|
||||
// Perform an alarm search. If this function returns a '1' then it has
|
||||
// enumerated the next device and you may retrieve the ROM from the
|
||||
// OneWire::address variable. If there are no devices, no further
|
||||
// devices, or something horrible happens in the middle of the
|
||||
// enumeration then a 0 is returned. If a new device is found then
|
||||
// its address is copied to newAddr. Use
|
||||
// DallasTemperature::resetAlarmSearch() to start over.
|
||||
bool DallasTemperature::alarmSearch(uint8_t* newAddr)
|
||||
{
|
||||
uint8_t i;
|
||||
char lastJunction = -1;
|
||||
uint8_t done = 1;
|
||||
|
||||
if (alarmSearchExhausted) return false;
|
||||
if (!_wire->reset()) return false;
|
||||
|
||||
// send the alarm search command
|
||||
_wire->write(0xEC, 0);
|
||||
|
||||
for(i = 0; i < 64; i++)
|
||||
{
|
||||
uint8_t a = _wire->read_bit( );
|
||||
uint8_t nota = _wire->read_bit( );
|
||||
uint8_t ibyte = i / 8;
|
||||
uint8_t ibit = 1 << (i & 7);
|
||||
|
||||
// I don't think this should happen, this means nothing responded, but maybe if
|
||||
// something vanishes during the search it will come up.
|
||||
if (a && nota) return false;
|
||||
|
||||
if (!a && !nota)
|
||||
{
|
||||
if (i == alarmSearchJunction)
|
||||
{
|
||||
// this is our time to decide differently, we went zero last time, go one.
|
||||
a = 1;
|
||||
alarmSearchJunction = lastJunction;
|
||||
}
|
||||
else if (i < alarmSearchJunction)
|
||||
{
|
||||
// take whatever we took last time, look in address
|
||||
if (alarmSearchAddress[ibyte] & ibit) a = 1;
|
||||
else
|
||||
{
|
||||
// Only 0s count as pending junctions, we've already exhausted the 0 side of 1s
|
||||
a = 0;
|
||||
done = 0;
|
||||
lastJunction = i;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// we are blazing new tree, take the 0
|
||||
a = 0;
|
||||
alarmSearchJunction = i;
|
||||
done = 0;
|
||||
}
|
||||
// OneWire search fix
|
||||
// See: http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1238032295
|
||||
}
|
||||
|
||||
if (a) alarmSearchAddress[ibyte] |= ibit;
|
||||
else alarmSearchAddress[ibyte] &= ~ibit;
|
||||
|
||||
_wire->write_bit(a);
|
||||
}
|
||||
|
||||
if (done) alarmSearchExhausted = 1;
|
||||
for (i = 0; i < 8; i++) newAddr[i] = alarmSearchAddress[i];
|
||||
return true;
|
||||
}
|
||||
|
||||
// returns true if device address might have an alarm condition
|
||||
// (only an alarm search can verify this)
|
||||
bool DallasTemperature::hasAlarm(const uint8_t* deviceAddress)
|
||||
{
|
||||
ScratchPad scratchPad;
|
||||
if (isConnected(deviceAddress, scratchPad))
|
||||
{
|
||||
char temp = calculateTemperature(deviceAddress, scratchPad) >> 7;
|
||||
|
||||
// check low alarm
|
||||
if (temp <= (char)scratchPad[LOW_ALARM_TEMP]) return true;
|
||||
|
||||
// check high alarm
|
||||
if (temp >= (char)scratchPad[HIGH_ALARM_TEMP]) return true;
|
||||
}
|
||||
|
||||
// no alarm
|
||||
return false;
|
||||
}
|
||||
|
||||
// returns true if any device is reporting an alarm condition on the bus
|
||||
bool DallasTemperature::hasAlarm(void)
|
||||
{
|
||||
DeviceAddress deviceAddress;
|
||||
resetAlarmSearch();
|
||||
return alarmSearch(deviceAddress);
|
||||
}
|
||||
|
||||
// runs the alarm handler for all devices returned by alarmSearch()
|
||||
void DallasTemperature::processAlarms(void)
|
||||
{
|
||||
resetAlarmSearch();
|
||||
DeviceAddress alarmAddr;
|
||||
|
||||
while (alarmSearch(alarmAddr))
|
||||
{
|
||||
if (validAddress(alarmAddr))
|
||||
_AlarmHandler(alarmAddr);
|
||||
}
|
||||
}
|
||||
|
||||
// sets the alarm handler
|
||||
void DallasTemperature::setAlarmHandler(AlarmHandler *handler)
|
||||
{
|
||||
_AlarmHandler = handler;
|
||||
}
|
||||
|
||||
// The default alarm handler
|
||||
void DallasTemperature::defaultAlarmHandler(const uint8_t* deviceAddress)
|
||||
{
|
||||
(void)deviceAddress;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
// Convert float Celsius to Fahrenheit
|
||||
float DallasTemperature::toFahrenheit(float celsius)
|
||||
{
|
||||
return (celsius * 1.8) + 32;
|
||||
}
|
||||
|
||||
// Convert float Fahrenheit to Celsius
|
||||
float DallasTemperature::toCelsius(float fahrenheit)
|
||||
{
|
||||
return (fahrenheit - 32) * 0.555555556;
|
||||
}
|
||||
|
||||
// convert from raw to Celsius
|
||||
float DallasTemperature::rawToCelsius(int16_t raw)
|
||||
{
|
||||
if (raw <= DEVICE_DISCONNECTED_RAW)
|
||||
return DEVICE_DISCONNECTED_C;
|
||||
// C = RAW/128
|
||||
return (float)raw * 0.0078125;
|
||||
}
|
||||
|
||||
// convert from raw to Fahrenheit
|
||||
float DallasTemperature::rawToFahrenheit(int16_t raw)
|
||||
{
|
||||
if (raw <= DEVICE_DISCONNECTED_RAW)
|
||||
return DEVICE_DISCONNECTED_F;
|
||||
// C = RAW/128
|
||||
// F = (C*1.8)+32 = (RAW/128*1.8)+32 = (RAW*0.0140625)+32
|
||||
return ((float)raw * 0.0140625) + 32;
|
||||
}
|
||||
|
||||
#if REQUIRESNEW
|
||||
|
||||
// MnetCS - Allocates memory for DallasTemperature. Allows us to instance a new object
|
||||
void* DallasTemperature::operator new(unsigned int size) // Implicit NSS obj size
|
||||
{
|
||||
void * p; // void pointer
|
||||
p = malloc(size); // Allocate memory
|
||||
memset((DallasTemperature*)p,0,size); // Initialise memory
|
||||
|
||||
//!!! CANT EXPLICITLY CALL CONSTRUCTOR - workaround by using an init() methodR - workaround by using an init() method
|
||||
return (DallasTemperature*) p; // Cast blank region to NSS pointer
|
||||
}
|
||||
|
||||
// MnetCS 2009 - Free the memory used by this instance
|
||||
void DallasTemperature::operator delete(void* p)
|
||||
{
|
||||
DallasTemperature* pNss = (DallasTemperature*) p; // Cast to NSS pointer
|
||||
pNss->~DallasTemperature(); // Destruct the object
|
||||
|
||||
free(p); // Free the memory
|
||||
}
|
||||
|
||||
#endif
|
||||
@@ -1,254 +0,0 @@
|
||||
#ifndef DallasTemperature_h
|
||||
#define DallasTemperature_h
|
||||
|
||||
#define DALLASTEMPLIBVERSION "3.7.2"
|
||||
|
||||
// This library is free software; you can redistribute it and/or
|
||||
// modify it under the terms of the GNU Lesser General Public
|
||||
// License as published by the Free Software Foundation; either
|
||||
// version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
// set to true to include code for new and delete operators
|
||||
#ifndef REQUIRESNEW
|
||||
#define REQUIRESNEW false
|
||||
#endif
|
||||
|
||||
// set to true to include code implementing alarm search functions
|
||||
#ifndef REQUIRESALARMS
|
||||
#define REQUIRESALARMS true
|
||||
#endif
|
||||
|
||||
#include <inttypes.h>
|
||||
#include <OneWire.h>
|
||||
|
||||
// Model IDs
|
||||
#define DS18S20MODEL 0x10 // also DS1820
|
||||
#define DS18B20MODEL 0x28
|
||||
#define DS1822MODEL 0x22
|
||||
#define DS1825MODEL 0x3B
|
||||
|
||||
// OneWire commands
|
||||
#define STARTCONVO 0x44 // Tells device to take a temperature reading and put it on the scratchpad
|
||||
#define COPYSCRATCH 0x48 // Copy EEPROM
|
||||
#define READSCRATCH 0xBE // Read EEPROM
|
||||
#define WRITESCRATCH 0x4E // Write to EEPROM
|
||||
#define RECALLSCRATCH 0xB8 // Reload from last known
|
||||
#define READPOWERSUPPLY 0xB4 // Determine if device needs parasite power
|
||||
#define ALARMSEARCH 0xEC // Query bus for devices with an alarm condition
|
||||
|
||||
// Scratchpad locations
|
||||
#define TEMP_LSB 0
|
||||
#define TEMP_MSB 1
|
||||
#define HIGH_ALARM_TEMP 2
|
||||
#define LOW_ALARM_TEMP 3
|
||||
#define CONFIGURATION 4
|
||||
#define INTERNAL_BYTE 5
|
||||
#define COUNT_REMAIN 6
|
||||
#define COUNT_PER_C 7
|
||||
#define SCRATCHPAD_CRC 8
|
||||
|
||||
// Device resolution
|
||||
#define TEMP_9_BIT 0x1F // 9 bit
|
||||
#define TEMP_10_BIT 0x3F // 10 bit
|
||||
#define TEMP_11_BIT 0x5F // 11 bit
|
||||
#define TEMP_12_BIT 0x7F // 12 bit
|
||||
|
||||
// Error Codes
|
||||
#define DEVICE_DISCONNECTED_C -127
|
||||
#define DEVICE_DISCONNECTED_F -196.6
|
||||
#define DEVICE_DISCONNECTED_RAW -7040
|
||||
|
||||
typedef uint8_t DeviceAddress[8];
|
||||
|
||||
class DallasTemperature
|
||||
{
|
||||
public:
|
||||
|
||||
DallasTemperature(OneWire*);
|
||||
|
||||
// initialise bus
|
||||
void begin(void);
|
||||
|
||||
// returns the number of devices found on the bus
|
||||
uint8_t getDeviceCount(void);
|
||||
|
||||
// returns true if address is valid
|
||||
bool validAddress(const uint8_t*);
|
||||
|
||||
// finds an address at a given index on the bus
|
||||
bool getAddress(uint8_t*, uint8_t);
|
||||
|
||||
// attempt to determine if the device at the given address is connected to the bus
|
||||
bool isConnected(const uint8_t*);
|
||||
|
||||
// attempt to determine if the device at the given address is connected to the bus
|
||||
// also allows for updating the read scratchpad
|
||||
bool isConnected(const uint8_t*, uint8_t*);
|
||||
|
||||
// read device's scratchpad
|
||||
void readScratchPad(const uint8_t*, uint8_t*);
|
||||
|
||||
// write device's scratchpad
|
||||
void writeScratchPad(const uint8_t*, const uint8_t*);
|
||||
|
||||
// read device's power requirements
|
||||
bool readPowerSupply(const uint8_t*);
|
||||
|
||||
// get global resolution
|
||||
uint8_t getResolution();
|
||||
|
||||
// set global resolution to 9, 10, 11, or 12 bits
|
||||
void setResolution(uint8_t);
|
||||
|
||||
// returns the device resolution: 9, 10, 11, or 12 bits
|
||||
uint8_t getResolution(const uint8_t*);
|
||||
|
||||
// set resolution of a device to 9, 10, 11, or 12 bits
|
||||
bool setResolution(const uint8_t*, uint8_t);
|
||||
|
||||
// sets/gets the waitForConversion flag
|
||||
void setWaitForConversion(bool);
|
||||
bool getWaitForConversion(void);
|
||||
|
||||
// sets/gets the checkForConversion flag
|
||||
void setCheckForConversion(bool);
|
||||
bool getCheckForConversion(void);
|
||||
|
||||
// sends command for all devices on the bus to perform a temperature conversion
|
||||
void requestTemperatures(void);
|
||||
|
||||
// returns time to wait for a temperature conversion based on given resolution
|
||||
int16_t millisToWaitForConversion(uint8_t);
|
||||
|
||||
// sends command for one device to perform a temperature conversion by address
|
||||
bool requestTemperaturesByAddress(const uint8_t*);
|
||||
|
||||
// sends command for one device to perform a temperature conversion by index
|
||||
bool requestTemperaturesByIndex(uint8_t);
|
||||
|
||||
// returns temperature raw value (12 bit integer of 1/16 degrees C)
|
||||
int16_t getTemp(const uint8_t*);
|
||||
|
||||
// returns temperature in degrees C
|
||||
float getTempC(const uint8_t*);
|
||||
|
||||
// returns temperature in degrees F
|
||||
float getTempF(const uint8_t*);
|
||||
|
||||
// Get temperature for device index (slow)
|
||||
float getTempCByIndex(uint8_t);
|
||||
|
||||
// Get temperature for device index (slow)
|
||||
float getTempFByIndex(uint8_t);
|
||||
|
||||
// returns true if the bus requires parasite power
|
||||
bool isParasitePowerMode(void);
|
||||
|
||||
bool isConversionAvailable(const uint8_t*);
|
||||
|
||||
#if REQUIRESALARMS
|
||||
|
||||
typedef void AlarmHandler(const uint8_t*);
|
||||
|
||||
// sets the high alarm temperature for a device
|
||||
// accepts a char. valid range is -55C - 125C
|
||||
void setHighAlarmTemp(const uint8_t*, char);
|
||||
|
||||
// sets the low alarm temperature for a device
|
||||
// accepts a char. valid range is -55C - 125C
|
||||
void setLowAlarmTemp(const uint8_t*, char);
|
||||
|
||||
// returns a signed char with the current high alarm temperature for a device
|
||||
// in the range -55C - 125C
|
||||
char getHighAlarmTemp(const uint8_t*);
|
||||
|
||||
// returns a signed char with the current low alarm temperature for a device
|
||||
// in the range -55C - 125C
|
||||
char getLowAlarmTemp(const uint8_t*);
|
||||
|
||||
// resets internal variables used for the alarm search
|
||||
void resetAlarmSearch(void);
|
||||
|
||||
// search the wire for devices with active alarms
|
||||
bool alarmSearch(uint8_t*);
|
||||
|
||||
// returns true if ia specific device has an alarm
|
||||
bool hasAlarm(const uint8_t*);
|
||||
|
||||
// returns true if any device is reporting an alarm on the bus
|
||||
bool hasAlarm(void);
|
||||
|
||||
// runs the alarm handler for all devices returned by alarmSearch()
|
||||
void processAlarms(void);
|
||||
|
||||
// sets the alarm handler
|
||||
void setAlarmHandler(const AlarmHandler *);
|
||||
|
||||
// The default alarm handler
|
||||
static void defaultAlarmHandler(const uint8_t*);
|
||||
|
||||
#endif
|
||||
|
||||
// convert from Celsius to Fahrenheit
|
||||
static float toFahrenheit(float);
|
||||
|
||||
// convert from Fahrenheit to Celsius
|
||||
static float toCelsius(float);
|
||||
|
||||
// convert from raw to Celsius
|
||||
static float rawToCelsius(int16_t);
|
||||
|
||||
// convert from raw to Fahrenheit
|
||||
static float rawToFahrenheit(int16_t);
|
||||
|
||||
#if REQUIRESNEW
|
||||
|
||||
// initialize memory area
|
||||
void* operator new (unsigned int);
|
||||
|
||||
// delete memory reference
|
||||
void operator delete(void*);
|
||||
|
||||
#endif
|
||||
|
||||
private:
|
||||
typedef uint8_t ScratchPad[9];
|
||||
|
||||
// parasite power on or off
|
||||
bool parasite;
|
||||
|
||||
// used to determine the delay amount needed to allow for the
|
||||
// temperature conversion to take place
|
||||
uint8_t bitResolution;
|
||||
|
||||
// used to requestTemperature with or without delay
|
||||
bool waitForConversion;
|
||||
|
||||
// used to requestTemperature to dynamically check if a conversion is complete
|
||||
bool checkForConversion;
|
||||
|
||||
// count of devices on the bus
|
||||
uint8_t devices;
|
||||
|
||||
// Take a pointer to one wire instance
|
||||
OneWire* _wire;
|
||||
|
||||
// reads scratchpad and returns the raw temperature
|
||||
int16_t calculateTemperature(const uint8_t*, uint8_t*);
|
||||
|
||||
void blockTillConversionComplete(uint8_t, const uint8_t*);
|
||||
|
||||
#if REQUIRESALARMS
|
||||
|
||||
// required for alarmSearch
|
||||
uint8_t alarmSearchAddress[8];
|
||||
char alarmSearchJunction;
|
||||
uint8_t alarmSearchExhausted;
|
||||
|
||||
// the alarm handler function pointer
|
||||
AlarmHandler *_AlarmHandler;
|
||||
|
||||
#endif
|
||||
|
||||
};
|
||||
#endif
|
||||
@@ -1,68 +0,0 @@
|
||||
Arduino Library for Dallas Temperature ICs
|
||||
==========================================
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
This library supports the following devices :
|
||||
|
||||
|
||||
* DS18B20
|
||||
* DS18S20 - Please note there appears to be an issue with this series.
|
||||
* DS1822
|
||||
* DS1820
|
||||
|
||||
|
||||
You will need a pull-up resistor of about 5 KOhm between the 1-Wire data line
|
||||
and your 5V power. If you are using the DS18B20, ground pins 1 and 3. The
|
||||
centre pin is the data line '1-wire'.
|
||||
|
||||
We have included a "REQUIRESNEW" and "REQUIRESALARMS" definition. If you
|
||||
want to slim down the code feel free to use either of these by including
|
||||
|
||||
|
||||
|
||||
#define REQUIRESNEW
|
||||
|
||||
or
|
||||
|
||||
#define REQUIRESALARMS
|
||||
|
||||
|
||||
at the top of DallasTemperature.h
|
||||
|
||||
|
||||
Credits
|
||||
-------
|
||||
|
||||
The OneWire code has been derived from
|
||||
http://www.arduino.cc/playground/Learning/OneWire.
|
||||
Miles Burton <miles@mnetcs.com> originally developed this library.
|
||||
Tim Newsome <nuisance@casualhacker.net> added support for multiple sensors on
|
||||
the same bus.
|
||||
Guil Barros [gfbarros@bappos.com] added getTempByAddress (v3.5)
|
||||
Rob Tillaart [rob.tillaart@gmail.com] added async modus (v3.7.0)
|
||||
|
||||
|
||||
Website
|
||||
-------
|
||||
|
||||
You can find the latest version of the library at
|
||||
http://milesburton.com/index.php?title=Dallas_Temperature_Control_Library
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
This library is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU Lesser General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2.1 of the License, or (at your option) any later version.
|
||||
|
||||
This library 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
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
@@ -1,85 +0,0 @@
|
||||
|
||||
This file contains the change history of the Dallas Temperature Control Library.
|
||||
|
||||
VERSION 3.7.2 BETA
|
||||
===================
|
||||
DATE: 6 DEC 2011
|
||||
|
||||
- Jordan Hochenbaum [jhochenbaum@gmail.com] updated library for compatibility with Arduino 1.0.
|
||||
|
||||
VERSION 3.7.0 BETA
|
||||
===================
|
||||
DATE: 11 JAN 2011
|
||||
|
||||
- Rob Tillaart [rob.tillaart@gmail.com] added async modus (v3.7.0)
|
||||
The library is backwards compatible with version 3.6.0
|
||||
|
||||
MAJOR: async modus
|
||||
------------------
|
||||
- Added - private bool waitForConversion.
|
||||
This boolean is default set to true in the Constructor to keep the library backwards compatible. If this flag is true calls to requestTemperatures(), requestTemperaturesByAddress() et al, will be blocking with the appropiate time specified (in datasheet) for the resolution used. If the flag is set to false, requestTemperatures() et al, will return immediately after the conversion command is send over the 1-wire interface. The programmer is responsible to wait long enough before reading the temperature values. This enables the application to do other things while waiting for a new reading, like calculations, update LCD, read/write other IO lines etc. See examples.
|
||||
|
||||
- Added - void setWaitForConversion(bool);
|
||||
To set the flag to true or false, depending on the modus needed.
|
||||
|
||||
- Added - bool getWaitForConversion(void);
|
||||
To get the current value of the flag.
|
||||
|
||||
- Changed - void requestTemperatures(void);
|
||||
Added a test (false == waitForConversion) to return immediately after the conversion command instead of waiting until the conversion is ready.
|
||||
|
||||
- Changed - bool requestTemperaturesByAddress(uint8_t*);
|
||||
Added a test (false == waitForConversion) to return immediately after the conversion command instead of waiting until the conversion is ready.
|
||||
|
||||
|
||||
MINOR version number
|
||||
--------------------
|
||||
- Added - #define DALLASTEMPLIBVERSION "3.7.0"
|
||||
To indicate the version number in .h file
|
||||
|
||||
|
||||
MINOR internal var bitResolution
|
||||
----------------------------
|
||||
- Changed - private int conversionDelay - is renamed to - private int bitResolution
|
||||
As this variable holds the resolution. The delay for the conversion is derived from it.
|
||||
|
||||
- Changed - uint8_t getResolution(uint8_t* deviceAddress);
|
||||
If the device is not connected, it returns 0, otherwise it returns the resolution of the device.
|
||||
|
||||
- Changed - bool setResolution(uint8_t* deviceAddress, uint8_t newResolution);
|
||||
If the device is not connected, it returns FALSE (fail), otherwise it returns TRUE (succes).
|
||||
|
||||
- Added - uint8_t getResolution();
|
||||
Returns bitResolution.
|
||||
|
||||
- Added - void setResolution(uint8_t newResolution)
|
||||
Sets the internal variable bitResolution, and all devices to this value
|
||||
|
||||
|
||||
MINOR check connected state
|
||||
----------------------------
|
||||
- Changed - bool requestTemperaturesByIndex(deviceIndex)
|
||||
Changed return type from void to bool. The function returns false if the device identified with [deviceIndex] is not found on the bus and true otherwise.
|
||||
|
||||
- Changed - bool requestTemperaturesByAddress(deviceAddress)
|
||||
Changed return type from void to bool. The function returns false if the device identified with [deviceAddress] is not found on the bus and true otherwise.
|
||||
Added code to handle the DS18S20 which has a 9 bit resolution separately.
|
||||
Changed code so the blocking delay matches the bitResolution set in the device with deviceAddress.
|
||||
|
||||
- Changed - bool requestTemperaturesByIndex(uint8_t deviceIndex)
|
||||
Changed return type from void to bool. The function returns false if the device identified with [deviceIndex] is not found on the bus and true otherwise.
|
||||
|
||||
|
||||
|
||||
VERSION 3.6.0
|
||||
==============
|
||||
DATE: 2010-10-10
|
||||
|
||||
- no detailed change history known except:
|
||||
|
||||
- The OneWire code has been derived from
|
||||
http://www.arduino.cc/playground/Learning/OneWire.
|
||||
- Miles Burton <miles@mnetcs.com> originally developed this library.
|
||||
- Tim Newsome <nuisance@casualhacker.net> added support for multiple sensors on
|
||||
the same bus.
|
||||
- Guil Barros [gfbarros@bappos.com] added getTempByAddress (v3.5)
|
||||
@@ -1,162 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
// arrays to hold device addresses
|
||||
DeviceAddress insideThermometer, outsideThermometer;
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
|
||||
// locate devices on the bus
|
||||
Serial.print("Found ");
|
||||
Serial.print(sensors.getDeviceCount(), DEC);
|
||||
Serial.println(" devices.");
|
||||
|
||||
// search for devices on the bus and assign based on an index.
|
||||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0");
|
||||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1");
|
||||
|
||||
// show the addresses we found on the bus
|
||||
Serial.print("Device 0 Address: ");
|
||||
printAddress(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device 0 Alarms: ");
|
||||
printAlarms(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device 1 Address: ");
|
||||
printAddress(outsideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device 1 Alarms: ");
|
||||
printAlarms(outsideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.println("Setting alarm temps...");
|
||||
|
||||
// alarm when temp is higher than 30C
|
||||
sensors.setHighAlarmTemp(insideThermometer, 30);
|
||||
|
||||
// alarm when temp is lower than -10C
|
||||
sensors.setLowAlarmTemp(insideThermometer, -10);
|
||||
|
||||
// alarm when temp is higher than 31C
|
||||
sensors.setHighAlarmTemp(outsideThermometer, 31);
|
||||
|
||||
// alarn when temp is lower than 27C
|
||||
sensors.setLowAlarmTemp(outsideThermometer, 27);
|
||||
|
||||
Serial.print("New Device 0 Alarms: ");
|
||||
printAlarms(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("New Device 1 Alarms: ");
|
||||
printAlarms(outsideThermometer);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
// function to print a device address
|
||||
void printAddress(DeviceAddress deviceAddress)
|
||||
{
|
||||
for (uint8_t i = 0; i < 8; i++)
|
||||
{
|
||||
if (deviceAddress[i] < 16) Serial.print("0");
|
||||
Serial.print(deviceAddress[i], HEX);
|
||||
}
|
||||
}
|
||||
|
||||
// function to print the temperature for a device
|
||||
void printTemperature(DeviceAddress deviceAddress)
|
||||
{
|
||||
float tempC = sensors.getTempC(deviceAddress);
|
||||
Serial.print("Temp C: ");
|
||||
Serial.print(tempC);
|
||||
Serial.print(" Temp F: ");
|
||||
Serial.print(DallasTemperature::toFahrenheit(tempC));
|
||||
}
|
||||
|
||||
void printAlarms(uint8_t deviceAddress[])
|
||||
{
|
||||
char temp;
|
||||
temp = sensors.getHighAlarmTemp(deviceAddress);
|
||||
Serial.print("High Alarm: ");
|
||||
Serial.print(temp, DEC);
|
||||
Serial.print("C/");
|
||||
Serial.print(DallasTemperature::toFahrenheit(temp));
|
||||
Serial.print("F | Low Alarm: ");
|
||||
temp = sensors.getLowAlarmTemp(deviceAddress);
|
||||
Serial.print(temp, DEC);
|
||||
Serial.print("C/");
|
||||
Serial.print(DallasTemperature::toFahrenheit(temp));
|
||||
Serial.print("F");
|
||||
}
|
||||
|
||||
// main function to print information about a device
|
||||
void printData(DeviceAddress deviceAddress)
|
||||
{
|
||||
Serial.print("Device Address: ");
|
||||
printAddress(deviceAddress);
|
||||
Serial.print(" ");
|
||||
printTemperature(deviceAddress);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
void checkAlarm(DeviceAddress deviceAddress)
|
||||
{
|
||||
if (sensors.hasAlarm(deviceAddress))
|
||||
{
|
||||
Serial.print("ALARM: ");
|
||||
printData(deviceAddress);
|
||||
}
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// call sensors.requestTemperatures() to issue a global temperature
|
||||
// request to all devices on the bus
|
||||
Serial.print("Requesting temperatures...");
|
||||
sensors.requestTemperatures();
|
||||
Serial.println("DONE");
|
||||
|
||||
// Method 1:
|
||||
// check each address individually for an alarm condition
|
||||
checkAlarm(insideThermometer);
|
||||
checkAlarm(outsideThermometer);
|
||||
/*
|
||||
// Alternate method:
|
||||
// Search the bus and iterate through addresses of devices with alarms
|
||||
|
||||
// space for the alarm device's address
|
||||
DeviceAddress alarmAddr;
|
||||
|
||||
Serial.println("Searching for alarms...");
|
||||
|
||||
// resetAlarmSearch() must be called before calling alarmSearch()
|
||||
sensors.resetAlarmSearch();
|
||||
|
||||
// alarmSearch() returns 0 when there are no devices with alarms
|
||||
while (sensors.alarmSearch(alarmAddr))
|
||||
{
|
||||
Serial.print("ALARM: ");
|
||||
printData(alarmAddr);
|
||||
}
|
||||
*/
|
||||
|
||||
}
|
||||
|
||||
@@ -1,144 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
// arrays to hold device addresses
|
||||
DeviceAddress insideThermometer, outsideThermometer;
|
||||
|
||||
// function that will be called when an alarm condition exists during DallasTemperatures::processAlarms();
|
||||
void newAlarmHandler(uint8_t* deviceAddress)
|
||||
{
|
||||
Serial.println("Alarm Handler Start");
|
||||
printAlarmInfo(deviceAddress);
|
||||
printTemp(deviceAddress);
|
||||
Serial.println();
|
||||
Serial.println("Alarm Handler Finish");
|
||||
}
|
||||
|
||||
void printCurrentTemp(DeviceAddress deviceAddress)
|
||||
{
|
||||
printAddress(deviceAddress);
|
||||
printTemp(deviceAddress);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
void printAddress(DeviceAddress deviceAddress)
|
||||
{
|
||||
Serial.print("Address: ");
|
||||
for (uint8_t i = 0; i < 8; i++)
|
||||
{
|
||||
if (deviceAddress[i] < 16) Serial.print("0");
|
||||
Serial.print(deviceAddress[i], HEX);
|
||||
}
|
||||
Serial.print(" ");
|
||||
}
|
||||
|
||||
void printTemp(DeviceAddress deviceAddress)
|
||||
{
|
||||
float tempC = sensors.getTempC(deviceAddress);
|
||||
if (tempC != DEVICE_DISCONNECTED)
|
||||
{
|
||||
Serial.print("Current Temp C: ");
|
||||
Serial.print(tempC);
|
||||
}
|
||||
else Serial.print("DEVICE DISCONNECTED");
|
||||
Serial.print(" ");
|
||||
}
|
||||
|
||||
void printAlarmInfo(DeviceAddress deviceAddress)
|
||||
{
|
||||
char temp;
|
||||
printAddress(deviceAddress);
|
||||
temp = sensors.getHighAlarmTemp(deviceAddress);
|
||||
Serial.print("High Alarm: ");
|
||||
Serial.print(temp, DEC);
|
||||
Serial.print("C");
|
||||
Serial.print(" Low Alarm: ");
|
||||
temp = sensors.getLowAlarmTemp(deviceAddress);
|
||||
Serial.print(temp, DEC);
|
||||
Serial.print("C");
|
||||
Serial.print(" ");
|
||||
}
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
|
||||
// locate devices on the bus
|
||||
Serial.print("Found ");
|
||||
Serial.print(sensors.getDeviceCount(), DEC);
|
||||
Serial.println(" devices.");
|
||||
|
||||
// search for devices on the bus and assign based on an index
|
||||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0");
|
||||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1");
|
||||
|
||||
Serial.print("Device insideThermometer ");
|
||||
printAlarmInfo(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device outsideThermometer ");
|
||||
printAlarmInfo(outsideThermometer);
|
||||
Serial.println();
|
||||
|
||||
// set alarm ranges
|
||||
Serial.println("Setting alarm temps...");
|
||||
sensors.setHighAlarmTemp(insideThermometer, 26);
|
||||
sensors.setLowAlarmTemp(insideThermometer, 22);
|
||||
sensors.setHighAlarmTemp(outsideThermometer, 25);
|
||||
sensors.setLowAlarmTemp(outsideThermometer, 21);
|
||||
|
||||
Serial.print("New insideThermometer ");
|
||||
printAlarmInfo(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("New outsideThermometer ");
|
||||
printAlarmInfo(outsideThermometer);
|
||||
Serial.println();
|
||||
|
||||
// attach alarm handler
|
||||
sensors.setAlarmHandler(&newAlarmHandler);
|
||||
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// ask the devices to measure the temperature
|
||||
sensors.requestTemperatures();
|
||||
|
||||
// if an alarm condition exists as a result of the most recent
|
||||
// requestTemperatures() request, it exists until the next time
|
||||
// requestTemperatures() is called AND there isn't an alarm condition
|
||||
// on the device
|
||||
if (sensors.hasAlarm())
|
||||
{
|
||||
Serial.println("Oh noes! There is at least one alarm on the bus.");
|
||||
}
|
||||
|
||||
// call alarm handler function defined by sensors.setAlarmHandler
|
||||
// for each device reporting an alarm
|
||||
sensors.processAlarms();
|
||||
|
||||
if (!sensors.hasAlarm())
|
||||
{
|
||||
// just print out the current temperature
|
||||
printCurrentTemp(insideThermometer);
|
||||
printCurrentTemp(outsideThermometer);
|
||||
}
|
||||
|
||||
delay(1000);
|
||||
}
|
||||
|
||||
@@ -1,140 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
#define TEMPERATURE_PRECISION 9
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
// arrays to hold device addresses
|
||||
DeviceAddress insideThermometer, outsideThermometer;
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
|
||||
// locate devices on the bus
|
||||
Serial.print("Locating devices...");
|
||||
Serial.print("Found ");
|
||||
Serial.print(sensors.getDeviceCount(), DEC);
|
||||
Serial.println(" devices.");
|
||||
|
||||
// report parasite power requirements
|
||||
Serial.print("Parasite power is: ");
|
||||
if (sensors.isParasitePowerMode()) Serial.println("ON");
|
||||
else Serial.println("OFF");
|
||||
|
||||
// assign address manually. the addresses below will beed to be changed
|
||||
// to valid device addresses on your bus. device address can be retrieved
|
||||
// by using either oneWire.search(deviceAddress) or individually via
|
||||
// sensors.getAddress(deviceAddress, index)
|
||||
//insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 };
|
||||
//outsideThermometer = { 0x28, 0x3F, 0x1C, 0x31, 0x2, 0x0, 0x0, 0x2 };
|
||||
|
||||
// search for devices on the bus and assign based on an index. ideally,
|
||||
// you would do this to initially discover addresses on the bus and then
|
||||
// use those addresses and manually assign them (see above) once you know
|
||||
// the devices on your bus (and assuming they don't change).
|
||||
//
|
||||
// method 1: by index
|
||||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0");
|
||||
if (!sensors.getAddress(outsideThermometer, 1)) Serial.println("Unable to find address for Device 1");
|
||||
|
||||
// method 2: search()
|
||||
// search() looks for the next device. Returns 1 if a new address has been
|
||||
// returned. A zero might mean that the bus is shorted, there are no devices,
|
||||
// or you have already retrieved all of them. It might be a good idea to
|
||||
// check the CRC to make sure you didn't get garbage. The order is
|
||||
// deterministic. You will always get the same devices in the same order
|
||||
//
|
||||
// Must be called before search()
|
||||
//oneWire.reset_search();
|
||||
// assigns the first address found to insideThermometer
|
||||
//if (!oneWire.search(insideThermometer)) Serial.println("Unable to find address for insideThermometer");
|
||||
// assigns the seconds address found to outsideThermometer
|
||||
//if (!oneWire.search(outsideThermometer)) Serial.println("Unable to find address for outsideThermometer");
|
||||
|
||||
// show the addresses we found on the bus
|
||||
Serial.print("Device 0 Address: ");
|
||||
printAddress(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device 1 Address: ");
|
||||
printAddress(outsideThermometer);
|
||||
Serial.println();
|
||||
|
||||
// set the resolution to 9 bit
|
||||
sensors.setResolution(insideThermometer, TEMPERATURE_PRECISION);
|
||||
sensors.setResolution(outsideThermometer, TEMPERATURE_PRECISION);
|
||||
|
||||
Serial.print("Device 0 Resolution: ");
|
||||
Serial.print(sensors.getResolution(insideThermometer), DEC);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Device 1 Resolution: ");
|
||||
Serial.print(sensors.getResolution(outsideThermometer), DEC);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
// function to print a device address
|
||||
void printAddress(DeviceAddress deviceAddress)
|
||||
{
|
||||
for (uint8_t i = 0; i < 8; i++)
|
||||
{
|
||||
// zero pad the address if necessary
|
||||
if (deviceAddress[i] < 16) Serial.print("0");
|
||||
Serial.print(deviceAddress[i], HEX);
|
||||
}
|
||||
}
|
||||
|
||||
// function to print the temperature for a device
|
||||
void printTemperature(DeviceAddress deviceAddress)
|
||||
{
|
||||
float tempC = sensors.getTempC(deviceAddress);
|
||||
Serial.print("Temp C: ");
|
||||
Serial.print(tempC);
|
||||
Serial.print(" Temp F: ");
|
||||
Serial.print(DallasTemperature::toFahrenheit(tempC));
|
||||
}
|
||||
|
||||
// function to print a device's resolution
|
||||
void printResolution(DeviceAddress deviceAddress)
|
||||
{
|
||||
Serial.print("Resolution: ");
|
||||
Serial.print(sensors.getResolution(deviceAddress));
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
// main function to print information about a device
|
||||
void printData(DeviceAddress deviceAddress)
|
||||
{
|
||||
Serial.print("Device Address: ");
|
||||
printAddress(deviceAddress);
|
||||
Serial.print(" ");
|
||||
printTemperature(deviceAddress);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// call sensors.requestTemperatures() to issue a global temperature
|
||||
// request to all devices on the bus
|
||||
Serial.print("Requesting temperatures...");
|
||||
sensors.requestTemperatures();
|
||||
Serial.println("DONE");
|
||||
|
||||
// print the device information
|
||||
printData(insideThermometer);
|
||||
printData(outsideThermometer);
|
||||
}
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// call sensors.requestTemperatures() to issue a global temperature
|
||||
// request to all devices on the bus
|
||||
Serial.print("Requesting temperatures...");
|
||||
sensors.requestTemperatures(); // Send the command to get temperatures
|
||||
Serial.println("DONE");
|
||||
|
||||
Serial.print("Temperature for the device 1 (index 0) is: ");
|
||||
Serial.println(sensors.getTempCByIndex(0));
|
||||
}
|
||||
@@ -1,109 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
// arrays to hold device address
|
||||
DeviceAddress insideThermometer;
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// locate devices on the bus
|
||||
Serial.print("Locating devices...");
|
||||
sensors.begin();
|
||||
Serial.print("Found ");
|
||||
Serial.print(sensors.getDeviceCount(), DEC);
|
||||
Serial.println(" devices.");
|
||||
|
||||
// report parasite power requirements
|
||||
Serial.print("Parasite power is: ");
|
||||
if (sensors.isParasitePowerMode()) Serial.println("ON");
|
||||
else Serial.println("OFF");
|
||||
|
||||
// assign address manually. the addresses below will beed to be changed
|
||||
// to valid device addresses on your bus. device address can be retrieved
|
||||
// by using either oneWire.search(deviceAddress) or individually via
|
||||
// sensors.getAddress(deviceAddress, index)
|
||||
//insideThermometer = { 0x28, 0x1D, 0x39, 0x31, 0x2, 0x0, 0x0, 0xF0 };
|
||||
|
||||
// Method 1:
|
||||
// search for devices on the bus and assign based on an index. ideally,
|
||||
// you would do this to initially discover addresses on the bus and then
|
||||
// use those addresses and manually assign them (see above) once you know
|
||||
// the devices on your bus (and assuming they don't change).
|
||||
if (!sensors.getAddress(insideThermometer, 0)) Serial.println("Unable to find address for Device 0");
|
||||
|
||||
// method 2: search()
|
||||
// search() looks for the next device. Returns 1 if a new address has been
|
||||
// returned. A zero might mean that the bus is shorted, there are no devices,
|
||||
// or you have already retrieved all of them. It might be a good idea to
|
||||
// check the CRC to make sure you didn't get garbage. The order is
|
||||
// deterministic. You will always get the same devices in the same order
|
||||
//
|
||||
// Must be called before search()
|
||||
//oneWire.reset_search();
|
||||
// assigns the first address found to insideThermometer
|
||||
//if (!oneWire.search(insideThermometer)) Serial.println("Unable to find address for insideThermometer");
|
||||
|
||||
// show the addresses we found on the bus
|
||||
Serial.print("Device 0 Address: ");
|
||||
printAddress(insideThermometer);
|
||||
Serial.println();
|
||||
|
||||
// set the resolution to 9 bit (Each Dallas/Maxim device is capable of several different resolutions)
|
||||
sensors.setResolution(insideThermometer, 9);
|
||||
|
||||
Serial.print("Device 0 Resolution: ");
|
||||
Serial.print(sensors.getResolution(insideThermometer), DEC);
|
||||
Serial.println();
|
||||
}
|
||||
|
||||
// function to print the temperature for a device
|
||||
void printTemperature(DeviceAddress deviceAddress)
|
||||
{
|
||||
// method 1 - slower
|
||||
//Serial.print("Temp C: ");
|
||||
//Serial.print(sensors.getTempC(deviceAddress));
|
||||
//Serial.print(" Temp F: ");
|
||||
//Serial.print(sensors.getTempF(deviceAddress)); // Makes a second call to getTempC and then converts to Fahrenheit
|
||||
|
||||
// method 2 - faster
|
||||
float tempC = sensors.getTempC(deviceAddress);
|
||||
Serial.print("Temp C: ");
|
||||
Serial.print(tempC);
|
||||
Serial.print(" Temp F: ");
|
||||
Serial.println(DallasTemperature::toFahrenheit(tempC)); // Converts tempC to Fahrenheit
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// call sensors.requestTemperatures() to issue a global temperature
|
||||
// request to all devices on the bus
|
||||
Serial.print("Requesting temperatures...");
|
||||
sensors.requestTemperatures(); // Send the command to get temperatures
|
||||
Serial.println("DONE");
|
||||
|
||||
// It responds almost immediately. Let's print out the data
|
||||
printTemperature(insideThermometer); // Use a simple function to print out the data
|
||||
}
|
||||
|
||||
// function to print a device address
|
||||
void printAddress(DeviceAddress deviceAddress)
|
||||
{
|
||||
for (uint8_t i = 0; i < 8; i++)
|
||||
{
|
||||
if (deviceAddress[i] < 16) Serial.print("0");
|
||||
Serial.print(deviceAddress[i], HEX);
|
||||
}
|
||||
}
|
||||
@@ -1,124 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
#define TEMPERATURE_PRECISION 9
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
int numberOfDevices; // Number of temperature devices found
|
||||
|
||||
DeviceAddress tempDeviceAddress; // We'll use this variable to store a found device address
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(9600);
|
||||
Serial.println("Dallas Temperature IC Control Library Demo");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
|
||||
// Grab a count of devices on the wire
|
||||
numberOfDevices = sensors.getDeviceCount();
|
||||
|
||||
// locate devices on the bus
|
||||
Serial.print("Locating devices...");
|
||||
|
||||
Serial.print("Found ");
|
||||
Serial.print(numberOfDevices, DEC);
|
||||
Serial.println(" devices.");
|
||||
|
||||
// report parasite power requirements
|
||||
Serial.print("Parasite power is: ");
|
||||
if (sensors.isParasitePowerMode()) Serial.println("ON");
|
||||
else Serial.println("OFF");
|
||||
|
||||
// Loop through each device, print out address
|
||||
for(int i=0;i<numberOfDevices; i++)
|
||||
{
|
||||
// Search the wire for address
|
||||
if(sensors.getAddress(tempDeviceAddress, i))
|
||||
{
|
||||
Serial.print("Found device ");
|
||||
Serial.print(i, DEC);
|
||||
Serial.print(" with address: ");
|
||||
printAddress(tempDeviceAddress);
|
||||
Serial.println();
|
||||
|
||||
Serial.print("Setting resolution to ");
|
||||
Serial.println(TEMPERATURE_PRECISION, DEC);
|
||||
|
||||
// set the resolution to TEMPERATURE_PRECISION bit (Each Dallas/Maxim device is capable of several different resolutions)
|
||||
sensors.setResolution(tempDeviceAddress, TEMPERATURE_PRECISION);
|
||||
|
||||
Serial.print("Resolution actually set to: ");
|
||||
Serial.print(sensors.getResolution(tempDeviceAddress), DEC);
|
||||
Serial.println();
|
||||
}else{
|
||||
Serial.print("Found ghost device at ");
|
||||
Serial.print(i, DEC);
|
||||
Serial.print(" but could not detect address. Check power and cabling");
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// function to print the temperature for a device
|
||||
void printTemperature(DeviceAddress deviceAddress)
|
||||
{
|
||||
// method 1 - slower
|
||||
//Serial.print("Temp C: ");
|
||||
//Serial.print(sensors.getTempC(deviceAddress));
|
||||
//Serial.print(" Temp F: ");
|
||||
//Serial.print(sensors.getTempF(deviceAddress)); // Makes a second call to getTempC and then converts to Fahrenheit
|
||||
|
||||
// method 2 - faster
|
||||
float tempC = sensors.getTempC(deviceAddress);
|
||||
Serial.print("Temp C: ");
|
||||
Serial.print(tempC);
|
||||
Serial.print(" Temp F: ");
|
||||
Serial.println(DallasTemperature::toFahrenheit(tempC)); // Converts tempC to Fahrenheit
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// call sensors.requestTemperatures() to issue a global temperature
|
||||
// request to all devices on the bus
|
||||
Serial.print("Requesting temperatures...");
|
||||
sensors.requestTemperatures(); // Send the command to get temperatures
|
||||
Serial.println("DONE");
|
||||
|
||||
|
||||
// Loop through each device, print out temperature data
|
||||
for(int i=0;i<numberOfDevices; i++)
|
||||
{
|
||||
// Search the wire for address
|
||||
if(sensors.getAddress(tempDeviceAddress, i))
|
||||
{
|
||||
// Output the device ID
|
||||
Serial.print("Temperature for device: ");
|
||||
Serial.println(i,DEC);
|
||||
|
||||
// It responds almost immediately. Let's print out the data
|
||||
printTemperature(tempDeviceAddress); // Use a simple function to print out the data
|
||||
}
|
||||
//else ghost device! Check your power requirements and cabling
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
// function to print a device address
|
||||
void printAddress(DeviceAddress deviceAddress)
|
||||
{
|
||||
for (uint8_t i = 0; i < 8; i++)
|
||||
{
|
||||
if (deviceAddress[i] < 16) Serial.print("0");
|
||||
Serial.print(deviceAddress[i], HEX);
|
||||
}
|
||||
}
|
||||
@@ -1,66 +0,0 @@
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
void setup(void)
|
||||
{
|
||||
// start serial port
|
||||
Serial.begin(115200);
|
||||
Serial.println("Dallas Temperature Control Library - Async Demo");
|
||||
Serial.println("\nDemo shows the difference in length of the call\n\n");
|
||||
|
||||
// Start up the library
|
||||
sensors.begin();
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
// Request temperature conversion (traditional)
|
||||
Serial.println("Before blocking requestForConversion");
|
||||
unsigned long start = millis();
|
||||
|
||||
sensors.requestTemperatures();
|
||||
|
||||
unsigned long stop = millis();
|
||||
Serial.println("After blocking requestForConversion");
|
||||
Serial.print("Time used: ");
|
||||
Serial.println(stop - start);
|
||||
|
||||
// get temperature
|
||||
Serial.print("Temperature: ");
|
||||
Serial.println(sensors.getTempCByIndex(0));
|
||||
Serial.println("\n");
|
||||
|
||||
// Request temperature conversion - non-blocking / async
|
||||
Serial.println("Before NON-blocking/async requestForConversion");
|
||||
start = millis();
|
||||
sensors.setWaitForConversion(false); // makes it async
|
||||
sensors.requestTemperatures();
|
||||
sensors.setWaitForConversion(true);
|
||||
stop = millis();
|
||||
Serial.println("After NON-blocking/async requestForConversion");
|
||||
Serial.print("Time used: ");
|
||||
Serial.println(stop - start);
|
||||
|
||||
|
||||
// 9 bit resolution by default
|
||||
// Note the programmer is responsible for the right delay
|
||||
// we could do something usefull here instead of the delay
|
||||
int resolution = 9;
|
||||
delay(750/ (1 << (12-resolution)));
|
||||
|
||||
// get temperature
|
||||
Serial.print("Temperature: ");
|
||||
Serial.println(sensors.getTempCByIndex(0));
|
||||
Serial.println("\n\n\n\n");
|
||||
|
||||
delay(5000);
|
||||
}
|
||||
@@ -1,80 +0,0 @@
|
||||
//
|
||||
// Sample of using Async reading of Dallas Temperature Sensors
|
||||
//
|
||||
#include <OneWire.h>
|
||||
#include <DallasTemperature.h>
|
||||
|
||||
// Data wire is plugged into port 2 on the Arduino
|
||||
#define ONE_WIRE_BUS 2
|
||||
|
||||
// Setup a oneWire instance to communicate with any OneWire devices (not just Maxim/Dallas temperature ICs)
|
||||
OneWire oneWire(ONE_WIRE_BUS);
|
||||
|
||||
// Pass our oneWire reference to Dallas Temperature.
|
||||
DallasTemperature sensors(&oneWire);
|
||||
|
||||
DeviceAddress tempDeviceAddress;
|
||||
|
||||
int resolution = 12;
|
||||
unsigned long lastTempRequest = 0;
|
||||
int delayInMillis = 0;
|
||||
float temperature = 0.0;
|
||||
int idle = 0;
|
||||
//
|
||||
// SETUP
|
||||
//
|
||||
void setup(void)
|
||||
{
|
||||
Serial.begin(115200);
|
||||
Serial.println("Dallas Temperature Control Library - Async Demo");
|
||||
Serial.print("Library Version: ");
|
||||
Serial.println(DALLASTEMPLIBVERSION);
|
||||
Serial.println("\n");
|
||||
|
||||
sensors.begin();
|
||||
sensors.getAddress(tempDeviceAddress, 0);
|
||||
sensors.setResolution(tempDeviceAddress, resolution);
|
||||
|
||||
sensors.setWaitForConversion(false);
|
||||
sensors.requestTemperatures();
|
||||
delayInMillis = 750 / (1 << (12 - resolution));
|
||||
lastTempRequest = millis();
|
||||
|
||||
pinMode(13, OUTPUT);
|
||||
}
|
||||
|
||||
void loop(void)
|
||||
{
|
||||
|
||||
if (millis() - lastTempRequest >= delayInMillis) // waited long enough??
|
||||
{
|
||||
digitalWrite(13, LOW);
|
||||
Serial.print(" Temperature: ");
|
||||
temperature = sensors.getTempCByIndex(0);
|
||||
Serial.println(temperature, resolution - 8);
|
||||
Serial.print(" Resolution: ");
|
||||
Serial.println(resolution);
|
||||
Serial.print("Idle counter: ");
|
||||
Serial.println(idle);
|
||||
Serial.println();
|
||||
|
||||
idle = 0;
|
||||
|
||||
// immediately after fetching the temperature we request a new sample
|
||||
// in the async modus
|
||||
// for the demo we let the resolution change to show differences
|
||||
resolution++;
|
||||
if (resolution > 12) resolution = 9;
|
||||
|
||||
sensors.setResolution(tempDeviceAddress, resolution);
|
||||
sensors.requestTemperatures();
|
||||
delayInMillis = 750 / (1 << (12 - resolution));
|
||||
lastTempRequest = millis();
|
||||
}
|
||||
|
||||
digitalWrite(13, HIGH);
|
||||
// we can do usefull things here
|
||||
// for the demo we just count the idle time in millis
|
||||
delay(1);
|
||||
idle++;
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
#######################################
|
||||
# Syntax Coloring Map For Ultrasound
|
||||
#######################################
|
||||
|
||||
#######################################
|
||||
# Datatypes (KEYWORD1)
|
||||
#######################################
|
||||
DallasTemperature KEYWORD1
|
||||
OneWire KEYWORD1
|
||||
AlarmHandler KEYWORD1
|
||||
DeviceAddress KEYWORD1
|
||||
|
||||
#######################################
|
||||
# Methods and Functions (KEYWORD2)
|
||||
#######################################
|
||||
|
||||
setResolution KEYWORD2
|
||||
getResolution KEYWORD2
|
||||
getTempC KEYWORD2
|
||||
toFahrenheit KEYWORD2
|
||||
getTempF KEYWORD2
|
||||
getTempCByIndex KEYWORD2
|
||||
getTempFByIndex KEYWORD2
|
||||
setWaitForConversion KEYWORD2
|
||||
getWaitForConversion KEYWORD2
|
||||
requestTemperatures KEYWORD2
|
||||
requestTemperaturesByAddress KEYWORD2
|
||||
requestTemperaturesByIndex KEYWORD2
|
||||
isParasitePowerMode KEYWORD2
|
||||
begin KEYWORD2
|
||||
getDeviceCount KEYWORD2
|
||||
getAddress KEYWORD2
|
||||
validAddress KEYWORD2
|
||||
isConnected KEYWORD2
|
||||
readScratchPad KEYWORD2
|
||||
writeScratchPad KEYWORD2
|
||||
readPowerSupply KEYWORD2
|
||||
setHighAlarmTemp KEYWORD2
|
||||
setLowAlarmTemp KEYWORD2
|
||||
getHighAlarmTemp KEYWORD2
|
||||
getLowAlarmTemp KEYWORD2
|
||||
resetAlarmSearch KEYWORD2
|
||||
alarmSearch KEYWORD2
|
||||
hasAlarm KEYWORD2
|
||||
toCelsius KEYWORD2
|
||||
processAlarmss KEYWORD2
|
||||
setAlarmHandlers KEYWORD2
|
||||
defaultAlarmHandler KEYWORD2
|
||||
calculateTemperature KEYWORD2
|
||||
millisToWaitForConversion KEYWORD2
|
||||
|
||||
#######################################
|
||||
# Constants (LITERAL1)
|
||||
#######################################
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
{
|
||||
"name": "DallasTemperature",
|
||||
"keywords": "onewire, 1-wire, bus, sensor, temperature",
|
||||
"description": "Arduino Library for Dallas Temperature ICs (DS18B20, DS18S20, DS1822, DS1820)",
|
||||
"repository":
|
||||
{
|
||||
"type": "git",
|
||||
"url": "https://github.com/milesburton/Arduino-Temperature-Control-Library.git"
|
||||
},
|
||||
"authors":
|
||||
[
|
||||
{
|
||||
"name": "Miles Burton",
|
||||
"email": "miles@mnetcs.com",
|
||||
"url": "http://www.milesburton.com",
|
||||
"maintainer": true
|
||||
},
|
||||
{
|
||||
"name": "Tim Newsome",
|
||||
"email": "nuisance@casualhacker.net"
|
||||
},
|
||||
{
|
||||
"name": "Guil Barros",
|
||||
"email": "gfbarros@bappos.com"
|
||||
},
|
||||
{
|
||||
"name": "Rob Tillaart",
|
||||
"email": "rob.tillaart@gmail.com"
|
||||
}
|
||||
],
|
||||
"dependencies":
|
||||
{
|
||||
"name": "OneWire",
|
||||
"authors": "Paul Stoffregen",
|
||||
"frameworks": "arduino"
|
||||
},
|
||||
"frameworks": "arduino",
|
||||
"platforms": "atmelavr"
|
||||
}
|
||||
@@ -1,259 +0,0 @@
|
||||
/*
|
||||
Emon.cpp - Library for openenergymonitor
|
||||
Created by Trystan Lea, April 27 2010
|
||||
GNU GPL
|
||||
modified to use up to 12 bits ADC resolution (ex. Arduino Due)
|
||||
by boredman@boredomprojects.net 26.12.2013
|
||||
*/
|
||||
|
||||
//#include "WProgram.h" un-comment for use on older versions of Arduino IDE
|
||||
#include "EmonLib.h"
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
|
||||
#include "Arduino.h"
|
||||
|
||||
#else
|
||||
|
||||
#include "WProgram.h"
|
||||
|
||||
#endif
|
||||
|
||||
//--------------------------------------------------------------------------------------
|
||||
// Sets the pins to be used for voltage and current sensors
|
||||
//--------------------------------------------------------------------------------------
|
||||
void EnergyMonitor::voltage(int _inPinV, double _VCAL, double _PHASECAL)
|
||||
{
|
||||
inPinV = _inPinV;
|
||||
VCAL = _VCAL;
|
||||
PHASECAL = _PHASECAL;
|
||||
}
|
||||
|
||||
void EnergyMonitor::current(int _inPinI, double _ICAL)
|
||||
{
|
||||
inPinI = _inPinI;
|
||||
ICAL = _ICAL;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------
|
||||
// Sets the pins to be used for voltage and current sensors based on emontx pin map
|
||||
//--------------------------------------------------------------------------------------
|
||||
void EnergyMonitor::voltageTX(double _VCAL, double _PHASECAL)
|
||||
{
|
||||
inPinV = 2;
|
||||
VCAL = _VCAL;
|
||||
PHASECAL = _PHASECAL;
|
||||
}
|
||||
|
||||
void EnergyMonitor::currentTX(int _channel, double _ICAL)
|
||||
{
|
||||
if (_channel == 1) inPinI = 3;
|
||||
if (_channel == 2) inPinI = 0;
|
||||
if (_channel == 3) inPinI = 1;
|
||||
ICAL = _ICAL;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------
|
||||
// emon_calc procedure
|
||||
// Calculates realPower,apparentPower,powerFactor,Vrms,Irms,kwh increment
|
||||
// From a sample window of the mains AC voltage and current.
|
||||
// The Sample window length is defined by the number of half wavelengths or crossings we choose to measure.
|
||||
//--------------------------------------------------------------------------------------
|
||||
void EnergyMonitor::calcVI(int crossings, int timeout)
|
||||
{
|
||||
#if defined emonTxV3
|
||||
int SUPPLYVOLTAGE=3300;
|
||||
#else
|
||||
int SUPPLYVOLTAGE = readVcc();
|
||||
#endif
|
||||
|
||||
int crossCount = 0; //Used to measure number of times threshold is crossed.
|
||||
int numberOfSamples = 0; //This is now incremented
|
||||
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
// 1) Waits for the waveform to be close to 'zero' (500 adc) part in sin curve.
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
boolean st=false; //an indicator to exit the while loop
|
||||
|
||||
unsigned long start = millis(); //millis()-start makes sure it doesnt get stuck in the loop if there is an error.
|
||||
|
||||
while(st==false) //the while loop...
|
||||
{
|
||||
startV = analogRead(inPinV); //using the voltage waveform
|
||||
if ((startV < (ADC_COUNTS/2+50)) && (startV > (ADC_COUNTS/2-50))) st=true; //check its within range
|
||||
if ((millis()-start)>timeout) st = true;
|
||||
}
|
||||
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
// 2) Main measurment loop
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
start = millis();
|
||||
|
||||
while ((crossCount < crossings) && ((millis()-start)<timeout))
|
||||
{
|
||||
numberOfSamples++; //Count number of times looped.
|
||||
|
||||
lastSampleV=sampleV; //Used for digital high pass filter
|
||||
lastSampleI=sampleI; //Used for digital high pass filter
|
||||
|
||||
lastFilteredV = filteredV; //Used for offset removal
|
||||
lastFilteredI = filteredI; //Used for offset removal
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// A) Read in raw voltage and current samples
|
||||
//-----------------------------------------------------------------------------
|
||||
sampleV = analogRead(inPinV); //Read in raw voltage signal
|
||||
sampleI = analogRead(inPinI); //Read in raw current signal
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// B) Apply digital high pass filters to remove 2.5V DC offset (centered on 0V).
|
||||
//-----------------------------------------------------------------------------
|
||||
filteredV = 0.996*(lastFilteredV+(sampleV-lastSampleV));
|
||||
filteredI = 0.996*(lastFilteredI+(sampleI-lastSampleI));
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// C) Root-mean-square method voltage
|
||||
//-----------------------------------------------------------------------------
|
||||
sqV= filteredV * filteredV; //1) square voltage values
|
||||
sumV += sqV; //2) sum
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// D) Root-mean-square method current
|
||||
//-----------------------------------------------------------------------------
|
||||
sqI = filteredI * filteredI; //1) square current values
|
||||
sumI += sqI; //2) sum
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// E) Phase calibration
|
||||
//-----------------------------------------------------------------------------
|
||||
phaseShiftedV = lastFilteredV + PHASECAL * (filteredV - lastFilteredV);
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// F) Instantaneous power calc
|
||||
//-----------------------------------------------------------------------------
|
||||
instP = phaseShiftedV * filteredI; //Instantaneous Power
|
||||
sumP +=instP; //Sum
|
||||
|
||||
//-----------------------------------------------------------------------------
|
||||
// G) Find the number of times the voltage has crossed the initial voltage
|
||||
// - every 2 crosses we will have sampled 1 wavelength
|
||||
// - so this method allows us to sample an integer number of half wavelengths which increases accuracy
|
||||
//-----------------------------------------------------------------------------
|
||||
lastVCross = checkVCross;
|
||||
if (sampleV > startV) checkVCross = true;
|
||||
else checkVCross = false;
|
||||
if (numberOfSamples==1) lastVCross = checkVCross;
|
||||
|
||||
if (lastVCross != checkVCross) crossCount++;
|
||||
}
|
||||
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
// 3) Post loop calculations
|
||||
//-------------------------------------------------------------------------------------------------------------------------
|
||||
//Calculation of the root of the mean of the voltage and current squared (rms)
|
||||
//Calibration coeficients applied.
|
||||
|
||||
double V_RATIO = VCAL *((SUPPLYVOLTAGE/1000.0) / (ADC_COUNTS));
|
||||
Vrms = V_RATIO * sqrt(sumV / numberOfSamples);
|
||||
|
||||
double I_RATIO = ICAL *((SUPPLYVOLTAGE/1000.0) / (ADC_COUNTS));
|
||||
Irms = I_RATIO * sqrt(sumI / numberOfSamples);
|
||||
|
||||
//Calculation power values
|
||||
realPower = V_RATIO * I_RATIO * sumP / numberOfSamples;
|
||||
apparentPower = Vrms * Irms;
|
||||
powerFactor=realPower / apparentPower;
|
||||
|
||||
//Reset accumulators
|
||||
sumV = 0;
|
||||
sumI = 0;
|
||||
sumP = 0;
|
||||
//--------------------------------------------------------------------------------------
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------
|
||||
double EnergyMonitor::calcIrms(int NUMBER_OF_SAMPLES)
|
||||
{
|
||||
|
||||
#if defined emonTxV3
|
||||
int SUPPLYVOLTAGE=3300;
|
||||
#else
|
||||
int SUPPLYVOLTAGE = readVcc();
|
||||
#endif
|
||||
|
||||
|
||||
for (int n = 0; n < NUMBER_OF_SAMPLES; n++)
|
||||
{
|
||||
lastSampleI = sampleI;
|
||||
sampleI = analogRead(inPinI);
|
||||
lastFilteredI = filteredI;
|
||||
filteredI = 0.996*(lastFilteredI+sampleI-lastSampleI);
|
||||
|
||||
// Root-mean-square method current
|
||||
// 1) square current values
|
||||
sqI = filteredI * filteredI;
|
||||
// 2) sum
|
||||
sumI += sqI;
|
||||
}
|
||||
|
||||
double I_RATIO = ICAL *((SUPPLYVOLTAGE/1000.0) / (ADC_COUNTS));
|
||||
Irms = I_RATIO * sqrt(sumI / NUMBER_OF_SAMPLES);
|
||||
|
||||
//Reset accumulators
|
||||
sumI = 0;
|
||||
//--------------------------------------------------------------------------------------
|
||||
|
||||
return Irms;
|
||||
}
|
||||
|
||||
void EnergyMonitor::serialprint()
|
||||
{
|
||||
Serial.print(realPower);
|
||||
Serial.print(' ');
|
||||
Serial.print(apparentPower);
|
||||
Serial.print(' ');
|
||||
Serial.print(Vrms);
|
||||
Serial.print(' ');
|
||||
Serial.print(Irms);
|
||||
Serial.print(' ');
|
||||
Serial.print(powerFactor);
|
||||
Serial.println(' ');
|
||||
delay(100);
|
||||
}
|
||||
|
||||
//thanks to http://hacking.majenko.co.uk/making-accurate-adc-readings-on-arduino
|
||||
//and Jérôme who alerted us to http://provideyourown.com/2012/secret-arduino-voltmeter-measure-battery-voltage/
|
||||
|
||||
long EnergyMonitor::readVcc() {
|
||||
long result;
|
||||
|
||||
//not used on emonTx V3 - as Vcc is always 3.3V - eliminates bandgap error and need for calibration http://harizanov.com/2013/09/thoughts-on-avr-adc-accuracy/
|
||||
|
||||
#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328__) || defined (__AVR_ATmega328P__)
|
||||
ADMUX = _BV(REFS0) | _BV(MUX3) | _BV(MUX2) | _BV(MUX1);
|
||||
#elif defined(__AVR_ATmega32U4__) || defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_AT90USB1286__)
|
||||
ADMUX = _BV(REFS0) | _BV(MUX4) | _BV(MUX3) | _BV(MUX2) | _BV(MUX1);
|
||||
ADCSRB &= ~_BV(MUX5); // Without this the function always returns -1 on the ATmega2560 http://openenergymonitor.org/emon/node/2253#comment-11432
|
||||
#elif defined (__AVR_ATtiny24__) || defined(__AVR_ATtiny44__) || defined(__AVR_ATtiny84__)
|
||||
ADMUX = _BV(MUX5) | _BV(MUX0);
|
||||
#elif defined (__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
|
||||
ADMUX = _BV(MUX3) | _BV(MUX2);
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
#if defined(__AVR__)
|
||||
delay(2); // Wait for Vref to settle
|
||||
ADCSRA |= _BV(ADSC); // Convert
|
||||
while (bit_is_set(ADCSRA,ADSC));
|
||||
result = ADCL;
|
||||
result |= ADCH<<8;
|
||||
result = 1126400L / result; //1100mV*1024 ADC steps http://openenergymonitor.org/emon/node/1186
|
||||
return result;
|
||||
#elif defined(__arm__)
|
||||
return (3300); //Arduino Due
|
||||
#else
|
||||
return (3300); //Guess that other un-supported architectures will be running a 3.3V!
|
||||
#endif
|
||||
}
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
/*
|
||||
Emon.h - Library for openenergymonitor
|
||||
Created by Trystan Lea, April 27 2010
|
||||
GNU GPL
|
||||
modified to use up to 12 bits ADC resolution (ex. Arduino Due)
|
||||
by boredman@boredomprojects.net 26.12.2013
|
||||
*/
|
||||
|
||||
#ifndef EmonLib_h
|
||||
#define EmonLib_h
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
|
||||
#include "Arduino.h"
|
||||
|
||||
#else
|
||||
|
||||
#include "WProgram.h"
|
||||
|
||||
#endif
|
||||
|
||||
// to enable 12-bit ADC resolution on Arduino Due,
|
||||
// include the following line in main sketch inside setup() function:
|
||||
// analogReadResolution(ADC_BITS);
|
||||
// otherwise will default to 10 bits, as in regular Arduino-based boards.
|
||||
#if defined(__arm__)
|
||||
#define ADC_BITS 12
|
||||
#else
|
||||
#define ADC_BITS 10
|
||||
#endif
|
||||
|
||||
#define ADC_COUNTS (1<<ADC_BITS)
|
||||
|
||||
|
||||
class EnergyMonitor
|
||||
{
|
||||
public:
|
||||
|
||||
void voltage(int _inPinV, double _VCAL, double _PHASECAL);
|
||||
void current(int _inPinI, double _ICAL);
|
||||
|
||||
void voltageTX(double _VCAL, double _PHASECAL);
|
||||
void currentTX(int _channel, double _ICAL);
|
||||
|
||||
void calcVI(int crossings, int timeout);
|
||||
double calcIrms(int NUMBER_OF_SAMPLES);
|
||||
void serialprint();
|
||||
|
||||
long readVcc();
|
||||
//Useful value variables
|
||||
double realPower,
|
||||
apparentPower,
|
||||
powerFactor,
|
||||
Vrms,
|
||||
Irms;
|
||||
|
||||
private:
|
||||
|
||||
//Set Voltage and current input pins
|
||||
int inPinV;
|
||||
int inPinI;
|
||||
//Calibration coeficients
|
||||
//These need to be set in order to obtain accurate results
|
||||
double VCAL;
|
||||
double ICAL;
|
||||
double PHASECAL;
|
||||
|
||||
//--------------------------------------------------------------------------------------
|
||||
// Variable declaration for emon_calc procedure
|
||||
//--------------------------------------------------------------------------------------
|
||||
int lastSampleV,sampleV; //sample_ holds the raw analog read value, lastSample_ holds the last sample
|
||||
int lastSampleI,sampleI;
|
||||
|
||||
double lastFilteredV,filteredV; //Filtered_ is the raw analog value minus the DC offset
|
||||
double lastFilteredI, filteredI;
|
||||
|
||||
double phaseShiftedV; //Holds the calibrated phase shifted voltage.
|
||||
|
||||
double sqV,sumV,sqI,sumI,instP,sumP; //sq = squared, sum = Sum, inst = instantaneous
|
||||
|
||||
int startV; //Instantaneous voltage at start of sample window.
|
||||
|
||||
boolean lastVCross, checkVCross; //Used to measure number of times threshold is crossed.
|
||||
int crossCount; // ''
|
||||
|
||||
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,25 +0,0 @@
|
||||
_ _ _
|
||||
| | (_) |
|
||||
___ _ __ ___ ___ _ __ | | _| |__
|
||||
/ _ \ '_ ` _ \ / _ \| '_ \| | | | '_ \
|
||||
| __/ | | | | | (_) | | | | |____| | |_) |
|
||||
\___|_| |_| |_|\___/|_| |_|______|_|_.__/
|
||||
|
||||
Arduino Energy Monitoring Library - compatible with Arduino 1.0
|
||||
*****************************************************************
|
||||
|
||||
Designed for use with emonTx: http://openenergymonitor.org/emon/Modules
|
||||
|
||||
Download to Arduino IDE 'libraries' folder. Restart of IDE required.
|
||||
|
||||
Git Clone and Git Pull can be easily used to keep the library up-to-date and manage changes.
|
||||
JeeLabs has done a good post on the topic: http://jeelabs.org/2011/12/29/out-with-the-old-in-with-the-new/
|
||||
|
||||
|
||||
|
||||
Update: 5th January 2014: Support Added for Arduino Due (ARM Cortex-M3, 12-bit ADC) by icboredman.
|
||||
|
||||
To enable this feature on Arduino Due, add the following statement to setup() function in main sketch:
|
||||
analogReadResolution(ADC_BITS); This will set ADC_BITS to 12 (Arduino Due), EmonLib will otherwise default to 10 analogReadResolution(ADC_BITS);.
|
||||
See blog post on using Arduino Due as energy monitor: http://boredomprojects.net/index.php/projects/home-energy-monitor
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
// EmonLibrary examples openenergymonitor.org, Licence GNU GPL V3
|
||||
|
||||
#include "EmonLib.h" // Include Emon Library
|
||||
EnergyMonitor emon1; // Create an instance
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(9600);
|
||||
|
||||
emon1.current(1, 111.1); // Current: input pin, calibration.
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
double Irms = emon1.calcIrms(1480); // Calculate Irms only
|
||||
|
||||
Serial.print(Irms*230.0); // Apparent power
|
||||
Serial.print(" ");
|
||||
Serial.println(Irms); // Irms
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
// EmonLibrary examples openenergymonitor.org, Licence GNU GPL V3
|
||||
|
||||
#include "EmonLib.h" // Include Emon Library
|
||||
EnergyMonitor emon1; // Create an instance
|
||||
|
||||
void setup()
|
||||
{
|
||||
Serial.begin(9600);
|
||||
|
||||
emon1.voltage(2, 234.26, 1.7); // Voltage: input pin, calibration, phase_shift
|
||||
emon1.current(1, 111.1); // Current: input pin, calibration.
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
emon1.calcVI(20,2000); // Calculate all. No.of half wavelengths (crossings), time-out
|
||||
emon1.serialprint(); // Print out all variables (realpower, apparent power, Vrms, Irms, power factor)
|
||||
|
||||
float realPower = emon1.realPower; //extract Real Power into variable
|
||||
float apparentPower = emon1.apparentPower; //extract Apparent Power into variable
|
||||
float powerFActor = emon1.powerFactor; //extract Power Factor into Variable
|
||||
float supplyVoltage = emon1.Vrms; //extract Vrms into Variable
|
||||
float Irms = emon1.Irms; //extract Irms into Variable
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
|
||||
#include "Encoder.h"
|
||||
|
||||
// Yes, all the code is in the header file, to provide the user
|
||||
// configure options with #define (before they include it), and
|
||||
// to facilitate some crafty optimizations!
|
||||
|
||||
Encoder_internal_state_t * Encoder::interruptArgs[];
|
||||
|
||||
|
||||
@@ -1,942 +0,0 @@
|
||||
/* Encoder Library, for measuring quadrature encoded signals
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
* Copyright (c) 2011,2013 PJRC.COM, LLC - Paul Stoffregen <paul@pjrc.com>
|
||||
*
|
||||
* Version 1.2 - fix -2 bug in C-only code
|
||||
* Version 1.1 - expand to support boards with up to 60 interrupts
|
||||
* Version 1.0 - initial release
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
|
||||
#ifndef Encoder_h_
|
||||
#define Encoder_h_
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#include "Arduino.h"
|
||||
#elif defined(WIRING)
|
||||
#include "Wiring.h"
|
||||
#else
|
||||
#include "WProgram.h"
|
||||
#include "pins_arduino.h"
|
||||
#endif
|
||||
|
||||
#include "utility/direct_pin_read.h"
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) || !defined(ENCODER_DO_NOT_USE_INTERRUPTS)
|
||||
#define ENCODER_USE_INTERRUPTS
|
||||
#define ENCODER_ARGLIST_SIZE CORE_NUM_INTERRUPT
|
||||
#include "utility/interrupt_pins.h"
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#include "utility/interrupt_config.h"
|
||||
#endif
|
||||
#else
|
||||
#define ENCODER_ARGLIST_SIZE 0
|
||||
#endif
|
||||
|
||||
|
||||
|
||||
// All the data needed by interrupts is consolidated into this ugly struct
|
||||
// to facilitate assembly language optimizing of the speed critical update.
|
||||
// The assembly code uses auto-incrementing addressing modes, so the struct
|
||||
// must remain in exactly this order.
|
||||
typedef struct {
|
||||
volatile IO_REG_TYPE * pin1_register;
|
||||
volatile IO_REG_TYPE * pin2_register;
|
||||
IO_REG_TYPE pin1_bitmask;
|
||||
IO_REG_TYPE pin2_bitmask;
|
||||
uint8_t state;
|
||||
int32_t position;
|
||||
} Encoder_internal_state_t;
|
||||
|
||||
class Encoder
|
||||
{
|
||||
public:
|
||||
Encoder(uint8_t pin1, uint8_t pin2) {
|
||||
#ifdef INPUT_PULLUP
|
||||
pinMode(pin1, INPUT_PULLUP);
|
||||
pinMode(pin2, INPUT_PULLUP);
|
||||
#else
|
||||
pinMode(pin1, INPUT);
|
||||
digitalWrite(pin1, HIGH);
|
||||
pinMode(pin2, INPUT);
|
||||
digitalWrite(pin2, HIGH);
|
||||
#endif
|
||||
encoder.pin1_register = PIN_TO_BASEREG(pin1);
|
||||
encoder.pin1_bitmask = PIN_TO_BITMASK(pin1);
|
||||
encoder.pin2_register = PIN_TO_BASEREG(pin2);
|
||||
encoder.pin2_bitmask = PIN_TO_BITMASK(pin2);
|
||||
encoder.position = 0;
|
||||
// allow time for a passive R-C filter to charge
|
||||
// through the pullup resistors, before reading
|
||||
// the initial state
|
||||
delayMicroseconds(2000);
|
||||
uint8_t s = 0;
|
||||
if (DIRECT_PIN_READ(encoder.pin1_register, encoder.pin1_bitmask)) s |= 1;
|
||||
if (DIRECT_PIN_READ(encoder.pin2_register, encoder.pin2_bitmask)) s |= 2;
|
||||
encoder.state = s;
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
interrupts_in_use = attach_interrupt(pin1, &encoder);
|
||||
interrupts_in_use += attach_interrupt(pin2, &encoder);
|
||||
#endif
|
||||
//update_finishup(); // to force linker to include the code (does not work)
|
||||
}
|
||||
|
||||
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
inline int32_t read() {
|
||||
if (interrupts_in_use < 2) {
|
||||
noInterrupts();
|
||||
update(&encoder);
|
||||
} else {
|
||||
noInterrupts();
|
||||
}
|
||||
int32_t ret = encoder.position;
|
||||
interrupts();
|
||||
return ret;
|
||||
}
|
||||
inline void write(int32_t p) {
|
||||
noInterrupts();
|
||||
encoder.position = p;
|
||||
interrupts();
|
||||
}
|
||||
#else
|
||||
inline int32_t read() {
|
||||
update(&encoder);
|
||||
return encoder.position;
|
||||
}
|
||||
inline void write(int32_t p) {
|
||||
encoder.position = p;
|
||||
}
|
||||
#endif
|
||||
private:
|
||||
Encoder_internal_state_t encoder;
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
uint8_t interrupts_in_use;
|
||||
#endif
|
||||
public:
|
||||
static Encoder_internal_state_t * interruptArgs[ENCODER_ARGLIST_SIZE];
|
||||
|
||||
// _______ _______
|
||||
// Pin1 ______| |_______| |______ Pin1
|
||||
// negative <--- _______ _______ __ --> positive
|
||||
// Pin2 __| |_______| |_______| Pin2
|
||||
|
||||
// new new old old
|
||||
// pin2 pin1 pin2 pin1 Result
|
||||
// ---- ---- ---- ---- ------
|
||||
// 0 0 0 0 no movement
|
||||
// 0 0 0 1 +1
|
||||
// 0 0 1 0 -1
|
||||
// 0 0 1 1 +2 (assume pin1 edges only)
|
||||
// 0 1 0 0 -1
|
||||
// 0 1 0 1 no movement
|
||||
// 0 1 1 0 -2 (assume pin1 edges only)
|
||||
// 0 1 1 1 +1
|
||||
// 1 0 0 0 +1
|
||||
// 1 0 0 1 -2 (assume pin1 edges only)
|
||||
// 1 0 1 0 no movement
|
||||
// 1 0 1 1 -1
|
||||
// 1 1 0 0 +2 (assume pin1 edges only)
|
||||
// 1 1 0 1 -1
|
||||
// 1 1 1 0 +1
|
||||
// 1 1 1 1 no movement
|
||||
/*
|
||||
// Simple, easy-to-read "documentation" version :-)
|
||||
//
|
||||
void update(void) {
|
||||
uint8_t s = state & 3;
|
||||
if (digitalRead(pin1)) s |= 4;
|
||||
if (digitalRead(pin2)) s |= 8;
|
||||
switch (s) {
|
||||
case 0: case 5: case 10: case 15:
|
||||
break;
|
||||
case 1: case 7: case 8: case 14:
|
||||
position++; break;
|
||||
case 2: case 4: case 11: case 13:
|
||||
position--; break;
|
||||
case 3: case 12:
|
||||
position += 2; break;
|
||||
default:
|
||||
position -= 2; break;
|
||||
}
|
||||
state = (s >> 2);
|
||||
}
|
||||
*/
|
||||
|
||||
private:
|
||||
static void update(Encoder_internal_state_t *arg) {
|
||||
#if defined(__AVR__)
|
||||
// The compiler believes this is just 1 line of code, so
|
||||
// it will inline this function into each interrupt
|
||||
// handler. That's a tiny bit faster, but grows the code.
|
||||
// Especially when used with ENCODER_OPTIMIZE_INTERRUPTS,
|
||||
// the inline nature allows the ISR prologue and epilogue
|
||||
// to only save/restore necessary registers, for very nice
|
||||
// speed increase.
|
||||
asm volatile (
|
||||
"ld r30, X+" "\n\t"
|
||||
"ld r31, X+" "\n\t"
|
||||
"ld r24, Z" "\n\t" // r24 = pin1 input
|
||||
"ld r30, X+" "\n\t"
|
||||
"ld r31, X+" "\n\t"
|
||||
"ld r25, Z" "\n\t" // r25 = pin2 input
|
||||
"ld r30, X+" "\n\t" // r30 = pin1 mask
|
||||
"ld r31, X+" "\n\t" // r31 = pin2 mask
|
||||
"ld r22, X" "\n\t" // r22 = state
|
||||
"andi r22, 3" "\n\t"
|
||||
"and r24, r30" "\n\t"
|
||||
"breq L%=1" "\n\t" // if (pin1)
|
||||
"ori r22, 4" "\n\t" // state |= 4
|
||||
"L%=1:" "and r25, r31" "\n\t"
|
||||
"breq L%=2" "\n\t" // if (pin2)
|
||||
"ori r22, 8" "\n\t" // state |= 8
|
||||
"L%=2:" "ldi r30, lo8(pm(L%=table))" "\n\t"
|
||||
"ldi r31, hi8(pm(L%=table))" "\n\t"
|
||||
"add r30, r22" "\n\t"
|
||||
"adc r31, __zero_reg__" "\n\t"
|
||||
"asr r22" "\n\t"
|
||||
"asr r22" "\n\t"
|
||||
"st X+, r22" "\n\t" // store new state
|
||||
"ld r22, X+" "\n\t"
|
||||
"ld r23, X+" "\n\t"
|
||||
"ld r24, X+" "\n\t"
|
||||
"ld r25, X+" "\n\t"
|
||||
"ijmp" "\n\t" // jumps to update_finishup()
|
||||
// TODO move this table to another static function,
|
||||
// so it doesn't get needlessly duplicated. Easier
|
||||
// said than done, due to linker issues and inlining
|
||||
"L%=table:" "\n\t"
|
||||
"rjmp L%=end" "\n\t" // 0
|
||||
"rjmp L%=plus1" "\n\t" // 1
|
||||
"rjmp L%=minus1" "\n\t" // 2
|
||||
"rjmp L%=plus2" "\n\t" // 3
|
||||
"rjmp L%=minus1" "\n\t" // 4
|
||||
"rjmp L%=end" "\n\t" // 5
|
||||
"rjmp L%=minus2" "\n\t" // 6
|
||||
"rjmp L%=plus1" "\n\t" // 7
|
||||
"rjmp L%=plus1" "\n\t" // 8
|
||||
"rjmp L%=minus2" "\n\t" // 9
|
||||
"rjmp L%=end" "\n\t" // 10
|
||||
"rjmp L%=minus1" "\n\t" // 11
|
||||
"rjmp L%=plus2" "\n\t" // 12
|
||||
"rjmp L%=minus1" "\n\t" // 13
|
||||
"rjmp L%=plus1" "\n\t" // 14
|
||||
"rjmp L%=end" "\n\t" // 15
|
||||
"L%=minus2:" "\n\t"
|
||||
"subi r22, 2" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=minus1:" "\n\t"
|
||||
"subi r22, 1" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=plus2:" "\n\t"
|
||||
"subi r22, 254" "\n\t"
|
||||
"rjmp L%=z" "\n\t"
|
||||
"L%=plus1:" "\n\t"
|
||||
"subi r22, 255" "\n\t"
|
||||
"L%=z:" "sbci r23, 255" "\n\t"
|
||||
"sbci r24, 255" "\n\t"
|
||||
"sbci r25, 255" "\n\t"
|
||||
"L%=store:" "\n\t"
|
||||
"st -X, r25" "\n\t"
|
||||
"st -X, r24" "\n\t"
|
||||
"st -X, r23" "\n\t"
|
||||
"st -X, r22" "\n\t"
|
||||
"L%=end:" "\n"
|
||||
: : "x" (arg) : "r22", "r23", "r24", "r25", "r30", "r31");
|
||||
#else
|
||||
uint8_t p1val = DIRECT_PIN_READ(arg->pin1_register, arg->pin1_bitmask);
|
||||
uint8_t p2val = DIRECT_PIN_READ(arg->pin2_register, arg->pin2_bitmask);
|
||||
uint8_t state = arg->state & 3;
|
||||
if (p1val) state |= 4;
|
||||
if (p2val) state |= 8;
|
||||
arg->state = (state >> 2);
|
||||
switch (state) {
|
||||
case 1: case 7: case 8: case 14:
|
||||
arg->position++;
|
||||
return;
|
||||
case 2: case 4: case 11: case 13:
|
||||
arg->position--;
|
||||
return;
|
||||
case 3: case 12:
|
||||
arg->position += 2;
|
||||
return;
|
||||
case 6: case 9:
|
||||
arg->position -= 2;
|
||||
return;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
/*
|
||||
#if defined(__AVR__)
|
||||
// TODO: this must be a no inline function
|
||||
// even noinline does not seem to solve difficult
|
||||
// problems with this. Oh well, it was only meant
|
||||
// to shrink code size - there's no performance
|
||||
// improvement in this, only code size reduction.
|
||||
__attribute__((noinline)) void update_finishup(void) {
|
||||
asm volatile (
|
||||
"ldi r30, lo8(pm(Ltable))" "\n\t"
|
||||
"ldi r31, hi8(pm(Ltable))" "\n\t"
|
||||
"Ltable:" "\n\t"
|
||||
"rjmp L%=end" "\n\t" // 0
|
||||
"rjmp L%=plus1" "\n\t" // 1
|
||||
"rjmp L%=minus1" "\n\t" // 2
|
||||
"rjmp L%=plus2" "\n\t" // 3
|
||||
"rjmp L%=minus1" "\n\t" // 4
|
||||
"rjmp L%=end" "\n\t" // 5
|
||||
"rjmp L%=minus2" "\n\t" // 6
|
||||
"rjmp L%=plus1" "\n\t" // 7
|
||||
"rjmp L%=plus1" "\n\t" // 8
|
||||
"rjmp L%=minus2" "\n\t" // 9
|
||||
"rjmp L%=end" "\n\t" // 10
|
||||
"rjmp L%=minus1" "\n\t" // 11
|
||||
"rjmp L%=plus2" "\n\t" // 12
|
||||
"rjmp L%=minus1" "\n\t" // 13
|
||||
"rjmp L%=plus1" "\n\t" // 14
|
||||
"rjmp L%=end" "\n\t" // 15
|
||||
"L%=minus2:" "\n\t"
|
||||
"subi r22, 2" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=minus1:" "\n\t"
|
||||
"subi r22, 1" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=plus2:" "\n\t"
|
||||
"subi r22, 254" "\n\t"
|
||||
"rjmp L%=z" "\n\t"
|
||||
"L%=plus1:" "\n\t"
|
||||
"subi r22, 255" "\n\t"
|
||||
"L%=z:" "sbci r23, 255" "\n\t"
|
||||
"sbci r24, 255" "\n\t"
|
||||
"sbci r25, 255" "\n\t"
|
||||
"L%=store:" "\n\t"
|
||||
"st -X, r25" "\n\t"
|
||||
"st -X, r24" "\n\t"
|
||||
"st -X, r23" "\n\t"
|
||||
"st -X, r22" "\n\t"
|
||||
"L%=end:" "\n"
|
||||
: : : "r22", "r23", "r24", "r25", "r30", "r31");
|
||||
}
|
||||
#endif
|
||||
*/
|
||||
|
||||
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
// this giant function is an unfortunate consequence of Arduino's
|
||||
// attachInterrupt function not supporting any way to pass a pointer
|
||||
// or other context to the attached function.
|
||||
static uint8_t attach_interrupt(uint8_t pin, Encoder_internal_state_t *state) {
|
||||
switch (pin) {
|
||||
#ifdef CORE_INT0_PIN
|
||||
case CORE_INT0_PIN:
|
||||
interruptArgs[0] = state;
|
||||
attachInterrupt(0, isr0, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT1_PIN
|
||||
case CORE_INT1_PIN:
|
||||
interruptArgs[1] = state;
|
||||
attachInterrupt(1, isr1, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT2_PIN
|
||||
case CORE_INT2_PIN:
|
||||
interruptArgs[2] = state;
|
||||
attachInterrupt(2, isr2, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT3_PIN
|
||||
case CORE_INT3_PIN:
|
||||
interruptArgs[3] = state;
|
||||
attachInterrupt(3, isr3, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT4_PIN
|
||||
case CORE_INT4_PIN:
|
||||
interruptArgs[4] = state;
|
||||
attachInterrupt(4, isr4, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT5_PIN
|
||||
case CORE_INT5_PIN:
|
||||
interruptArgs[5] = state;
|
||||
attachInterrupt(5, isr5, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT6_PIN
|
||||
case CORE_INT6_PIN:
|
||||
interruptArgs[6] = state;
|
||||
attachInterrupt(6, isr6, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT7_PIN
|
||||
case CORE_INT7_PIN:
|
||||
interruptArgs[7] = state;
|
||||
attachInterrupt(7, isr7, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT8_PIN
|
||||
case CORE_INT8_PIN:
|
||||
interruptArgs[8] = state;
|
||||
attachInterrupt(8, isr8, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT9_PIN
|
||||
case CORE_INT9_PIN:
|
||||
interruptArgs[9] = state;
|
||||
attachInterrupt(9, isr9, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT10_PIN
|
||||
case CORE_INT10_PIN:
|
||||
interruptArgs[10] = state;
|
||||
attachInterrupt(10, isr10, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT11_PIN
|
||||
case CORE_INT11_PIN:
|
||||
interruptArgs[11] = state;
|
||||
attachInterrupt(11, isr11, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT12_PIN
|
||||
case CORE_INT12_PIN:
|
||||
interruptArgs[12] = state;
|
||||
attachInterrupt(12, isr12, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT13_PIN
|
||||
case CORE_INT13_PIN:
|
||||
interruptArgs[13] = state;
|
||||
attachInterrupt(13, isr13, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT14_PIN
|
||||
case CORE_INT14_PIN:
|
||||
interruptArgs[14] = state;
|
||||
attachInterrupt(14, isr14, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT15_PIN
|
||||
case CORE_INT15_PIN:
|
||||
interruptArgs[15] = state;
|
||||
attachInterrupt(15, isr15, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT16_PIN
|
||||
case CORE_INT16_PIN:
|
||||
interruptArgs[16] = state;
|
||||
attachInterrupt(16, isr16, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT17_PIN
|
||||
case CORE_INT17_PIN:
|
||||
interruptArgs[17] = state;
|
||||
attachInterrupt(17, isr17, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT18_PIN
|
||||
case CORE_INT18_PIN:
|
||||
interruptArgs[18] = state;
|
||||
attachInterrupt(18, isr18, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT19_PIN
|
||||
case CORE_INT19_PIN:
|
||||
interruptArgs[19] = state;
|
||||
attachInterrupt(19, isr19, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT20_PIN
|
||||
case CORE_INT20_PIN:
|
||||
interruptArgs[20] = state;
|
||||
attachInterrupt(20, isr20, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT21_PIN
|
||||
case CORE_INT21_PIN:
|
||||
interruptArgs[21] = state;
|
||||
attachInterrupt(21, isr21, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT22_PIN
|
||||
case CORE_INT22_PIN:
|
||||
interruptArgs[22] = state;
|
||||
attachInterrupt(22, isr22, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT23_PIN
|
||||
case CORE_INT23_PIN:
|
||||
interruptArgs[23] = state;
|
||||
attachInterrupt(23, isr23, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT24_PIN
|
||||
case CORE_INT24_PIN:
|
||||
interruptArgs[24] = state;
|
||||
attachInterrupt(24, isr24, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT25_PIN
|
||||
case CORE_INT25_PIN:
|
||||
interruptArgs[25] = state;
|
||||
attachInterrupt(25, isr25, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT26_PIN
|
||||
case CORE_INT26_PIN:
|
||||
interruptArgs[26] = state;
|
||||
attachInterrupt(26, isr26, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT27_PIN
|
||||
case CORE_INT27_PIN:
|
||||
interruptArgs[27] = state;
|
||||
attachInterrupt(27, isr27, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT28_PIN
|
||||
case CORE_INT28_PIN:
|
||||
interruptArgs[28] = state;
|
||||
attachInterrupt(28, isr28, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT29_PIN
|
||||
case CORE_INT29_PIN:
|
||||
interruptArgs[29] = state;
|
||||
attachInterrupt(29, isr29, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
|
||||
#ifdef CORE_INT30_PIN
|
||||
case CORE_INT30_PIN:
|
||||
interruptArgs[30] = state;
|
||||
attachInterrupt(30, isr30, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT31_PIN
|
||||
case CORE_INT31_PIN:
|
||||
interruptArgs[31] = state;
|
||||
attachInterrupt(31, isr31, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT32_PIN
|
||||
case CORE_INT32_PIN:
|
||||
interruptArgs[32] = state;
|
||||
attachInterrupt(32, isr32, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT33_PIN
|
||||
case CORE_INT33_PIN:
|
||||
interruptArgs[33] = state;
|
||||
attachInterrupt(33, isr33, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT34_PIN
|
||||
case CORE_INT34_PIN:
|
||||
interruptArgs[34] = state;
|
||||
attachInterrupt(34, isr34, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT35_PIN
|
||||
case CORE_INT35_PIN:
|
||||
interruptArgs[35] = state;
|
||||
attachInterrupt(35, isr35, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT36_PIN
|
||||
case CORE_INT36_PIN:
|
||||
interruptArgs[36] = state;
|
||||
attachInterrupt(36, isr36, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT37_PIN
|
||||
case CORE_INT37_PIN:
|
||||
interruptArgs[37] = state;
|
||||
attachInterrupt(37, isr37, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT38_PIN
|
||||
case CORE_INT38_PIN:
|
||||
interruptArgs[38] = state;
|
||||
attachInterrupt(38, isr38, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT39_PIN
|
||||
case CORE_INT39_PIN:
|
||||
interruptArgs[39] = state;
|
||||
attachInterrupt(39, isr39, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT40_PIN
|
||||
case CORE_INT40_PIN:
|
||||
interruptArgs[40] = state;
|
||||
attachInterrupt(40, isr40, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT41_PIN
|
||||
case CORE_INT41_PIN:
|
||||
interruptArgs[41] = state;
|
||||
attachInterrupt(41, isr41, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT42_PIN
|
||||
case CORE_INT42_PIN:
|
||||
interruptArgs[42] = state;
|
||||
attachInterrupt(42, isr42, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT43_PIN
|
||||
case CORE_INT43_PIN:
|
||||
interruptArgs[43] = state;
|
||||
attachInterrupt(43, isr43, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT44_PIN
|
||||
case CORE_INT44_PIN:
|
||||
interruptArgs[44] = state;
|
||||
attachInterrupt(44, isr44, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT45_PIN
|
||||
case CORE_INT45_PIN:
|
||||
interruptArgs[45] = state;
|
||||
attachInterrupt(45, isr45, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT46_PIN
|
||||
case CORE_INT46_PIN:
|
||||
interruptArgs[46] = state;
|
||||
attachInterrupt(46, isr46, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT47_PIN
|
||||
case CORE_INT47_PIN:
|
||||
interruptArgs[47] = state;
|
||||
attachInterrupt(47, isr47, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT48_PIN
|
||||
case CORE_INT48_PIN:
|
||||
interruptArgs[48] = state;
|
||||
attachInterrupt(48, isr48, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT49_PIN
|
||||
case CORE_INT49_PIN:
|
||||
interruptArgs[49] = state;
|
||||
attachInterrupt(49, isr49, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT50_PIN
|
||||
case CORE_INT50_PIN:
|
||||
interruptArgs[50] = state;
|
||||
attachInterrupt(50, isr50, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT51_PIN
|
||||
case CORE_INT51_PIN:
|
||||
interruptArgs[51] = state;
|
||||
attachInterrupt(51, isr51, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT52_PIN
|
||||
case CORE_INT52_PIN:
|
||||
interruptArgs[52] = state;
|
||||
attachInterrupt(52, isr52, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT53_PIN
|
||||
case CORE_INT53_PIN:
|
||||
interruptArgs[53] = state;
|
||||
attachInterrupt(53, isr53, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT54_PIN
|
||||
case CORE_INT54_PIN:
|
||||
interruptArgs[54] = state;
|
||||
attachInterrupt(54, isr54, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT55_PIN
|
||||
case CORE_INT55_PIN:
|
||||
interruptArgs[55] = state;
|
||||
attachInterrupt(55, isr55, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT56_PIN
|
||||
case CORE_INT56_PIN:
|
||||
interruptArgs[56] = state;
|
||||
attachInterrupt(56, isr56, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT57_PIN
|
||||
case CORE_INT57_PIN:
|
||||
interruptArgs[57] = state;
|
||||
attachInterrupt(57, isr57, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT58_PIN
|
||||
case CORE_INT58_PIN:
|
||||
interruptArgs[58] = state;
|
||||
attachInterrupt(58, isr58, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT59_PIN
|
||||
case CORE_INT59_PIN:
|
||||
interruptArgs[59] = state;
|
||||
attachInterrupt(59, isr59, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
default:
|
||||
return 0;
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
#endif // ENCODER_USE_INTERRUPTS
|
||||
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) && !defined(ENCODER_OPTIMIZE_INTERRUPTS)
|
||||
#ifdef CORE_INT0_PIN
|
||||
static void isr0(void) { update(interruptArgs[0]); }
|
||||
#endif
|
||||
#ifdef CORE_INT1_PIN
|
||||
static void isr1(void) { update(interruptArgs[1]); }
|
||||
#endif
|
||||
#ifdef CORE_INT2_PIN
|
||||
static void isr2(void) { update(interruptArgs[2]); }
|
||||
#endif
|
||||
#ifdef CORE_INT3_PIN
|
||||
static void isr3(void) { update(interruptArgs[3]); }
|
||||
#endif
|
||||
#ifdef CORE_INT4_PIN
|
||||
static void isr4(void) { update(interruptArgs[4]); }
|
||||
#endif
|
||||
#ifdef CORE_INT5_PIN
|
||||
static void isr5(void) { update(interruptArgs[5]); }
|
||||
#endif
|
||||
#ifdef CORE_INT6_PIN
|
||||
static void isr6(void) { update(interruptArgs[6]); }
|
||||
#endif
|
||||
#ifdef CORE_INT7_PIN
|
||||
static void isr7(void) { update(interruptArgs[7]); }
|
||||
#endif
|
||||
#ifdef CORE_INT8_PIN
|
||||
static void isr8(void) { update(interruptArgs[8]); }
|
||||
#endif
|
||||
#ifdef CORE_INT9_PIN
|
||||
static void isr9(void) { update(interruptArgs[9]); }
|
||||
#endif
|
||||
#ifdef CORE_INT10_PIN
|
||||
static void isr10(void) { update(interruptArgs[10]); }
|
||||
#endif
|
||||
#ifdef CORE_INT11_PIN
|
||||
static void isr11(void) { update(interruptArgs[11]); }
|
||||
#endif
|
||||
#ifdef CORE_INT12_PIN
|
||||
static void isr12(void) { update(interruptArgs[12]); }
|
||||
#endif
|
||||
#ifdef CORE_INT13_PIN
|
||||
static void isr13(void) { update(interruptArgs[13]); }
|
||||
#endif
|
||||
#ifdef CORE_INT14_PIN
|
||||
static void isr14(void) { update(interruptArgs[14]); }
|
||||
#endif
|
||||
#ifdef CORE_INT15_PIN
|
||||
static void isr15(void) { update(interruptArgs[15]); }
|
||||
#endif
|
||||
#ifdef CORE_INT16_PIN
|
||||
static void isr16(void) { update(interruptArgs[16]); }
|
||||
#endif
|
||||
#ifdef CORE_INT17_PIN
|
||||
static void isr17(void) { update(interruptArgs[17]); }
|
||||
#endif
|
||||
#ifdef CORE_INT18_PIN
|
||||
static void isr18(void) { update(interruptArgs[18]); }
|
||||
#endif
|
||||
#ifdef CORE_INT19_PIN
|
||||
static void isr19(void) { update(interruptArgs[19]); }
|
||||
#endif
|
||||
#ifdef CORE_INT20_PIN
|
||||
static void isr20(void) { update(interruptArgs[20]); }
|
||||
#endif
|
||||
#ifdef CORE_INT21_PIN
|
||||
static void isr21(void) { update(interruptArgs[21]); }
|
||||
#endif
|
||||
#ifdef CORE_INT22_PIN
|
||||
static void isr22(void) { update(interruptArgs[22]); }
|
||||
#endif
|
||||
#ifdef CORE_INT23_PIN
|
||||
static void isr23(void) { update(interruptArgs[23]); }
|
||||
#endif
|
||||
#ifdef CORE_INT24_PIN
|
||||
static void isr24(void) { update(interruptArgs[24]); }
|
||||
#endif
|
||||
#ifdef CORE_INT25_PIN
|
||||
static void isr25(void) { update(interruptArgs[25]); }
|
||||
#endif
|
||||
#ifdef CORE_INT26_PIN
|
||||
static void isr26(void) { update(interruptArgs[26]); }
|
||||
#endif
|
||||
#ifdef CORE_INT27_PIN
|
||||
static void isr27(void) { update(interruptArgs[27]); }
|
||||
#endif
|
||||
#ifdef CORE_INT28_PIN
|
||||
static void isr28(void) { update(interruptArgs[28]); }
|
||||
#endif
|
||||
#ifdef CORE_INT29_PIN
|
||||
static void isr29(void) { update(interruptArgs[29]); }
|
||||
#endif
|
||||
#ifdef CORE_INT30_PIN
|
||||
static void isr30(void) { update(interruptArgs[30]); }
|
||||
#endif
|
||||
#ifdef CORE_INT31_PIN
|
||||
static void isr31(void) { update(interruptArgs[31]); }
|
||||
#endif
|
||||
#ifdef CORE_INT32_PIN
|
||||
static void isr32(void) { update(interruptArgs[32]); }
|
||||
#endif
|
||||
#ifdef CORE_INT33_PIN
|
||||
static void isr33(void) { update(interruptArgs[33]); }
|
||||
#endif
|
||||
#ifdef CORE_INT34_PIN
|
||||
static void isr34(void) { update(interruptArgs[34]); }
|
||||
#endif
|
||||
#ifdef CORE_INT35_PIN
|
||||
static void isr35(void) { update(interruptArgs[35]); }
|
||||
#endif
|
||||
#ifdef CORE_INT36_PIN
|
||||
static void isr36(void) { update(interruptArgs[36]); }
|
||||
#endif
|
||||
#ifdef CORE_INT37_PIN
|
||||
static void isr37(void) { update(interruptArgs[37]); }
|
||||
#endif
|
||||
#ifdef CORE_INT38_PIN
|
||||
static void isr38(void) { update(interruptArgs[38]); }
|
||||
#endif
|
||||
#ifdef CORE_INT39_PIN
|
||||
static void isr39(void) { update(interruptArgs[39]); }
|
||||
#endif
|
||||
#ifdef CORE_INT40_PIN
|
||||
static void isr40(void) { update(interruptArgs[40]); }
|
||||
#endif
|
||||
#ifdef CORE_INT41_PIN
|
||||
static void isr41(void) { update(interruptArgs[41]); }
|
||||
#endif
|
||||
#ifdef CORE_INT42_PIN
|
||||
static void isr42(void) { update(interruptArgs[42]); }
|
||||
#endif
|
||||
#ifdef CORE_INT43_PIN
|
||||
static void isr43(void) { update(interruptArgs[43]); }
|
||||
#endif
|
||||
#ifdef CORE_INT44_PIN
|
||||
static void isr44(void) { update(interruptArgs[44]); }
|
||||
#endif
|
||||
#ifdef CORE_INT45_PIN
|
||||
static void isr45(void) { update(interruptArgs[45]); }
|
||||
#endif
|
||||
#ifdef CORE_INT46_PIN
|
||||
static void isr46(void) { update(interruptArgs[46]); }
|
||||
#endif
|
||||
#ifdef CORE_INT47_PIN
|
||||
static void isr47(void) { update(interruptArgs[47]); }
|
||||
#endif
|
||||
#ifdef CORE_INT48_PIN
|
||||
static void isr48(void) { update(interruptArgs[48]); }
|
||||
#endif
|
||||
#ifdef CORE_INT49_PIN
|
||||
static void isr49(void) { update(interruptArgs[49]); }
|
||||
#endif
|
||||
#ifdef CORE_INT50_PIN
|
||||
static void isr50(void) { update(interruptArgs[50]); }
|
||||
#endif
|
||||
#ifdef CORE_INT51_PIN
|
||||
static void isr51(void) { update(interruptArgs[51]); }
|
||||
#endif
|
||||
#ifdef CORE_INT52_PIN
|
||||
static void isr52(void) { update(interruptArgs[52]); }
|
||||
#endif
|
||||
#ifdef CORE_INT53_PIN
|
||||
static void isr53(void) { update(interruptArgs[53]); }
|
||||
#endif
|
||||
#ifdef CORE_INT54_PIN
|
||||
static void isr54(void) { update(interruptArgs[54]); }
|
||||
#endif
|
||||
#ifdef CORE_INT55_PIN
|
||||
static void isr55(void) { update(interruptArgs[55]); }
|
||||
#endif
|
||||
#ifdef CORE_INT56_PIN
|
||||
static void isr56(void) { update(interruptArgs[56]); }
|
||||
#endif
|
||||
#ifdef CORE_INT57_PIN
|
||||
static void isr57(void) { update(interruptArgs[57]); }
|
||||
#endif
|
||||
#ifdef CORE_INT58_PIN
|
||||
static void isr58(void) { update(interruptArgs[58]); }
|
||||
#endif
|
||||
#ifdef CORE_INT59_PIN
|
||||
static void isr59(void) { update(interruptArgs[59]); }
|
||||
#endif
|
||||
#endif
|
||||
};
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) && defined(ENCODER_OPTIMIZE_INTERRUPTS)
|
||||
#if defined(__AVR__)
|
||||
#if defined(INT0_vect) && CORE_NUM_INTERRUPT > 0
|
||||
ISR(INT0_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(0)]); }
|
||||
#endif
|
||||
#if defined(INT1_vect) && CORE_NUM_INTERRUPT > 1
|
||||
ISR(INT1_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(1)]); }
|
||||
#endif
|
||||
#if defined(INT2_vect) && CORE_NUM_INTERRUPT > 2
|
||||
ISR(INT2_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(2)]); }
|
||||
#endif
|
||||
#if defined(INT3_vect) && CORE_NUM_INTERRUPT > 3
|
||||
ISR(INT3_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(3)]); }
|
||||
#endif
|
||||
#if defined(INT4_vect) && CORE_NUM_INTERRUPT > 4
|
||||
ISR(INT4_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(4)]); }
|
||||
#endif
|
||||
#if defined(INT5_vect) && CORE_NUM_INTERRUPT > 5
|
||||
ISR(INT5_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(5)]); }
|
||||
#endif
|
||||
#if defined(INT6_vect) && CORE_NUM_INTERRUPT > 6
|
||||
ISR(INT6_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(6)]); }
|
||||
#endif
|
||||
#if defined(INT7_vect) && CORE_NUM_INTERRUPT > 7
|
||||
ISR(INT7_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(7)]); }
|
||||
#endif
|
||||
#endif // AVR
|
||||
#endif // ENCODER_OPTIMIZE_INTERRUPTS
|
||||
|
||||
|
||||
#endif
|
||||
@@ -1,29 +0,0 @@
|
||||
/* Encoder Library - Basic Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
#include <Encoder.h>
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder.
|
||||
// Best Performance: both pins have interrupt capability
|
||||
// Good Performance: only the first pin has interrupt capability
|
||||
// Low Performance: neither pin has interrupt capability
|
||||
Encoder myEnc(5, 6);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("Basic Encoder Test:");
|
||||
}
|
||||
|
||||
long oldPosition = -999;
|
||||
|
||||
void loop() {
|
||||
long newPosition = myEnc.read();
|
||||
if (newPosition != oldPosition) {
|
||||
oldPosition = newPosition;
|
||||
Serial.println(newPosition);
|
||||
}
|
||||
}
|
||||
@@ -1,46 +0,0 @@
|
||||
/* Encoder Library - NoInterrupts Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
// If you define ENCODER_DO_NOT_USE_INTERRUPTS *before* including
|
||||
// Encoder, the library will never use interrupts. This is mainly
|
||||
// useful to reduce the size of the library when you are using it
|
||||
// with pins that do not support interrupts. Without interrupts,
|
||||
// your program must call the read() function rapidly, or risk
|
||||
// missing changes in position.
|
||||
#define ENCODER_DO_NOT_USE_INTERRUPTS
|
||||
#include <Encoder.h>
|
||||
|
||||
// Beware of Serial.print() speed. Without interrupts, if you
|
||||
// transmit too much data with Serial.print() it can slow your
|
||||
// reading from Encoder. Arduino 1.0 has improved transmit code.
|
||||
// Using the fastest baud rate also helps. Teensy has USB packet
|
||||
// buffering. But all boards can experience problems if you print
|
||||
// too much and fill up buffers.
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder.
|
||||
// With ENCODER_DO_NOT_USE_INTERRUPTS, no interrupts are ever
|
||||
// used, even if the pin has interrupt capability
|
||||
Encoder myEnc(5, 6);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("Basic NoInterrupts Test:");
|
||||
}
|
||||
|
||||
long position = -999;
|
||||
|
||||
void loop() {
|
||||
long newPos = myEnc.read();
|
||||
if (newPos != position) {
|
||||
position = newPos;
|
||||
Serial.println(position);
|
||||
}
|
||||
// With any substantial delay added, Encoder can only track
|
||||
// very slow motion. You may uncomment this line to see
|
||||
// how badly a delay affects your encoder.
|
||||
//delay(50);
|
||||
}
|
||||
@@ -1,113 +0,0 @@
|
||||
/* Encoder Library - SpeedTest - for measuring maximum Encoder speed
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
|
||||
// This SpeedTest example provides a simple way to verify how much
|
||||
// CPU time Encoder is consuming. Connect a DC voltmeter to the
|
||||
// output pin and measure the voltage while the encoder is stopped
|
||||
// or running at a very slow speed. Even though the pin is rapidly
|
||||
// pulsing, a DC voltmeter will show the average voltage. Due to
|
||||
// software timing, it will read a number much less than a steady
|
||||
// logic high, but this number will give you a baseline reading
|
||||
// for output with minimal interrupt overhead. Then increase the
|
||||
// encoder speed. The voltage will decrease as the processor spends
|
||||
// more time in Encoder's interrupt routines counting the pulses
|
||||
// and less time pulsing the output pin. When the voltage is
|
||||
// close to zero and will not decrease any farther, you have reached
|
||||
// the absolute speed limit. Or, if using a mechanical system where
|
||||
// you reach a speed limit imposed by your motors or other hardware,
|
||||
// the amount this voltage has decreased, compared to the baseline,
|
||||
// should give you a good approximation of the portion of available
|
||||
// CPU time Encoder is consuming at your maximum speed.
|
||||
|
||||
// Encoder requires low latency interrupt response. Available CPU
|
||||
// time does NOT necessarily prove or guarantee correct performance.
|
||||
// If another library, like NewSoftSerial, is disabling interrupts
|
||||
// for lengthy periods of time, Encoder can be prevented from
|
||||
// properly counting the intput signals while interrupt are disabled.
|
||||
|
||||
|
||||
// This optional setting causes Encoder to use more optimized code,
|
||||
// but the downside is a conflict if any other part of your sketch
|
||||
// or any other library you're using requires attachInterrupt().
|
||||
// It must be defined before Encoder.h is included.
|
||||
//#define ENCODER_OPTIMIZE_INTERRUPTS
|
||||
|
||||
#include <Encoder.h>
|
||||
#include "pins_arduino.h"
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder
|
||||
// or shift register circuit which emulates a quadrature encoder
|
||||
// case 1: both pins are interrupts
|
||||
// case 2: only first pin used as interrupt
|
||||
Encoder myEnc(5, 6);
|
||||
|
||||
// Connect a DC voltmeter to this pin.
|
||||
const int outputPin = 12;
|
||||
|
||||
/* This simple circuit, using a Dual Flip-Flop chip, can emulate
|
||||
quadrature encoder signals. The clock can come from a fancy
|
||||
function generator or a cheap 555 timer chip. The clock
|
||||
frequency can be measured with another board running FreqCount
|
||||
http://www.pjrc.com/teensy/td_libs_FreqCount.html
|
||||
|
||||
+5V
|
||||
| Quadrature Encoder Signal Emulator
|
||||
Clock |
|
||||
Input o----*-------------------------- ---------------------------o Output1
|
||||
| |14 | |
|
||||
| _______|_______ | | _______________
|
||||
| | CD4013 | | | | CD4013 |
|
||||
| 5 | | 1 | | 9 | | 13
|
||||
---------| D Q |-----|----*----| D Q |------o Output2
|
||||
| | | | | | |
|
||||
| | 3 | | | 11 | |
|
||||
| ----|> Clk | ---------|> Clk |
|
||||
| | | | |
|
||||
| 6 | | 8 | |
|
||||
| ----| S | ----| S |
|
||||
| | | | | | |
|
||||
| | 4 | _ | 2 | 10 | _ | 12
|
||||
| *----| R Q |--- *----| R Q |----
|
||||
| | | | | | | |
|
||||
| | |_______________| | |_______________| |
|
||||
| | | | |
|
||||
| | | 7 | |
|
||||
| | | | |
|
||||
--------------------------------------------------------------
|
||||
| | |
|
||||
| | |
|
||||
----- ----- -----
|
||||
--- --- ---
|
||||
- - -
|
||||
*/
|
||||
|
||||
|
||||
void setup() {
|
||||
pinMode(outputPin, OUTPUT);
|
||||
}
|
||||
|
||||
#if defined(__AVR__)
|
||||
#define REGTYPE unsigned char
|
||||
#elif defined(__PIC32MX__)
|
||||
#define REGTYPE unsigned long
|
||||
#endif
|
||||
|
||||
void loop() {
|
||||
volatile int count = 0;
|
||||
volatile REGTYPE *reg = portOutputRegister(digitalPinToPort(outputPin));
|
||||
REGTYPE mask = digitalPinToBitMask(outputPin);
|
||||
|
||||
while (1) {
|
||||
myEnc.read(); // Read the encoder while interrupts are enabled.
|
||||
noInterrupts();
|
||||
*reg |= mask; // Pulse the pin high, while interrupts are disabled.
|
||||
count = count + 1;
|
||||
*reg &= ~mask;
|
||||
interrupts();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
/* Encoder Library - TwoKnobs Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
#include <Encoder.h>
|
||||
|
||||
// Change these pin numbers to the pins connected to your encoder.
|
||||
// Best Performance: both pins have interrupt capability
|
||||
// Good Performance: only the first pin has interrupt capability
|
||||
// Low Performance: neither pin has interrupt capability
|
||||
Encoder knobLeft(5, 6);
|
||||
Encoder knobRight(7, 8);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("TwoKnobs Encoder Test:");
|
||||
}
|
||||
|
||||
long positionLeft = -999;
|
||||
long positionRight = -999;
|
||||
|
||||
void loop() {
|
||||
long newLeft, newRight;
|
||||
newLeft = knobLeft.read();
|
||||
newRight = knobRight.read();
|
||||
if (newLeft != positionLeft || newRight != positionRight) {
|
||||
Serial.print("Left = ");
|
||||
Serial.print(newLeft);
|
||||
Serial.print(", Right = ");
|
||||
Serial.print(newRight);
|
||||
Serial.println();
|
||||
positionLeft = newLeft;
|
||||
positionRight = newRight;
|
||||
}
|
||||
// if a character is sent from the serial monitor,
|
||||
// reset both back to zero.
|
||||
if (Serial.available()) {
|
||||
Serial.read();
|
||||
Serial.println("Reset both knobs to zero");
|
||||
knobLeft.write(0);
|
||||
knobRight.write(0);
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
ENCODER_USE_INTERRUPTS LITERAL1
|
||||
ENCODER_OPTIMIZE_INTERRUPTS LITERAL1
|
||||
ENCODER_DO_NOT_USE_INTERRUPTS LITERAL1
|
||||
Encoder KEYWORD1
|
||||
@@ -1,27 +0,0 @@
|
||||
#ifndef direct_pin_read_h_
|
||||
#define direct_pin_read_h_
|
||||
|
||||
#if defined(__AVR__) || defined(__MK20DX128__) || defined(__MK20DX256__)
|
||||
|
||||
#define IO_REG_TYPE uint8_t
|
||||
#define PIN_TO_BASEREG(pin) (portInputRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base)) & (mask)) ? 1 : 0)
|
||||
|
||||
#elif defined(__SAM3X8E__)
|
||||
|
||||
#define IO_REG_TYPE uint32_t
|
||||
#define PIN_TO_BASEREG(pin) (portInputRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base)) & (mask)) ? 1 : 0)
|
||||
|
||||
#elif defined(__PIC32MX__)
|
||||
|
||||
#define IO_REG_TYPE uint32_t
|
||||
#define PIN_TO_BASEREG(pin) (portModeRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base+4)) & (mask)) ? 1 : 0)
|
||||
|
||||
#endif
|
||||
|
||||
#endif
|
||||
@@ -1,87 +0,0 @@
|
||||
#if defined(__AVR__)
|
||||
|
||||
#include <avr/io.h>
|
||||
#include <avr/interrupt.h>
|
||||
|
||||
#define attachInterrupt(num, func, mode) enableInterrupt(num)
|
||||
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
#define SCRAMBLE_INT_ORDER(num) ((num < 4) ? num + 2 : ((num < 6) ? num - 4 : num))
|
||||
#define DESCRAMBLE_INT_ORDER(num) ((num < 2) ? num + 4 : ((num < 6) ? num - 2 : num))
|
||||
#else
|
||||
#define SCRAMBLE_INT_ORDER(num) (num)
|
||||
#define DESCRAMBLE_INT_ORDER(num) (num)
|
||||
#endif
|
||||
|
||||
static void enableInterrupt(uint8_t num)
|
||||
{
|
||||
switch (DESCRAMBLE_INT_ORDER(num)) {
|
||||
#if defined(EICRA) && defined(EIMSK)
|
||||
case 0:
|
||||
EICRA = (EICRA & 0xFC) | 0x01;
|
||||
EIMSK |= 0x01;
|
||||
return;
|
||||
case 1:
|
||||
EICRA = (EICRA & 0xF3) | 0x04;
|
||||
EIMSK |= 0x02;
|
||||
return;
|
||||
case 2:
|
||||
EICRA = (EICRA & 0xCF) | 0x10;
|
||||
EIMSK |= 0x04;
|
||||
return;
|
||||
case 3:
|
||||
EICRA = (EICRA & 0x3F) | 0x40;
|
||||
EIMSK |= 0x08;
|
||||
return;
|
||||
#elif defined(MCUCR) && defined(GICR)
|
||||
case 0:
|
||||
MCUCR = (MCUCR & ~((1 << ISC00) | (1 << ISC01))) | (mode << ISC00);
|
||||
GICR |= (1 << INT0);
|
||||
return;
|
||||
case 1:
|
||||
MCUCR = (MCUCR & ~((1 << ISC10) | (1 << ISC11))) | (mode << ISC10);
|
||||
GICR |= (1 << INT1);
|
||||
return;
|
||||
#elif defined(MCUCR) && defined(GIMSK)
|
||||
case 0:
|
||||
MCUCR = (MCUCR & ~((1 << ISC00) | (1 << ISC01))) | (mode << ISC00);
|
||||
GIMSK |= (1 << INT0);
|
||||
return;
|
||||
case 1:
|
||||
MCUCR = (MCUCR & ~((1 << ISC10) | (1 << ISC11))) | (mode << ISC10);
|
||||
GIMSK |= (1 << INT1);
|
||||
return;
|
||||
#endif
|
||||
#if defined(EICRB) && defined(EIMSK)
|
||||
case 4:
|
||||
EICRB = (EICRB & 0xFC) | 0x01;
|
||||
EIMSK |= 0x10;
|
||||
return;
|
||||
case 5:
|
||||
EICRB = (EICRB & 0xF3) | 0x04;
|
||||
EIMSK |= 0x20;
|
||||
return;
|
||||
case 6:
|
||||
EICRB = (EICRB & 0xCF) | 0x10;
|
||||
EIMSK |= 0x40;
|
||||
return;
|
||||
case 7:
|
||||
EICRB = (EICRB & 0x3F) | 0x40;
|
||||
EIMSK |= 0x80;
|
||||
return;
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
#elif defined(__PIC32MX__)
|
||||
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#undef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#endif
|
||||
|
||||
#else
|
||||
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#undef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#endif
|
||||
|
||||
#endif
|
||||
@@ -1,156 +0,0 @@
|
||||
// interrupt pins for known boards
|
||||
|
||||
// Teensy (and maybe others) define these automatically
|
||||
#if !defined(CORE_NUM_INTERRUPT)
|
||||
|
||||
// Wiring boards
|
||||
#if defined(WIRING)
|
||||
#define CORE_NUM_INTERRUPT NUM_EXTERNAL_INTERRUPTS
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 0
|
||||
#define CORE_INT0_PIN EI0
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 1
|
||||
#define CORE_INT1_PIN EI1
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 2
|
||||
#define CORE_INT2_PIN EI2
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 3
|
||||
#define CORE_INT3_PIN EI3
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 4
|
||||
#define CORE_INT4_PIN EI4
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 5
|
||||
#define CORE_INT5_PIN EI5
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 6
|
||||
#define CORE_INT6_PIN EI6
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 7
|
||||
#define CORE_INT7_PIN EI7
|
||||
#endif
|
||||
|
||||
// Arduino Uno, Duemilanove, Diecimila, LilyPad, Mini, Fio, etc...
|
||||
#elif defined(__AVR_ATmega328P__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega8__)
|
||||
#define CORE_NUM_INTERRUPT 2
|
||||
#define CORE_INT0_PIN 2
|
||||
#define CORE_INT1_PIN 3
|
||||
|
||||
// Arduino Mega
|
||||
#elif defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
#define CORE_NUM_INTERRUPT 6
|
||||
#define CORE_INT0_PIN 2
|
||||
#define CORE_INT1_PIN 3
|
||||
#define CORE_INT2_PIN 21
|
||||
#define CORE_INT3_PIN 20
|
||||
#define CORE_INT4_PIN 19
|
||||
#define CORE_INT5_PIN 18
|
||||
|
||||
// Arduino Leonardo (untested)
|
||||
#elif defined(__AVR_ATmega32U4__) && !defined(CORE_TEENSY)
|
||||
#define CORE_NUM_INTERRUPT 4
|
||||
#define CORE_INT0_PIN 3
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 0
|
||||
#define CORE_INT3_PIN 1
|
||||
|
||||
// Sanguino (untested)
|
||||
#elif defined(__AVR_ATmega644P__) || defined(__AVR_ATmega644__)
|
||||
#define CORE_NUM_INTERRUPT 3
|
||||
#define CORE_INT0_PIN 10
|
||||
#define CORE_INT1_PIN 11
|
||||
#define CORE_INT2_PIN 2
|
||||
|
||||
// Chipkit Uno32 - attachInterrupt may not support CHANGE option
|
||||
#elif defined(__PIC32MX__) && defined(_BOARD_UNO_)
|
||||
#define CORE_NUM_INTERRUPT 5
|
||||
#define CORE_INT0_PIN 38
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 7
|
||||
#define CORE_INT3_PIN 8
|
||||
#define CORE_INT4_PIN 35
|
||||
|
||||
// Chipkit Uno32 - attachInterrupt may not support CHANGE option
|
||||
#elif defined(__PIC32MX__) && defined(_BOARD_MEGA_)
|
||||
#define CORE_NUM_INTERRUPT 5
|
||||
#define CORE_INT0_PIN 3
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 7
|
||||
#define CORE_INT3_PIN 21
|
||||
#define CORE_INT4_PIN 20
|
||||
|
||||
// http://hlt.media.mit.edu/?p=1229
|
||||
#elif defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
|
||||
#define CORE_NUM_INTERRUPT 1
|
||||
#define CORE_INT0_PIN 2
|
||||
|
||||
// Arduino Due (untested)
|
||||
#elif defined(__SAM3X8E__)
|
||||
#define CORE_NUM_INTERRUPT 54
|
||||
#define CORE_INT0_PIN 0
|
||||
#define CORE_INT1_PIN 1
|
||||
#define CORE_INT2_PIN 2
|
||||
#define CORE_INT3_PIN 3
|
||||
#define CORE_INT4_PIN 4
|
||||
#define CORE_INT5_PIN 5
|
||||
#define CORE_INT6_PIN 6
|
||||
#define CORE_INT7_PIN 7
|
||||
#define CORE_INT8_PIN 8
|
||||
#define CORE_INT9_PIN 9
|
||||
#define CORE_INT10_PIN 10
|
||||
#define CORE_INT11_PIN 11
|
||||
#define CORE_INT12_PIN 12
|
||||
#define CORE_INT13_PIN 13
|
||||
#define CORE_INT14_PIN 14
|
||||
#define CORE_INT15_PIN 15
|
||||
#define CORE_INT16_PIN 16
|
||||
#define CORE_INT17_PIN 17
|
||||
#define CORE_INT18_PIN 18
|
||||
#define CORE_INT19_PIN 19
|
||||
#define CORE_INT20_PIN 20
|
||||
#define CORE_INT21_PIN 21
|
||||
#define CORE_INT22_PIN 22
|
||||
#define CORE_INT23_PIN 23
|
||||
#define CORE_INT24_PIN 24
|
||||
#define CORE_INT25_PIN 25
|
||||
#define CORE_INT26_PIN 26
|
||||
#define CORE_INT27_PIN 27
|
||||
#define CORE_INT28_PIN 28
|
||||
#define CORE_INT29_PIN 29
|
||||
#define CORE_INT30_PIN 30
|
||||
#define CORE_INT31_PIN 31
|
||||
#define CORE_INT32_PIN 32
|
||||
#define CORE_INT33_PIN 33
|
||||
#define CORE_INT34_PIN 34
|
||||
#define CORE_INT35_PIN 35
|
||||
#define CORE_INT36_PIN 36
|
||||
#define CORE_INT37_PIN 37
|
||||
#define CORE_INT38_PIN 38
|
||||
#define CORE_INT39_PIN 39
|
||||
#define CORE_INT40_PIN 40
|
||||
#define CORE_INT41_PIN 41
|
||||
#define CORE_INT42_PIN 42
|
||||
#define CORE_INT43_PIN 43
|
||||
#define CORE_INT44_PIN 44
|
||||
#define CORE_INT45_PIN 45
|
||||
#define CORE_INT46_PIN 46
|
||||
#define CORE_INT47_PIN 47
|
||||
#define CORE_INT48_PIN 48
|
||||
#define CORE_INT49_PIN 49
|
||||
#define CORE_INT50_PIN 50
|
||||
#define CORE_INT51_PIN 51
|
||||
#define CORE_INT52_PIN 52
|
||||
#define CORE_INT53_PIN 53
|
||||
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if !defined(CORE_NUM_INTERRUPT)
|
||||
#error "Interrupts are unknown for this board, please add to this code"
|
||||
#endif
|
||||
#if CORE_NUM_INTERRUPT <= 0
|
||||
#error "Encoder requires interrupt pins, but this board does not have any :("
|
||||
#error "You could try defining ENCODER_DO_NOT_USE_INTERRUPTS as a kludge."
|
||||
#endif
|
||||
|
||||
@@ -1,170 +0,0 @@
|
||||
#include <CarrierHeatpumpIR.h>
|
||||
|
||||
CarrierHeatpumpIR::CarrierHeatpumpIR() : HeatpumpIR()
|
||||
{
|
||||
static const char PROGMEM model[] PROGMEM = "carrier";
|
||||
static const char PROGMEM info[] PROGMEM = "{\"mdl\":\"carrier\",\"dn\":\"Carrier\",\"mT\":17,\"xT\":30,\"fs\":6}";
|
||||
|
||||
_model = model;
|
||||
_info = info;
|
||||
}
|
||||
|
||||
|
||||
void CarrierHeatpumpIR::send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd)
|
||||
{
|
||||
(void)swingVCmd;
|
||||
(void)swingHCmd;
|
||||
|
||||
// Sensible defaults for the heat pump mode
|
||||
|
||||
uint8_t operatingMode = CARRIER_AIRCON1_MODE_HEAT;
|
||||
uint8_t fanSpeed = CARRIER_AIRCON1_FAN_AUTO;
|
||||
uint8_t temperature = 23;
|
||||
|
||||
if (powerModeCmd == POWER_OFF)
|
||||
{
|
||||
operatingMode = CARRIER_AIRCON1_MODE_OFF;
|
||||
}
|
||||
else
|
||||
{
|
||||
switch (operatingModeCmd)
|
||||
{
|
||||
case MODE_AUTO:
|
||||
operatingMode = CARRIER_AIRCON1_MODE_AUTO;
|
||||
break;
|
||||
case MODE_HEAT:
|
||||
operatingMode = CARRIER_AIRCON1_MODE_HEAT;
|
||||
break;
|
||||
case MODE_COOL:
|
||||
operatingMode = CARRIER_AIRCON1_MODE_COOL;
|
||||
break;
|
||||
case MODE_DRY:
|
||||
operatingMode = CARRIER_AIRCON1_MODE_DRY;
|
||||
fanSpeedCmd = FAN_AUTO; // Fan speed is always 'AUTO' in DRY mode
|
||||
break;
|
||||
case MODE_FAN:
|
||||
operatingMode = CARRIER_AIRCON1_MODE_FAN;
|
||||
temperatureCmd = 22; // Temperature is always 22 in FAN mode
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
switch (fanSpeedCmd)
|
||||
{
|
||||
case FAN_AUTO:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN_AUTO;
|
||||
break;
|
||||
case FAN_1:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN1;
|
||||
break;
|
||||
case FAN_2:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN2;
|
||||
break;
|
||||
case FAN_3:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN3;
|
||||
break;
|
||||
case FAN_4:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN4;
|
||||
break;
|
||||
case FAN_5:
|
||||
fanSpeed = CARRIER_AIRCON1_FAN5;
|
||||
break;
|
||||
}
|
||||
|
||||
if ( temperatureCmd > 16 && temperatureCmd < 31)
|
||||
{
|
||||
temperature = temperatureCmd;
|
||||
}
|
||||
|
||||
sendCarrier(IR, operatingMode, fanSpeed, temperature);
|
||||
}
|
||||
|
||||
// Send the Carrier code
|
||||
// Carrier has the LSB and MSB in different format than Panasonic
|
||||
|
||||
void CarrierHeatpumpIR::sendCarrier(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature)
|
||||
{
|
||||
uint8_t sendBuffer[9] = { 0x4f, 0xb0, 0xc0, 0x3f, 0x80, 0x00, 0x00, 0x00, 0x00 }; // The data is on the last four uint8_ts
|
||||
|
||||
static const uint8_t temperatures[] PROGMEM = { 0x00, 0x08, 0x04, 0x0c, 0x02, 0x0a, 0x06, 0x0e, 0x01, 0x09, 0x05, 0x0d, 0x03, 0x0b };
|
||||
uint8_t checksum = 0;
|
||||
|
||||
// PROGMEM arrays cannot be addressed directly, see http://forum.arduino.cc/index.php?topic=106603.0
|
||||
sendBuffer[5] = pgm_read_byte(&(temperatures[(temperature-17)]));
|
||||
|
||||
sendBuffer[6] = operatingMode | fanSpeed;
|
||||
|
||||
// Checksum
|
||||
|
||||
for (int i=0; i<8; i++) {
|
||||
checksum += IR.bitReverse(sendBuffer[i]);
|
||||
}
|
||||
|
||||
// There's something really strange with the checksum calculation...
|
||||
// With these many of the codes matchs with the code from the real Carrier remote
|
||||
// Still certain temperatures do not work with fan speeds 1, 2 or 5
|
||||
|
||||
switch (sendBuffer[6] & 0xF0) {
|
||||
case 0x00: // MODE_AUTO - certain temperature / fan speed combinations do not work
|
||||
checksum += 0x02;
|
||||
switch (sendBuffer[6] & 0x0F) {
|
||||
case 0x02: // FAN1
|
||||
case 0x03: // FAN5
|
||||
case 0x06: // FAN2
|
||||
checksum += 0x80;
|
||||
break;
|
||||
}
|
||||
break;
|
||||
case 0x40: // MODE_DRY - all settings should work
|
||||
checksum += 0x02;
|
||||
break;
|
||||
case 0xC0: // MODE_HEAT - certain temperature / fan speed combinations do not work
|
||||
switch (sendBuffer[6] & 0x0F) {
|
||||
case 0x05: // FAN4
|
||||
case 0x06: // FAN2
|
||||
checksum += 0xC0;
|
||||
break;
|
||||
}
|
||||
break;
|
||||
case 0x20: // MODE_FAN - all settings should work
|
||||
checksum += 0x02;
|
||||
switch (sendBuffer[6] & 0x0F) {
|
||||
case 0x02: // FAN1
|
||||
case 0x03: // FAN5
|
||||
case 0x06: // FAN2
|
||||
checksum += 0x80;
|
||||
break;
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
sendBuffer[8] = IR.bitReverse(checksum);
|
||||
|
||||
// 40 kHz PWM frequency
|
||||
IR.setFrequency(38);
|
||||
|
||||
// Header
|
||||
IR.mark(CARRIER_AIRCON1_HDR_MARK);
|
||||
IR.space(CARRIER_AIRCON1_HDR_SPACE);
|
||||
|
||||
// Payload
|
||||
for (size_t i=0; i<sizeof(sendBuffer); i++) {
|
||||
IR.sendIRbyte(sendBuffer[i], CARRIER_AIRCON1_BIT_MARK, CARRIER_AIRCON1_ZERO_SPACE, CARRIER_AIRCON1_ONE_SPACE);
|
||||
}
|
||||
|
||||
// Pause + new header
|
||||
IR.mark(CARRIER_AIRCON1_BIT_MARK);
|
||||
IR.space(CARRIER_AIRCON1_MSG_SPACE);
|
||||
|
||||
IR.mark(CARRIER_AIRCON1_HDR_MARK);
|
||||
IR.space(CARRIER_AIRCON1_HDR_SPACE);
|
||||
|
||||
// Payload again
|
||||
for (size_t i=0; i<sizeof(sendBuffer); i++) {
|
||||
IR.sendIRbyte(sendBuffer[i], CARRIER_AIRCON1_BIT_MARK, CARRIER_AIRCON1_ZERO_SPACE, CARRIER_AIRCON1_ONE_SPACE);
|
||||
}
|
||||
|
||||
// End mark
|
||||
IR.mark(CARRIER_AIRCON1_BIT_MARK);
|
||||
IR.space(0);
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
/*
|
||||
Carrier 42NQV035G / 38NYV035H2 heatpump control (remote control P/N WH-L05SE)
|
||||
*/
|
||||
#ifndef CarrierHeatpumpIR_h
|
||||
#define CarrierHeatpumpIR_h
|
||||
|
||||
#include <HeatpumpIR.h>
|
||||
|
||||
// Carrier (42NQV035G / 38NYV035H2) timing constants (remote control P/N WH-L05SE)
|
||||
#define CARRIER_AIRCON1_HDR_MARK 4320
|
||||
#define CARRIER_AIRCON1_HDR_SPACE 4350
|
||||
#define CARRIER_AIRCON1_BIT_MARK 500
|
||||
#define CARRIER_AIRCON1_ONE_SPACE 1650
|
||||
#define CARRIER_AIRCON1_ZERO_SPACE 550
|
||||
#define CARRIER_AIRCON1_MSG_SPACE 7400
|
||||
|
||||
// Carrier codes
|
||||
#define CARRIER_AIRCON1_MODE_AUTO 0x00 // Operating mode
|
||||
#define CARRIER_AIRCON1_MODE_HEAT 0xC0
|
||||
#define CARRIER_AIRCON1_MODE_COOL 0x80
|
||||
#define CARRIER_AIRCON1_MODE_DRY 0x40
|
||||
#define CARRIER_AIRCON1_MODE_FAN 0x20
|
||||
#define CARRIER_AIRCON1_MODE_OFF 0xE0 // Power OFF
|
||||
#define CARRIER_AIRCON1_FAN_AUTO 0x00 // Fan speed
|
||||
#define CARRIER_AIRCON1_FAN1 0x02
|
||||
#define CARRIER_AIRCON1_FAN2 0x06
|
||||
#define CARRIER_AIRCON1_FAN3 0x01
|
||||
#define CARRIER_AIRCON1_FAN4 0x05
|
||||
#define CARRIER_AIRCON1_FAN5 0x03
|
||||
|
||||
|
||||
class CarrierHeatpumpIR : public HeatpumpIR
|
||||
{
|
||||
public:
|
||||
CarrierHeatpumpIR();
|
||||
void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd);
|
||||
|
||||
private:
|
||||
void sendCarrier(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature);
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,146 +0,0 @@
|
||||
#include <DaikinHeatpumpIR.h>
|
||||
|
||||
DaikinHeatpumpIR::DaikinHeatpumpIR() : HeatpumpIR()
|
||||
{
|
||||
static const char PROGMEM model[] PROGMEM = "daikin";
|
||||
static const char PROGMEM info[] PROGMEM = "{\"mdl\":\"daikin\",\"dn\":\"Daikin\",\"mT\":18,\"xT\":30,\"fs\":6,\"maint\":[10,11,12,13,14,15,16,17]}}}";
|
||||
|
||||
_model = model;
|
||||
_info = info;
|
||||
}
|
||||
|
||||
|
||||
// Daikin numeric values to command bytes
|
||||
void DaikinHeatpumpIR::send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd)
|
||||
{
|
||||
// Sensible defaults for the heat pump mode
|
||||
|
||||
uint8_t operatingMode = DAIKIN_AIRCON_MODE_OFF | DAIKIN_AIRCON_MODE_AUTO;
|
||||
uint8_t fanSpeed = DAIKIN_AIRCON_FAN_AUTO;
|
||||
uint8_t temperature = 23;
|
||||
|
||||
switch (powerModeCmd)
|
||||
{
|
||||
case POWER_ON:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_ON;
|
||||
break;
|
||||
}
|
||||
|
||||
switch (operatingModeCmd)
|
||||
{
|
||||
case MODE_AUTO:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_AUTO;
|
||||
break;
|
||||
case MODE_HEAT:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_HEAT;
|
||||
break;
|
||||
case MODE_COOL:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_COOL;
|
||||
break;
|
||||
case MODE_DRY:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_DRY;
|
||||
temperatureCmd = 0x24;
|
||||
break;
|
||||
case MODE_FAN:
|
||||
operatingMode |= DAIKIN_AIRCON_MODE_FAN;
|
||||
temperatureCmd = 0xC0;
|
||||
break;
|
||||
}
|
||||
|
||||
switch (fanSpeedCmd)
|
||||
{
|
||||
case FAN_AUTO:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN_AUTO;
|
||||
break;
|
||||
case FAN_1:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN1;
|
||||
break;
|
||||
case FAN_2:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN2;
|
||||
break;
|
||||
case FAN_3:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN3;
|
||||
break;
|
||||
case FAN_4:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN4;
|
||||
break;
|
||||
case FAN_5:
|
||||
fanSpeed = DAIKIN_AIRCON_FAN5;
|
||||
break;
|
||||
}
|
||||
|
||||
if ((operatingModeCmd == DAIKIN_AIRCON_MODE_HEAT && temperatureCmd >= 10 && temperatureCmd <= 30) ||
|
||||
(temperatureCmd >= 18 && temperatureCmd <= 30))
|
||||
{
|
||||
temperature = temperatureCmd << 1;
|
||||
}
|
||||
|
||||
sendDaikin(IR, operatingMode, fanSpeed, temperature, swingVCmd, swingHCmd);
|
||||
}
|
||||
|
||||
|
||||
// Send the Daikin code
|
||||
void DaikinHeatpumpIR::sendDaikin(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV, uint8_t swingH)
|
||||
{
|
||||
(void)swingV;
|
||||
(void)swingH;
|
||||
|
||||
uint8_t daikinTemplate[35] = {
|
||||
0x11, 0xDA, 0x27, 0x00, 0xC5, 0x00, 0x00, 0xD7, // First header
|
||||
// 0 1 2 3 4 5 6 7
|
||||
0x11, 0xDA, 0x27, 0x00, 0x42, 0x49, 0x05, 0xA2, // Second header, this seems to have the wall clock time (bytes 12 & 13 are changing)
|
||||
// 8 9 10 11 12 13 14 15
|
||||
0x11, 0xDA, 0x27, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x06, 0x60, 0x00, 0x00, 0xC0, 0x00, 0x00, 0x00 };
|
||||
// 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
|
||||
|
||||
daikinTemplate[21] = operatingMode;
|
||||
daikinTemplate[22] = temperature;
|
||||
daikinTemplate[24] = fanSpeed;
|
||||
|
||||
// Checksum calculation
|
||||
// * Checksums at bytes 7 and 15 are calculated the same way
|
||||
uint8_t checksum = 0x00;
|
||||
|
||||
for (int i=16; i<34; i++) {
|
||||
checksum += daikinTemplate[i];
|
||||
}
|
||||
|
||||
daikinTemplate[34] = checksum;
|
||||
|
||||
// 38 kHz PWM frequency
|
||||
IR.setFrequency(38);
|
||||
|
||||
// Header
|
||||
IR.mark(DAIKIN_AIRCON_HDR_MARK);
|
||||
IR.space(DAIKIN_AIRCON_HDR_SPACE);
|
||||
|
||||
// First header
|
||||
for (int i=0; i<8; i++) {
|
||||
IR.sendIRbyte(daikinTemplate[i], DAIKIN_AIRCON_BIT_MARK, DAIKIN_AIRCON_ZERO_SPACE, DAIKIN_AIRCON_ONE_SPACE);
|
||||
}
|
||||
|
||||
// Pause + new header
|
||||
IR.mark(DAIKIN_AIRCON_BIT_MARK);
|
||||
IR.space(DAIKIN_AIRCON_MSG_SPACE);
|
||||
IR.mark(DAIKIN_AIRCON_HDR_MARK);
|
||||
IR.space(DAIKIN_AIRCON_HDR_SPACE);
|
||||
|
||||
// Second header - this probably has the wall clock time
|
||||
for (int i=8; i<16; i++) {
|
||||
IR.sendIRbyte(daikinTemplate[i], DAIKIN_AIRCON_BIT_MARK, DAIKIN_AIRCON_ZERO_SPACE, DAIKIN_AIRCON_ONE_SPACE);
|
||||
}
|
||||
|
||||
// Pause + new header
|
||||
IR.mark(DAIKIN_AIRCON_BIT_MARK);
|
||||
IR.space(DAIKIN_AIRCON_MSG_SPACE);
|
||||
IR.mark(DAIKIN_AIRCON_HDR_MARK);
|
||||
IR.space(DAIKIN_AIRCON_HDR_SPACE);
|
||||
|
||||
// Last 19 bytes - the actual payload
|
||||
for (int i=16; i<35; i++) {
|
||||
IR.sendIRbyte(daikinTemplate[i], DAIKIN_AIRCON_BIT_MARK, DAIKIN_AIRCON_ZERO_SPACE, DAIKIN_AIRCON_ONE_SPACE);
|
||||
}
|
||||
|
||||
IR.mark(DAIKIN_AIRCON_BIT_MARK);
|
||||
IR.space(0);
|
||||
}
|
||||
@@ -1,44 +0,0 @@
|
||||
/*
|
||||
Daikin heatpump control (Daikin remote control P/N ARC433B50)
|
||||
*/
|
||||
#ifndef DaikinHeatpumpIR_h
|
||||
#define DaikinHeatpumpIR_h
|
||||
|
||||
#include <HeatpumpIR.h>
|
||||
|
||||
|
||||
// Daikin timing constants
|
||||
#define DAIKIN_AIRCON_HDR_MARK 3360 // 3300
|
||||
#define DAIKIN_AIRCON_HDR_SPACE 1760 // 1600
|
||||
#define DAIKIN_AIRCON_BIT_MARK 360 // 310
|
||||
#define DAIKIN_AIRCON_ONE_SPACE 1370 // 1220
|
||||
#define DAIKIN_AIRCON_ZERO_SPACE 520 // 400
|
||||
#define DAIKIN_AIRCON_MSG_SPACE 32300 // 30800
|
||||
|
||||
// Daikin codes
|
||||
#define DAIKIN_AIRCON_MODE_AUTO 0x00 // Operating mode
|
||||
#define DAIKIN_AIRCON_MODE_HEAT 0x40
|
||||
#define DAIKIN_AIRCON_MODE_COOL 0x30
|
||||
#define DAIKIN_AIRCON_MODE_DRY 0x20
|
||||
#define DAIKIN_AIRCON_MODE_FAN 0x60
|
||||
#define DAIKIN_AIRCON_MODE_OFF 0x00 // Power OFF
|
||||
#define DAIKIN_AIRCON_MODE_ON 0x01
|
||||
#define DAIKIN_AIRCON_FAN_AUTO 0xA0 // Fan speed
|
||||
#define DAIKIN_AIRCON_FAN1 0x30
|
||||
#define DAIKIN_AIRCON_FAN2 0x40
|
||||
#define DAIKIN_AIRCON_FAN3 0x50
|
||||
#define DAIKIN_AIRCON_FAN4 0x60
|
||||
#define DAIKIN_AIRCON_FAN5 0x70
|
||||
|
||||
|
||||
class DaikinHeatpumpIR : public HeatpumpIR
|
||||
{
|
||||
public:
|
||||
DaikinHeatpumpIR();
|
||||
void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd);
|
||||
|
||||
private:
|
||||
void sendDaikin(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV, uint8_t swingH);
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,193 +0,0 @@
|
||||
#include <FujitsuHeatpumpIR.h>
|
||||
|
||||
FujitsuHeatpumpIR::FujitsuHeatpumpIR() : HeatpumpIR()
|
||||
{
|
||||
static const char PROGMEM model[] PROGMEM = "fujitsu_awyz";
|
||||
static const char PROGMEM info[] PROGMEM = "{\"mdl\":\"fujitsu_awyz\",\"dn\":\"Fujitsu AWYZ\",\"mT\":16,\"xT\":30,\"fs\":5}";
|
||||
|
||||
_model = model;
|
||||
_info = info;
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd)
|
||||
{
|
||||
send(IR, powerModeCmd, operatingModeCmd, fanSpeedCmd, temperatureCmd, swingVCmd, swingHCmd, false);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd, bool ecoModeCmd)
|
||||
{
|
||||
// Sensible defaults for the heat pump mode
|
||||
|
||||
uint8_t operatingMode = FUJITSU_AIRCON1_MODE_HEAT;
|
||||
uint8_t fanSpeed = FUJITSU_AIRCON1_FAN_AUTO;
|
||||
uint8_t temperature = 23;
|
||||
uint8_t swingV = FUJITSU_AIRCON1_VDIR_MANUAL;
|
||||
uint8_t swingH = FUJITSU_AIRCON1_HDIR_MANUAL;
|
||||
uint8_t ecoMode = FUJITSU_AIRCON1_ECO_OFF;
|
||||
|
||||
if (powerModeCmd == POWER_OFF)
|
||||
{
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_OFF;
|
||||
}
|
||||
else
|
||||
{
|
||||
switch (operatingModeCmd)
|
||||
{
|
||||
case MODE_AUTO:
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_AUTO;
|
||||
break;
|
||||
case MODE_HEAT:
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_HEAT;
|
||||
break;
|
||||
case MODE_COOL:
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_COOL;
|
||||
break;
|
||||
case MODE_DRY:
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_DRY;
|
||||
break;
|
||||
case MODE_FAN:
|
||||
operatingMode = FUJITSU_AIRCON1_MODE_FAN;
|
||||
// When Fujitsu goes to FAN mode, it sets the low bit of the uint8_t with the temperature. What is the meaning of that?
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
switch (fanSpeedCmd)
|
||||
{
|
||||
case FAN_AUTO:
|
||||
fanSpeed = FUJITSU_AIRCON1_FAN_AUTO;
|
||||
break;
|
||||
case FAN_1:
|
||||
fanSpeed = FUJITSU_AIRCON1_FAN1;
|
||||
break;
|
||||
case FAN_2:
|
||||
fanSpeed = FUJITSU_AIRCON1_FAN2;
|
||||
break;
|
||||
case FAN_3:
|
||||
fanSpeed = FUJITSU_AIRCON1_FAN3;
|
||||
break;
|
||||
case FAN_4:
|
||||
fanSpeed = FUJITSU_AIRCON1_FAN4;
|
||||
break;
|
||||
}
|
||||
|
||||
if ( temperatureCmd > 15 && temperatureCmd < 31)
|
||||
{
|
||||
temperature = temperatureCmd;
|
||||
}
|
||||
|
||||
// Only support 'don't move' or 'swing' at the moment, not any specific position
|
||||
if ( swingVCmd == VDIR_SWING) {
|
||||
swingV = FUJITSU_AIRCON1_VDIR_SWING;
|
||||
}
|
||||
|
||||
if ( swingHCmd == HDIR_SWING) {
|
||||
swingH = FUJITSU_AIRCON1_HDIR_SWING;
|
||||
}
|
||||
|
||||
if (ecoModeCmd) {
|
||||
ecoMode = FUJITSU_AIRCON1_ECO_ON;
|
||||
}
|
||||
|
||||
sendFujitsu(IR, operatingMode, fanSpeed, temperature, swingV, swingH, ecoMode);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsu(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV, uint8_t swingH, uint8_t ecoMode)
|
||||
{
|
||||
// ON, HEAT, AUTO FAN, +24 degrees
|
||||
uint8_t FujitsuTemplate[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0xFE, 0x09, 0x30, 0x80, 0x04, 0x00, 0x00, 0x00, 0x00, 0x20, 0x00 };
|
||||
// 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
|
||||
|
||||
uint8_t OFF_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x02, 0xFD };
|
||||
uint8_t checksum = 0x00;
|
||||
|
||||
/*
|
||||
|
||||
Fujitsu does not have codes to set the air direction to any specific position, but just go to the next position:
|
||||
|
||||
uint8_t nextVerticalPosition_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x6C, 0x93 };
|
||||
uint8_t nextHorizontalPosition_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x79,0x86 };
|
||||
|
||||
These would need to be sent separately...
|
||||
*/
|
||||
// Set the operatingmode on the template message
|
||||
FujitsuTemplate[9] = operatingMode;
|
||||
|
||||
// Set the eco mode on the template message
|
||||
FujitsuTemplate[14] = ecoMode;
|
||||
|
||||
// Set the temperature on the template message. The least significant bit should be set to '1'
|
||||
FujitsuTemplate[8] = (temperature - 16) << 4 | 0x01;
|
||||
|
||||
// Set the fan speed and air direction on the template message
|
||||
FujitsuTemplate[10] = fanSpeed + swingV + swingH;
|
||||
|
||||
// Calculate the checksum
|
||||
for (int i=0; i<15; i++) {
|
||||
checksum += FujitsuTemplate[i];
|
||||
}
|
||||
|
||||
FujitsuTemplate[15] = (uint8_t)(0x9E - checksum);
|
||||
|
||||
if (operatingMode == FUJITSU_AIRCON1_MODE_OFF) {
|
||||
// OFF
|
||||
sendFujitsuMsg(IR, sizeof(OFF_msg), OFF_msg);
|
||||
} else {
|
||||
sendFujitsuMsg(IR, sizeof(FujitsuTemplate), FujitsuTemplate);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsuHiPower(IRSender& IR)
|
||||
{
|
||||
uint8_t HiPower_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x39, 0xC6 };
|
||||
|
||||
sendFujitsuMsg(IR, sizeof(HiPower_msg), HiPower_msg);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsuFilterClean(IRSender& IR)
|
||||
{
|
||||
uint8_t FilterClean_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x02, 0xFD };
|
||||
|
||||
sendFujitsuMsg(IR, sizeof(FilterClean_msg), FilterClean_msg);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsuSuperQuiet(IRSender& IR)
|
||||
{
|
||||
uint8_t SuperQuiet_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x02, 0xFD };
|
||||
|
||||
sendFujitsuMsg(IR, sizeof(SuperQuiet_msg), SuperQuiet_msg);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsuTestRun(IRSender& IR)
|
||||
{
|
||||
uint8_t TestRun_msg[] = { 0x14, 0x63, 0x00, 0x10, 0x10, 0x02, 0xFD };
|
||||
|
||||
sendFujitsuMsg(IR, sizeof(TestRun_msg), TestRun_msg);
|
||||
}
|
||||
|
||||
|
||||
void FujitsuHeatpumpIR::sendFujitsuMsg(IRSender& IR, uint8_t msgSize, uint8_t *msg)
|
||||
{
|
||||
// 40 kHz PWM frequency
|
||||
IR.setFrequency(38);
|
||||
|
||||
// Header
|
||||
IR.mark(FUJITSU_AIRCON1_HDR_MARK);
|
||||
IR.space(FUJITSU_AIRCON1_HDR_SPACE);
|
||||
|
||||
// Data
|
||||
for (uint8_t i=0; i<msgSize; i++) {
|
||||
IR.sendIRbyte(msg[i], FUJITSU_AIRCON1_BIT_MARK, FUJITSU_AIRCON1_ZERO_SPACE, FUJITSU_AIRCON1_ONE_SPACE);
|
||||
}
|
||||
|
||||
// End mark
|
||||
IR.mark(FUJITSU_AIRCON1_BIT_MARK);
|
||||
IR.space(0);
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
/*
|
||||
Fujitsu Nocria (AWYZ14) heatpump control (remote control P/N AR-PZ2)
|
||||
*/
|
||||
#ifndef FujitsuHeatpumpIR_h
|
||||
#define FujitsuHeatpumpIR_h
|
||||
|
||||
#include <HeatpumpIR.h>
|
||||
|
||||
|
||||
// Fujitsu Nocria (AWYZ14) timing constants (remote control P/N AR-PZ2)
|
||||
#define FUJITSU_AIRCON1_HDR_MARK 3210
|
||||
#define FUJITSU_AIRCON1_HDR_SPACE 1680
|
||||
#define FUJITSU_AIRCON1_BIT_MARK 410
|
||||
#define FUJITSU_AIRCON1_ONE_SPACE 1230
|
||||
#define FUJITSU_AIRCON1_ZERO_SPACE 440
|
||||
|
||||
// Fujitsu codes
|
||||
#define FUJITSU_AIRCON1_MODE_AUTO 0x00 // Operating mode
|
||||
#define FUJITSU_AIRCON1_MODE_HEAT 0x04
|
||||
#define FUJITSU_AIRCON1_MODE_COOL 0x01
|
||||
#define FUJITSU_AIRCON1_MODE_DRY 0x02
|
||||
#define FUJITSU_AIRCON1_MODE_FAN 0x03
|
||||
#define FUJITSU_AIRCON1_MODE_OFF 0xFF // Power OFF - not real codes, but we need something...
|
||||
#define FUJITSU_AIRCON1_FAN_AUTO 0x00 // Fan speed
|
||||
#define FUJITSU_AIRCON1_FAN1 0x04
|
||||
#define FUJITSU_AIRCON1_FAN2 0x03
|
||||
#define FUJITSU_AIRCON1_FAN3 0x02
|
||||
#define FUJITSU_AIRCON1_FAN4 0x01
|
||||
#define FUJITSU_AIRCON1_VDIR_MANUAL 0x00 // Air direction modes
|
||||
#define FUJITSU_AIRCON1_VDIR_SWING 0x10
|
||||
#define FUJITSU_AIRCON1_HDIR_MANUAL 0x00
|
||||
#define FUJITSU_AIRCON1_HDIR_SWING 0x20
|
||||
#define FUJITSU_AIRCON1_ECO_OFF 0x20
|
||||
#define FUJITSU_AIRCON1_ECO_ON 0x00
|
||||
|
||||
|
||||
|
||||
class FujitsuHeatpumpIR : public HeatpumpIR
|
||||
{
|
||||
public:
|
||||
FujitsuHeatpumpIR();
|
||||
void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd);
|
||||
void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd, bool ecoModeCmd);
|
||||
void sendFujitsuHiPower(IRSender& IR);
|
||||
void sendFujitsuFilterClean(IRSender& IR);
|
||||
void sendFujitsuSuperQuiet(IRSender& IR);
|
||||
void sendFujitsuTestRun(IRSender& IR);
|
||||
|
||||
private:
|
||||
void sendFujitsu(IRSender& IR, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV, uint8_t swingH, uint8_t ecoMode);
|
||||
void sendFujitsuMsg(IRSender& IR, uint8_t msgSize, uint8_t *msg);
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,21 +0,0 @@
|
||||
#include <HeatpumpIR.h>
|
||||
|
||||
HeatpumpIR::HeatpumpIR()
|
||||
{
|
||||
}
|
||||
|
||||
// This is a virtual function, i.e. never called
|
||||
void HeatpumpIR::send(IRSender&, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t)
|
||||
{
|
||||
}
|
||||
|
||||
// Heatpump model and info getters
|
||||
const char PROGMEM* HeatpumpIR::model()
|
||||
{
|
||||
return _model;
|
||||
}
|
||||
|
||||
const char PROGMEM* HeatpumpIR::info()
|
||||
{
|
||||
return _info;
|
||||
}
|
||||
@@ -1,68 +0,0 @@
|
||||
/*
|
||||
The generic heatpump interface
|
||||
* Constants for modes
|
||||
* The constructor and the 'send' command interface
|
||||
*/
|
||||
|
||||
#ifndef HeatpumpIR_h
|
||||
#define HeatpumpIR_h
|
||||
|
||||
#include <Arduino.h>
|
||||
#include <IRSender.h>
|
||||
|
||||
|
||||
// Power state
|
||||
#define POWER_OFF 0
|
||||
#define POWER_ON 1
|
||||
|
||||
// Operating modes
|
||||
#define MODE_AUTO 1
|
||||
#define MODE_HEAT 2
|
||||
#define MODE_COOL 3
|
||||
#define MODE_DRY 4
|
||||
#define MODE_FAN 5
|
||||
#define MODE_MAINT 6
|
||||
|
||||
// Fan speeds. Note that some heatpumps have less than 5 fan speeds
|
||||
#define FAN_AUTO 0
|
||||
#define FAN_1 1
|
||||
#define FAN_2 2
|
||||
#define FAN_3 3
|
||||
#define FAN_4 4
|
||||
#define FAN_5 5
|
||||
|
||||
// Vertical air directions. Note that these cannot be set on all heat pumps
|
||||
#define VDIR_AUTO 0
|
||||
#define VDIR_MANUAL 0
|
||||
#define VDIR_SWING 1
|
||||
#define VDIR_UP 2
|
||||
#define VDIR_MUP 3
|
||||
#define VDIR_MIDDLE 4
|
||||
#define VDIR_MDOWN 5
|
||||
#define VDIR_DOWN 6
|
||||
|
||||
// Horizontal air directions. Note that these cannot be set on all heat pumps
|
||||
#define HDIR_AUTO 0
|
||||
#define HDIR_MANUAL 0
|
||||
#define HDIR_SWING 1
|
||||
#define HDIR_MIDDLE 2
|
||||
#define HDIR_LEFT 3
|
||||
#define HDIR_MLEFT 4
|
||||
#define HDIR_MRIGHT 5
|
||||
#define HDIR_RIGHT 6
|
||||
|
||||
|
||||
class HeatpumpIR
|
||||
{
|
||||
protected:
|
||||
HeatpumpIR(); // Cannot create generic heatpump instances
|
||||
const char * _model;
|
||||
const char * _info;
|
||||
|
||||
public:
|
||||
virtual void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd);
|
||||
const char PROGMEM* model();
|
||||
const char PROGMEM* info();
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,129 +0,0 @@
|
||||
#include <HisenseHeatpumpIR.h>
|
||||
|
||||
HisenseHeatpumpIR::HisenseHeatpumpIR() : HeatpumpIR()
|
||||
{
|
||||
static const char PROGMEM model[] PROGMEM = "hisense_aud";
|
||||
static const char PROGMEM info[] PROGMEM = "{\"mdl\":\"hisense_aud\",\"dn\":\"Hisense AUD\",\"mT\":18,\"xT\":32,\"fs\":3}";
|
||||
|
||||
_model = model;
|
||||
_info = info;
|
||||
}
|
||||
|
||||
|
||||
void HisenseHeatpumpIR::send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd , uint8_t fanSpeedCmd , uint8_t temperatureCmd , uint8_t swingVCmd , uint8_t swingHCmd )
|
||||
{
|
||||
(void)swingVCmd;
|
||||
(void)swingHCmd;
|
||||
|
||||
// Sensible defaults for the heat pump mode
|
||||
|
||||
uint8_t powerMode = HISENSE_AIRCON1_POWER_ON;
|
||||
uint8_t operatingMode = HISENSE_AIRCON1_MODE_HEAT;
|
||||
uint8_t fanSpeed = HISENSE_AIRCON1_FAN_AUTO;
|
||||
uint8_t temperature = 21;
|
||||
uint8_t swingV=0;
|
||||
uint8_t swingH=0;
|
||||
|
||||
if (powerModeCmd == POWER_OFF)
|
||||
{
|
||||
powerMode = HISENSE_AIRCON1_POWER_OFF;
|
||||
}
|
||||
else
|
||||
{
|
||||
switch (operatingModeCmd)
|
||||
{
|
||||
case MODE_AUTO:
|
||||
operatingMode = HISENSE_AIRCON1_MODE_AUTO;
|
||||
fanSpeedCmd = FAN_AUTO; // Fan speed is always 'AUTO' in AUTO mode
|
||||
break;
|
||||
case MODE_HEAT:
|
||||
operatingMode = HISENSE_AIRCON1_MODE_HEAT;
|
||||
break;
|
||||
case MODE_COOL:
|
||||
operatingMode = HISENSE_AIRCON1_MODE_COOL;
|
||||
break;
|
||||
case MODE_DRY:
|
||||
operatingMode = HISENSE_AIRCON1_MODE_DRY;
|
||||
fanSpeedCmd = FAN_AUTO; // Fan speed is always 'AUTO' in DRY mode
|
||||
break;
|
||||
case MODE_FAN:
|
||||
operatingMode = HISENSE_AIRCON1_MODE_FAN;
|
||||
if ( fanSpeedCmd == FAN_AUTO ) {
|
||||
fanSpeedCmd = FAN_1; // Fan speed cannot be 'AUTO' in FAN mode
|
||||
temperatureCmd = 25; // Fixed temperature FAN mode
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
switch (fanSpeedCmd)
|
||||
{
|
||||
case FAN_AUTO:
|
||||
fanSpeed = HISENSE_AIRCON1_FAN_AUTO;
|
||||
break;
|
||||
case FAN_1:
|
||||
fanSpeed = HISENSE_AIRCON1_FAN1;
|
||||
break;
|
||||
case FAN_2:
|
||||
fanSpeed = HISENSE_AIRCON1_FAN2;
|
||||
break;
|
||||
case FAN_3:
|
||||
fanSpeed = HISENSE_AIRCON1_FAN3;
|
||||
break;
|
||||
}
|
||||
|
||||
if ( temperatureCmd > 17 && temperatureCmd < 33)
|
||||
{
|
||||
temperature = temperatureCmd;
|
||||
}
|
||||
|
||||
|
||||
sendHisense(IR, powerMode, operatingMode, fanSpeed, temperature, swingV, swingH);
|
||||
}
|
||||
|
||||
// Send the Hisense code
|
||||
void HisenseHeatpumpIR::sendHisense(IRSender& IR, uint8_t powerMode, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV ,uint8_t swingH)
|
||||
{
|
||||
(void)swingV;
|
||||
(void)swingH;
|
||||
|
||||
uint8_t HisenseTemplate[] = { 0x87, 0x06, 0x00, 0x00, 0x00, 0x00, 0x00, // Header uint8_t 0-1
|
||||
0x00, 0x00, 0x00, 0x0C, 0x00, 0x00, 0x00 }; //
|
||||
|
||||
uint8_t i;
|
||||
|
||||
// Set the Fan speed, On/Off.
|
||||
HisenseTemplate[2] = fanSpeed | powerMode;
|
||||
HisenseTemplate[3] = (((temperature - 18) << 4) | operatingMode ) ;
|
||||
|
||||
// Calculate the uint8_t checksum EXOR uint8_t 2 to 12
|
||||
HisenseTemplate[13] = HisenseTemplate[2];
|
||||
for (i=3; i<13; i++) {
|
||||
HisenseTemplate[13]= HisenseTemplate[i] ^ HisenseTemplate[13];
|
||||
}
|
||||
|
||||
// 38 kHz PWM frequency
|
||||
IR.setFrequency(38);
|
||||
|
||||
// Send Header mark
|
||||
IR.mark(HISENSE_AIRCON1_HDR_MARK);
|
||||
IR.space(HISENSE_AIRCON1_HDR_SPACE);
|
||||
|
||||
// Payload header part
|
||||
for (i=0; i<7; i++) {
|
||||
IR.sendIRbyte(HisenseTemplate[i], HISENSE_AIRCON1_BIT_MARK, HISENSE_AIRCON1_ZERO_SPACE, HISENSE_AIRCON1_ONE_SPACE);
|
||||
}
|
||||
|
||||
// Mesage space
|
||||
IR.mark(HISENSE_AIRCON1_BIT_MARK);
|
||||
IR.space(HISENSE_AIRCON1_MSG_SPACE);
|
||||
|
||||
// Payload message part
|
||||
for (; i<14; i++) {
|
||||
IR.sendIRbyte(HisenseTemplate[i], HISENSE_AIRCON1_BIT_MARK, HISENSE_AIRCON1_ZERO_SPACE, HISENSE_AIRCON1_ONE_SPACE);
|
||||
}
|
||||
|
||||
// End mark
|
||||
IR.mark(HISENSE_AIRCON1_BIT_MARK);
|
||||
IR.space(0);
|
||||
}
|
||||
@@ -1,73 +0,0 @@
|
||||
/*
|
||||
Hisense AQV12PSBN / AQV09ASA heatpump control (remote control P/N zzz)
|
||||
*/
|
||||
#ifndef HisenseHeatpumpIR_h
|
||||
#define HisenseHeatpumpIR_h
|
||||
|
||||
#include <HeatpumpIR.h>
|
||||
|
||||
|
||||
// Hisense timing constants
|
||||
#define HISENSE_AIRCON1_HDR_MARK 9060
|
||||
#define HISENSE_AIRCON1_HDR_SPACE 4550
|
||||
#define HISENSE_AIRCON1_BIT_MARK 520
|
||||
#define HISENSE_AIRCON1_ONE_SPACE 1700
|
||||
#define HISENSE_AIRCON1_ZERO_SPACE 630
|
||||
#define HISENSE_AIRCON1_MSG_SPACE 8140
|
||||
|
||||
// Power state
|
||||
#define HISENSE_AIRCON1_POWER_OFF 0x04 //**
|
||||
#define HISENSE_AIRCON1_POWER_ON 0x00 //**
|
||||
|
||||
// Operating modes
|
||||
// Hisense codes
|
||||
#define HISENSE_AIRCON1_MODE_AUTO 0x04 // Not available 0x00
|
||||
#define HISENSE_AIRCON1_MODE_HEAT 0x00
|
||||
#define HISENSE_AIRCON1_MODE_COOL 0x02
|
||||
#define HISENSE_AIRCON1_MODE_DRY 0x03
|
||||
#define HISENSE_AIRCON1_MODE_FAN 0x04
|
||||
#define HISENSE_AIRCON1_MODE_MAINT 0x04 // Power OFF
|
||||
|
||||
// Fan speeds. Note that some heatpumps have less than 5 fan speeds
|
||||
|
||||
#define HISENSE_AIRCON1_FAN_AUTO 0x00 // Fan speed
|
||||
#define HISENSE_AIRCON1_FAN1 0x03 // * low
|
||||
#define HISENSE_AIRCON1_FAN2 0x02 // * med
|
||||
#define HISENSE_AIRCON1_FAN3 0x01 // * high
|
||||
#define HISENSE_AIRCON1_FAN4 0x01 // * high Not available
|
||||
#define HISENSE_AIRCON1_FAN5 0x01 // * high Not available
|
||||
|
||||
// Not available in this model.
|
||||
// Vertical air directions. Note that these cannot be set on all heat pumps
|
||||
#define HISENSE_VDIR_AUTO 0
|
||||
#define HISENSE_VDIR_MANUAL 0
|
||||
#define HISENSE_VDIR_SWING 0
|
||||
#define HISENSE_VDIR_UP 0
|
||||
#define HISENSE_VDIR_MUP 0
|
||||
#define HISENSE_VDIR_MIDDLE 0
|
||||
#define HISENSE_VDIR_MDOWN 0
|
||||
#define HISENSE_VDIR_DOWN 0
|
||||
|
||||
// Not available in this model.
|
||||
// Horizontal air directions. Note that these cannot be set on all heat pumps
|
||||
#define HISENSE_HDIR_AUTO 0
|
||||
#define HISENSE_HDIR_MANUAL 0
|
||||
#define HISENSE_HDIR_SWING 0
|
||||
#define HISENSE_HDIR_MIDDLE 0
|
||||
#define HISENSE_HDIR_LEFT 0
|
||||
#define HISENSE_HDIR_MLEFT 0
|
||||
#define HISENSE_HDIR_MRIGHT 0
|
||||
#define HISENSE_HDIR_RIGHT 0
|
||||
|
||||
|
||||
class HisenseHeatpumpIR : public HeatpumpIR
|
||||
{
|
||||
public:
|
||||
HisenseHeatpumpIR();
|
||||
void send(IRSender& IR, uint8_t powerModeCmd, uint8_t operatingModeCmd, uint8_t fanSpeedCmd, uint8_t temperatureCmd, uint8_t swingVCmd, uint8_t swingHCmd);
|
||||
|
||||
private:
|
||||
void sendHisense(IRSender& IR, uint8_t powerMode, uint8_t operatingMode, uint8_t fanSpeed, uint8_t temperature, uint8_t swingV, uint8_t swingH);
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,206 +0,0 @@
|
||||
#include <Arduino.h>
|
||||
#include <IRSender.h>
|
||||
|
||||
// Heavily based on Ken Shirriff's IRRemote library:
|
||||
// https://github.com/shirriff/Arduino-IRremote
|
||||
//
|
||||
// For PWM on Arduino, see http://playground.arduino.cc/Main/TimerPWMCheatsheet
|
||||
|
||||
IRSender::IRSender(uint8_t pin)
|
||||
{
|
||||
_pin = pin;
|
||||
}
|
||||
|
||||
// Set the PWM frequency. The selected pin determines which timer to use
|
||||
void IRSender::setFrequency(int frequency)
|
||||
{
|
||||
uint8_t pwmval8 = F_CPU / 2000 / (frequency);
|
||||
uint16_t pwmval16 = F_CPU / 2000 / (frequency);
|
||||
|
||||
pinMode(_pin, OUTPUT);
|
||||
digitalWrite(_pin, LOW); // When not sending PWM, we want it low
|
||||
|
||||
switch (_pin)
|
||||
{
|
||||
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
// Arduino Mega
|
||||
case 9:
|
||||
// Fall-through to 10, timer2 controls both 9 and 10
|
||||
case 10:
|
||||
TCCR2A = _BV(WGM20);
|
||||
TCCR2B = _BV(WGM22) | _BV(CS20);
|
||||
OCR2A = pwmval8;
|
||||
OCR2B = pwmval8 / 3;
|
||||
break;
|
||||
case 11:
|
||||
// Fall-through to 12, timer1 controls both 11 and 12
|
||||
case 12:
|
||||
TCCR1A = _BV(WGM11);
|
||||
TCCR1B = _BV(WGM13) | _BV(CS10);
|
||||
ICR1 = pwmval16;
|
||||
OCR1A = pwmval16 / 3;
|
||||
OCR1B = pwmval16 / 3;
|
||||
break;
|
||||
case 44:
|
||||
// Fall-through to 46, timer 5 controls pins 44, 45 and 46 on Arduino Mega
|
||||
case 45:
|
||||
case 46:
|
||||
TCCR5A = _BV(WGM51) | _BV(WGM50);
|
||||
TCCR5B = _BV(WGM53) | _BV(CS50);
|
||||
ICR5 = pwmval16;
|
||||
OCR5A = pwmval16 / 3;
|
||||
#else
|
||||
// Arduino Duemilanove etc
|
||||
case 3:
|
||||
// Fall-through to 11, timer2 controls both 3 and 11
|
||||
case 11:
|
||||
TCCR2A = _BV(WGM20);
|
||||
TCCR2B = _BV(WGM22) | _BV(CS20);
|
||||
OCR2A = pwmval8;
|
||||
OCR2B = pwmval8 / 3;
|
||||
break;
|
||||
case 9:
|
||||
// Fall-through to 10, timer1 controls both 9 and 10
|
||||
case 10:
|
||||
TCCR1A = _BV(WGM11);
|
||||
TCCR1B = _BV(WGM13) | _BV(CS10);
|
||||
ICR1 = pwmval16;
|
||||
OCR1A = pwmval16 / 3;
|
||||
OCR1B = pwmval16 / 3;
|
||||
break;
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
// Send a uint8_t (8 bits) over IR
|
||||
void IRSender::sendIRbyte(uint8_t sendByte, int bitMarkLength, int zeroSpaceLength, int oneSpaceLength)
|
||||
{
|
||||
for (int i=0; i<8 ; i++)
|
||||
{
|
||||
if (sendByte & 0x01)
|
||||
{
|
||||
mark(bitMarkLength);
|
||||
space(oneSpaceLength);
|
||||
}
|
||||
else
|
||||
{
|
||||
mark(bitMarkLength);
|
||||
space(zeroSpaceLength);
|
||||
}
|
||||
|
||||
sendByte >>= 1;
|
||||
}
|
||||
}
|
||||
|
||||
// The Carrier IR protocol has the bits in a reverse order (compared to the other heatpumps)
|
||||
// See http://www.nrtm.org/index.php/2013/07/25/reverse-bits-in-a-uint8_t/
|
||||
uint8_t IRSender::bitReverse(uint8_t x)
|
||||
{
|
||||
// 01010101 | 10101010
|
||||
x = ((x >> 1) & 0x55) | ((x << 1) & 0xaa);
|
||||
// 00110011 | 11001100
|
||||
x = ((x >> 2) & 0x33) | ((x << 2) & 0xcc);
|
||||
// 00001111 | 11110000
|
||||
x = ((x >> 4) & 0x0f) | ((x << 4) & 0xf0);
|
||||
return x;
|
||||
}
|
||||
|
||||
// Send an IR 'mark' symbol, i.e. transmitter ON
|
||||
void IRSender::mark(int markLength)
|
||||
{
|
||||
switch (_pin)
|
||||
{
|
||||
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
// Arduino Mega
|
||||
case 9:
|
||||
(TCCR2A |= _BV(COM2B1)); // Enable pin 3 PWM output
|
||||
break;
|
||||
case 11:
|
||||
(TCCR1A |= _BV(COM1A1)); // Enable pin 9 PWM output
|
||||
break;
|
||||
case 12:
|
||||
(TCCR1A |= _BV(COM1B1)); // Enable pin 10 PWM output
|
||||
break;
|
||||
case 10:
|
||||
(TCCR2A |= _BV(COM2A1)); // Enable pin 11 PWM output
|
||||
break;
|
||||
case 44:
|
||||
(TCCR5A |= _BV(COM5C1)); // Enable pin 44 PWM output on Arduino Mega
|
||||
break;
|
||||
case 45:
|
||||
(TCCR5A |= _BV(COM5B1)); // Enable pin 45 PWM output on Arduino Mega
|
||||
break;
|
||||
case 46:
|
||||
(TCCR5A |= _BV(COM5A1)); // Enable pin 46 PWM output on Arduino Mega
|
||||
break;
|
||||
#else
|
||||
// Arduino Duemilanove etc
|
||||
case 3:
|
||||
(TCCR2A |= _BV(COM2B1)); // Enable pin 3 PWM output
|
||||
break;
|
||||
case 9:
|
||||
(TCCR1A |= _BV(COM1A1)); // Enable pin 9 PWM output
|
||||
break;
|
||||
case 10:
|
||||
(TCCR1A |= _BV(COM1B1)); // Enable pin 10 PWM output
|
||||
break;
|
||||
case 11:
|
||||
(TCCR2A |= _BV(COM2A1)); // Enable pin 11 PWM output
|
||||
break;
|
||||
#endif
|
||||
}
|
||||
|
||||
delayMicroseconds(markLength);
|
||||
}
|
||||
|
||||
// Send an IR 'space' symbol, i.e. transmitter OFF
|
||||
void IRSender::space(int spaceLength)
|
||||
{
|
||||
switch (_pin)
|
||||
{
|
||||
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
// Arduino Mega
|
||||
case 9:
|
||||
(TCCR2A &= ~(_BV(COM2B1))); // Disable pin 3 PWM output
|
||||
break;
|
||||
case 11:
|
||||
(TCCR1A &= ~(_BV(COM1A1))); // Disable pin 9 PWM output
|
||||
break;
|
||||
case 12:
|
||||
(TCCR1A &= ~(_BV(COM1B1))); // Disable pin 10 PWM output
|
||||
break;
|
||||
case 10:
|
||||
(TCCR2A &= ~(_BV(COM2A1))); // Disable pin 11 PWM output
|
||||
break;
|
||||
case 44:
|
||||
(TCCR5A &= ~(_BV(COM5C1))); // Disable pin 44 PWM output on Arduino Mega
|
||||
case 45:
|
||||
(TCCR5A &= ~(_BV(COM5B1))); // Disable pin 45 PWM output on Arduino Mega
|
||||
case 46:
|
||||
(TCCR5A &= ~(_BV(COM5A1))); // Disable pin 46 PWM output on Arduino Mega
|
||||
#else
|
||||
// Arduino Duemilanove etc
|
||||
case 3:
|
||||
(TCCR2A &= ~(_BV(COM2B1))); // Disable pin 3 PWM output
|
||||
break;
|
||||
case 9:
|
||||
(TCCR1A &= ~(_BV(COM1A1))); // Disable pin 9 PWM output
|
||||
break;
|
||||
case 10:
|
||||
(TCCR1A &= ~(_BV(COM1B1))); // Disable pin 10 PWM output
|
||||
break;
|
||||
case 11:
|
||||
(TCCR2A &= ~(_BV(COM2A1))); // Disable pin 11 PWM output
|
||||
break;
|
||||
#endif
|
||||
}
|
||||
|
||||
// Mitsubishi heatpump uses > 16383us spaces, and delayMicroseconds only works up to 2^14 - 1 us
|
||||
// Use the less accurate milliseconds delay for longer delays
|
||||
|
||||
if (spaceLength < 16383) {
|
||||
delayMicroseconds(spaceLength);
|
||||
} else {
|
||||
delay(spaceLength/1000);
|
||||
}
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
/*
|
||||
Class to send IR signals using the Arduino PWM
|
||||
*/
|
||||
#ifndef IRSender_h
|
||||
#define IRSender_h
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
class IRSender
|
||||
{
|
||||
public:
|
||||
IRSender(uint8_t pin);
|
||||
void setFrequency(int frequency);
|
||||
void sendIRbyte(uint8_t sendByte, int bitMarkLength, int zeroSpaceLength, int oneSpaceLength);
|
||||
uint8_t bitReverse(uint8_t x);
|
||||
void space(int spaceLength);
|
||||
void mark(int markLength);
|
||||
|
||||
private:
|
||||
uint8_t _pin;
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,339 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) 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
|
||||
this service 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 make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. 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.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
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
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the 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 a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE 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.
|
||||
|
||||
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
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
{description}
|
||||
Copyright (C) {year} {fullname}
|
||||
|
||||
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 2 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, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision 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, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
{signature of Ty Coon}, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This 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.
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user