Maxim Integrated / Mbed OS MAXREFDES101_SOURCE

HSP Platform firmware evaluating ECG data and hearth rate over PPG data.

Dependencies:   max32630fthr Adafruit_FeatherOLED USBDevice

Interfaces/SensorComm/SensorComm/SensorComm.h@4:682a4ebb995a, 2021-03-25 (annotated)

Committer:
phonemacro
Date:
Thu Mar 25 21:59:17 2021 +0000
Revision:
4:682a4ebb995a
Parent:
1:f60eafbf009a 
fix compile errors from mbed OS changes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gmehmet 1:f60eafbf009a 1 /*******************************************************************************
gmehmet 1:f60eafbf009a 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
gmehmet 1:f60eafbf009a 3 *
gmehmet 1:f60eafbf009a 4 * Permission is hereby granted, free of charge, to any person obtaining a
gmehmet 1:f60eafbf009a 5 * copy of this software and associated documentation files (the "Software"),
gmehmet 1:f60eafbf009a 6 * to deal in the Software without restriction, including without limitation
gmehmet 1:f60eafbf009a 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
gmehmet 1:f60eafbf009a 8 * and/or sell copies of the Software, and to permit persons to whom the
gmehmet 1:f60eafbf009a 9 * Software is furnished to do so, subject to the following conditions:
gmehmet 1:f60eafbf009a 10 *
gmehmet 1:f60eafbf009a 11 * The above copyright notice and this permission notice shall be included
gmehmet 1:f60eafbf009a 12 * in all copies or substantial portions of the Software.
gmehmet 1:f60eafbf009a 13 *
gmehmet 1:f60eafbf009a 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
gmehmet 1:f60eafbf009a 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gmehmet 1:f60eafbf009a 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
gmehmet 1:f60eafbf009a 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
gmehmet 1:f60eafbf009a 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
gmehmet 1:f60eafbf009a 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
gmehmet 1:f60eafbf009a 20 * OTHER DEALINGS IN THE SOFTWARE.
gmehmet 1:f60eafbf009a 21 *
gmehmet 1:f60eafbf009a 22 * Except as contained in this notice, the name of Maxim Integrated
gmehmet 1:f60eafbf009a 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
gmehmet 1:f60eafbf009a 24 * Products, Inc. Branding Policy.
gmehmet 1:f60eafbf009a 25 *
gmehmet 1:f60eafbf009a 26 * The mere transfer of this software does not imply any licenses
gmehmet 1:f60eafbf009a 27 * of trade secrets, proprietary technology, copyrights, patents,
gmehmet 1:f60eafbf009a 28 * trademarks, maskwork rights, or any other form of intellectual
gmehmet 1:f60eafbf009a 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
gmehmet 1:f60eafbf009a 30 * ownership rights.
gmehmet 1:f60eafbf009a 31 *******************************************************************************
gmehmet 1:f60eafbf009a 32 */
gmehmet 1:f60eafbf009a 33
gmehmet 1:f60eafbf009a 34 #ifndef _SENSORCOMM_H_
gmehmet 1:f60eafbf009a 35 #define _SENSORCOMM_H_
gmehmet 1:f60eafbf009a 36
gmehmet 1:f60eafbf009a 37 #include "mbed.h"
gmehmet 1:f60eafbf009a 38 #include <stdint.h>
gmehmet 1:f60eafbf009a 39 #include "MaximSensor.h"
gmehmet 1:f60eafbf009a 40
gmehmet 1:f60eafbf009a 41 /**
gmehmet 1:f60eafbf009a 42 * @brief SensorComm is Maxim Sensor Studio GUI command handler base class.
gmehmet 1:f60eafbf009a 43 * @details SensorComm includes base functions and data structures for to
gmehmet 1:f60eafbf009a 44 * create new command handler classes. All command handler classes should
gmehmet 1:f60eafbf009a 45 * implement this class.
gmehmet 1:f60eafbf009a 46 */
gmehmet 1:f60eafbf009a 47 class SensorComm
gmehmet 1:f60eafbf009a 48 {
gmehmet 1:f60eafbf009a 49 public:
gmehmet 1:f60eafbf009a 50
gmehmet 1:f60eafbf009a 51 //Flag to check if ascii is enabled
gmehmet 1:f60eafbf009a 52 static bool AsciiEn;
gmehmet 1:f60eafbf009a 53
gmehmet 1:f60eafbf009a 54 const static uint8_t kMaxRegisterInOneStruct = 4;
gmehmet 1:f60eafbf009a 55
gmehmet 1:f60eafbf009a 56 // size of that struct is 20 bytes(checked)
gmehmet 1:f60eafbf009a 57 typedef struct{
gmehmet 1:f60eafbf009a 58 uint8_t reg_adresses[4];
gmehmet 1:f60eafbf009a 59 uint32_t reg_values[4];
gmehmet 1:f60eafbf009a 60 }Reg_Val_BLE;
gmehmet 1:f60eafbf009a 61
gmehmet 1:f60eafbf009a 62 /* PUBLIC FUNCTION DECLARATIONS */
gmehmet 1:f60eafbf009a 63 /**
gmehmet 1:f60eafbf009a 64 * @brief SensorComm constructor.
gmehmet 1:f60eafbf009a 65 *
gmehmet 1:f60eafbf009a 66 * @param[in] sensorType Name of sensor (ie "ppg")
gmehmet 1:f60eafbf009a 67 * @param[in] visible Whether this sensor should be visible to users in DeviceStudio
gmehmet 1:f60eafbf009a 68 */
gmehmet 1:f60eafbf009a 69 SensorComm(const char *type, bool visible);
gmehmet 1:f60eafbf009a 70
gmehmet 1:f60eafbf009a 71 /**
gmehmet 1:f60eafbf009a 72 * @brief SensorComm destructor.
gmehmet 1:f60eafbf009a 73 *
gmehmet 1:f60eafbf009a 74 */
gmehmet 1:f60eafbf009a 75 virtual ~SensorComm();
gmehmet 1:f60eafbf009a 76
gmehmet 1:f60eafbf009a 77 /**
gmehmet 1:f60eafbf009a 78 * @brief Initializer for SensorComm.
gmehmet 1:f60eafbf009a 79 *
gmehmet 1:f60eafbf009a 80 * @param[in] s MaximSensor instance to handle sensor commands.
gmehmet 1:f60eafbf009a 81 */
gmehmet 1:f60eafbf009a 82 void comm_init(MaximSensor *s);
gmehmet 1:f60eafbf009a 83
gmehmet 1:f60eafbf009a 84 /**
gmehmet 1:f60eafbf009a 85 * @brief Get the type of the sensor
gmehmet 1:f60eafbf009a 86 *
gmehmet 1:f60eafbf009a 87 * @param[out] char* to name of type (ie "ppg")
gmehmet 1:f60eafbf009a 88 */
gmehmet 1:f60eafbf009a 89 const char* get_type();
gmehmet 1:f60eafbf009a 90
gmehmet 1:f60eafbf009a 91 /**
gmehmet 1:f60eafbf009a 92 * @brief Get the maxim part name of the sensor
gmehmet 1:f60eafbf009a 93 *
gmehmet 1:f60eafbf009a 94 * @param[out] char* to name (ie "max86140")
gmehmet 1:f60eafbf009a 95 */
gmehmet 1:f60eafbf009a 96 virtual const char* get_part_name();
gmehmet 1:f60eafbf009a 97
gmehmet 1:f60eafbf009a 98 /**
gmehmet 1:f60eafbf009a 99 * @brief Get the maxim algorithm version of the sensor
gmehmet 1:f60eafbf009a 100 *
gmehmet 1:f60eafbf009a 101 * @param[out] char* to name (ie "max86140")
gmehmet 1:f60eafbf009a 102 */
gmehmet 1:f60eafbf009a 103 virtual const char* get_algo_ver();
gmehmet 1:f60eafbf009a 104
gmehmet 1:f60eafbf009a 105 /**
gmehmet 1:f60eafbf009a 106 * @brief Get the id and revision of the part
gmehmet 1:f60eafbf009a 107 *
gmehmet 1:f60eafbf009a 108 */
gmehmet 1:f60eafbf009a 109 int get_part_info(uint8_t *part_id, uint8_t *part_rev);
gmehmet 1:f60eafbf009a 110
gmehmet 1:f60eafbf009a 111 /**
gmehmet 1:f60eafbf009a 112 * @brief Returns whether the sensor should be visible to users in DeviceStudio
gmehmet 1:f60eafbf009a 113 */
gmehmet 1:f60eafbf009a 114 bool is_visible() { return vis; }
gmehmet 1:f60eafbf009a 115
gmehmet 1:f60eafbf009a 116 /**
gmehmet 1:f60eafbf009a 117 * @brief Get whether or not the sensor is enabled
gmehmet 1:f60eafbf009a 118 *
gmehmet 1:f60eafbf009a 119 * @param[out] true if the sensor is enabled
gmehmet 1:f60eafbf009a 120 */
gmehmet 1:f60eafbf009a 121 bool is_enabled();
gmehmet 1:f60eafbf009a 122
gmehmet 1:f60eafbf009a 123 /**
gmehmet 1:f60eafbf009a 124 * @brief Get data report mode of the sensor
gmehmet 1:f60eafbf009a 125 *
gmehmet 1:f60eafbf009a 126 * @param[out] data report mode
gmehmet 1:f60eafbf009a 127 */
gmehmet 1:f60eafbf009a 128 uint8_t get_data_report_mode();
gmehmet 1:f60eafbf009a 129
gmehmet 1:f60eafbf009a 130
gmehmet 1:f60eafbf009a 131
gmehmet 1:f60eafbf009a 132 /**
gmehmet 1:f60eafbf009a 133 * @brief Stop collecting data and disable sensor
gmehmet 1:f60eafbf009a 134 */
gmehmet 1:f60eafbf009a 135 virtual void stop();
gmehmet 1:f60eafbf009a 136
gmehmet 1:f60eafbf009a 137 /**
gmehmet 1:f60eafbf009a 138 * @brief Parses DeviceStudio commands.
gmehmet 1:f60eafbf009a 139 * @details Parses and executes commands. Prints return code to i/o device.
gmehmet 1:f60eafbf009a 140 *
gmehmet 1:f60eafbf009a 141 * @param[in] cmd - Command to parse
gmehmet 1:f60eafbf009a 142 *
gmehmet 1:f60eafbf009a 143 * @returns true if sensor acted upon the command, false if command was unknown
gmehmet 1:f60eafbf009a 144 */
gmehmet 1:f60eafbf009a 145 virtual bool parse_command(const char* cmd);
gmehmet 1:f60eafbf009a 146
gmehmet 1:f60eafbf009a 147 /**
gmehmet 1:f60eafbf009a 148 * @brief Fill in buffer with sensor data
gmehmet 1:f60eafbf009a 149 *
gmehmet 1:f60eafbf009a 150 * @param[in] buf Buffer to fill data into
gmehmet 1:f60eafbf009a 151 * @param[in] size Maximum size of buffer
gmehmet 1:f60eafbf009a 152 * @param[out] Number of bytes written to buffer
gmehmet 1:f60eafbf009a 153 */
gmehmet 1:f60eafbf009a 154 virtual int data_report_execute(char* buf, int size);
gmehmet 1:f60eafbf009a 155
gmehmet 1:f60eafbf009a 156 /**
gmehmet 1:f60eafbf009a 157 *
gmehmet 1:f60eafbf009a 158 * @param status
gmehmet 1:f60eafbf009a 159 */
gmehmet 1:f60eafbf009a 160 void SensorComm_Set_Ble_Status(bool status);
gmehmet 1:f60eafbf009a 161
gmehmet 1:f60eafbf009a 162 void SensorComm_Set_Flash_Status(bool status);
gmehmet 1:f60eafbf009a 163
gmehmet 1:f60eafbf009a 164 int InsertRegValuesIntoBleQeueu(addr_val_pair *reg_values, uint8_t reg_count);
gmehmet 1:f60eafbf009a 165
gmehmet 1:f60eafbf009a 166 virtual unsigned char get_sensor_id();
gmehmet 1:f60eafbf009a 167
gmehmet 1:f60eafbf009a 168 protected:
gmehmet 1:f60eafbf009a 169
gmehmet 1:f60eafbf009a 170 /* PROTECTED VARIABLES */
gmehmet 1:f60eafbf009a 171 Mutex comm_mutex;
gmehmet 1:f60eafbf009a 172
gmehmet 1:f60eafbf009a 173 MaximSensor *sensor;
gmehmet 1:f60eafbf009a 174
gmehmet 1:f60eafbf009a 175 int sensor_get_reg(char *ptr_ch, uint8_t *reg_addr, uint8_t *value);
gmehmet 1:f60eafbf009a 176 int sensor_set_reg(char *ptr_ch);
gmehmet 1:f60eafbf009a 177
gmehmet 1:f60eafbf009a 178 volatile uint8_t data_report_mode;
gmehmet 1:f60eafbf009a 179 volatile uint8_t console_interface_exists;
gmehmet 1:f60eafbf009a 180 volatile bool m_sensorcomm_ble_interface_exists_;
gmehmet 1:f60eafbf009a 181 volatile bool m_sensorcomm_flash_rec_started_;
gmehmet 1:f60eafbf009a 182
gmehmet 1:f60eafbf009a 183 const char* sensor_type;
gmehmet 1:f60eafbf009a 184 bool vis;
gmehmet 1:f60eafbf009a 185 int sample_count;
gmehmet 1:f60eafbf009a 186 };
gmehmet 1:f60eafbf009a 187
gmehmet 1:f60eafbf009a 188 #endif /* _SENSORCOMM_H_ */