pixie_chroma_internal.h

Go to the documentation of this file.

 
#ifndef pixie_chroma_h
#define pixie_chroma_h
 
#include "Arduino.h"
 
 
enum t_update_mode {
    AUTOMATIC, 
    MANUAL     
};
 
enum t_justification {
    LEFT,
    CENTER,
    RIGHT
};
 
enum t_scroll_type {
    SMOOTH,
    SHIFT,
    INSTANT
};
//............................................................................
class PixieChroma{
    public:
        PixieChroma(); 
        
        /*+-- Functions - Setup ------------------------------------------------------------*/ 
        /*|*/ void begin( const uint8_t data_pin, uint8_t pixies_x, uint8_t pixies_y );
        /*|*/ void begin_quad( uint8_t pixies_per_pin, uint8_t pixies_x, uint8_t pixies_y );
        /*|*/ void set_color_animation( void ( *action )( PixieChroma*, float ) );
        /*|*/ void set_color_animation_speed( float speed );
        /*|*/ void set_brightness( uint8_t level );
        /*|*/ void set_frame_rate_target( uint16_t target );
        /*|*/ void set_gamma_correction( bool enabled );
        /*|*/ void set_justification( t_justification justification, int16_t row = -1 );
        /*|*/ void set_line_wrap( bool enabled );
        /*|*/ void set_max_power( float volts, uint16_t milliamps );
        /*|*/ void set_palette( const uint8_t* pal );
        /*|*/ void set_palette( CRGBPalette16 pal );
        /*|*/ void set_scroll_type(t_scroll_type type);
        /*|*/ void set_update_mode( t_update_mode mode, uint16_t FPS = 60 );
        /*+---------------------------------------------------------------------------------*/ 
        
