LRFUtils.h

Go to the documentation of this file.

//
//  LRFUtils.h
//  LittleRobotFriends
//
//  Created by Mark Argo on 2014-05-01.
//  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 __LRFUtils_h
#define __LRFUtils_h

#include <Arduino.h>

//-------------------------------------------------------------
#pragma mark - Pattern Types
//-------------------------------------------------------------

// LRFColor - lookup index for color constants (4 bits max)

typedef enum
{
    LRFColor_Blank  = 0,    
    LRFColor_Red,           
    LRFColor_Green,         
    LRFColor_Blue,          
    LRFColor_Orange,        
    LRFColor_Cyan,          
    LRFColor_Purple,        
    LRFColor_Yellow,        
    LRFColor_Pink,          
    LRFColor_SoftRed,       
    LRFColor_SoftGreen,     
    LRFColor_SoftBlue,      
    LRFColor_SoftYellow,    
    LRFColor_SoftCyan,      
    LRFColor_SoftPink,      
    LRFColor_White = 15     
} __attribute__ ((packed)) LRFColor;


typedef struct
{
    unsigned char red;      
    unsigned char green;    
    unsigned char blue;     
} __attribute__ ((packed)) LRFColorValue;


typedef enum
{
    LRFPatternMode_Flat = 0,        
    LRFPatternMode_FlatFlip,        
    LRFPatternMode_FlatFlipToggle,  
    LRFPatternMode_Fade,            
    LRFPatternMode_FadeFlip,        
    LRFPatternMode_FadeToggle,      
    LRFPatternMode_FadeFlipToggle,  
    LRFPatternMode_Boomerang,       
    LRFPatternMode_BoomerangToggle, 
    LRFPatternMode_RandomFlat,      
    LRFPatternMode_RandomFade,      
    LRFPatternMode_RandomToggle,    
    LRFPatternMode_RandomBoomerang, 
    LRFPatternMode_None = 15        
} __attribute__ ((packed)) LRFPatternMode;


typedef struct
{
    LRFColor                start:4;        
    LRFColor                target:4;       
    LRFPatternMode          mode:4;         
    int                     reserved:4;     
} __attribute__ ((packed)) LRFPatternStruct;


typedef union
{
    LRFPatternStruct pattern;
    int raw;
} __attribute__ ((packed)) LRFPattern;


//-------------------------------------------------------------
#pragma mark - Sound Types
//-------------------------------------------------------------


typedef enum
{
    LRFNote_A   = 0,    
    LRFNote_AS,         
    LRFNote_B,          
    LRFNote_C,          
    LRFNote_CS,         
    LRFNote_D,          
    LRFNote_DS,         
    LRFNote_E,          
    LRFNote_F,          
    LRFNote_FS,         
    LRFNote_G,          
    LRFNote_GS,         
    LRFNote_NULL = 15   
} __attribute__ ((packed)) LRFNote;


typedef enum
{
    LRFOctave_1 = 0,    
    LRFOctave_2,        
    LRFOctave_3,        
    LRFOctave_4,        
    LRFOctave_5,        
    LRFOctave_6,        
    LRFOctave_7,        
    LRFOctave_8         
} __attribute__ ((packed)) LRFOctave;


typedef enum
{
    LRFIntonation_Flat = 0,     
    LRFIntonation_Rising = 1,   
    LRFIntonation_Falling = 2,  
    LRFIntonation_Peaking = 3,  
    LRFIntonation_Dipping = 4   
} __attribute__ ((packed)) LRFIntonation;

typedef enum
{
    LRFDuration_None = 0,       
    LRFDuration_Short,          
    LRFDuration_DoubleShort,    
    LRFDuration_Medium,         
    LRFDuration_DoubleMedium,   
    LRFDuration_Long,           
    LRFDuration_DoubleLong,     
    LRFDuration_VeryLong        
} __attribute__ ((packed)) LRFDuration;

typedef struct
{
    LRFNote         note:4;         
    LRFOctave       octave:3;       
    LRFIntonation   intonation:3;   
    LRFDuration     duration:3;     
    LRFDuration     pause:3;        
} __attribute__ ((packed)) LRFSoundStruct;

#define LRFSoundStruct_Blank        {LRFNote_NULL,0,0,0,0}

typedef union
{
    LRFSoundStruct sound;
    int raw;
} __attribute__ ((packed)) LRFSound;

// LRFFunctionPtr - General function pointer object
typedef void (*LRFFunctionPtr)(void);


//-------------------------------------------------------------
#pragma mark - Lookup Functions
//-------------------------------------------------------------

void lrf_utils_color_lookup(LRFColor color, LRFColorValue *value);

void lrf_utils_color_lookup_random(LRFColorValue *value);

unsigned int lrf_utils_duration_lookup(LRFDuration duration);

unsigned int lrf_utils_note_to_frequency(LRFNote note, LRFOctave octave);

bool lrf_utils_is_holiday_hardware(void);


#endif