sfDevXM125Presence.h

Go to the documentation of this file.

 
#pragma once
 
#include "sfDevXM125Core.h"
 
// Defines
 
// defines and data structs
/* ****************************** Presence Values ****************************** */
 
const uint32_t SFE_XM125_PRESENCE_DETECTOR_STATUS_MASK = 0b10010000111111110000000011111111;
 
const uint32_t SFE_XM125_PRESENCE_DETECTED_MASK = 0x00000001;
const uint32_t SFE_XM125_PRESENCE_DETECTED_STICKY_MASK = 0x00000002;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_ERROR_MASK = 0x00008000;
const uint32_t SFE_XM125_PRESENCE_TEMPERATURE_MASK = 0xffff0000;
const uint32_t SFE_XM125_PRESENCE_MAJOR_VERSION_MASK = 0xffff0000;
const uint32_t SFE_XM125_PRESENCE_MINOR_VERSION_MASK = 0x0000ff00;
const uint32_t SFE_XM125_PRESENCE_PATCH_VERSION_MASK = 0x000000ff;
 
const uint32_t SFE_XM125_PRESENCE_RSS_REGISTER_OK_MASK = 0x00000001;
const uint32_t SFE_XM125_PRESENCE_CONFIG_CREATE_OK_MASK = 0x00000002;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CREATE_OK_MASK = 0x00000004;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CALIBRATE_OK_MASK = 0x00000008;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_CREATE_OK_MASK = 0x00000010;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_BUFFER_OK_MASK = 0x00000020;
const uint32_t SFE_XM125_PRESENCE_SENSOR_BUFFER_OK_MASK = 0x00000040;
const uint32_t SFE_XM125_PRESENCE_CONFIG_APPLY_OK_MASK = 0x00000080;
const uint32_t SFE_XM125_PRESENCE_RSS_REGISTER_ERROR_MASK = 0x00010000;
const uint32_t SFE_XM125_PRESENCE_CONFIG_CREATE_ERROR_MASK = 0x00020000;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CREATE_ERROR_MASK = 0x00040000;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CALIBRATE_ERROR_MASK = 0x00080000;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_CREATE_ERROR_MASK = 0x00100000;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_BUFFER_ERROR_MASK = 0x00200000;
const uint32_t SFE_XM125_PRESENCE_SENSOR_BUFFER_ERROR_MASK = 0x00400000;
const uint32_t SFE_XM125_PRESENCE_CONFIG_APPLY_ERROR_MASK = 0x00800000;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_REG_ERROR_MASK = 0x10000000;
const uint32_t SFE_XM125_PRESENCE_BUSY_MASK = 0x80000000;
 
const uint32_t SFE_XM125_PRESENCE_ALL_ERROR_MASK =
    (SFE_XM125_PRESENCE_RSS_REGISTER_ERROR_MASK | SFE_XM125_PRESENCE_CONFIG_CREATE_ERROR_MASK |
     SFE_XM125_PRESENCE_SENSOR_CREATE_ERROR_MASK | SFE_XM125_PRESENCE_SENSOR_CALIBRATE_ERROR_MASK |
     SFE_XM125_PRESENCE_DETECTOR_CREATE_ERROR_MASK | SFE_XM125_PRESENCE_DETECTOR_BUFFER_ERROR_MASK |
     SFE_XM125_PRESENCE_SENSOR_BUFFER_ERROR_MASK | SFE_XM125_PRESENCE_CONFIG_APPLY_ERROR_MASK |
     SFE_XM125_PRESENCE_DETECTOR_REG_ERROR_MASK | SFE_XM125_PRESENCE_DETECTOR_ERROR_MASK |
     SFE_XM125_PRESENCE_BUSY_MASK);
 
const uint32_t SFE_XM125_PRESENCE_MAJOR_VERSION_MASK_SHIFT = 16;
const uint32_t SFE_XM125_PRESENCE_MINOR_VERSION_MASK_SHIFT = 8;
const uint32_t SFE_XM125_PRESENCE_RSS_REGISTER_ERROR_MASK_SHIFT = 15;
const uint32_t SFE_XM125_PRESENCE_CONFIG_CREATE_ERROR_MASK_SHIFT = 16;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CREATE_ERROR_MASK_SHIFT = 17;
const uint32_t SFE_XM125_PRESENCE_SENSOR_CALIBRATE_ERROR_MASK_SHIFT = 18;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_CREATE_ERROR_MASK_SHIFT = 19;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_BUFFER_ERROR_MASK_SHIFT = 20;
const uint32_t SFE_XM125_PRESENCE_SENSOR_BUFFER_ERROR_MASK_SHIFT = 21;
const uint32_t SFE_XM125_PRESENCE_CONFIG_APPLY_ERROR_MASK_SHIFT = 22;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_REG_ERROR_MASK_SHIFT = 27;
const uint32_t SFE_XM125_PRESENCE_DETECTOR_ERROR_MASK_SHIFT = 14;
const uint32_t SFE_XM125_PRESENCE_TEMPERATURE_MASK_SHIFT = 16;
const uint32_t SFE_XM125_PRESENCE_BUSY_MASK_SHIFT = 30;
 
