sensor_lib.h

Go to the documentation of this file.

#ifndef TOPOSENS_SENSOR_LIB_H /* include control, avoid multiple includes of header file */
#define TOPOSENS_SENSOR_LIB_H

#ifdef __cplusplus
extern "C"
{
#endif

/*---- "library includes" -------------------------------------------------------------*/

/*---- "project includes" -------------------------------------------------------------*/
#include "config/sensor_lib_config.h"
#include "custom_structs.h"
#include "custom_types.h"
#include "message_flags.h"

/*---- <system includes> --------------------------------------------------------------*/
#include <stdbool.h>
#include <stdint.h>

/*---- public macros and constants ----------------------------------------------------*/
#define UID_SIZE 4
#define MAX_PARSED_LOG_MESSAGE_LEN 200
#define TIMEOUT_M_SECONDS 200000

  /*---- public types -------------------------------------------------------------------*/
  typedef struct UID_t
  {
    uint8_t values[UID_SIZE];
  } UID_t;

  typedef struct Point3D_t
  {
    int16_t X_i16;
    int16_t Y_i16;
    int16_t Z_i16;
    uint8_t Intensity_u8;
  } Point3D_t;

  typedef struct Point1D_t
  {
    uint16_t VectorLength_u16;
    uint8_t Intensity_u8;
  } Point1D_t;

  typedef enum SessionState_t
  {
    INIT,
    EXPECTED,
    RUNNING,
    COMPLETE,
  } SessionState_t;

  typedef struct Sensor_Session_t
  {
    SessionState_t SessionState;
    uint16_t SenderId_u16;
    uint8_t NumberOfPoints_u8;
    uint16_t NoiseLevel_u16;
    bool NearFieldPoint_b;
    uint8_t NumberOf1DPoints;
    uint8_t NumberOf3DPoints;
    Point1D_t Point1D_tp[MAX_NUMBER_OF_POINTS_PER_SESSION];
    Point3D_t Point3D_tp[MAX_NUMBER_OF_POINTS_PER_SESSION];
  } Sensor_Session_t;

  typedef struct ADCDump_t
  {
    SessionState_t SessionState;
    uint16_t SenderId_u16;
    uint32_t ExpectedDumpSize_u32;
    uint32_t ReceivedDumpSize_u32;
    uint8_t* DumpBlob_pu8;
  } ADCDump_t;

  typedef struct Sensor_t
  {
    uint16_t InterfaceSensorId_u16;
    uint8_t InterfaceIndex_u8;
    enum SensorMode_t SensorMode;
  } Sensor_t;

  typedef struct ACK_Status_t
  {
    uint16_t SenderId_u16; 
    bool WaitForACK_b;     
    bool ACK_b;            
    uint8_t ResponsePayload_pu8[CAN_MAX_FRAME_LEN]; 
  } ACK_Status_t;

  /*---- public variables prototypes ----------------------------------------------------*/

  /*---- public functions prototypes ----------------------------------------------------*/

  Sensor_t* GetKnownSensors();

  uint8_t GetNumberOfKnownSensors();

  void SetTargetSensor(uint16_t TargetSensor_u16);

  Version_t RequestVersion_t(VersionByte_t TargetComponent_t);

  // Actions

  bool RequestReboot();

  bool RequestMeasurement();

  bool RequestFactoryReset();

  bool RequestStoreSettings();

  bool RequestLoadSettings();

  bool RequestADCDump();

  // Setter

  // ADC

  bool SetParameterADCUseFixedFrameRate(bool UseFixedFrameRate_b);

  bool SetParameterADCFixedFrameRate(uint8_t FrameRate_u8);

  // Transducer

  bool SetParameterTransducerVolume(uint8_t Volume_u8);

  bool SetParameterTransducerNumOfPulses(uint8_t NumOfPulses_u8);

  // SignalProcessing

  bool SetParameterSignalProcessingTemperature(float Temperature_f);

  bool SetParameterSignalProcessingHumidity(uint8_t Humidity_u8);

  bool SetParameterSignalProcessingNoiseLevelThresholdFactor(float Factor_f);

  bool SetParameterSignalProcessingNoiseRatioThreshold(uint8_t Threshold_u8);

  bool SetParameterSignalProcessingEnableNearFieldDetection(bool Enable_b);

  bool SetParameterSignalProcessingEnableMultipathFilter(bool Enable_b);

  bool SetParameterSignalProcessingEnableAutoGain(bool Enable_b);

  // System

  bool SetParameterSystemNodeID(uint16_t NodeID_u16);

  bool SetParameterSystemLogLevel(LogLevel_t LogLevel_t);

  bool SetParameterSystemSensorMode(SensorMode_t Mode_t);

  // Getter

  bool GetParameterADCUseFixedFrameRate_b();

  uint8_t GetParameterADCFixedFrameRate_u8();

  // Transducer

  uint8_t GetParameterTransducerVolume_u8();

  uint8_t GetParameterTransducerNumOfPulses_u8();

  // SignalProcessing

  float GetParameterSignalProcessingTemperature_f();

  uint8_t GetParameterSignalProcessingHumidity_u8();

  float GetParameterSignalProcessingNoiseLevelThresholdFactor_f();

  uint8_t GetParameterSignalProcessingNoiseRatioThreshold_u8();

  bool GetParameterSignalProcessingEnableNearFieldDetection_b();

  bool GetParameterSignalProcessingEnableMultipathFilter_b();

  bool GetParameterSignalProcessingEnableAutoGain_b();

  // System

  uint16_t GetParameterSystemNodeID_u16();

  float GetParameterSystemMCUTemperature_f();

  LogLevel_t GetParameterSystemLogLevel_t();

  ResetReason_t GetParameterSystemResetReason_t();

  SensorState_t GetParameterSystemSensorState_t();

  UID_t GetParameterSystemUniqueID_t(uint8_t Index_u8);

  SensorMode_t GetParameterSystemSensorMode_t();

  bool GetParameterSystemCalibrationState_b();

  // Sessions

  uint16_t WaitForSessionStart();

  uint16_t WaitForSessionEnd();

  uint16_t WaitForADCSessionEnd();

  Sensor_Session_t* GetSessionData(uint16_t Sender_u16);

  ADCDump_t* GetADCDumpData(uint16_t Sender_u16);

  // Ready

  uint16_t WaitForReady();

  // Connections

  void InitInterface(char* InterfaceName, uint32_t DataRate_u32, CommsInterfaceType_t Interface_t);

  void DeinitInterface(CommsInterfaceType_t Interface_t);

  // Callbacks

  void RegisterSessionStartCallback(void (*Callback)(uint16_t Sender_u16));

  void RegisterPointSessionEndCallback(void (*Callback)(uint16_t Sender_u16));

  void RegisterADCDumpSessionEndCallback(void (*Callback)(uint16_t Sender_u16));

  void RegisterRdyCallback(void (*Callback)(uint16_t Sender_u16));

  void RegisterADCDumpStartRequestCallback(void (*Callback)(uint16_t Sender_u16,
                                                            uint32_t ADCDumpSize_32));

  void RegisterLogMsgCallback(void (*Callback)(uint16_t Sender_u16, uint8_t* ReceivedPayload_pu8));

  // Logging

  void ParseLogMessageToText(char* Output_p8, uint16_t SenderId_u16,
                             const uint8_t* ReceivedPayload_pu8);

  // Helpers

  void WaitForACK(uint8_t* payload, uint16_t length_u16);

  bool GetBoolFromPayload_b(const uint8_t* Payload_pu8);

  uint8_t GetU8FromPayload_u8(const uint8_t* Payload_pu8);

  uint8_t GetU8FromTwoArgumentPayload_u8(const uint8_t* Payload_pu8);

  uint16_t GetU16FromPayload_u16(const uint8_t* Payload_pu8);

  uint16_t GetU16FromTwoArgumentPayload_u16(const uint8_t* Payload_pu8);

  bool RequestWasSuccessful_b();

  uint8_t* GetResponsePayloadFromACKStatus(ACK_Status_t* ackstatus);

  ACK_Status_t* GetCurrentACKStatus(uint8_t index);

  int32_t GetI32FromPayload_i32(const uint8_t* Payload_pu8);

  int32_t GetI32FromTwoArgumentPayload_i32(const uint8_t* Payload_pu8);

  /*---- public inline functions --------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif  // TOPOSENS_SENSOR_LIB_H