Diff: custom_ranging_sensor.h

Revision:

0:c1910e04fc6c

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/custom_ranging_sensor.h	Wed Jul 21 14:19:31 2021 +0000
@@ -0,0 +1,158 @@
+/**
+  ******************************************************************************
+  * @file    custom_ranging_sensor.h
+  * @author  IMG SW Application Team
+  * @brief   This file contains definitions for the BSP Ranging Sensors
+  *          interface for custom boards
+  ******************************************************************************
+  * @attention
+  *
+  * <h2><center>&copy; Copyright (c) 2021 STMicroelectronics.
+  * All rights reserved.</center></h2>
+  *
+  * This software component is licensed by ST under BSD 3-Clause license,
+  * the "License"; You may not use this file except in compliance with the
+  * License. You may obtain a copy of the License at:
+  *                        opensource.org/licenses/BSD-3-Clause
+  *
+  ******************************************************************************
+  */
+
+/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef __CUSTOM_RANGING_SENSOR_H__
+#define __CUSTOM_RANGING_SENSOR_H__
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+/* Includes ------------------------------------------------------------------*/
+
+#include "custom_tof_conf.h"
+#include "ranging_sensor.h"
+
+
+/* Common Error codes */
+#define BSP_ERROR_NONE                         0
+#define BSP_ERROR_NO_INIT                     -1
+#define BSP_ERROR_WRONG_PARAM                 -2
+#define BSP_ERROR_BUSY                        -3
+#define BSP_ERROR_PERIPH_FAILURE              -4
+#define BSP_ERROR_COMPONENT_FAILURE           -5
+#define BSP_ERROR_UNKNOWN_FAILURE             -6
+#define BSP_ERROR_UNKNOWN_COMPONENT           -7
+#define BSP_ERROR_BUS_FAILURE                 -8
+#define BSP_ERROR_CLOCK_FAILURE               -9
+#define BSP_ERROR_MSP_FAILURE                 -10
+#define BSP_ERROR_FEATURE_NOT_SUPPORTED       -11
+
+
+#ifndef USE_CUSTOM_RANGING_VL53L3CX
+#define USE_CUSTOM_RANGING_VL53L3CX (1U)
+#endif
+
+#if (USE_CUSTOM_RANGING_VL53L3CX == 1U)
+#include "vl53l3cx.h"
+#endif
+
+#if (USE_CUSTOM_RANGING_VL53L3CX == 1U)
+#define CUSTOM_VL53L3CX (1)
+#endif
+
+#define RANGING_SENSOR_VL53L3CX_ADDRESS     (VL53L3CX_DEVICE_ADDRESS)
+#define RANGING_SENSOR_NB_TARGET_PER_ZONE   (VL53L3CX_NB_TARGET_PER_ZONE)
+#define RANGING_SENSOR_MAX_NB_ZONES         (VL53L3CX_MAX_NB_ZONES)
+
+#define RS_MULTI_TARGET_SHORT_RANGE   (VL53L3CX_PROFILE_SHORT)
+#define RS_MULTI_TARGET_MEDIUM_RANGE	(VL53L3CX_PROFILE_MEDIUM)
+#define RS_MULTI_TARGET_LONG_RANGE		(VL53L3CX_PROFILE_LONG)
+
+#define RS_MODE_BLOCKING_CONTINUOUS     (VL53L3CX_MODE_BLOCKING_CONTINUOUS)
+#define RS_MODE_BLOCKING_ONESHOT        (VL53L3CX_MODE_BLOCKING_ONESHOT)
+#define RS_MODE_ASYNC_CONTINUOUS        (VL53L3CX_MODE_ASYNC_CONTINUOUS)
+#define RS_MODE_ASYNC_ONESHOT           (VL53L3CX_MODE_ASYNC_ONESHOT)
+
+#define CUSTOM_RANGING_INSTANCES_NBR    (3)
+
+#define CUSTOM_RANGING_POWERMODE_ON   	(0U)  /*!< run */
+#define CUSTOM_RANGING_POWERMODE_OFF  	(1U)  /*!< standby */
+
+#if (CUSTOM_RANGING_INSTANCES_NBR == 0U)
+#error "No ranging sensor instance has been selected"
+#endif
+
+typedef struct
+{
+  uint32_t NumberOfZones;
+  uint32_t MaxNumberOfTargetsPerZone;
+  uint32_t CustomROI;          /*!< Not available: 0, Available: 1 */
+  uint32_t ThresholdDetection; /*!< Not available: 0, Available: 1 */
+} RANGING_SENSOR_Capabilities_t;
+
+typedef struct
+{
+  uint32_t RangingProfile;
+  uint32_t TimingBudget;   /*!< Expressed in milliseconds */
+  uint32_t Frequency;      /*!< Expressed in Hz */
+  uint32_t EnableAmbient;  /*<! Enable: 1, Disable: 0 */
+  uint32_t EnableSignal;   /*<! Enable: 1, Disable: 0 */
+  PinName pin_gpio1;  // name of interrupt pin
+  uint32_t EnableInterrupt;   /*<! Enable: 1, Disable: 0 */
+  VL53L3CX_Interrupt_Func  Interrupt_Func;
+} RANGING_SENSOR_ProfileConfig_t;
+
+typedef struct
+{
+  uint8_t TopLeftX;   /*!< Top Left x coordinate */
+  uint8_t TopLeftY;   /*!< Top Left y coordinate */
+  uint8_t BotRightX;  /*!< Bot Right x coordinate */
+  uint8_t BotRightY;  /*!< Bot Right y coordinate */
+} RANGING_SENSOR_ROIConfig_t;
+
+typedef struct
+{
+  uint32_t Criteria;
+  uint32_t LowThreshold;
+  uint32_t HighThreshold;
+} RANGING_SENSOR_ITConfig_t;
+
+typedef struct
+{
+  uint32_t NumberOfTargets;
+  uint32_t Distance[RANGING_SENSOR_NB_TARGET_PER_ZONE];  /*!< millimeters */
+  uint32_t Status[RANGING_SENSOR_NB_TARGET_PER_ZONE];    /*!< OK: 0, NOK: !0 */
+  float_t Ambient[RANGING_SENSOR_NB_TARGET_PER_ZONE];    /*!< kcps / spad */
+  float_t Signal[RANGING_SENSOR_NB_TARGET_PER_ZONE];     /*!< kcps / spad */
+} RANGING_SENSOR_ZoneResult_t;
+
+typedef struct
+{
+  uint32_t NumberOfZones;
+  RANGING_SENSOR_ZoneResult_t ZoneResult[RANGING_SENSOR_MAX_NB_ZONES];
+} RANGING_SENSOR_Result_t;
+
+extern void *CUSTOM_RANGING_CompObj[CUSTOM_RANGING_INSTANCES_NBR];
+
+int32_t CUSTOM_RANGING_SENSOR_Init(uint32_t Instance);
+int32_t CUSTOM_RANGING_SENSOR_DeInit(uint32_t Instance);
+int32_t CUSTOM_RANGING_SENSOR_ReadID(uint32_t Instance, uint32_t *pId);
+int32_t CUSTOM_RANGING_SENSOR_GetCapabilities(uint32_t Instance, RANGING_SENSOR_Capabilities_t *pCapabilities);
+int32_t CUSTOM_RANGING_SENSOR_ConfigProfile(uint32_t Instance, RANGING_SENSOR_ProfileConfig_t *pConfig);
+int32_t CUSTOM_RANGING_SENSOR_ConfigROI(uint32_t Instance, RANGING_SENSOR_ROIConfig_t *pConfig);
+int32_t CUSTOM_RANGING_SENSOR_ConfigIT(uint32_t Instance, RANGING_SENSOR_ITConfig_t *pConfig);
+int32_t CUSTOM_RANGING_SENSOR_GetDistance(uint32_t Instance, RANGING_SENSOR_Result_t *pResult);
+int32_t CUSTOM_RANGING_SENSOR_Start(uint32_t Instance, uint8_t Mode);
+int32_t CUSTOM_RANGING_SENSOR_Stop(uint32_t Instance);
+int32_t CUSTOM_RANGING_SENSOR_SetAddress(uint32_t Instance, uint16_t Address);
+int32_t CUSTOM_RANGING_SENSOR_GetAddress(uint32_t Instance, uint16_t *pAddress);
+int32_t CUSTOM_RANGING_SENSOR_SetPowerMode(uint32_t Instance, uint32_t PowerMode);
+int32_t CUSTOM_RANGING_SENSOR_GetPowerMode(uint32_t Instance, uint32_t *pPowerMode);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __CUSTOM_RANGING_SENSOR_H__ */
+
+/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
+