led_matrix.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c)  2025 Society of Robotics and Automation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef LED_MATRIX_H
#define LED_MATRIX_H
 
#include <string.h>
#include <stdint.h>
#include <ctype.h>
#include <freertos/FreeRTOS.h>
#include <freertos/task.h>
#include "esp_log.h"
 
#include "shift_register.h"
 
typedef uint32_t led_matrix_data_t;
 
typedef bool led_matrix_data_arr_t[CONFIG_LED_MATRIX_ROWS][CONFIG_LED_MATRIX_COLUMNS];
 
typedef struct {
    led_matrix_data_t data;
    shift_register_t config;
} led_matrix;
 
typedef enum {
    LED_MATRIX_OUTPUT_SEQ,
    LED_MATRIX_OUTPUT_PAR
} led_matrix_output_mode_t;
 
static const uint8_t led_matrix_rows = CONFIG_LED_MATRIX_ROWS;
 
static const uint8_t led_matrix_columns = CONFIG_LED_MATRIX_COLUMNS;
 
static const uint8_t led_matrix_map[CONFIG_LED_MATRIX_ROWS * CONFIG_LED_MATRIX_COLUMNS] = {
     0,  1,  2,  3,  4,  5,
    10, 11, 12, 13, 14, 15,
    20, 21, 22, 23,  8,  9,
    30, 31, 16, 17, 18, 19,
    24, 25, 26, 27, 28, 29
};
 
led_matrix led_matrix_init(void);
 
led_matrix_data_t bool_to_uint32(const led_matrix_data_arr_t input_arr);
 
esp_err_t led_matrix_set_bit(led_matrix *matrix, const uint8_t led_number, const uint8_t led_value);
 
esp_err_t led_matrix_set_data(led_matrix *matrix, const led_matrix_data_t data);
 
esp_err_t led_matrix_set_data_raw(led_matrix *matrix, const led_matrix_data_t data);
 
esp_err_t led_matrix_write(const led_matrix *matrix, const led_matrix_output_mode_t mode);
 
esp_err_t led_matrix_display_string(led_matrix *matrix, const char *message, double wait_ms);
 
esp_err_t led_matrix_cleanup(led_matrix matrix);
 
#endif