How To: Make a Simple/Cheap Scene Controller (with video)

AWI

Not even close to @petewill 's great build descriptions but here my version the "touch" version which can be battery operated. The used keyboard uses around 150uA. The touch panel generates an interrupt which wakes the arduino, reads the key and swiches a scene.

upload-10b4b56c-4f8e-4f43-ac06-69217e48adcb

The code below toggles between 'Scene ON' and 'Scene OFF' and stores the last state in EEPROM.

All credits to @petewill

/**
 * 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 <henrik.ekblad@mysensors.org>
 * Copyright (C) 2013-2015 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.
 *
 *******************************
 *
 * REVISION HISTORY
 * Version 1.0 - PeteWill
 *   	   1.1 - AWI
 * 
 * DESCRIPTION
 * A simple scene controller for use with MySensors.  8 scenes can be executed
 *  with an 8 key keypad, make sure to attach the pins and fill keyPins[] resp.
 * Watch a how to video here: https://youtu.be/KMGj5Bi7vL0 
 */
#include <SPI.h>
#include <MySensor.h>

#define SN "Scene Controller"
#define SV "1.0"

#define NODE_ID 14 // or set to AUTO if you want gw to assign a NODE_ID for you.
const byte KEYPAD_CHILD_ID = 0 ;

MySensor gw;
MyMessage scene_on(KEYPAD_CHILD_ID, V_SCENE_ON);
MyMessage scene_off(KEYPAD_CHILD_ID, V_SCENE_OFF);

const int DV = 2;									//DataValid (=key pressed) pin goes there
const int DV_int = DV-2;							//DataValid interrupt on pin 3 => 1
const unsigned long SLEEP_TIME = 3600000 ;			// sleep for an hour (or more if you want to)
volatile boolean DVint = false ; 					// interrupt flag, set by interrupt
const byte keyPins[] = {A0, A1, A2, A3, 3, 4, 5, 6};// keypad pins, (8 pin keyboard)
byte keyState[8]  ;									// hold current keystate (copy of EEPROM)

void setup(){
	gw.begin(NULL, NODE_ID);
	gw.sendSketchInfo(SN, SV);
	gw.present(KEYPAD_CHILD_ID, S_SCENE_CONTROLLER);
	pinMode(DV,INPUT);          					// Data Valid (interrupt)
	for (int i=0 ; i < sizeof(keyPins); i++){
		keyState[i] = gw.loadState(i) ; 			// load last Scenestates from EEPROM
		}
	}

// loop only if interrupt, else sleep
void loop(){
    // if so get a key value and send to MySensosrs network
	byte key = fetchData();    						// if so fetch key
    Serial.println(key);							// serial print as binary
	if (key > 0){									// (key-1) is used as index
		boolean keyVal = !gw.loadState(key-1);		// use lastState from EEPROM and toggle
		gw.saveState(key-1, keyVal);				// save new state to EEPROM
		if (keyVal) gw.send(scene_on.set(key-1));	// set the Scene On or Off
		else gw.send(scene_off.set(key-1));
		}
    DVint=false;									// reset interrupt flag
	gw.sleep(DV_int, RISING, SLEEP_TIME);			// node wakes up on key interrupt or time
	Serial.println(" key pressed or time trigger ");
}

// interrupt routine, only sets flag
void intrp(){DVint = true;};

// fetch serial data, only highest number key is returned
byte fetchData(){
	int Key=0;                        				// default key = 0 (nothing pressed)
	for (byte i = 0 ; i < sizeof(keyPins) ; i++){	// check each key, 
		if(digitalRead(keyPins[i]) == HIGH) Key=i+1;// set key if pressed (now only highest key)
		}
	return Key;										// return Key (0 if no key pressed)
}

Tomasz Pazio

ok easy.... two changes and 32 scenes can be managed :)

const byte ROWS = 4;
const byte COLS = 4;
byte rowPins[ROWS] = {3, 4, 5, 6};
byte colPins[COLS] = {A0, A1, A2, A3};
char keys[ROWS][COLS] = {{'1','2','3','A'},
                         {'4','5','6','B'},
                         {'7','8','9','C'},
                         {'*','0','#','D'}};


-----------------------------------------

 keyInt = keyInt + 100;

petewill

@AWI Excellent, thanks for adding the code for the capacitive touch, battery operated sensor! I added a link to your post in my initial post.

brom_snor

Hi Petewill
I 'd like to build your Scene Controller but I am missing the keypad.h library. Where can I get it?

greetings
Brom_Snor

petewill

@brom_snor
Sorry about that. I thought it was part of the default libraries. I must have downloaded it a while ago. This one should work: http://playground.arduino.cc/Code/Keypad

Fred LaR

Hi all - Another capacitive version with an "out of the bottle" keypad - 4 buttons. Like AWI's version, also toggles between 'Scene ON' and 'Scene OFF', but states are kept in a variable (keyState) - LEDs added for better toogle visibility. Capacitive routine found at http://www.arduino.cc/playground/Code/CapacitiveSensor

Great post from @petewill and nice version from AWI. Thanks!

#include <SPI.h>
#include <MySensor.h>
#define SN "Scene Controller"
#define SV "1.2"
#define NODE_ID 20 // or set to AUTO if you want gw to assign a NODE_ID for you.
const byte KEYPAD_CHILD_ID = 1 ;
MySensor gw;
MyMessage scene_on(KEYPAD_CHILD_ID, V_SCENE_ON);
MyMessage scene_off(KEYPAD_CHILD_ID, V_SCENE_OFF);

