LRF.h

Go to the documentation of this file.

//
//  LRF.h
//  LittleRobotFriends
//
//  Created by Mark Argo on 2014-05-20.
//  Copyright (c) 2014 Aesthetec Studio Inc. All rights reserved.
//

/*
 THIS SOFTWARE IS PROVIDED “AS IS”, WITHOUT ANY REPRESENTATIONS, CONDITIONS, 
 AND/OR WARRANTIES OF ANY KIND.  WITHOUT LIMITATION, AESTHETEC STUDIO AND ITS 
 AFFILIATES, LICENSORS, SUPPLIERS, CONTRIBUTORS, SUBCONTRACTORS, DISTRIBUTORS 
 AND ALL CONTRIBUTORS DISCLAIM ANY EXPRESS OR IMPLIED REPRESENTATIONS, 
 CONDITIONS, OR WARRANTIES OF MERCHANTABILITY, MERCHANTABLE QUALITY, SATISFACTORY 
 QUALITY, NON-INFRINGEMENT, TITLE, DURABILITY, OR FITNESS FOR A PARTICULAR 
 PURPOSE, WHETHER ARISING BY STATUTE, COURSE OF DEALING, USAGE OF TRADE, OR 
 OTHERWISE.  EXCEPT AS OTHERWISE PROVIDED IN THIS AGREEMENT, YOU SHALL BEAR 
 THE ENTIRE RISK FOR ANY USE OR ANY OTHER EXPLOITATION MADE BY YOU OF ANY 
 RIGHTS IN THE COVERED SOFTWARE.
 
 Additional copyright information found at http://littlerobotfriends.com/legal/
*/

#ifndef __LRF_h
#define __LRF_h

#include <Arduino.h>
#include "LRFUtils.h"
#include "LRFEvents.h"
#include "LRFInfrared.h"

#define LRF_FIRMWARE_MAJOR                      1   
#define LRF_FIRMWARE_MINOR                      1   

#define LRF_DEBUG_CONSOLE_ENABLED               0
#define LRF_FORCE_HARDWARE_TEST                 0
#define LRF_ADVANCED_HARDWARE_TEST              0


class LittleRobotFriend
{
private:
    
public:
    void setup(void);                       
    void loop(void);                        
    
    
    void blink(LRFPattern pattern);
    void blink(LRFPattern pattern, unsigned int duration);
     
    void say(LRFSound sound);
    
    void blinkAndSay(LRFPattern pattern, LRFSound sound);
    
    void blinkAndSay(LRFPattern pattern, LRFSound *sounds, char soundCount);
    

    void setEventHandler(LRFEvent event, LRFEventHandler handler);
    
    
     
    void setBoredom(unsigned int timeout, unsigned char count);
    
    void sleep(void);

    

    LRFIRMessage readIRMessage(void);

    void sendIRMessage(LRFIRMessage message);


    unsigned char readTouch(void);

    unsigned char readLight(void);

    unsigned char readMicrophone(void);
    

    void setLeftLED(unsigned char red, unsigned char green, unsigned char blue, bool update=true);
    void setRightLED(unsigned char red, unsigned char green, unsigned char blue, bool update=true);
    void setBothLEDs(unsigned char red, unsigned char green, unsigned char blue, bool update=true);
    
    void setSpeaker(unsigned int frequency, unsigned int duration);
    
};

extern LittleRobotFriend lrf;

#endif