cord_leds.h

/*
 * This file is part of the LibreRVAC project
 *
 * Copyright © 2015-2016
 *     Aleks-Daniel Jakimenko-Aleksejev <alex.jakimenko@gmail.com>
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once
#include <stdint.h>
#include <stdbool.h>

// TODO this tends to be pretty hot, so we are limiting ourselves
// to 8-bit values. We should find a way to have no such limitation.

typedef struct Led {
    uint_fast8_t brighteness; ///< 0-255, higher values mean that LED will shine brighter
    uint_fast8_t blink_frequency; ///< 0 if LED should be lit still, other values will make it blink
    bool smooth; ///< True if blinking should be smooth, false otherwise
    uint_fast8_t blink_shift; ///< TODO
} Led;