serial_communication.h

Go to the documentation of this file.

/*
 * Copyright 2015 Sebastian Neuser
 *
 * This file is part of the uMIDI firmware.
 *
 * The MIDI volume controller firmware is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The uMIDI firmware is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the uMIDI firmware.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _SERIAL_COM_H
#define _SERIAL_COM_H


//---------------- includes ----------------//
#include <stdbool.h>
#include <stdint.h>
#include <avr/pgmspace.h>


//---------------- constants ----------------//

#define CMD_BUFFER_SIZE         100

#define CMD_HISTORY_SIZE        4

#define ESCAPE_CHAR_CODE        27

#define MAX_PAGE_NUM            ((PROGMEM_SIZE - BOOT_SECTION_SIZE) / SPM_PAGESIZE / 2 - 1)

#define RESET_TIMEOUT           2


//---------------- data types ----------------//

typedef bool (*cmd_handler_t)(const char* cmd);

struct serial_command
{
    PGM_P cmd_string;           

    PGM_P help_string;          

    cmd_handler_t handler;      
};


//---------------- functions and procedures ----------------//

void init_serial_communication(const struct serial_command commands[], uint8_t commands_size);

void serial_communication_task(void);


//---------------- EOF ----------------//
#endif // _SERIAL_COM_H