Simplify gateway code (handles interrupts internally) and remove external dependencies. Ledmode is now always "enabled".

Remove unused libraries.
Add default CS/CE pin to Config.h
Add new variebles for voltage and current.
Add new internal command sent to controller when gateway is ready and online

Author: henrikekblad

SerialGateway/SerialGateway.ino

@@ -1,4 +1,4 @@
-/*
+  /*
  * Copyright (C) 2013 Henrik Ekblad <henrik.ekblad@gmail.com>
  * 
  * This program is free software; you can redistribute it and/or
@@ -22,16 +22,14 @@
  */
 
 #include <SPI.h>  
-#include <MsTimer2.h>  
-#include <PinChangeInt.h>
 #include <MyGateway.h>  
 #include <stdarg.h>
 
 #define INCLUSION_MODE_TIME 1 // Number of minutes inclusion mode is enabled
 #define INCLUSION_MODE_PIN 3 // Digital pin used for inclusion mode button
 
 
-MyGateway gw(9, 10, INCLUSION_MODE_TIME, INCLUSION_MODE_PIN,  6, 5, 4);
+MyGateway gw(DEFAULT_CE_PIN, DEFAULT_CS_PIN, INCLUSION_MODE_TIME, INCLUSION_MODE_PIN,  6, 5, 4);
 
 char inputString[MAX_RECEIVE_LENGTH] = "";    // A string to hold incoming commands from serial/ethernet interface
 int inputPos = 0;
@@ -40,34 +38,15 @@ boolean commandComplete = false;  // whether the string is complete
 void setup()  
 { 
   gw.begin();
-
-  // C++ classes and interrupts really sucks. Need to attach interrupt 
-  // outside thw Gateway class due to language shortcomings! Gah! 
-
-  if (gw.isLedMode()) {
-    // Add led timer interrupt
-    MsTimer2::set(300, ledTimersInterrupt);
-    MsTimer2::start();
-    // Add interrupt for inclustion button to pin 
-    PCintPort::attachInterrupt(INCLUSION_MODE_PIN, startInclusionInterrupt, RISING);
-  }
 }
 
 void loop()  
 { 
   gw.processRadioMessage();   
   checkSerialInput();
-  
 }
 
 