        /*+-- Functions - write(  ) ----------------------------------------------------------*/ 
        /*|*/ void add_char( char chr, int16_t x_pos, int16_t y_pos );
        /*|*/ void add_char( uint8_t bitmap_col_1, uint8_t bitmap_col_2, uint8_t bitmap_col_3, uint8_t bitmap_col_4, uint8_t bitmap_col_5, int16_t x_pos, int16_t y_pos );
        /*|*/ void write( uint8_t bitmap_col_1, uint8_t bitmap_col_2, uint8_t bitmap_col_3, uint8_t bitmap_col_4, uint8_t bitmap_col_5, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( char* message, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( int16_t input, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( uint16_t input, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( int32_t input, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( uint32_t input, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ #ifndef ARDUINO_ARCH_TEENSY_3_X
        /*|*/     void write( long unsigned int input, uint8_t x_pos = 0, uint8_t y_pos = 0 ); // pretty much the same as uint32_t, but Arduino is stupid
        /*|*/ #endif
        /*|*/ void write( float input, uint8_t places = 2, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ void write( double input, uint8_t places = 2, uint8_t x_pos = 0, uint8_t y_pos = 0 );
        /*|*/ 
        /*|*/ void write_pix( char* message, int16_t x_offset = 0, int16_t y_offset = 0 );
        /*|*/ void write_pix( uint8_t bitmap_col_1, uint8_t bitmap_col_2, uint8_t bitmap_col_3, uint8_t bitmap_col_4, uint8_t bitmap_col_5, int16_t x_dest = 0, int16_t y_dest = 0 );
        /*|*/ 
        /*+---------------------------------------------------------------------------------*/ 
 
        /*+-- Functions - print(  ) ----------------------------------------------------------*/ 
        /*|*/ void print( uint8_t bitmap_col_1, uint8_t bitmap_col_2, uint8_t bitmap_col_3, uint8_t bitmap_col_4, uint8_t bitmap_col_5 );
        /*|*/ void print( char chr );
        /*|*/ void print( char* message );
        /*|*/ void print( int16_t input );
        /*|*/ void print( uint16_t input );
        /*|*/ void print( int32_t input );
        /*|*/ void print( uint32_t input );
        /*|*/ #ifndef ARDUINO_ARCH_TEENSY_3_X
        /*|*/     void print( long unsigned int input ); // pretty much the same as uint32_t, but Arduino is stupid
        /*|*/ #endif
        /*|*/ void print( float input, uint8_t places = 2 );
        /*|*/ void print( double input, uint8_t places = 2 );
        /*+---------------------------------------------------------------------------------*/ 
 
        /*+-- Functions - println(  ) --------------------------------------------------------*/    
        /*|*/ void println( uint8_t bitmap_col_1, uint8_t bitmap_col_2, uint8_t bitmap_col_3, uint8_t bitmap_col_4, uint8_t bitmap_col_5 );
        /*|*/ void println( char* message );
        /*|*/ void println( int16_t input );
        /*|*/ void println( uint16_t input );
        /*|*/ void println( int32_t input );
        /*|*/ void println( uint32_t input );
        /*|*/ #ifndef ARDUINO_ARCH_TEENSY_3_X
        /*|*/     void println( long unsigned int input ); // pretty much the same as uint32_t, but Arduino is stupid
        /*|*/ #endif
        /*|*/ void println( float input, uint8_t places = 2 );
        /*|*/ void println( double input, uint8_t places = 2 );
        /*+---------------------------------------------------------------------------------*/
 
        /*+-- Functions - Cursor -----------------------------------------------------------*/ 
        /*|*/ uint8_t get_cursor_x();
        /*|*/ int16_t get_cursor_x_exact();
        /*|*/ uint8_t get_cursor_y();
        /*|*/ int16_t get_cursor_y_exact();
        /*|*/ void    set_cursor( uint8_t x_position, uint8_t y_position = 0 );
        /*+---------------------------------------------------------------------------------*/
        
        /*+-- Functions - Updating the mask/LEDs -------------------------------------------*/
        /*|*/ void clear();
        /*|*/ void free();
        /*|*/ void hold();
        /*|*/ void show();
        /*|*/ void delay(uint32_t milliseconds);
        /*+---------------------------------------------------------------------------------*/
        
        /*+-- Functions - Color ------------------------------------------------------------*/ 
        /*|*/ void color( CRGB col ); // Set all displays
        /*|*/ void color( CRGB col, uint8_t x, uint8_t y ); // Set one display
        /*|*/ void color( CRGB col, int16_t x1, int16_t y1, int16_t x2, int16_t y2 ); // Set a 2D rectangle
        /*|*/ void print_color( CRGB col );
        /*|*/ CRGB kelvin_to_rgb( uint16_t temperature ); // Get an approximate CRGB ( not yet gamma corrected ) of a blackbody radiation temperature
        /*+---------------------------------------------------------------------------------*/
 
        /*+-- Functions - Mask Effects -----------------------------------------------------*/ 
        /*|*/ void blur( fract8 blur_amount );
        /*|*/ void blur_x( fract8 blur_amount );
        /*|*/ void blur_y( fract8 blur_amount );
        /*|*/ void dim( uint8_t amount, bool reset_cursor = false ); // Fade towards black by amount
        /*+---------------------------------------------------------------------------------*/
        
        /*+-- Functions - Color Effects ----------------------------------------------------*/ 
        /*|*/ void color_blur( fract8 blur_amount );
        /*|*/ void color_blur_x( fract8 blur_amount );
        /*|*/ void color_blur_y( fract8 blur_amount );
        /*|*/ void color_dim( uint8_t amount ); // Fade towards black by amount
        /*+---------------------------------------------------------------------------------*/
 
        /*+-- Functions - 2D Tools ---------------------------------------------------------*/ 
        /*|*/ void     draw_line_color( int16_t x1, int16_t y1, int16_t x2, int16_t y2, CRGB color );
        /*|*/ void     draw_line_mask( int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint8_t value = 255 );
        /*|*/ float    get_uv_x( int32_t x_pixel );
        /*|*/ float    get_uv_y( int32_t y_pixel );
        /*|*/ uint8_t  get_pixel_mask( int32_t x, int32_t y );
        /*|*/ CRGB     get_pixel_color( int32_t x, int32_t y );
        /*|*/ void     print_xy_table();
        /*|*/ void     scroll_message( char* message, uint8_t row = 0 );
        /*|*/ void     set_pixel_mask( int32_t x, int32_t y, uint8_t value );
        /*|*/ void     set_pixel_color( int32_t x, int32_t y, CRGB color );
        /*|*/ void     shift_mask_x( int16_t amount, int16_t row = -1 );
        /*|*/ void     shift_mask_y( int16_t amount );
        /*|*/ void     shift_color_map_x( int16_t amount, int16_t row = -1 );
        /*|*/ void     shift_color_map_y( int16_t amount );
        /*|*/ uint16_t uv( float x, float y, bool wrap = false );
        /*|*/ uint16_t xy( int32_t x, int32_t y, bool wrap = false );
        /*+---------------------------------------------------------------------------------*/
        
        /*+-- Functions - Developer --------------------------------------------------------*/ 
        /*|*/ bool unit_tests();
        /*+---------------------------------------------------------------------------------*/
 
        // Variables -------------------------------------------------------------------------
//............................................................................
        CRGB *color_map;
    //............................................................................
        uint8_t *mask;
    //............................................................................
        CRGBPalette16 current_palette;
        //............................................................................
        uint16_t matrix_width;
    //............................................................................
        uint16_t matrix_height;
//............................................................................
        uint16_t pixel_count;
    //............................................................................
        uint16_t led_count;
        //............................................................................
        float delta = 1.0;
    //............................................................................
        float animation_speed = 1.0;
        //............................................................................
        float frame_rate;
        
    private:
        // Functions ----------------------------------
        void build_controller( const uint8_t pin );
        void calc_xy();
        void fetch_shortcode( char* message, uint16_t code_start, uint16_t code_end, bool return_code = false );
        void parse_custom_shortcode( char* message, uint16_t code_start, uint16_t code_end, bool return_code = false );
        int16_t calc_justification( t_justification justification, uint8_t row );
        void scroll_char(char c, uint8_t row);
        void scroll_char(uint8_t* bitmap, uint8_t row);
        
        // Variables ----------------------------------
        #if defined( ARDUINO_ARCH_ESP8266 ) || defined( ARDUINO_ARCH_ESP32 )
            Ticker animate;
        #elif defined( ARDUINO_ARCH_TEENSY_3_X )
            IntervalTimer animate;
        #endif
 
        const uint8_t display_padding_x = 1;
        const uint8_t display_padding_y = 2;
        const uint8_t display_width     = display_padding_x + 5 + display_padding_x;
        const uint8_t display_height    = display_padding_y + 7 + display_padding_y;
        const uint8_t extra_space_left  = display_width;
        const uint8_t leds_per_pixie    = 70;
        const uint8_t bit_table[2]      = { 0, 255 };
 
        volatile int16_t cursor_x;
        volatile int16_t cursor_y;
        volatile int16_t cursor_x_temp;
        volatile int16_t cursor_y_temp;
        t_justification justifications[8] = { LEFT, LEFT, LEFT, LEFT, LEFT, LEFT, LEFT, LEFT };         // Up to 8 rows
        bool scrolling[8]                 = { false, false, false, false, false, false, false, false }; // Up to 8 rows
        uint16_t scroll_frame_delay_ms = 10;
        uint16_t scroll_hold_ms        = 80;
        t_scroll_type scroll_type = SMOOTH;
        
        CRGB *color_map_out;
        uint8_t *mask_out;
        int16_t *xy_table;
        uint32_t t_last;
        CRGB print_col = CRGB( 0, 255, 0 );
        uint8_t temp_code[5];
 
        float    max_V  = 5;
        uint16_t max_mA = 500;    
        uint8_t  brightness_level = 255;
        
        bool correct_gamma = false;
        bool line_wrap = true;
        bool just_wrapped = false;
        bool custom_animation = false;
        
        bool freeze = false;
        bool ticker_running = false;
        float fps_target = 60;
        
        uint8_t pixie_pin;
        uint8_t chars_x;
        uint8_t chars_y;
}; 
 
#endif