SDI12.h File Reference

This file contains the main class for the SDI-12 implementation. More...

#include <inttypes.h>
#include <Arduino.h>
#include <Stream.h>
#include "SDI12_boards.h"

Include dependency graph for SDI12.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	SDI12
	The main class for SDI 12 instances. More...

Macros
#define	NO_IGNORE_CHAR   '\x01'
	a char not found in a valid ASCII numeric field
#define	SDI12_BUFFER_SIZE   81
	The buffer size for incoming SDI-12 data. More...
#define	READTIME   TCNTX
	The function or macro used to read the clock timer value.

Typedefs
typedef const __FlashStringHelper *	FlashString
	Helper for strings stored in flash.

Detailed Description

This file contains the main class for the SDI-12 implementation.

Copyright

(c) 2013-2020 Stroud Water Research Center (SWRC) and the EnviroDIY Development Team

Date

August 2013

Author

Kevin M.Smith SDI12.nosp@m.@eth.nosp@m.oseng.nosp@m.inee.nosp@m.ring..nosp@m.org

========================== Arduino SDI-12 ==================================

An Arduino library for SDI-12 communication with a wide variety of environmental sensors. This library provides a general software solution, without requiring any additional hardware.

======================== Attribution & License =============================

Copyright (C) 2013 Stroud Water Research Center Available at https://github.com/EnviroDIY/Arduino-SDI-12

Authored initially in August 2013 by: Kevin M. Smith (http://ethosengineering.org) Inquiries: SDI12.nosp@m.@eth.nosp@m.oseng.nosp@m.inee.nosp@m.ring..nosp@m.org

Modified 2017 by Manuel Jimenez Buendia to work with ARM based processors (Arduino Zero)

Maintenance and merging 2017 by Sara Damiano

based on the SoftwareSerial library (formerly NewSoftSerial), authored by: ladyada (http://ladyada.net) Mikal Hart (http://www.arduiniana.org) Paul Stoffregen (http://www.pjrc.com) Garrett Mace (http://www.macetech.com) Brett Hagman (http://www.roguerobotics.com/)

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 Street, Fifth Floor, Boston, MA 02110-1301 USA

Macro Definition Documentation

SDI12_BUFFER_SIZE

#define SDI12_BUFFER_SIZE   81

The buffer size for incoming SDI-12 data.

All responses should be less than 81 characters:

• address is a single (1) character
• values has a maximum value of 75 characters
• CRC is 3 characters
• CR is a single character
• LF is a single character