-void startInclusionInterrupt() {
-  gw.startInclusionInterrupt();
-}
-
-void ledTimersInterrupt() {
-  gw.ledTimersInterrupt();
-}
 
 void checkSerialInput() {
   if (commandComplete) {

libraries/MsTimer2/examples/FlashLed/FlashLed.pde

@@ -10,6 +10,10 @@
 #define RF24_PA_LEVEL_GW   RF24_PA_LEVEL  //Gateway PA Level, defaults to Sensor net PA Level.  Tune here if using an amplified nRF2401+ in your gateway.
 #define BASE_RADIO_ID 	   ((uint64_t)0xA8A8E1FC00LL) // This is also act as base value for sensor nodeId addresses. Change this (or channel) if you have more than one sensor network.
 
+// MySensors online examples defaults
+#define DEFAULT_CE_PIN 9
+#define DEFAULT_CS_PIN 10
+
 
 /***
  * Enable/Disable debug logging

libraries/MsTimer2/keywords.txt

@@ -10,22 +10,29 @@
 */
 
 #include "MyGateway.h"
+#include "utility/MsTimer2.h"
+#include "utility/PinChangeInt.h"
 
 
-MyGateway::MyGateway(uint8_t _cepin, uint8_t _cspin, uint8_t _inclusion_time) : MySensor(_cepin, _cspin) {
-	ledMode = false;
-	inclusionTime = _inclusion_time;
-}
+uint8_t pinRx;
+uint8_t pinTx;
+uint8_t pinEr;
+boolean buttonTriggeredInclusion;
+volatile uint8_t countRx;
+volatile uint8_t countTx;
+volatile uint8_t countErr;
+boolean inclusionMode; // Keeps track on inclusion mode
+
 
 MyGateway::MyGateway(uint8_t _cepin, uint8_t _cspin, uint8_t _inclusion_time, uint8_t _inclusion_pin, uint8_t _rx, uint8_t _tx, uint8_t _er) : MySensor(_cepin, _cspin) {
-	ledMode = true;
 	pinInclusion = _inclusion_pin;
 	inclusionTime = _inclusion_time;
 	pinRx = _rx;
 	pinTx = _tx;
 	pinEr = _er;
 }
 
+
 void MyGateway::begin(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e dataRate, void (*inDataCallback)(char *)) {
 	Serial.begin(BAUD_RATE);
 	repeaterMode = true;
@@ -47,47 +54,48 @@ void MyGateway::begin(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e da
 	countTx = 0;
 	countErr = 0;
 
-	if (ledMode) {
-		// Setup led pins
-		pinMode(pinRx, OUTPUT);
-		pinMode(pinTx, OUTPUT);
-		pinMode(pinEr, OUTPUT);
-		digitalWrite(pinRx, LOW);
-		digitalWrite(pinTx, LOW);
-		digitalWrite(pinEr, LOW);
+	// Setup led pins
+	pinMode(pinRx, OUTPUT);
+	pinMode(pinTx, OUTPUT);
+	pinMode(pinEr, OUTPUT);
+	digitalWrite(pinRx, LOW);
+	digitalWrite(pinTx, LOW);
+	digitalWrite(pinEr, LOW);
 
-		// Setup digital in that triggers inclusion mode
-		pinMode(pinInclusion, INPUT);
-		digitalWrite(pinInclusion, HIGH);
+	// Setup digital in that triggers inclusion mode
+	pinMode(pinInclusion, INPUT);
+	digitalWrite(pinInclusion, HIGH);
 
-		// Set initial state of leds
-		digitalWrite(pinRx, HIGH);
-		digitalWrite(pinTx, HIGH);
-		digitalWrite(pinEr, HIGH);
+	// Set initial state of leds
+	digitalWrite(pinRx, HIGH);
+	digitalWrite(pinTx, HIGH);
+	digitalWrite(pinEr, HIGH);
 
-	}
 
 	// Start up the radio library
 	setupRadio(paLevel, channel, dataRate);
 	RF24::openReadingPipe(WRITE_PIPE, BASE_RADIO_ID);
 	RF24::openReadingPipe(CURRENT_NODE_PIPE, BASE_RADIO_ID);
 	RF24::startListening();
 
-	// Send startup log message on serial
-	serial(PSTR("0;0;%d;0;%d;Arduino startup complete.\n"),  C_INTERNAL, I_LOG_MESSAGE);
-
-}
+	// Add led timer interrupt
+    MsTimer2::set(300, ledTimersInterrupt);
+    MsTimer2::start();
 
+	// Add interrupt for inclusion button to pin
+	PCintPort::attachInterrupt(pinInclusion, startInclusionInterrupt, RISING);
 
-boolean MyGateway::isLedMode() {
-	return ledMode;
+	// Send startup log message on serial
+	serial(PSTR("0;0;%d;0;%d;Gateway startup complete.\n"),  C_INTERNAL, I_GATEWAY_READY);
 }
 
-void MyGateway::startInclusionInterrupt() {
+
+void startInclusionInterrupt() {
 	  buttonTriggeredInclusion = true;
 }
 
 
+
 void MyGateway::checkButtonTriggeredInclusion() {
    if (buttonTriggeredInclusion) {
     // Ok, someone pressed the inclusion button on the gateway
@@ -243,7 +251,7 @@ void MyGateway::serial(MyMessage &msg) {
 }
 
 
-void MyGateway::ledTimersInterrupt() {
+void ledTimersInterrupt() {
   if(countRx && countRx != 255) {
     // switch led on
     digitalWrite(pinRx, LOW);

libraries/MySensors/MyConfig.h

@@ -14,8 +14,8 @@
 
 #include "MySensor.h"
 
-#define MAX_RECEIVE_LENGTH 100 // Max buffersize needed for messages coming from vera
-#define MAX_SEND_LENGTH 120 // Max buffersize needed for messages coming from vera
+#define MAX_RECEIVE_LENGTH 100 // Max buffersize needed for messages coming from controller
+#define MAX_SEND_LENGTH 120 // Max buffersize needed for messages destined for controller
 
 class MyGateway : public MySensor
 {
@@ -36,43 +36,27 @@ class MyGateway : public MySensor
 		* @param _er Digital pin for error led
 		*
 		*/
-		MyGateway(uint8_t _cepin=9, uint8_t _cspin=10, uint8_t _inclusion_time = 1);
-		MyGateway(uint8_t _cepin, uint8_t _cspin, uint8_t _inclusion_time, uint8_t _inclusion_pin, uint8_t _rx, uint8_t _tx, uint8_t _er);
+		MyGateway(uint8_t _cepin=DEFAULT_CE_PIN, uint8_t _cspin=DEFAULT_CS_PIN, uint8_t _inclusion_time = 1, uint8_t _inclusion_pin = 3, uint8_t _rx=6, uint8_t _tx=5, uint8_t _er=4);
 
 		/* Use this and pass a function that should be called when you want to process commands that arrive from radio network */
 		void begin(rf24_pa_dbm_e paLevel=RF24_PA_LEVEL_GW, uint8_t channel=RF24_CHANNEL, rf24_datarate_e dataRate=RF24_DATARATE, void (*dataCallback)(char *)=NULL);
 
 		void processRadioMessage();
 	    void parseAndSend(char *inputString);
-	    boolean isLedMode();
-	    void ledTimersInterrupt();
-	    void startInclusionInterrupt();
 
 	private:
 	    char convBuf[MAX_PAYLOAD*2+1];
 	    char serialBuffer[MAX_SEND_LENGTH]; // Buffer for building string when sending data to vera
 	    unsigned long inclusionStartTime;
-	    boolean inclusionMode; // Keeps track on inclusion mode
-	    boolean buttonTriggeredInclusion;
-	    volatile uint8_t countRx;
-	    volatile uint8_t countTx;
-	    volatile uint8_t countErr;
-	    boolean ledMode;
 	    boolean useWriteCallback;
 	    void (*dataCallback)(char *);
-
-
 	    uint8_t pinInclusion;
 	    uint8_t inclusionTime;
-	    uint8_t pinRx;
-	    uint8_t pinTx;
-	    uint8_t pinEr;
 
 		uint8_t h2i(char c);
 
 	    void serial(const char *fmt, ... );
 	    void serial(MyMessage &msg);
-	    void interruptStartInclusion();
 	    void checkButtonTriggeredInclusion();
 	    void setInclusionMode(boolean newMode);
 	    void checkInclusionFinished();
@@ -82,6 +66,7 @@ class MyGateway : public MySensor
 	    void errBlink(uint8_t cnt);
 };
 
-
+void ledTimersInterrupt();
+void startInclusionInterrupt();
 
 #endif

libraries/MySensors/MyGateway.cpp

@@ -39,15 +39,15 @@ typedef enum {
 	V_IMPEDANCE, V_ARMED, V_TRIPPED, V_WATT, V_KWH, V_SCENE_ON, V_SCENE_OFF,
 	V_HEATER, V_HEATER_SW, V_LIGHT_LEVEL, V_VAR1, V_VAR2, V_VAR3, V_VAR4, V_VAR5,
 	V_UP, V_DOWN, V_STOP, V_IR_SEND, V_IR_RECEIVE, V_FLOW, V_VOLUME, V_LOCK_STATUS,
-	V_DUST_LEVEL
+	V_DUST_LEVEL, V_VOLTAGE, V_CURRENT
 } data;
 
 // Type of internal messages (for internal messages)
 typedef enum {
 	I_BATTERY_LEVEL, I_TIME, I_VERSION, I_ID_REQUEST, I_ID_RESPONSE,
 	I_INCLUSION_MODE, I_CONFIG, I_FIND_PARENT, I_FIND_PARENT_RESPONSE,
 	I_LOG_MESSAGE, I_CHILDREN, I_SKETCH_NAME, I_SKETCH_VERSION,
-	I_REBOOT
+	I_REBOOT, I_GATEWAY_READY
 } internal;
 
 // Type of sensor  (for presentation message)

libraries/MySensors/MyGateway.h

@@ -88,10 +88,10 @@ class MySensor : public RF24
 	*
 	* Creates a new instance of Sensor class.
 	*
-	* @param _cepin The pin attached to RF24 Chip Enable on the RF module (defualt 9)
+	* @param _cepin The pin attached to RF24 Chip Enable on the RF module (default 9)
 	* @param _cspin The pin attached to RF24 Chip Select (default 10)
 	*/
-	MySensor(uint8_t _cepin=9, uint8_t _cspin=10);
+	MySensor(uint8_t _cepin=DEFAULT_CE_PIN, uint8_t _cspin=DEFAULT_CS_PIN);
 
 	/**
 	* Begin operation of the MySensors library