x10.h

/*
 	Stepper.h - - Stepper library for Wiring/Arduino - Version 0.4
  
  Original library		(0.1) by Tom Igoe.
  Timing bug fixes		(0.2) "   "   "

	Sends X10 commands.
	
	2017-APR-17	Richard Hughes	Version 0.5
  
	-	Added timing varaibles for bitLength, bitDelay, offsetDelay and
		halfCycleDelay so that timings can be selected and runtime.
	-	Moved definition of receive pin and LED pin from x10.cpp
	-	Created new constructor without parameters and moved the init 
		function to be public so that the class can be created and
		initialised seperately.
	
*/

// ensure this library description is only included once
#ifndef x10_h
#define x10_h

// include types & constants of Wiring core API
#include <stdlib.h>
#include "Arduino.h"
#include "pins_arduino.h"

// library interface description
class x10 {
  public:
    // constructors:
    x10(int zeroCrossingPin, int dataPin, int rp, int led);
    x10(int zeroCrossingPin, int dataPin, int rp);
    x10(int zeroCrossingPin, int dataPin);
	x10();
    // write command method:
	void write(byte houseCode, byte numberCode, int numRepeats);
    int version(void);
    boolean received(void);
    byte unitCode(void);  // returns integer unit code
    byte houseCode(void); // returns ascii A-P human readable house code
    byte uc(void);        // returns binary unit code (x10constants.h)
    byte hc(void);        // returns binary house code (x10constants.h)
    byte cmndCode(void);
    void reset(void);
    void debug(void);
    void Check_Rcvr();
    void Parse_Frame();
    void attach();
    void detach();
	void init(int zeroCrossingPin, int dataPin, int rp, int led);
	void init(int zeroCrossingPin, int dataPin, int rp);
	void init(int zeroCrossingPin, int dataPin);
	void detectMainsFreq();
	// Timing varaibles.
	float mainsFrequency;
	long bitDelay;
	long bitLength;
	long offsetDelay;
	long halfCycleDelay;
  private:
    int zeroCrossingPin;	// AC zero crossing pin
    int dataPin;			// data out pin
	int recvPin;			// Receive data pin
	int ledPin;				// LED pin
    // sends the individual bits of the commands:
    void sendBits(byte cmd, byte numBits, byte isStartCode);
    // checks for AC zero crossing
    void waitForZeroCross(int pin, int howManyTimes);
};

#endif