long time = 0;
long debounce = 800;
const byte keyLeds[] = {14, 15, 16, 17}; //LEDs to turn on/off
const byte keyPins[] = {2, 3, 4, 5}; //capacitive keys
byte keyState = B1111; //save LEDs states

void setup() {
Serial.begin(9600);
for (byte i = 0 ; i < sizeof(keyLeds) ; i++)
{ pinMode(keyLeds[i], OUTPUT);
}
gw.begin(NULL, NODE_ID);
gw.sendSketchInfo(SN, SV);
gw.present(KEYPAD_CHILD_ID, S_SCENE_CONTROLLER);
}

void loop() {
uint8_t pinRead;
for (byte i = 0 ; i < sizeof(keyPins) ; i++){
pinRead = readCapacitivePin(keyPins[i]);
if (pinRead > 2 && millis() - time > debounce) {
digitalWrite(keyLeds[i], bitRead(keyState,i));
if (bitRead(keyState,i) == 1){
gw.send(scene_on.set(keyPins[i]));
bitWrite(keyState, i, 0);} else
{gw.send(scene_off.set(keyPins[i]));
bitWrite(keyState, i, 1);}
time = millis();
}
}
}

// — readCapPin found at http://www.arduino.cc/playground/Code/CapacitiveSensor
uint8_t readCapacitivePin(int pinToMeasure) {

// Variables used to translate from Arduino to AVR pin naming
volatile uint8_t* port;
volatile uint8_t* ddr;
volatile uint8_t* pin;
// Here we translate the input pin number from
// Arduino pin number to the AVR PORT, PIN, DDR,
// and which bit of those registers we care about.
byte bitmask;
port = portOutputRegister(digitalPinToPort(pinToMeasure));
ddr = portModeRegister(digitalPinToPort(pinToMeasure));
bitmask = digitalPinToBitMask(pinToMeasure);
pin = portInputRegister(digitalPinToPort(pinToMeasure));
// Discharge the pin first by setting it low and output
*port &= ~(bitmask);
*ddr |= bitmask;
delay(1);
// Make the pin an input with the internal pull-up on
*ddr &= ~(bitmask);
*port |= bitmask;

// Now see how long the pin to get pulled up. This manual unrolling of the loop
// decreases the number of hardware cycles between each read of the pin,
// thus increasing sensitivity.
uint8_t cycles = 17;
if (*pin & bitmask) { cycles = 0;}
else if (*pin & bitmask) { cycles = 1;}
else if (*pin & bitmask) { cycles = 2;}
else if (*pin & bitmask) { cycles = 3;}
else if (*pin & bitmask) { cycles = 4;}
else if (*pin & bitmask) { cycles = 5;}
else if (*pin & bitmask) { cycles = 6;}
else if (*pin & bitmask) { cycles = 7;}
else if (*pin & bitmask) { cycles = 8;}
else if (*pin & bitmask) { cycles = 9;}
else if (*pin & bitmask) { cycles = 10;}
else if (*pin & bitmask) { cycles = 11;}
else if (*pin & bitmask) { cycles = 12;}
else if (*pin & bitmask) { cycles = 13;}
else if (*pin & bitmask) { cycles = 14;}
else if (*pin & bitmask) { cycles = 15;}
else if (*pin & bitmask) { cycles = 16;}

// Discharge the pin again by setting it low and output
// It’s important to leave the pins low if you want to
// be able to touch more than 1 sensor at a time – if
// the sensor is left pulled high, when you touch
// two sensors, your body will transfer the charge between
// sensors.
*port &= ~(bitmask);
*ddr |= bitmask;

return cycles;
}

DrJeff

@Fred-LaR WOW!
You just perked up my intrest got to try this one!

msebbe

Anybody made some Nice enclosure for this?

petewill

@Fred-LaR That's a great idea. Nice!

Michal Mormon

My domoticz found S_SCENE_CONTROLLER sensor but there is not any devices for such a hardware. Do you know how can I control scene with it?

mfalkvidd

@Michal-Mormon which version of Domoticz are you using?

Michal Mormon

Domoticz v.2.4633

Michel - It

lua script?

petewill

@Michel---It said:

lua script?

Sorry, not sure what you're asking.

Maciej Kulawik

@Michal-Mormon
S_SCENE_CONTROLLER can send messages V_SCENE_ON and V_SCENE_OFF. If you send those messages for the first time, domoticz will create new switch with the name 'scene'.

Michal Mormon

@Maciej-Kulawik
I found it as 'Scene' switch but this example send only V_SCENE_ON the first time (the switch is still ON later)

Maciej Kulawik

@Michal-Mormon
Yes, exactly! It looks like without scene_off sent from scene controller in domoticz it will be one-time action (since if this scene switch is switched on you cannot switch it on again). You can try to setup automatic switching it off in domoticz.

Michal Mormon

I added 2 lines and works perfect with Domoticz:

MyMessage scene(KEYPAD_CHILD_ID, V_SCENE_ON);
MyMessage scene2(KEYPAD_CHILD_ID, V_SCENE_OFF); //added line

gw.send(scene.set(keyInt));
gw.send(scene2.set(keyInt)); //added line

Michel - It

@Michal-Mormon awesome!

DrJeff

@petewill Have you updated this code to 2.0 yet? What is different?

How To: Make a Simple/Cheap Scene Controller (with video)

17

11.7k

11.2k

113.0k