const uint16_t SFE_XM125_PRESENCE_VERSION = 0x00;
typedef struct
{
    uint32_t presence_major : 16;
    uint32_t presence_minor : 8;
    uint32_t presence_patch : 8;
} sfe_xm125_presence_version_t;
 
const uint16_t SFE_XM125_PRESENCE_PROTOCOL_STATUS = 0x01;
typedef struct
{
    uint32_t presence_protocol_state_error : 1;
    uint32_t presence_packet_length_error : 1;
    uint32_t presence_address_error : 1;
    uint32_t presence_write_failed : 1;
    uint32_t presence_write_to_read_only : 1;
    uint32_t reserved1 : 27;
} sfe_xm125_presence_protocol_status_t;
 
const uint16_t SFE_XM125_PRESENCE_MEASURE_COUNTER = 0x02;
 
const uint16_t SFE_XM125_PRESENCE_DETECTOR_STATUS = 0x03;
typedef struct
{
    uint32_t presence_rss_register_ok : 1;
    uint32_t presence_config_create_ok : 1;
    uint32_t presence_sensor_create_ok : 1;
    uint32_t presence_sensor_calibrate_ok : 1;
    uint32_t presence_detector_create_ok : 1;
    uint32_t presence_detector_buffer_ok : 1;
    uint32_t presence_sensor_buffer_ok : 1;
    uint32_t presence_config_apply_ok : 1;
    uint32_t reserved1 : 8;
    uint32_t presence_rss_register_error : 1;
    uint32_t presence_config_create_error : 1;
    uint32_t presence_sensor_create_error : 1;
    uint32_t presence_sensor_calibrate_error : 1;
    uint32_t presence_detector_create_error : 1;
    uint32_t presence_detector_buffer_error : 1;
    uint32_t presence_sensor_buffer_error : 1;
    uint32_t presence_config_apply_error : 1;
    uint32_t reserved2 : 4;
    uint32_t presence_detector_error : 1;
    uint32_t reserved3 : 2;
    uint32_t presence_busy : 1;
 
} sfe_xm125_presence_detector_status_t;
 
const uint16_t SFE_XM125_PRESENCE_RESULT = 0x10;
typedef struct
{
    uint32_t presence_detected : 1;
    uint32_t presence_detected_sticky : 1;
    uint32_t reserved1 : 13;
    uint32_t presence_detector_error : 1;
    uint32_t presence_temperature : 16;
} sfe_xm125_presence_result_t;
 
const uint16_t SFE_XM125_PRESENCE_DISTANCE = 0x11;
const uint16_t SFE_XM125_INTRA_PRESENCE_SCORE = 0x12;
const uint16_t SFE_XM125_INTER_PRESENCE = 0x13;
 
const uint16_t SFE_XM125_PRESENCE_SWEEPS_PER_FRAME = 0x40;
const uint16_t sfe_xm125_presence_sweeps_per_frame_default = 16;
 
const uint16_t SFE_XM125_PRESENCE_INTER_FRAME_TIMEOUT = 0x41;
const uint16_t sfe_xm125_presence_inter_frame_timeout_default = 3;
 
const uint16_t SFE_XM125_PRESENCE_INTER_PHASE_BOOST_ENABLED = 0x42;
const bool sfe_xm125_presence_inter_phase_boost_enabled_default = false;
 
const uint16_t SFE_XM125_PRESENCE_INTRA_DETECTION_ENABLED = 0x43;
const bool sfe_xm125_presence_intra_detection_enabled_default = true;
 
const uint16_t SFE_XM125_PRESENCE_INTER_DETECTION_ENABLED = 0x44;
const bool sfe_xm125_presence_inter_detection_enabled_default = true;
 
const uint16_t SFE_XM125_PRESENCE_FRAME_RATE = 0x45;
const uint16_t sfe_xm125_presence_frame_rate_default = 12000;
 
const uint16_t SFE_XM125_PRESENCE_INTRA_DETECTION_THRESHOLD = 0x46;
const uint16_t sfe_xm125_presence_intra_detection_threshold_default = 1300;
 
const uint16_t SFE_XM125_PRESENCE_INTER_DETECTION_THRESHOLD = 0x47;
const uint16_t sfe_xm125_presence_inter_detection_threshold_default = 1000;
 
