linefollower 2.0.0.0

Functions

void linefollower_cfg_setup (linefollower_cfg_t *cfg)
 Config Object Initialization function.
 
LINEFOLLOWER_RETVAL linefollower_init (linefollower_t *ctx, linefollower_cfg_t *cfg)
 Initialization function.
 
uint8_t linefollower_get_u1 (linefollower_t *ctx)
 Get status of U1 pin function.
 
uint8_t linefollower_get_u2 (linefollower_t *ctx)
 Get status of U2 pin function.
 
uint8_t linefollower_get_u3 (linefollower_t *ctx)
 Get status of U3 pin function.
 
uint8_t linefollower_get_u4 (linefollower_t *ctx)
 Get status of U4 pin function.
 
uint8_t linefollower_get_u5 (linefollower_t *ctx)
 Get status of U5 pin function.
 
void linefollower_data_track (linefollower_t *ctx, linefollower_direction_t *data_track)
 Get status of all pin function.
 
uint8_t linefollower_get_direction (linefollower_t *ctx)
 Get direction data function.
 

Detailed Description

Function Documentation

◆ linefollower_cfg_setup()

void linefollower_cfg_setup ( linefollower_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ linefollower_data_track()

void linefollower_data_track ( linefollower_t * ctx,
linefollower_direction_t * data_track )

Get status of all pin function.

Parameters
ctxClick object.
data_trackData track structure

This function get status of all pin of the QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_direction()

uint8_t linefollower_get_direction ( linefollower_t * ctx)

Get direction data function.

Parameters
ctxClick object.
Returns
direction
- 0 [ LINEFOLLOWER_DIR_STRAIGHT ] : Straight movement;
- 1 [ LINEFOLLOWER_DIR_LEFT ] : Left movement;
- 2 [ LINEFOLLOWER_DIR_RIGHT ] : Right movement;
- 3 [ LINEFOLLOWER_DIR_SHARP_LEFT ] : Sharp left movement;
- 4 [ LINEFOLLOWER_DIR_SHARP_RIGHT ] : Sharp right movement;
- 5 [ LINEFOLLOWER_DIR_TRACKING_LOST ] : Tracking lost;

This function direction movement data of the QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_u1()

uint8_t linefollower_get_u1 ( linefollower_t * ctx)

Get status of U1 pin function.

Parameters
ctxClick object.
Returns
Detect line black-white color::
  • 0 : no black;
  • 1 : black;

This function get state of the RST pin U1: QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_u2()

uint8_t linefollower_get_u2 ( linefollower_t * ctx)

Get status of U2 pin function.

Parameters
ctxClick object.
Returns
Detect line black-white color:
  • 0 : no black;
  • 1 : black;

This function get state of the RST pin U2: QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_u3()

uint8_t linefollower_get_u3 ( linefollower_t * ctx)

Get status of U3 pin function.

Parameters
ctxClick object.
Returns
Detect line black-white color:
  • 0 : no black;
  • 1 : black;

This function get state of the RST pin U3: QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_u4()

uint8_t linefollower_get_u4 ( linefollower_t * ctx)

Get status of U4 pin function.

Parameters
ctxClick object.
Returns
Detect line black-white color:
  • 0 : no black;
  • 1 : black;

This function get state of the RST pin U4: QRE1113 Minature Reective Object Sensor.

◆ linefollower_get_u5()

uint8_t linefollower_get_u5 ( linefollower_t * ctx)

Get status of U5 pin function.

Parameters
ctxClick object.
Returns
Detect line black-white color:
  • 0 : no black;
  • 1 : black;

This function get state of the RST pin U5: QRE1113 Minature Reective Object Sensor.

◆ linefollower_init()

LINEFOLLOWER_RETVAL linefollower_init ( linefollower_t * ctx,
linefollower_cfg_t * cfg )

Initialization function.

Parameters
linefollowerClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.