Support for GSM/SMS device

Author: user2684

.travis.yml

@@ -503,4 +503,10 @@ jobs:
        - sed -r -i 's/\/\/(SensorMPR121 .+)/\1/' $SKETCH
        - sed -r -i 's/\/\/(#include <sensors\/SensorMPR121.h>)/\1/' $SKETCH
        - eval $OTA_CONFIGURATION
+       - eval $COMPILE
+    - name: "SensorGSM"
+      script: 
+       - sed -r -i 's/\/\/(SensorGSM .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorGSM.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
        - eval $COMPILE

README.md

@@ -151,6 +151,7 @@ SensorDSM501A            | 1     | Dust sensor module DSM501A for PM1.0 and PM2.
 SensorPN532              | 1     | PN532 NFC RFID Module                                                                             | https://github.com/elechouse/PN532
 SensorCCS811             | 1     | CCS811 gas/Air Quality sensor. Measure VOC and eCO2                                               | https://github.com/adafruit/Adafruit_CCS811
 SensorMPR121             | 1     | MPR121-based capacitive touch control sensor                                                      | https://github.com/adafruit/Adafruit_MPR121
+SensorGSM                | 1     | Send SMS through an attached serial modem (e.g. SIM900)                                           | -
 
 Those sensors requiring a pin to operate would take it as an argument in the constructor. 
 NodeManager automatically creates all the child_ids, assigning an incremental counter. If you need to set your own child_id, pass it as the last argument to the constructor
@@ -977,6 +978,16 @@ Each sensor class may expose additional methods.
 	bool getCodeIsValid();
 ~~~	
 
+* SensorGSM
+~~~c
+	// set the baud rate of the serial port for connecting to the sensor (default: 115200)
+	void setBaudRate(uint32_t value);
+	// [101] set the recipient phone number
+	void setRecipient(const char* value);
+	// send the provided text via SMS to the configured recipient
+	void sendSMS(const char* text);
+~~~	
+
 ### OTA Configuration
 
 When `NODEMANAGER_OTA_CONFIGURATION` is set to ON the API presented above can be also called remotely through `SensorConfiguration`, which is automatically added to NodeManager. SensorConfiguration exposes by default child id 200 that can be used to interact with the service by sending `V_CUSTOM` type of messages and commands within the payload. For each `REQ` message, the node will respond with a `SET` message if successful. 

examples/Template/Template.ino

@@ -364,6 +364,9 @@ NodeManager. Just uncomment the settings you need and the sensors you want to ad
 //#include <sensors/SensorCCS811.h>
 //SensorCCS811 ccs811;
 
+//#include <sensors/SensorGSM.h>
+//SensorGSM gsm(6,7);
+
 /***********************************
  * Main Sketch
  */

keywords.txt

@@ -218,4 +218,5 @@ SensorPca9685W	KEYWORD1
 SensorDSM501A	KEYWORD1
 SensorPN532	KEYWORD1
 SensorCCS811	KEYWORD1
-SensorMPR121	KEYWORD1
+SensorMPR121	KEYWORD1
+SensorGSM	KEYWORD1

sensors/SensorGSM.h

@@ -0,0 +1,121 @@
+/*
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <[email protected]>
+ * Copyright (C) 2013-2017 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * 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.
+ */
+#ifndef SensorGSM_h
+#define SensorGSM_h
+ 
+/*
+SensorGSM: send SMS through a serial GSM modem
+*/
+
+#include <SoftwareSerial.h>
+
+class SensorGSM: public Sensor {
+	
+protected:
+	SoftwareSerial* _serial;
+	int8_t _rx_pin;
+	int8_t _tx_pin;
+	uint32_t _baud_rate = 115200;
+	const char* _recipient = "";
+	
+public:
+	SensorGSM(int8_t rxpin, int8_t txpin, uint8_t child_id = 0): Sensor(rxpin) {
+		_name = "GSM";
+		_rx_pin = rxpin;
+		_tx_pin = txpin;
+		children.allocateBlocks(1);
+		new Child(this,STRING,nodeManager.getAvailableChildId(child_id), S_CUSTOM, V_CUSTOM, _name);
+	};
+	
+	// set the baud rate of the serial port for connecting to the sensor (default: 115200)
+	void setBaudRate(uint32_t value) {
+		_baud_rate = value;
+	};
+	
+	// [101] set the recipient phone number
+	void setRecipient(const char* value) {
+		_recipient = value;
+	};
+	
+	// send the provided text via SMS to the configured recipient
+	void sendSMS(const char* text) {
+		_serial->println("AT+CMGF=1");    
+		_read();
+		_serial->print("AT+CMGS=\"");
+		_serial->print(_recipient);
+		_serial->println("\"\r");
+		_read();
+		_serial->print(text);
+		_serial->println (char(26));
+		_read();
+		children.get()->setValue("OK");
+	}
+	
+	// define what to do during setup
+	void onSetup() {
+		// report immediately
+		setReportTimerMode(IMMEDIATELY);
+		// setup software serial
+		_serial = new SoftwareSerial(_rx_pin,_tx_pin);
+		// connect to the sensor
+		_serial->begin(_baud_rate);
+		// wait for the SIM card to connect to the carrier
+		wait(3000);
+		_read();
+		// AT handshake 
+		_serial->println("AT");
+		_read();
+		// signal quality test
+		_serial->println("AT+CSQ");
+		_read();
+		// read SIM information
+		_serial->println("AT+CCID");
+		_read();
+		// check whether it has registered in the network
+		_serial->println("AT+CREG?");
+		_read();
+	};
+	
+	// what to do when receiving a message
+	void onReceive(MyMessage* message) {
+		Child* child = getChild(message->sensor);
+		if (child == nullptr) return;
+		// send the SMS using the text provided in the message payload
+		if (message->getCommand() == C_SET) sendSMS(message->getString());
+	};
+
+#if NODEMANAGER_OTA_CONFIGURATION == ON
+	// define what to do when receiving an OTA configuration request
+	void onOTAConfiguration(ConfigurationRequest* request) {
+		switch(request->getFunction()) {
+		case 101: setRecipient(request->getValueString()); break;
+		default: return;
+		}
+	};
+#endif
+
+protected:
+	// Forward what Software Serial received to Serial Port
+	void _read() {
+		wait(500);
+		String input = _serial->readString();
+		if (input.length() != 0) debug_verbose(PSTR(LOG_SENSOR "READ %s\n"),const_cast<char*>(input.c_str()));
+	};
+};
+#endif