Public function

Functions
void	scanner_cfg_setup (scanner_cfg_t *cfg)
	Config Object Initialization function.
SCANNER_RETVAL	scanner_init (scanner_t *ctx, scanner_cfg_t *cfg)
	Initialization function.
void	scanner_set_sdi (scanner_t *ctx, uint8_t sdi_mode)
	Set SDI Pin function.
uint8_t	scanner_get_sdo (scanner_t *ctx)
	Get SDO Pin state function.
void	scanner_clock (scanner_t *ctx)
	Pulse function.
void	scanner_serial_cmd (scanner_t *ctx, uint8_t cmd)
	Write function.
uint8_t	scanner_serial_read_reg (scanner_t *ctx, uint8_t reg_adr)
	Read function.
void	scanner_serial_write_reg (scanner_t *ctx, uint8_t reg_adr, uint8_t write_data)
	Write function.
void	scanner_startup (scanner_t *ctx)
	Start function.
void	scanner_read_pixel (scanner_t *ctx, uint8_t *pixel_data)
	Read pixels.

Detailed Description

Function Documentation

scanner_cfg_setup()

void scanner_cfg_setup

(

scanner_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

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

Note

All used pins will be set to unconnected state.

scanner_clock()

void scanner_clock

(

scanner_t *

ctx

)

Pulse function.

Parameters

ctx	Click object.

@description Function is used to make SCK pulse.

scanner_get_sdo()

uint8_t scanner_get_sdo

(

scanner_t *

ctx

)

Get SDO Pin state function.

Parameters

ctx	Click object.

Returns

• 1 : Pin high
• 0 : Pin low

@description Function is used to get pin state.

scanner_init()

SCANNER_RETVAL scanner_init	(	scanner_t *	ctx,
		scanner_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

scanner_read_pixel()

void scanner_read_pixel	(	scanner_t *	ctx,
		uint8_t *	pixel_data )

Read pixels.

Parameters

ctx	Click object.
pixel_data	Pixel buffer data.

@description Function is used to read pixel status.

Note

pixel_data should be buffer of 102 elements so that every data can be stored

scanner_serial_cmd()

void scanner_serial_cmd	(	scanner_t *	ctx,
		uint8_t	cmd )

Write function.

Parameters

ctx	Click object.
cmd	Write cmd.

@description Function is used to write command to the device.

scanner_serial_read_reg()

uint8_t scanner_serial_read_reg	(	scanner_t *	ctx,
		uint8_t	reg_adr )

Read function.

Parameters

ctx	Click object.
reg_adr	Register address.

Returns

• Returns read data.

@description Function is used to read from the device.

scanner_serial_write_reg()

void scanner_serial_write_reg	(	scanner_t *	ctx,
		uint8_t	reg_adr,
		uint8_t	write_data )

Write function.

Parameters

ctx	Click object.
reg_adr	Register address.
write_data	Data to be written.

@description Function is used to write to the device.

scanner_set_sdi()

void scanner_set_sdi	(	scanner_t *	ctx,
		uint8_t	sdi_mode )

Set SDI Pin function.

Parameters

ctx	Click object.
sdi_mode	Defines state of the pin. 1 : Pin high 0 : Pin low

@description Function is used to maipulate the state of the SDI pin.

scanner_startup()

void scanner_startup

(

scanner_t *

ctx

)

Start function.

Parameters

ctx	Click object.

@description Function is used to start up the linear array sensor.

Note

It is necessary to use this function in the application initialization stage.