const uint16_t SFE_XM125_PRESENCE_INTER_FRAME_DEVIATION = 0x48;
const uint16_t sfe_xm125_presence_inter_frame_deviation_default = 500;
 
const uint16_t SFE_XM125_PRESENCE_INTER_FRAME_FAST_CUTOFF = 0x49;
const uint16_t sfe_xm125_presence_inter_frame_fast_cutoff_default = 6000;
 
const uint16_t SFE_XM125_PRESENCE_INTER_FRAME_SLOW_CUTOFF = 0x4a;
const uint16_t sfe_xm125_presence_inter_frame_slow_cutoff_default = 200;
 
const uint16_t SFE_XM125_PRESENCE_INTRA_FRAME_TIME_CONST = 0x4b;
const uint16_t sfe_xm125_presence_intra_frame_time_const_default = 150;
 
const uint16_t SFE_XM125_PRESENCE_INTRA_OUTPUT_TIME_CONST = 0x4c;
const uint16_t sfe_xm125_presence_intra_output_time_const_default = 300;
 
const uint16_t SFE_XM125_PRESENCE_INTER_OUTPUT_TIME_CONST = 0x4d;
const uint16_t sfe_xm125_presence_inter_output_time_const_default = 2000;
 
const uint16_t SFE_XM125_PRESENCE_AUTO_PROFILE_ENABLED = 0x4e;
const bool sfe_xm125_presence_auto_profile_enabled_default = true;
 
const uint16_t SFE_XM125_PRESENCE_AUTO_STEP_LENGTH_ENABLED = 0x4f;
const bool sfe_xm125_presence_auto_step_length_enabled_default = true;
 
const uint16_t SFE_XM125_PRESENCE_MANUAL_PROFILE = 0x50;
typedef enum
{
    XM125_PRESENCE_PROFILE1 = 1,
    XM125_PRESENCE_PROFILE2 = 2,
    XM125_PRESENCE_PROFILE3 = 3,
    XM125_PRESENCE_PROFILE4 = 4,
    XM125_PRESENCE_PROFILE5 = 5,
} sfe_xm125_presence_manual_profile_t;
 
const uint16_t SFE_XM125_PRESENCE_MANUAL_STEP_LENGTH = 0x51;
const uint16_t sfe_xm125_presence_manual_step_length_default = 72;
 
const uint16_t SFE_XM125_PRESENCE_START = 0x52;
const uint16_t sfe_xm125_presence_start_default = 250;
 
const uint16_t SFE_XM125_PRESENCE_END = 0x53;
const uint16_t sfe_xm125_presence_end_default = 2500;
 
const uint16_t SFE_XM125_PRESENCE_RESET_FILTERS_ON_PREPARE = 0x54;
const bool sfe_xm125_presence_reset_filters_on_prepare_default = true;
 
const uint16_t SFE_XM125_PRESENCE_HWAAS = 0x55;
const uint16_t sfe_xm125_presence_hwaas_default = 32;
 
const uint16_t SFE_XM125_PRESENCE_DETECTION_ON_GPIO = 0x80;
const bool sfe_xm125_presence_detection_on_gpio_default = false;
 
const uint16_t SFE_XM125_PRESENCE_COMMAND = 0x100;
typedef enum
{
    XM125_PRESENCE_APPLY_CONFIGURATION = 1,
    XM125_PRESENCE_START_DETECTOR = 2,
    XM125_PRESENCE_STOP_DETECTOR = 3,
    XM125_PRESENCE_ENABLE_UART_LOGS = 32,
    XM125_PRESENCE_DISABLE_UART_LOGS = 33,
    XM125_PRESENCE_LOG_CONFIGURATION = 34,
    XM125_PRESENCE_RESET_MODULE = 138119737,
} sfe_xm125_presence_command_t;
 
const uint32_t SFE_XM125_PRESENCE_APPLY_CONFIGURATION = 1;
const uint32_t SFE_XM125_PRESENCE_START_DETECTOR = 2;
const uint32_t SFE_XM125_PRESENCE_STOP_DETECTOR = 3;
const uint32_t SFE_XM125_PRESENCE_ENABLE_UART_LOGS = 32;
const uint32_t SFE_XM125_PRESENCE_DISABLE_UART_LOGS = 33;
const uint32_t SFE_XM125_PRESENCE_LOG_CONFIGURATION = 34;
const uint32_t SFE_XM125_PRESENCE_RESET_MODULE = 1381192737;
 
// Presence class definition
 
class sfDevXM125Presence : public sfDevXM125Core
{
  public:
    sfTkError_t begin(sfTkII2C *theBus = nullptr);
 
    sfTkError_t detectorStart(uint32_t start = 1000, uint32_t end = 5000);
 
