NixieClock.h

/*
	Author 		: 	MeetinaXD
					(meetinaxd@ltiex.com)
	Last Edit 	: 	Octo 27,2019. 20:09 (UTC + 08)
	Program 	:	NixieClock Control Unit (ATMega 328p-u in Arduino)
	Modify Logs	:	
					* Octo 27,20:09, 增加防中毒和看门狗功能
					* Octo 31,14:28, 修改isOverTime中的错误；更改喂狗次序，修复一开机为功能3时导致重启的问题
					* Nove 2 ,18:15, 修改了开始动画的逻辑，必须选择功能后才出现，修改了防中毒逻辑。
<<<<<<< HEAD
<<<<<<< HEAD
					* Nove 3 ,--:--, 修复当显示的纪念日正计时不为三位数时，小数点可能不会正确显示的问题。
									 现在纪念日，日数小数点的位置不再被固定在第三位，根据数字长度自动显示在后面。
<<<<<<< HEAD
					* Nove 5 ,21:06, 删除了refresh方法，合并到sendData中
									 buildDate不再指定，使用__DATE__宏定义
									 不再使用bits数组储存数字，使用NixieTube结构体，方便控制灯的开关
									 规范数字赋值，统一使用setNixie()方法设置数字
									 新增getNixie获取当前辉光管的数字，不允许直接访问变量
									 修复BUG：灯关闭时不进行辉光管刷新

=======
>>>>>>> parent of b228e38... 补充说明
=======
>>>>>>> parent of b228e38... 补充说明
=======
>>>>>>> parent of db6f504... 一堆更改
	WARNING:
		THIS PROGRAM IS NOT A FREE SOFTWARE, YOU ARE NOT
		ALLOW TO REDISTRIBUTE IT AND/OR MODIFY IT FOR 
		PROFIT WITHOUT AUTHOR'S PERMISSION.

		IF YOU ARE PERSONAL USE,NOT FOR PARTICULAR PURPOSE,
		YOU CAN USE BUT YOU SHOULD ACCEPT THE GNU LESSER 
		GENERAL PUBLIC LICENSE,AND COPY THIS LICENSE ALONG 
		WITH THIS PROGRAM.
		************** ALL RIGHTS RESERVED. **************
*/

#ifndef __NIXCK__HEADER__
#define __NIXCK__HEADER__
#if (ARDUINO >= 100)
	#include <Arduino.h>
#else
	#include <WProgram.h>
#endif

#include <stdbool.h>
#include <Wire.h>
#include <avr/wdt.h> /* 看门狗 */
#include "RTClib.h"

//定义辉光钟防中毒的刷新时间，单位为秒
#define __OVER_TIME__ 300 //五分钟刷新一次

// ******** definition for 74HC595N tube ********
#define DSA 5
#define DSB 6
#define DSC 7

#define MRA 8
#define MRB 9
#define MRC 10

#define SHCPA 1
#define SHCPB 2
#define SHCPC 3 

#define STCP 0
// ******** definition for NixieClock switch ********
#define BUTTONA 12
#define BUTTONB 11

// #define setbit(x,y)	x|=(1<<y)//指定的某一位数置1
// #define clrbit(x,y)	x&=~(1<<y)//指定的某一位数置0
// #define reversebit(x,y)	x^=(1<<y)//指定的某一位数取反
// #define getbit(x,y)	 ((x) >> (y)&1)//获取的某一位的值


// ******** definition for NixieClock functions ********

byte getBit(byte number,byte pos);  //适应8位cpu的取位函数
byte oneInByte(byte x);				//统计byte里面1出现的次数
byte getNumber(uint32_t number,byte i,byte length);//取出一个数里面的某一个数

void showNothing();		//function : 息屏
void showTime();		//function : 显示RTC时间
void showCounter();		//function : 显示计时
void showWorldChange(); //function : 显示世界线变动

void startingEffect();	//开机动画
void simulateFlash(byte i,byte level);	//模拟闪烁
void roundNixie(byte NixieTube,byte round);	//轮转辉光管

bool isOverTime();		//判断是否已经超时
void refreshNixie();	//刷新所有辉光管(防止辉光管中毒)

void sendData();		//发送数据到74HC595N译码器
void refresh();			//74HC595N译码器STCP引脚上升沿，输出使能

void lightUpNixie(byte i);			//打开辉光管，使其可以被设置
void closeDownNixie(byte i);		//关闭辉光管，使其不能被设置
void setNixie(byte i,byte number);  //设置辉光管显示的数字
void lightUpPoint(byte i);			//打开小数点
void closeDownPoint();				//关闭小数点

void readFromRTC_Module();		//从RTC时间模块中读出时间


// ******** definition for constant values ********
const uint32_t powList[] = {1,10,100,1000,10000,100000};
const byte movList[8] = {1,2,4,8,16,32,64,128};
const byte pointList[6] = {1,2,4,6,8,9};
	/*
		一个数字时，点亮第二个辉光管的右小数点
		两个数字时，点亮第三个辉光管的左小数点
		三个数字时，点亮第四个辉光管的左小数点
		四个数字时，点亮第五个辉光管的左小数点（希望可以到四位数吧）
		五个数字时，点亮第六个辉光管的左小数点
		六个数字时，点亮第六个辉光管的右小数点
	*/
const byte SHCP[3] = {SHCPA,SHCPB,SHCPC};
const byte DS[3] = {DSA,DSB,DSC};
const byte MR[3] = {MRA,MRB,MRC};

const byte buildDate[6] = {1,9,1,1,0,6};
const byte LoveDate[6] = {1,9,0,3,1,4};
const byte simulateTime[2][10] = {
									{150,200,90,100,40,60,20,20,10,10},
									{150,200,90,100,40,60,20,20,10,10}
								}; /*两种不同速度的闪烁效果，是可以支持无限多种预设的
									但是我太懒了，只研究了一种。
									在simulateFlash()中，level即是这个数组的下标。
									*/
// const DateTime LoveDateTime (2019,3,14,17,43,00);								
const DateTime LoveDateTime (2019,1,14,18,35,00);
#endif/* __NIXCK__HEADER__ */