INF2004-Project/ir__sensor_8h_source.html

#ifndef IR_SENSOR_H // Include guard.

#define IR_SENSOR_H

#include "pico/types.h"

#include "irline/barcode.h"


typedef struct ir_flags

{

    bool top_wall;

    bool left_wall;

} ir_flags_t;


// Function prototypes.

//

void                ir_setup_adc_pin(uint adc_pin);

void                ir_setup_gpio_pin(uint gpio_pin);

barcode_line_type_t ir_read_barcode(void);

uint16_t            ir_read_line(uint gpio_pin_in);

void                ir_update_top_flag(ir_flags_t *flag);

void                ir_update_left_flag(ir_flags_t *flag);

uint16_t ir_find_wall_directions(uint gpio_pin_left, uint gpio_pin_right);


#endif // IR_SENSOR_H


// End of file driver/ir_sensor/ir_sensor.h.

barcode.h
Header file for the barcode driver.

barcode_line_type_t
barcode_line_type_t
Enum for the barcode line types (black or white, thin or thick). None for error handling.
Definition: barcode.h:125

ir_update_left_flag
void ir_update_left_flag(ir_flags_t *flag)
Indicates whether there is a left wall.
Definition: ir_sensor.c:73

ir_update_top_flag
void ir_update_top_flag(ir_flags_t *flag)
Indicates whether there is a top wall.
Definition: ir_sensor.c:62

ir_setup_adc_pin
void ir_setup_adc_pin(uint adc_pin)
Initalises the analog pins for the IR sensor to ADC.
Definition: ir_sensor.c:24

ir_find_wall_directions
uint16_t ir_find_wall_directions(uint gpio_pin_left, uint gpio_pin_right)
This returns the information of the walls in the node.
Definition: ir_sensor.c:87

ir_read_barcode
barcode_line_type_t ir_read_barcode(void)
This function reads the barcode and determines the colour and the thickness.
Definition: ir_sensor.c:109

ir_read_line
uint16_t ir_read_line(uint gpio_pin_in)
Detects line.
Definition: ir_sensor.c:50

ir_flags_t
struct ir_flags ir_flags_t
Indicates whether the IR line sensor detects walls on the top and left sides.

ir_setup_gpio_pin
void ir_setup_gpio_pin(uint gpio_pin)
Initialises the digital pin for the IR sensor.
Definition: ir_sensor.c:37

ir_flags
Indicates whether the IR line sensor detects walls on the top and left sides.
Definition: ir_sensor.h:22

ir_flags::top_wall
bool top_wall
Indicates whether there is a top wall.
Definition: ir_sensor.h:23

ir_flags::left_wall
bool left_wall
Indicates whether there is a left wall.
Definition: ir_sensor.h:24