This file contains API for ClickID Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_one_wire.h"

Data Structures
struct	clickid_version_t
	ClickID version. More...

struct	clickid_information_t
	ClickID information. More...

struct	clickid_t
	ClickID context object. More...

struct	clickid_cfg_t
	ClickID configuration object. More...

Macros
#define	CLICKID_CMD_WRITE_MEMORY 0x96
	ClickID commands list.

#define	CLICKID_CMD_READ_MEMORY 0x69

#define	CLICKID_CMD_RELEASE 0xAA

#define	CLICKID_MEM_ACCESS_SUCCESS 0xAA
	ClickID memory access result list.

#define	CLICKID_MEM_ACCESS_FAIL 0x55

#define	CLICKID_USER_EEPROM_START 0x0000
	ClickID memory map.

#define	CLICKID_USER_EEPROM_END 0x01FF

#define	CLICKID_PAGE_START 0x00

#define	CLICKID_PAGE_END 0x1F

#define	CLICKID_PAGE_SIZE 32

#define	CLICKID_MANIFEST_START_ADDRESS 0x0020

#define	CLICKID_FAMILY_CODE 0xCC
	ClickID family code value.

#define	CLICKID_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	clickid_return_value_t { CLICKID_OK = 0 , CLICKID_ERROR = -1 }
	ClickID return value data. More...

Functions
void	clickid_cfg_setup (clickid_cfg_t *cfg)
	ClickID configuration object setup function.

err_t	clickid_init (clickid_t ctx, clickid_cfg_t cfg)
	ClickID initialization function.

void	clickid_deinit (clickid_t *ctx)
	ClickID de-initialization function.

err_t	clickid_check_communication (clickid_t *ctx)
	ClickID check communication function.

err_t	clickid_read_memory (clickid_t ctx, uint16_t address, uint8_t data_out, uint16_t len)
	ClickID read memory function.

err_t	clickid_write_memory (clickid_t ctx, uint16_t address, uint8_t data_in, uint16_t len)
	ClickID write memory function.

err_t	clickid_read_information (clickid_t ctx, clickid_information_t info)
	ClickID read information function.

Detailed Description

This file contains API for ClickID Driver.

Enumeration Type Documentation

ClickID return value data.

Predefined enum values for driver return values.

Enumerator
CLICKID_OK
CLICKID_ERROR