Arduino and the mechanical relay - Revision history

MikeKrebs at 03:51, 4 August 2018

2018-08-04T03:51:00Z

MikeKrebs at 03:15, 2 July 2018

2018-07-02T03:15:00Z

MikeKrebs at 03:14, 2 July 2018

2018-07-02T03:14:03Z

MikeKrebs: Update the things you might want to change

2018-07-02T03:05:04Z

Update the things you might want to change

MikeKrebs at 00:57, 2 July 2018

2018-07-02T00:57:10Z

MikeKrebs at 00:54, 2 July 2018

2018-07-02T00:54:53Z

Dirknerkle at 13:21, 26 June 2018

2018-06-26T13:21:35Z

MikeKrebs: /* Things you might have to change */

2018-06-23T05:12:25Z

Things you might have to change

MikeKrebs: Started explaining the code

2018-06-23T05:08:31Z

Started explaining the code

MikeKrebs: Add code to page

2018-06-22T03:51:57Z

Add code to page

New page

<nowiki>
// Vixen/xLights generic serial mechanical relay sketch
// - Uses digitalWrite as this outputs LOW or HIGH no pwm values
// - This is what is needed for a mechanical relay

// Hookup the relay in order of channel definition
// Define as many as you need
// put channels (pins) in an array so we can use looping structures to control
int channels[] = {2, 3, 4, 5, 6, 7, 8, 10};

// Vixen information
// - CHANNEL_COUNT is number of channels it will listen for from Vixen
const int CHANNEL_COUNT = 8;
// speed for the com port for talking with vixen
const long VIXEN_COM_SPEED = 115200L;
// Generic Serial controller config - must be present, must match controller setup
const int VIXEN_HEADER[3] = {33, 34, 35}; // This is character !"# (hard to replicate in Vixen sequence)
// Relays
// - most mechanical relays turn on when pin is low, off on high
const int ON = LOW;
const int OFF = HIGH;

// these are program variables we need to use in multiple places
const int SIZE_OF_HEADER = sizeof(VIXEN_HEADER) / sizeof(int); // no need to change
int buffer[CHANNEL_COUNT]; // no need to change going to hold relay output values

void setup()
{
Serial.begin(VIXEN_COM_SPEED);
Serial.write("Setup");

// set the channel pins to output mode
for (int channelIndex = 0; channelIndex < CHANNEL_COUNT; channelIndex++) {
pinMode(channels[channelIndex], OUTPUT);
}

turnLightsOff();
powerOnSelfTest(); // watch your lights to make sure they are all going on in order
}

void loop()
{
waitForVixenHeader(VIXEN_HEADER);
readFromVixen();
outputToLights();
}

void turnLightsOff()
{
//turn them all off
for (int channelIndex = 0; channelIndex < CHANNEL_COUNT; channelIndex++) {
digitalWrite(channels[channelIndex], OFF);
}
}

void outputToLights()
{
for (int channelIndex = 0; channelIndex < CHANNEL_COUNT; channelIndex++) {
// we should only be seeing 255 and 0 but in case someone tried a fade
// 48 is used for debug purposes. You can use the serial monitor to test
// send this string !"#01010101 to turn on every other relay as 0 == dec(48) 1 == dec(49)
if (buffer[channelIndex] > 48) {
digitalWrite(channels[channelIndex], ON);
}
else {
digitalWrite(channels[channelIndex], OFF);
}
}
}

void readFromVixen()
{
char buffer2[CHANNEL_COUNT];
int index = 0;

while (Serial.available() < CHANNEL_COUNT) {}
// We have enough data!
for (int i = 0; i < CHANNEL_COUNT; i++) {
int inByte = Serial.read();
buffer[i] = inByte;
Serial.write(inByte);
}
}

