arduino-hc-05/HC05.h

/*
 * HC05.h - interface definitions for the HC05 library
 *
 * Select hardware or software serial port:
 *   Define HC05_SOFTWARE_SERIAL to select a SoftwareSerial port, then
 *   initialize the HC05 class with either two arguments, for a hardware port,
 *   or four arguments for a software serial port:
 *
 *     HC05(cmdPin, statePin)
 *     or
 *     HC05(cmdPin, statePin, rxPin, txPin)
 *
 * Specify an alternate hardware serial port by changing the
 * HC05_HW_SERIAL_PORT define.
 *
 * Define DEBUG_HC05 to enable debugging messages and use the
 * DEBUG_BEGIN() macro in the sketch setup() function.
 * By default, debugging messages go to the harware serial port, Serial.
 * Change that by defining DEBUG_SW_PORT.
 *
 */
#ifndef HC05_h
#define HC05_h

#include <inttypes.h>
#include <Stream.h>
#include <SoftwareSerial.h>

/*
 * Comment the following define line if you aren't using the State pin or
 * if your HC05 does not have such a pin.  You still must specify a
 * statePin to initialize the HC05 class, but the pin will not be used.
 */
#define HC05_STATE_PIN

/*
 * This macro must be defined even if you are using a software serial
 * port. You can change this to any serial port supported by your
 * Arduino (i.e, Serial1, Serial2, etc.)
 */
#define HC05_HW_SERIAL_PORT Serial


/*
 * Optional macros, define as needed
 */
#define HC05_SOFTWARE_SERIAL
#define DEBUG_HC05
//#define DEBUG_SW_PORT swserial(4,5)

#ifdef DEBUG_HC05
#ifdef DEBUG_SW_PORT
#define DEBUG_PORT swserial
#else
#define DEBUG_PORT Serial
#endif

#define DEBUG_BEGIN(baud) DEBUG_PORT.begin(baud)
#define DEBUG_WRITE(...) DEBUG_PORT.write(__VA_ARGS__)
#define DEBUG_PRINT(...) DEBUG_PORT.print(__VA_ARGS__)
#define DEBUG_PRINTLN(...) DEBUG_PORT.println(__VA_ARGS__)

#else
#define DEBUG_BEGIN(baud)
#define DEBUG_WRITE(...)
#define DEBUG_PRINT(...)
#define DEBUG_PRINTLN(...)

#endif  // DEBUG_HC05

class HC05 : public Stream
{
public:
    enum Roles {
        Slave = 0,
        Master = 1,
        SlaveLoop = 2
    };

    HC05(int cmdPin, int statePin);
    HC05(int cmdPin, int statePin, uint8_t rx, uint8_t tx);
    unsigned long findBaud();
    void setBaud(unsigned long baud);  // always no parity, one stop bit
    void setBaud(unsigned long baud, unsigned long stopbits, unsigned long parity);

    // cmd(): 100ms default timeout covers simple commands, but commands
    // that manage the connection are likely to take much longer.
    bool cmd(String cmd, unsigned long timeout=100);
    bool cmd(const char* cmd, unsigned long timeout=100);

    // HC05 cmdMode2 forces 38400, no parity, one stop bit
    // Entering cmdMode2 uses a pin to turn the HC05 power on and off
    // with the cmdPin high. cmdPin must remain high to stay in
    // cmdMode2, so use cmdMode2End() to exit.
    void cmdMode2Start(int pwrPin);
    void cmdMode2End(void);

#ifdef HC05_STATE_PIN
    bool connected(void);
#endif
    virtual int available(void);
    virtual void begin(unsigned long);
    virtual int peek(void);
    virtual int read(void);
    virtual void flush(void);
    virtual size_t write(uint8_t);
    using Print::write;
#ifdef HC05_SOFTWARE_SERIAL
    SoftwareSerial _btSerial;
#endif

private:
    bool cmdMode;
    int _cmdPin;
#ifdef HC05_STATE_PIN
    int _statePin;
#endif
    int _bufsize;
    char _buffer[32];
    void setCmdPin(bool state);

    String _stringBuffer;
    String _stringData;
    int _lastError;

public:
    bool atGetCommand(String command, unsigned long timeout=100);
    bool atGetCommand1(String command, String arg1, unsigned long timeout=100);

    bool atTest(unsigned long timeout=100);
    bool atReset(unsigned long timeout=100);
    bool atVersion(unsigned long timeout=100);
    bool atRestore(unsigned long timeout=100);
    bool atGetAddress(unsigned long timeout=100);
    bool atGetName(unsigned long timeout=100);
    bool atSetName(String name, unsigned long timeout=100);
    bool atGetRemoteName(String address, unsigned long timeout=100);
    bool atGetRole(unsigned long timeout=100);
    bool atSetRole(Roles role, unsigned long timeout=100);
    bool atGetPassKey(unsigned long timeout=100);
    bool atSetPassKey(String passKey, unsigned long timeout=100);
};

extern HC05 btSerial;
#endif  // HC05_h