dotmatrixr  2.0.0.0
Functions

Functions

void dotmatrixr_cfg_setup (dotmatrixr_cfg_t *cfg)
 Config Object Initialization function. More...
 
DOTMATRIXR_RETVAL dotmatrixr_init (dotmatrixr_t *ctx, dotmatrixr_cfg_t *cfg)
 Initialization function. More...
 
void dotmatrixr_generic_transfer (dotmatrixr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void dotmatrixr_set_bl_pin_state (dotmatrixr_t *ctx, uint8_t state)
 Sets BL pin to high or low state. More...
 
void dotmatrixr_set_rs_pin_state (dotmatrixr_t *ctx, uint8_t state)
 Sets RS pin to high or low state. More...
 
void dotmatrixr_set_rst_pin_state (dotmatrixr_t *ctx, uint8_t state)
 Sets RST pin to high or low state. More...
 
void dotmatrixr_restart (dotmatrixr_t *ctx)
 Restart device. More...
 
void dotmatrixr_ctrl_0 (dotmatrixr_t *ctx, uint8_t ctrl_byte)
 Function for writing control word 0. More...
 
void dotmatrixr_ctrl_1 (dotmatrixr_t *ctx, uint8_t ctrl_byte)
 Function for writing control word 1. More...
 
void dotmatrixr_write_ascii (dotmatrixr_t *ctx, char *ascii_data)
 Sets display to written value. More...
 

Detailed Description

Function Documentation

◆ dotmatrixr_cfg_setup()

void dotmatrixr_cfg_setup ( dotmatrixr_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.

◆ dotmatrixr_ctrl_0()

void dotmatrixr_ctrl_0 ( dotmatrixr_t ctx,
uint8_t  ctrl_byte 
)

Function for writing control word 0.

Parameters
ctxClick object.
ctrl_byteControl byte

◆ dotmatrixr_ctrl_1()

void dotmatrixr_ctrl_1 ( dotmatrixr_t ctx,
uint8_t  ctrl_byte 
)

Function for writing control word 1.

Parameters
ctxClick object.
ctrl_byteControl byte

◆ dotmatrixr_generic_transfer()

void dotmatrixr_generic_transfer ( dotmatrixr_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ dotmatrixr_init()

DOTMATRIXR_RETVAL dotmatrixr_init ( dotmatrixr_t ctx,
dotmatrixr_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ dotmatrixr_restart()

void dotmatrixr_restart ( dotmatrixr_t ctx)

Restart device.

Parameters
ctxClick object.

◆ dotmatrixr_set_bl_pin_state()

void dotmatrixr_set_bl_pin_state ( dotmatrixr_t ctx,
uint8_t  state 
)

Sets BL pin to high or low state.

Parameters
ctxClick object.
statePin state

◆ dotmatrixr_set_rs_pin_state()

void dotmatrixr_set_rs_pin_state ( dotmatrixr_t ctx,
uint8_t  state 
)

Sets RS pin to high or low state.

Parameters
ctxClick object.
statePin state

◆ dotmatrixr_set_rst_pin_state()

void dotmatrixr_set_rst_pin_state ( dotmatrixr_t ctx,
uint8_t  state 
)

Sets RST pin to high or low state.

Parameters
ctxClick object.
statePin state

◆ dotmatrixr_write_ascii()

void dotmatrixr_write_ascii ( dotmatrixr_t ctx,
char *  ascii_data 
)

Sets display to written value.

Parameters
ctxClick object.
ascii_dataString to be displayed