void waitForVixenHeader(int header[])
{
for (int i = 0; i < SIZE_OF_HEADER; i++) {
// wait for serial available
while (!Serial.available()) {}
// Check the byte until it matches the VIXEN_HEADER byte
int inByte = Serial.read();
if (inByte != VIXEN_HEADER[i]) {
i = -1; // wrong data set to "zero"
}
}
// found the header!
}

// powerOnSelfTest - does a couple of checks to make sure everything turns on and off
// - watch your lights, they should go on in order
void powerOnSelfTest()
{
// This routines turns on and off each relay in order
for (int channelIndex = 0; channelIndex < CHANNEL_COUNT; channelIndex++) {
digitalWrite(channels[channelIndex], ON); // turn on one channel at a time
delay(2000);
digitalWrite(channels[channelIndex], OFF);
}
// This routines turns on each relay in order leaving them all on for .5 seconds
for (int channelIndex = 0; channelIndex < CHANNEL_COUNT; channelIndex++) {
digitalWrite(channels[channelIndex], ON); // all on test
delay(500); // wait .5 seconds
}
delay(2000); // slight pause to check all on
turnLightsOff();
}
</nowiki>

@@ Line 182: / Line 182: @@
 const long SERIAL_COM_SPEED = 115200L;
-This set the communication speed back to the player. This will have to match the controller setup in your player. 115,200 baud is equivalent to 115,200 bps which translates to:
+This sets the communication speed back to the player. This will have to match the controller setup in your player. 115,200 baud is equivalent to 115,200 bps which translates to:
 ,200 / 8 bits of data plus 2 bits of overhead = 11,520 bytes per second
 ,520 bytes / 20 fps (50 ms) = 576 bytes per frame

@@ Line 1: / Line 1: @@
 So you bought an arduino and then you got one of those cheap relay boards and you decided to try to do blinky flashy with them. First, it is not a great idea but assuming you want to try it, here you go!
-== First, here's the program code -- comments follow later! ==
+== Second, here's the program code -- comments follow later! ==
   <nowiki>

@@ Line 1: / Line 1: @@
 == First, here's the program code -- comments follow later! ==
@@ Line 122: / Line 124: @@
 Let's talk about the code...
-At the top of the sketch, you will find the definitions of how you are going to use the Arduino with Vixen, xLights or any other serial output. These things are self explanatory but for the "I've never seen an Arduino or Vixen setup" people, here is another try to explain them.
+At the top of the sketch, you will find the definitions of how you are going to use the Arduino with Vixen or any other serial output. These things are self explanatory but for the "I've never seen an Arduino or Vixen setup" people, here is another try to explain them.
 == Things you might have to change ==
@@ Line 128: / Line 130: @@
 int channels[] = {2, 3, 4, 5, 6, 7, 8, 10};
