SmartController.ino

//#define UNIT_TEST_ENABLE //toggle unit testing

/**
 * This is the firmware of Xlight SmartController based on Photon/P1 MCU.
 * There are two Protocol Domains:
 * 1. MySensor Protocol: Radio network and BLE communication
 * 2. MQTT Protocol: LAN & WAN
 *
 * Created by Baoshi Sun <bs.sun@datatellit.com>
 * Copyright (C) 2015-2016 DTIT
 * Full contributor list:
 *
 * Documentation:
 * Support Forum:
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 *******************************
 *
 * REVISION HISTORY
 * Version 1.0 - Created by Baoshi Sun <bs.sun@datatellit.com>
 *
 * DESCRIPTION
 * 1. Setup program skeleton
 * 2. Define major interfaces
 * 3. Define basic data structures
 * 4. Define fundamental status machine
 * 5. Define primary messages
 * 6. Define cloud variables and Functions
 *
 * ToDo:
 * 1. Include MySensor lib
 * 2. Include MQTT lib
**/

#ifdef UNIT_TEST_ENABLE
	#include "test.ino"
#else

//------------------------------------------------------------------
// Include dependency packages below
//------------------------------------------------------------------
#include "application.h"
#include "xlxConfig.h"
#include "xlSmartController.h"
#include "xlxSerialConsole.h"
#include "SparkIntervalTimer.h"
#include "xlxBLEInterface.h"

//------------------------------------------------------------------
// Program Body Begins Here
//------------------------------------------------------------------

// SINGLETONS:
// theSys: SmartControllerClass
// theConfig: ConfigClass
// theConsole: SerialConsoleClass
// theLog: LoggerClass
// theRadio: RF24ServerClass

// Define hardware IntervalTimer
IntervalTimer sysTimer;

void SysteTimerCB()
{
	static UC fastTick = 0;				// must be static
	static UC slowTick = 0;				// must be static

  // Change Status Indicator according to system status
  // e.g: fast blink, slow blink, breath, etc
  // ToDo:

  // ToDo: MIC input (tone detection)

  // High speed non-block process
	if (++fastTick > RTE_TICK_FASTPROCESS) {
		fastTick = 0;
  	theSys.FastProcess();
	}

	//if( !theConfig.GetDisableWiFi() ) {
		// Timeout interuption of Cloud connecting
//#ifndef SYS_SERIAL_DEBUG
		//if( WiFi.listening() ) {
			/*if (++slowTick > RTE_TICK_SLOWPROCESS) {
				slowTick = 0;
				//SERIAL_LN("Wi-Fi in listening mode...");
				// Get Wi-Fi credential from BLE
				//SERIAL_LN("ProcessLocalCommands ...");
				//theSys.ProcessLocalCommands();
				//SERIAL_LN("ProcessLocalCommands end");
				if( WiFi.hasCredentials() ) {
					//WiFi.listen(false);
					//theSys.ResetSerialPort();
					SERIAL_LN("will connect Wi-Fi in system thread");
					//theSys.connectWiFi();
				}
			}*/
			// Reset?
		//}
//#endif
	//}
}

// Set "manual" mode
SYSTEM_MODE(MANUAL);
SYSTEM_THREAD(ENABLED);
//
void setup()
{
	WiFi.on();
	WiFi.listen(false);
  // System Initialization
  theSys.Init();
#ifdef SYS_TEST
	theSys.InitCloudObj();
	Particle.connect();
	waitFor(Particle.connected, 5000);
#endif
  // Load Configuration
  theConfig.LoadConfig();
	// Initialize Pins
  theSys.InitPins();

	// Initialization Radio Interfaces
	theSys.InitRadio();

	// Open Wi-Fi
	if( theConfig.GetDisableWiFi() ) {
		WiFi.disconnect();
		WiFi.off();
	} else {
		// Initiaze Cloud Variables & Functions
		///It is fine to call this function when the cloud is disconnected - Objects will be registered next time the cloud is connected
	  theSys.InitCloudObj();
	}

	// Initialize Serial Console
  theConsole.Init();
  // Start system timer: callback every n * 0.5ms using hmSec timescale
  //Use TIMER6 to retain PWM capabilities on all pins
  sysTimer.begin(SysteTimerCB, RTE_DELAY_SYSTIMER, hmSec, TIMER6);

	if( !theConfig.GetDisableWiFi() ) {
		while(1) {
			if( !WiFi.hasCredentials() || !theConfig.GetWiFiStatus() ) {
				if( !theSys.connectWiFi() ) {
					// get credential from BLE or Serial
					SERIAL_LN("will enter listening mode");
					WiFi.listen();
					break;
				}
			}

			// Connect to Wi-Fi
			SERIAL_LN("will connect WiFi");
			if( theSys.connectWiFi() ) {
				if( theConfig.GetUseCloud() == CLOUD_DISABLE ) {
					Particle.disconnect();
				} else {
					// Connect to the Cloud
					if( !theSys.connectCloud() ) {
						if( theConfig.GetUseCloud() == CLOUD_MUST_CONNECT ) {
							// Must connect to the Cloud
							continue;
						}
					}
				}
			} else {
				if( theConfig.GetUseCloud() == CLOUD_MUST_CONNECT ) {
					// Must have network
					continue;
				}
			}
			break;
		}

	  // Initialization network Interfaces
	  theSys.InitNetwork();

		// Wait the system started
		if( Particle.connected() == true ) {
			while( millis() < 2000 ) {
				Particle.process();
			}
		}
	}

  // Initialize Sensors
  theSys.InitSensors();

  // System Starts
  theSys.Start();

	// Setp WD and reset the application if no reponds
	ApplicationWatchdog wd(RTE_WATCHDOG_TIMEOUT, System.reset, 256);
}

// Notes: approximate RTE_DELAY_SELFCHECK ms per loop
/// If you need more accurate and faster timer, do it with sysTimer
void loop()
{
	static UL lastTick = millis();
  static UC tick = 0;

  // Process commands
  IF_MAINLOOP_TIMER( theSys.ProcessCommands(), "ProcessCommands" );

  // Collect data
	if( millis() - lastTick >= 1000 ) {
		lastTick = millis();
  	IF_MAINLOOP_TIMER( theSys.CollectData(tick++), "CollectData" );

		// Check Max Base RF network enable duration
		theSys.CheckRFBaseNetEnableDur();
	}

	// Act on new Rules in Rules chain
	IF_MAINLOOP_TIMER( theSys.ReadNewRules(), "ReadNewRules" );

  // ToDo: transfer data

  // ToDo: status synchronize

	// Process Panel input
  IF_MAINLOOP_TIMER( theSys.ProcessPanel(), "ProcessPanel" );

  // Self-test & alarm trigger, also insert delay between each loop
  IF_MAINLOOP_TIMER( theSys.SelfCheck(RTE_DELAY_SELFCHECK), "SelfCheck" );
	//if( !theConfig.GetDisableWiFi() ) {
		// Process Could Messages
	  //if( Particle.connected() == true ) {
	    IF_MAINLOOP_TIMER( Particle.process(), "ProcessCloud" );
	  //}
	//}
	//wd.checkin();
}

#endif