nz_rtc.h File Reference

Functions for ISL1208 RTC used on SBC66 Boards. More...

Go to the source code of this file.

Detailed Description

Functions for ISL1208 RTC used on SBC66 Boards.

Author

Modtronix Engineering

Compiler:

MPLAB XC16

Description

Functions for using the ISL1208 RTC used on SBC66 Boards

Configuration

The following defines are used to configure this module, and should be placed in projdefs.h. Note that all items marked [-DEFAULT-] are defaults, and do not have to be placed in projdefs.h if they contain desired configuration! For details, see Project Configuration.

// *********************************************************************
// ------------ RTC Configuration (from nz_rtc.h) -------------
// *********************************************************************
//#define     NZ_RTC_ENABLE                         //[-DEFAULT-] RTC is disabled by default
#define     NZ_RTC_UNLOCK                       (1) //[-DEFAULT-] Unlock RTC during initialization

Usage

To use this module, the following must be done:

• Include nz_rtc.h in the c file it is used in.
• Add nz_rtc.c to the MPLAB project, this is the main RTC driver file.
• The following additional files are required by nz_rtc.c, and must be added to the project: nz_circularBufferPwr2.c, nz_helpers.c, nz_netcruzer.c and nz_serI2C.c
• Add "#define NZ_RTC_ENABLE (1)" to projdefs.h file.
• In projdefs.h, do any RTC, I2C or other configuration required. This is done by copying the configuration section from the *.h files to projdefs.h. Nothing required, defaults will work!
• All DONE! Can now use RTC functions defined in nz_rtc.h! Some examples: RTC_TIME_AND_DATE td = {8,15,30,25,12,10,0}; //8:15;30 25 Dec 2010 rtcSetTimeAndDate(&td); //Set RTC time and date

Software License Agreement

The software supplied herewith is owned by Modtronix Engineering, and is protected under applicable copyright laws. The software supplied herewith is intended and supplied to you, the Company customer, for use solely and exclusively on products manufactured by Modtronix Engineering. The code may be modified and can be used free of charge for commercial and non commercial applications. All rights are reserved. Any use in violation of the foregoing restrictions may subject the user to criminal sanctions under applicable laws, as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE IS PROVIDED IN AN 'AS IS' CONDITION. NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

File History

2014-01-02, David H. (DH):

• Initial version