vl53l5cx_platform.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 Fabien-B <name.surname@gmail.com>
 *
 * This file is part of paparazzi
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 */
 
 
#ifndef _PLATFORM_H_
#define _PLATFORM_H_
#pragma once
 
#include <stdint.h>
#include <string.h>
#include "mcu_periph/i2c.h"
 
#define VL53L5CX_I2C_BUF_SIZE 512
 
 
enum VL53L5CX_ERRORS {
  VL53L5CX_NO_ERROR = 0,
  VL53L5CX_NOT_DETECTED = 1,
  VL53L5CX_ULD_LOADING_FAILED = 2,
  VL53L5CX_SET_RESOLUTION_FAILED = 3,
  VL53L5CX_RUNTIME_FAILURE = 4,
};
 
typedef struct
{
  /* To be filled with customer's platform. At least an I2C address/descriptor
   * needs to be added */
  /* Example for most standard platform : I2C address of sensor */
  uint16_t        address;
  //I2CDriver*      i2cp;
  struct i2c_periph *i2cdev;
  bool data_available;
  int16_t distances_mm[64];
 
  enum VL53L5CX_ERRORS error_code;
  uint8_t buf[VL53L5CX_I2C_BUF_SIZE+2];
  void* user_data;
 
} VL53L5CX_Platform;
 
/*
 * @brief The macro below is used to define the number of target per zone sent
 * through I2C. This value can be changed by user, in order to tune I2C
 * transaction, and also the total memory size (a lower number of target per
 * zone means a lower RAM). The value must be between 1 and 4.
 */
 
#define   VL53L5CX_NB_TARGET_PER_ZONE   1U
 
/*
 * @brief The macro below can be used to avoid data conversion into the driver.
 * By default there is a conversion between firmware and user data. Using this macro
 * allows to use the firmware format instead of user format. The firmware format allows
 * an increased precision.
 */
 
// #define  VL53L5CX_USE_RAW_FORMAT
 
/*
 * @brief All macro below are used to configure the sensor output. User can
 * define some macros if he wants to disable selected output, in order to reduce
 * I2C access.
 */
 
// #define VL53L5CX_DISABLE_AMBIENT_PER_SPAD
// #define VL53L5CX_DISABLE_NB_SPADS_ENABLED
// #define VL53L5CX_DISABLE_NB_TARGET_DETECTED
// #define VL53L5CX_DISABLE_SIGNAL_PER_SPAD
// #define VL53L5CX_DISABLE_RANGE_SIGMA_MM
// #define VL53L5CX_DISABLE_DISTANCE_MM
// #define VL53L5CX_DISABLE_REFLECTANCE_PERCENT
// #define VL53L5CX_DISABLE_TARGET_STATUS
// #define VL53L5CX_DISABLE_MOTION_INDICATOR
 
uint8_t RdByte(
    VL53L5CX_Platform *p_platform,
    uint16_t RegisterAdress,
    uint8_t *p_value);
 
uint8_t WrByte(
    VL53L5CX_Platform *p_platform,
    uint16_t RegisterAdress,
    uint8_t value);
 
uint8_t RdMulti(
    VL53L5CX_Platform *p_platform,
    uint16_t RegisterAdress,
    uint8_t *p_values,
    uint32_t size);
 
uint8_t WrMulti(
    VL53L5CX_Platform *p_platform,
    uint16_t RegisterAdress,
    uint8_t *p_values,
    uint32_t size);
 
// uint8_t Reset_Sensor(
//    VL53L5CX_Platform *p_platform);
 
void SwapBuffer(
    uint8_t     *buffer,
    uint16_t     size);
uint8_t WaitMs(
    VL53L5CX_Platform *p_platform,
    uint32_t TimeMs);
 
#endif  // _PLATFORM_H_