shift_register.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 SHIFT_REGISTER_H
#define SHIFT_REGISTER_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stdlib.h>
 
#include "pin_defs.h"
#include "utils.h"
 
#include "driver/gpio.h"
#include "hal/gpio_types.h"
#include "driver/gptimer.h"
#include "driver/gptimer_types.h"
#include "esp_err.h"
#include "esp_check.h"
 
typedef struct {
    gpio_num_t sdata;
    gpio_num_t srclk;
    gpio_num_t rclk;
    gptimer_handle_t timer;
} shift_register_t;
 
esp_err_t shift_register_gpio_init(shift_register_t *conf);
 
esp_err_t shift_register_write_uint8(const shift_register_t *sreg, const uint8_t data, const bool instant);
 
esp_err_t shift_register_write_uint32(const shift_register_t *sreg, const uint32_t data, const bool instant);
 
esp_err_t shift_register_cleanup(shift_register_t sreg);
 
#endif