lightranger7 2.1.0.0
lightranger7.h File Reference

This file contains API for LightRanger 7 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  lightranger7_t
 LightRanger 7 Click context object. More...
 
struct  lightranger7_cfg_t
 LightRanger 7 Click configuration object. More...
 

Macros

#define LIGHTRANGER7_CMD_START   's'
 LightRanger 7 control commands.
 
#define LIGHTRANGER7_CMD_STOP   'p'
 
#define LIGHTRANGER7_TX_DRV_BUFFER_SIZE   100
 LightRanger 7 driver buffer size.
 
#define LIGHTRANGER7_RX_DRV_BUFFER_SIZE   1000
 
#define LIGHTRANGER7_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  lightranger7_return_value_t { LIGHTRANGER7_OK = 0 , LIGHTRANGER7_ERROR = -1 }
 LightRanger 7 Click return value data. More...
 

Functions

void lightranger7_cfg_setup (lightranger7_cfg_t *cfg)
 LightRanger 7 configuration object setup function.
 
err_t lightranger7_init (lightranger7_t *ctx, lightranger7_cfg_t *cfg)
 LightRanger 7 initialization function.
 
err_t lightranger7_generic_write (lightranger7_t *ctx, uint8_t *data_in, uint16_t len)
 LightRanger 7 data writing function.
 
err_t lightranger7_generic_read (lightranger7_t *ctx, uint8_t *data_out, uint16_t len)
 LightRanger 7 data reading function.
 
err_t lightranger7_start_measurement (lightranger7_t *ctx)
 LightRanger 7 start measurement function.
 
err_t lightranger7_stop_measurement (lightranger7_t *ctx)
 LightRanger 7 stop measurement function.
 
void lightranger7_enable_device (lightranger7_t *ctx)
 LightRanger 7 enable device function.
 
void lightranger7_disable_device (lightranger7_t *ctx)
 LightRanger 7 disable device function.
 
void lightranger7_reset_device (lightranger7_t *ctx)
 LightRanger 7 reset device function.
 

Detailed Description

This file contains API for LightRanger 7 Click Driver.

Enumeration Type Documentation

◆ lightranger7_return_value_t

LightRanger 7 Click return value data.

Predefined enum values for driver return values.

Enumerator
LIGHTRANGER7_OK 
LIGHTRANGER7_ERROR