-This line assigns pins from the arduino to specific "channels". The order of definition is the order the pins will be turned on or off. In your software, you would assign channel one to Shrub1, channel two to Shrub2, etc. This is done in the element to controller mapping in Vixen or in model definition in xLights. You will need to map these through the Arduino pins to the specific relay on your relay board and out to the lights.
+This line assigns pins from the arduino to specific "channels". The order of definition is the order the pins will be turned on or off. In your software, you would assign channel one to Shrub1, channel two to Shrub2, etc. This is done in the element to controller mapping in Vixen. You will need to map these through the Arduino pins to the specific relay on your relay board and out to the lights.
 It might look like this:
 {| class="wikitable"
@@ Line 193: / Line 195: @@
 Most mechanical relays turn on when we send off (LOW or x'00'). If your relays are off when they should be on (and on when they should be off), then you will need to flip the LOW and HIGH.
-Everything else in this sketch should just work with generic serial controller. As of June, 2018, this limits you to Vixen 2 or Vixen 3. If you need a Renard sketch, see Arduino and the mechanical relay using Renard.
+Everything else in this sketch should just work with generic serial controller. As of June, 2018, this limits you to Vixen 2 or Vixen 3. If you need a Renard sketch, see [[Arduino and the mechanical relay using Renard]].

@@ Line 3: / Line 3: @@
   <nowiki>
 // *** diychristmas.org free software so long as this line remains in sketch!
-// Vixen/xLights "generic" serial mechanical relay sketch
+// Basically Vixen "generic" serial mechanical relay sketch
 //  - Uses digitalWrite as this outputs LOW or HIGH no pwm values
 //  - This is what is needed for a mechanical relay
@@ Line 12: / Line 13: @@
 int channels[] = {2, 3, 4, 5, 6, 7, 8, 10};
-// Vixen/xLights information
+// Vixen information
 // speed for the com port for talking with player
 const long SERIAL_COM_SPEED = 115200L;
@@ Line 179: / Line 180: @@
 const long SERIAL_COM_SPEED = 115200L;
 const int CONTROLLER_HEADER[3] = {33, 34, 35};
 const int ON  = LOW;
 const int OFF = HIGH;

← Older revision		Revision as of 13:21, 26 June 2018
Line 1:		Line 1:
		+	== First, here's the program code -- comments follow later! ==
		+
	<nowiki>		<nowiki>
	// *** diychristmas.org free software so long as this line remains in sketch!		// *** diychristmas.org free software so long as this line remains in sketch!

@@ Line 2: / Line 2: @@
   <nowiki>
 // *** diychristmas.org free software so long as this line remains in sketch!
 // Vixen/xLights "generic" serial mechanical relay sketch
 //  - Uses digitalWrite as this outputs LOW or HIGH no pwm values
@@ Line 12: / Line 12: @@
 int channels[] = {2, 3, 4, 5, 6, 7, 8, 10};
-// Vixen information
+// Vixen/xLights information
-//  - CHANNEL_COUNT is number of channels it will listen for from Vixen
+// speed for the com port for talking with player
 const long SERIAL_COM_SPEED = 115200L;
 // Generic Serial controller config - must be present, must match controller setup
-const int VIXEN_HEADER[3] = {33, 34, 35}; // This is character !"# (hard to replicate in Vixen sequence)
+const int CONTROLLER_HEADER[3] = {33, 34, 35}; // This is character !"# (hard to replicate in sequencer)
 // Relays
 //  - most mechanical relays turn on when pin is low, off on high
@@ Line 25: / Line 24: @@
 // these are program variables we need to use in multiple places
-const int SIZE_OF_HEADER = sizeof(VIXEN_HEADER) / sizeof(int); // no need to change
+const int SIZE_OF_HEADER = sizeof(CONTROLLER_HEADER) / sizeof(int); // no need to change
 int buffer[CHANNEL_COUNT]; // no need to change going to hold relay output values
@@ Line 31: / Line 31: @@
+{
    Serial.begin(SERIAL_COM_SPEED);
    // set the channel pins to output mode
@@ Line 44: / Line 43: @@
 void loop()
+{
-   waitForVixenHeader(VIXEN_HEADER);
+   waitForControllerHeader(CONTROLLER_HEADER);
-   readFromVixen();
+   readSequenceData();
    outputToLights();
+}
@@ Line 72: / Line 71: @@
+}
-void readFromVixen()
+void readSequenceData()
+{
    char buffer2[CHANNEL_COUNT];
@@ Line 86: / Line 85: @@
+}
-void waitForVixenHeader(int header[])
+void waitForControllerHeader(int header[])
+{
    for (int i = 0; i < SIZE_OF_HEADER; i++) {
      // wait for serial available
      while (!Serial.available()) {}
-     // Check the byte until it matches the VIXEN_HEADER byte
+     // Check the byte until it matches the CONTROLLER_HEADER byte
      int inByte = Serial.read();
-     if (inByte != VIXEN_HEADER[i]) {
+     if (inByte != CONTROLLER_HEADER[i]) {
        i = -1; // wrong data set to "zero"
+     }
@@ Line 118: / Line 117: @@
    turnLightsOff();
+}
 </nowiki>