DS3231.hh File Reference

#include "Cosa/TWI.hh"
#include "Cosa/Time.hh"
#include "Cosa/IOStream.hh"

Include dependency graph for DS3231.hh:

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

Go to the source code of this file.

Classes
class	DS3231
struct	DS3231::alarm1_t
struct	DS3231::alarm2_t
union	DS3231::control_t
union	DS3231::status_t
struct	DS3231::timekeeper_t

Functions
IOStream &	operator<< (IOStream &outs, DS3231::alarm1_t &t)
IOStream &	operator<< (IOStream &outs, DS3231::alarm2_t &t)
IOStream &	operator<< (IOStream &outs, DS3231::timekeeper_t &t)

Detailed Description

Version

1.0

License

Copyright (C) 2014-2015, Mikael Patel

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.

This file is part of the Arduino Che Cosa project.

Definition in file DS3231.hh.

Function Documentation

IOStream& operator<<	(	IOStream &	outs,
		DS3231::alarm1_t &	t
	)

Print the alarm to the given stream with the format (DD HH:MM:SS). The values should be in BCD i.e. not converted to binary.

Parameters

[in]	outs	output stream.
[in]	t	alarm time structure.

Returns

iostream.

Definition at line 94 of file DS3231.cpp.

IOStream& operator<<	(	IOStream &	outs,
		DS3231::alarm2_t &	t
	)

Print the alarm to the given stream with the format (DD HH:MM). The values should be in BCD i.e. not converted to binary.

Parameters

[in]	outs	output stream.
[in]	t	alarm time structure.

Returns

iostream.

Definition at line 103 of file DS3231.cpp.

IOStream& operator<<	(	IOStream &	outs,
		DS3231::timekeeper_t &	t
	)

Print the timekeeper structure to the given stream. The timekeeper values should be in BCD i.e. not converted to binary.

Parameters

[in]	outs	output stream.
[in]	t	alarm time structure.

Returns

iostream.

Definition at line 111 of file DS3231.cpp.