i2ctocan 2.0.0.0
i2ctocan.h File Reference

This file contains API for I2C to CAN Click Driver. More...

#include "drv_digital_out.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  i2ctocan_t
 I2C to CAN Click context object. More...
 
struct  i2ctocan_cfg_t
 I2C to CAN Click configuration object. More...
 

Macros

#define I2CTOCAN_SET_DEV_ADDR   0x00
 I2C to CAN device address setting.
 
#define I2CTOCAN_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  i2ctocan_return_value_t { I2CTOCAN_OK = 0 , I2CTOCAN_ERROR = -1 }
 I2C to CAN Click return value data. More...
 

Functions

void i2ctocan_cfg_setup (i2ctocan_cfg_t *cfg)
 I2C to CAN configuration object setup function.
 
err_t i2ctocan_init (i2ctocan_t *ctx, i2ctocan_cfg_t *cfg)
 I2C to CAN initialization function.
 
err_t i2ctocan_default_cfg (i2ctocan_t *ctx)
 I2C to CAN default configuration function.
 
err_t i2ctocan_enable_device (i2ctocan_t *ctx)
 I2C to CAN enable the device function.
 
err_t i2ctocan_shutdown (i2ctocan_t *ctx)
 I2C to CAN shutdown the device function.
 
err_t i2ctocan_set_slave_address (i2ctocan_t *ctx, uint8_t slave_addr)
 Set I2C Slave address function.
 
err_t i2ctocan_generic_write (i2ctocan_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 I2C to CAN I2C writing function.
 
err_t i2ctocan_generic_read (i2ctocan_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 I2C to CAN I2C reading function.
 

Detailed Description

This file contains API for I2C to CAN Click Driver.

Enumeration Type Documentation

◆ i2ctocan_return_value_t

I2C to CAN Click return value data.

Predefined enum values for driver return values.

Enumerator
I2CTOCAN_OK 
I2CTOCAN_ERROR