    sfTkError_t getDistanceValuemm(uint32_t &presenceVal);
 
    sfTkError_t getDetectorVersion(uint32_t &major, uint32_t &minor, uint32_t &patch);
 
    sfTkError_t getDetectorError(uint32_t &error);
 
    sfTkError_t getMeasureCounter(uint32_t &counter);
 
    sfTkError_t getDetectorStatus(uint32_t &status);
 
    sfTkError_t getDetectorErrorStatus(uint32_t &status);
 
    sfTkError_t getDetectorPresenceDetected(uint32_t &detected);
 
    sfTkError_t getDetectorPresenceStickyDetected(uint32_t &sticky);
 
    sfTkError_t getDetectorRegError(uint32_t &error);
 
    sfTkError_t getTemperature(uint32_t &temp);
 
    sfTkError_t getDistance(uint32_t &distance);
 
    sfTkError_t getIntraPresenceScore(uint32_t &intra);
 
    sfTkError_t getInterPresenceScore(uint32_t &inter);
 
    sfTkError_t getSweepsPerFrame(uint32_t &sweeps);
 
    sfTkError_t setSweepsPerFrame(uint32_t sweeps);
 
    sfTkError_t getInterFramePresenceTimeout(uint32_t &time);
 
    sfTkError_t setInterFramePresenceTimeout(uint32_t time);
 
    sfTkError_t getInterPhaseBoostEnabled(bool &en);
 
    sfTkError_t setInterPhaseBoostEnabled(bool en);
 
    sfTkError_t getIntraDetectionEnabled(bool &en);
 
    sfTkError_t setInterDetectionEnabled(bool en);
 
    sfTkError_t getFrameRate(uint32_t &rate);
 
    sfTkError_t setFrameRate(uint32_t rate);
 
    sfTkError_t getIntraDetectionThreshold(uint32_t &thresh);
 
    sfTkError_t setIntraDetectionThreshold(uint32_t thresh);
 
    sfTkError_t getInterDetectionThreshold(uint32_t &thresh);
 
    sfTkError_t setInterDetectionThreshold(uint32_t thresh);
 
    sfTkError_t getInterFrameDeviationTime(uint32_t &time);
 
    sfTkError_t setInterFrameDeviationTime(uint32_t time);
 
    sfTkError_t getInterFrameFastCutoff(uint32_t &cut);
 
    sfTkError_t setInterFrameFastCutoff(uint32_t cut);
 
    sfTkError_t getInterFrameSlowCutoff(uint32_t &cut);
 
    sfTkError_t setInterFrameSlowCutoff(uint32_t cut);
 
    sfTkError_t getIntraFrameTimeConst(uint32_t &time);
 
    sfTkError_t setIntraFrameTimeConst(uint32_t time);
 
    sfTkError_t getIntraOutputTimeConst(uint32_t &time);
 
    sfTkError_t setIntraOutputTimeConst(uint32_t time);
 
    sfTkError_t getInterOutputTimeConst(uint32_t &time);
 
    sfTkError_t setInterOutputTimeConst(uint32_t time);
 
    sfTkError_t getAutoProfileEn(bool &en);
 
    sfTkError_t setAutoProfileEn(bool en);
 
    sfTkError_t getAutoStepLengthEn(bool &en);
 
    sfTkError_t setAutoStepLengthEn(bool en);
 
    sfTkError_t getManualProfile(uint32_t &prof);
 
    sfTkError_t setManualProfile(uint32_t prof);
 
    sfTkError_t getManualStepLength(uint32_t &length);
 
    sfTkError_t setManualStepLength(uint32_t length);
 
    sfTkError_t getStart(uint32_t &start);
 
    sfTkError_t setStart(uint32_t start);
 
    sfTkError_t getEnd(uint32_t &end);
 
    sfTkError_t setEnd(uint32_t end);
 
    sfTkError_t getResetFilters(bool &reset);
 
    sfTkError_t setResetFilters(bool reset);
 
    sfTkError_t getHWAAS(uint32_t &avg);
 
    sfTkError_t setHWAAS(uint32_t avg);
 
    sfTkError_t getDetectionOnGPIO(uint32_t &detected);
 
    sfTkError_t setDetectionOnGPIO(uint32_t detected);
 
    sfTkError_t setCommand(uint32_t cmd);
 
    sfTkError_t applyConfiguration();
 
    sfTkError_t start();
 
    sfTkError_t stop();
 
    sfTkError_t enableUartLogs();
 
    sfTkError_t disableUartLogs();
 
    sfTkError_t logConfiguration();
 
    sfTkError_t reset();
 
    sfTkError_t getBusy(uint32_t &busy);
 
    sfTkError_t busyWait();
};