rs485_driver.h

Go to the documentation of this file.

 
#ifndef RS485_DRIVER_H
#define RS485_DRIVER_H
 
#include "driver/uart.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
 
#define RS485_DRIVER_TASK_NAME            ("RS485_DRV") 
#define RS485_DRIVER_TASK_STACK_DEPTH     (4096U)       
#define RS485_DRIVER_TASK_PRIORITY        (16U)         
#define RS485_DRIVER_TASK_CPU_AFFINITY    (0U)          
#define RS485_DRIVER_TASK_BUFFER_SIZE     (256U)        
#define RS485_DRIVER_TASK_NOTIFY_STOP_BIT (1U << 0U)    
typedef enum {
    RS485_DRIVER_EVENT_FLAG_DATA       = (1U << 0), 
    RS485_DRIVER_EVENT_FLAG_RX_TIMEOUT = (1U << 1), 
    RS485_DRIVER_EVENT_FLAG_OVERFLOW   = (1U << 2), 
    RS485_DRIVER_EVENT_FLAG_PARITY     = (1U << 3)  
} rs485_driver_event_flags_t;
 
typedef struct {
    uint8_t data[RS485_DRIVER_TASK_BUFFER_SIZE]; 
    size_t length;                               
    int64_t timestamp_us;                        
    uint8_t flags;                               
} rs485_driver_event_t;
 
typedef struct {
    uint32_t baudrate;       
    uint8_t port;            
    uint8_t data_bits;       
    uint8_t parity;          
    uint8_t stop_bits;       
    uint8_t rx_pin;          
    uint32_t rx_buffer_size; 
    uint32_t queue_size;     
    void (*on_event_cb) (
        void *, const rs485_driver_event_t *); 
    void *on_event_cb_arg_void_ptr;            
} rs485_driver_config_t;
 
typedef struct {
    const rs485_driver_config_t *config_ptr; 
    QueueHandle_t event_queue;               
    uint8_t frame_bit_length;                
} rs485_driver_t;
 
esp_err_t rs485_driver_init (rs485_driver_t *rs485_drv_ptr, const rs485_driver_config_t *config_ptr);
 
uint8_t rs485_driver_get_bits_count (rs485_driver_t *rs485_drv_ptr);
 
void rs485_driver_deinit (rs485_driver_t *rs485_drv_ptr);
 
#endif